Gsm |
GSM modem component library that communicates with a GSM modem or phone with integrated modem.
This component works with AT(Hayes) compliant GSM modems connected to one of the serial ports.You can use it also with USB, IrDA and bluetooth devices, because these devices have a driver that redirects the input from the USB, IrDA or bluetooth port to a virtual serial port (you can check it in System/Device Manager/Modems).
To use with Android smart phones, you have to install the USB drivers first, activate USB debugging and connect it with USB cable as transferring files.
Inheritance HierarchyNamespace: ZylSoft.Gsm
Assembly: ZylGsm (in ZylGsm.dll) Version: 1.2.0.21451
XMLNS for XAML: Not mapped to an xmlns.
SyntaxThe GsmModem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GsmModem | Constructor. |
| GsmModem(IContainer) | Constructor. |
| GsmModem(SerialCommPort) | Constructor. |
| GsmModem(SerialCommPort, SerialBaudRate) | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | AutoReadNewMessage | If this property is true (default value), then new incoming messages are read automatically and after this, their status will be set to "received read message" (ReadMessage event). |
| AutoReconnect | Set this property to true, if you want to automatically reconnect to the serial port after a Faulted event, when the port is available again. Set AutoReconnect to true, before the port is faulted, otherwise it will have no effect. The default value is false. |
| AutoReconnectCheckInterval | The time interval in milliseconds the serial port is trying to periodically reconnect, after a Faulted event occur, if AutoReconnect is set to true. It must be a positive value. The default value is 4000. |
| BaudRate | Baud rate at which the communications device operates. |
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CloseWhenLineStatusIsZero | When this property is true and line status becomes 0 (supposing that it was non 0 after the port has been opened), the port will be closed automatically. Set it to true, for improved fault detection. If you have problems with the port closing itself automatically immediately after open, set this property to false. The default value is true. |
| ConnectedTo | Returns the physical port where the component is connected to. |
| ConnectionTime | Indicates when the last connection was established. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| CustomBaudRate | Custom baud rate value, used when BaudRate is set to Custom. |
| CustomPortName | Custom port name can be used when Port is set to Custom. You can use any name, different from COMMxx. |
| DataWidth | Number of bits in the bytes transmitted and received. |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| DetectionMethod | Detection method for detecting GSM modem. |
| EnableDtrOnOpen | Enable/disable DTR when the port is open. |
| EnableRtsOnOpen | Enable/disable RTS when the port is open. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| HardwareFlowControl | Hardware flow control of the serial port. |
| IdleInterval | Idle time interval in milliseconds. If the elapsed time from the last receive is higher than IdleInterval, Idle event occurs. If IdleInterval is 0, Idle event never occurs. |
| IdleTimeoutInterval | You can set a time-out value to automatically close the connection and fire the IdleTimeout event, if there is no data received in several milliseconds. A value of zero indicates that time-out is not used. |
| InputBuffer | Recommended size of the device's internal input buffer, in bytes. |
| Interval | Time interval between two receiving in milliseconds (frequency). |
 | IsFaulted | Indicates that the last connection was faulted. |
