Modem
The modem Device Driver allows Iotellect Server to control a GSM modem or any other modem that is based on AT command set. Modem devices are often used to send SMS messages in response to alerts.
Configuring Iotellect Server for Serial Communications
In most cases the modem is connected to a serial port of Iotellect Server machine. See Enabling Serial Communications to find out to get access to a serial device.
Receiving SMS Messages
The modem device driver fires an SMS event in Administration context each time a new message is received.
Driver Information
Driver Plugin ID: | com.tibbo.linkserver.plugin.device.modem |
Global Settings
None defined.
User Level Settings
None defined.
Device Account Properties
Connection Properties
Connection settings define how Iotellect Server communicates with a modem. These settings may be accessed using the Edit Device Properties action of Device Context. The following connection properties are available:
Property | Description |
Mode | A choice of TCP, UDP and Serial. |
IP address or host name | Address of the modem (for TCP/UDP mode). |
Port | Modem listening port (for TCP/UDP mode) or name of serial port the modem is connected to (for Serial mode). |
Baud Rate | Baud Rate (for Serial mode). |
Incoming Flow Control | Incoming flow control type: None, CTS/RTS, or XON/XOFF (for Serial mode). |
Outgoing Flow Control | Outgoing flow control type: None, CTS/RTS, or XON/XOFF (for Serial mode). |
Data Bits | Serial data bits (for Serial mode). |
Stop Bits | Serial stop bits (for Serial mode). |
Parity | Serial parity (for Serial mode). |
Timeout | Command timeout (default is 5 seconds). |
Commands
This property contains a list of modem commands that will be periodically sent to the modem on every synchronization cycle. Last reply to each command will be available as a single variable of Device Context.
 | The commands table if pre-filled with commonly used modem status commands. |
Here is a list of properties of each modem command:
Property | Description |
Name | Command name. This will be used to name the Device Context variable used to access the reply, so it may contain only letters, digits and underscore. |
Description | Command textual description. Will be used as the description of the Device Context variable. |
Command | The text of command to sent (should include "AT" prefix for most commands). |
Wait for Standard Reply | If enabled, wait until the modem replies with OK. If disabled, stop receiving reply once a newline character is received. |
 | If you wish to connect several similar modem devices to Iotellect, you could fill in the Commands table only once and then copy it to other devices using the Replicate action. |
Device Assets
Assets are not supported by the driver.
Device Settings
Modem device driver creates one Device setting variable per every command found in the Commands table. The variable contains text of reply received from modem.
Device Operations
Send SMS
This operation is used to send an SMS message via connected GSM modem. It prompts user to enter recipient's number, SMS text, and optionally enable unicode mode.
| Add Send SMS action to an alert's automatic corrective actions list to enable sending SMS notifications when the alert is raised. |
Execute Custom Command
Allows to send a custom command to modem.
Device Events
SMS
Fired when Iotellect Server receives an incoming SMS message.
Event Name | sms |
Permissions: | Accessible at Observer permission level |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
sender | String | Sender's number. |
text | String | Message text. |
Connection Handling
This driver makes the device Online if connection with modem was successfully established and it has replied OK to two commands: ATE0 and AT.
Synchronization Details
Synchronization between Iotellect Server and modem device includes the following steps:
- Creating a Settings Cache according to the Commands list. Each variable is used to access the reply to a single modem command.
- Executing modem commands and storing the replies in settings cache.
Was this page helpful?