| IsIdle | True if Idle occurred, until Resumed. |
| IsListing | True, if the stored messages are listing, false, if already done. Use it with GetAllSms method, to be able to determine when all the messages were read. |
| IsReceiving | This property is false when the component is receiving data from the port, otherwise is false. Use this property to check if the component is inside a receiving process. |
| IsSending | This property is true when the component is sending data to the port, otherwise is false. Use this property to check if the component is inside a sending process. |
| LastTimeReceived | Last date-time when data received from the serial port. |
| MaxMemoryPhonebookContactCount | Maximum number of contacts in memory phonebook. |
| MaxSimPhonebookContactCount | Maximum number of contacts in SIM phone book. |
| MemoryPhonebook | Phonebook of the phone's memory. |
| MessageFormat | SMS message format. Can be PDU or text. |
| MinCheckDisconnectedInterval | The minimum time interval in milliseconds, for which the port availability is checked. For time critical usage it's recommended to set it to a higher value. Default value is 50. |
| NeedSynchronization | Set this property to true for thread safety. The default value is false. Note: if you set it to true, you may experiment thread interblocking and lower speed. |
| OutputBuffer | Recommended size of the device's internal output buffer, in bytes. |
| ParityBits | Parity scheme to be used. |
| Pin | PIN code. |
| Port | Physical name of the serial port. |
| Priority | Priority of the receiver thread. |
| ReadIntervalTimeout | Maximum time allowed to elapse between the arrival of two characters on the communications line, in milliseconds. During a ReadFile operation, the time period begins when the first character is received. If the interval between the arrival of any two characters exceeds this amount, the ReadFile operation is completed and any buffered data is returned. A value of zero indicates that interval time-outs are not used. A value of MAXDWORD, combined with zero values for both the ReadTotalTimeoutConstant and ReadTotalTimeoutMultiplier members, specifies that the read operation is to return immediately with the characters that have already been received, even if no characters have been received. |
| ReadTotalTimeoutConstant | Constant used to calculate the total time-out period for read operations, in milliseconds. For each read operation, this value is added to the product of the ReadTotalTimeoutMultiplier member and the requested number of bytes. A value of zero for both the ReadTotalTimeoutMultiplier and ReadTotalTimeoutConstant members indicates that total time-outs are not used for read operations. |
| ReadTotalTimeoutMultiplier | Multiplier used to calculate the total time-out period for read operations, in milliseconds. For each read operation, this value is multiplied by the requested number of bytes to be read. |
| SimPhonebook | Phonebook of the SIM card. |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| SkipInit | Skip initialization commands at open. |
| SkipSetupFailed | When this property is true, if setting serial parameters like DCB in the Open method fails, will ignore this. Otherwise method Open will return false and the port will not be opened. |
| SoftwareFlowControl | Software flow control of the serial port. |
| StopBits | Number of stop bits to be used. |
| StorageLocation | SMS storage location. Can be SIM or phone memory. |
 | UnlockKey | It is used to protect your software after deployment. You will have to set it to the correct value, before opening the port. You will find the key in your software package. |
| WriteTotalTimeoutConstant | Constant used to calculate the total time-out period for write operations, in milliseconds. For each write operation, this value is added to the product of the WriteTotalTimeoutMultiplier member and the number of bytes to be written. A value of zero for both the WriteTotalTimeoutMultiplier and WriteTotalTimeoutConstant members indicates that total time-outs are not used for write operations. |
| WriteTotalTimeoutMultiplier | Multiplier used to calculate the total time-out period for write operations, in milliseconds. For each write operation, this value is multiplied by the number of bytes to be written. |
Methods| Name | Description | |
|---|---|---|
| AddContact | Add a contact to the phone book. |
| AnswerCall | Answer incoming call. |
| AsciiByteArrayToString | Converts ANSI byte array to string. |
| ByteArrayToDecimalString | Converts byte array to decimal string representation. |
| ByteArrayToHexaString | Converts byte array to hexadecimal string representation. |
| ClearInputBuffer | Clears input buffer |
| ClearOutputBuffer | Clears output buffer |
| Close | Closes the serial port. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| DeleteContact | Delete a contact from the phone book. |
| DeleteSms | Delete an SMS message specified by index from the selected location (PhoneSim or PhoneMemory). |
| DetectAllGsm | Detects all GSM modems connected to the system and returns the communication port and baud rate. |
| DetectAllGsm(SerialBaudRate, SerialBaudRate) | Detects all GSM modems connected to the system and returns the communication port and baud rate. Only baud rate values between startBaudRate and endBaudRate are checked. |
| DetectGsm(SerialCommPort, SerialBaudRate) | Detects the first GSM modem connected to the system and returns as output parameters the communication port and baud rate. |
| DetectGsm(String, SerialBaudRate) | Detects the first GSM modem connected to the system and returns as output parameters the communication port and baud rate. |
| DetectGsm(SerialBaudRate, SerialBaudRate, String, SerialBaudRate) | Detects the first GSM modem connected to the system and returns as output parameters the communication port and baud rate. Only baud rate values between startBaudRate and endBaudRate are checked. |
| DetectGsm(SerialBaudRate, SerialBaudRate, SerialCommPort, SerialBaudRate) | Detects the first GSM modem connected to the system and returns as output parameters the communication port and baud rate. Only baud rate values between startBaudRate and endBaudRate are checked. |
| DialData | Dial phone number in data mode. |
| DialVoice | Dial phone number in voice mode. |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
 | Dispose(Boolean) |
Clean up any resources being used.
(Overrides ComponentDispose(Boolean)) |
| EnableEcho | Enable or disable echo. |
| EnterPin | Enter PIN code if necessary. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteATCommand(String, Char) | Execute AT command. |
| ExecuteATCommand(String, ListString, Int32, Char) | Execute AT command. |
| Finalize |
Finalizer.
(Overrides ComponentFinalize) |
| GetAllSms | Return all the SMS from location memory (PhoneSim or PhoneMemory), depending on SmsType. |
| GetAvailableInputBufferSize | Returns the size of the buffer available to be read (bytes to read). You can use this method, before ReadBuffer. |
| GetExistingCommPortNames | Returns the existing serial port names of the system. |
| GetExistingCommPorts | Returns the existing serial ports of the system. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetImei | Return IMEI number of the modem / phone. |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetSms | Returns the SMS from location memory (PhoneSim or PhoneMemory), indicated by index. If the message exists, ReadMessage event will fire with the text of the message, time stamp, caller and center number. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Gsm7BitDefaultAlphabet | Return GSM 7 bit alphabet. |
| HideMyPhoneNumber | Hide or show phone number, when calling. |
| InitGsmModem | Initialize the modem. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| IntToSerialCommPort | Converts string to SerialCommPort. |
| IsConnected | Returns true if the serial port is connected. |
| IsExistingCommPort(SerialCommPort) | Checks if a serial port exists. |
| IsExistingCommPort(String) | Checks if a serial port exists. |
| LoadPhonebook | Load the phonebook of the phone. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| OnConnected | Raises the Connected event. |
| OnContactLoaded | Raises the ContactLoaded event. |
| OnDetecting | Raises the Detecting event. |
| OnDisconnected | Raises the Disconnected event. |
| OnError | Raises the Error event. |
| OnFaulted | Raises the Faulted event. |
| OnIdle | Raises the Idle event. |
| OnIdleTimeout | Raises the IdleTimeout event. |
| OnInitialized | Raises the Initialized event. |
| OnNewMessage | Raises the NewMessage event. |
| OnReadMessage | Raises the ReadMessage event. |
| OnReceived | Raises the Received event. |
| OnReconnecting | Raises the Reconnecting event. |
| OnResumed | Raises the Resumed event. |
| OnRing | Raises the Ring event. |
| OnSent | Raises the Sent event. |
| Open | Opens the serial port. |
| ReadBuffer | Synchronously reads the received data from the serial port to a byte array. Otherwise returns null. |
| ReadStringUpToEndChars | Reads the serial port up to the first occurence of one of the endChars sequences of the endCharsList collection. |
| ResetIdleState | Resets the idle state of the port. |
| SendAsciiString | Send an ASCII string to the serial port. |
| SendByteArray | Send a byte array to the serial port. |
| SendSmsAsPdu | Send SMS in PDU format. |
| SendSmsAsText | Send SMS in text format. |
| SerialCommPortToString | Converts SerialCommPort to string. |
| SetAutoAnswer | Set auto answer. |
| SetMessageFormat | Set the SMS message format. |
| SetStorageLocation | Set SMS storage location. |
| StringToAsciiByteArray | Converts string to ANSI byte array. |
| StringToSerialCommPort | Converts string to SerialCommPort. |
| TerminateCall | Hang up current call. |
| TestDevice | Tests if the connection is alive. |
| TestGsmModemCapabilities | Tests the capability of the GSM modem. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | Connected | Occurs after the serial port is connected. |
| ContactLoaded | Occurs when a contact is loaded from the phone book. |
| Detecting | Occurs when the GPS receiver detection is in progress and there are new values of port or baud rate in view. |
| Disconnected | Occurs when the serial port is disconnected. |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| Error | Occurs when the GSM modem reports an error in the command execution. |
| Faulted | Occurs when the serial port communication is faulted. |
| Idle | If the elapsed time from the last receive is higher than IdleInterval (milliseconds), Idle event occurs. If IdleTinerval is 0, this event will never occur. |
| IdleTimeout | Occurs when there is no data received in several milliseconds, the interval is specified in the IdleTimeoutInterval property. |
| Initialized | Occurs after the GSM modem was initialized. |
| NewMessage | Occurs when new SMS message is received. |
| ReadMessage | Occurs when an SMS is requested by GetSms method or when new SMS is received. |
| Received | Occurs when data was received. |
| Reconnecting | Occurs when the serial port connection was lost (faulted) and tries to reconnect. AutoReconnect must be true. |
| Resumed | Occurs when the receiver is idle and data is received. |
| Ring | Occurs when the phone is ringing. |
| Sent | Occurs when data was sent. |
Fields| Name | Description | |
|---|---|---|
 | PhoneMemory | Phone memory. |
| PhoneSim | Phone SIM. |
See Also