sms-SmsService

This is the main component used for sending text messages. All text messages are queued under this service and sent by the service’s Transport object. If any text messages are queued when the station shuts down, the station sends them when it next starts up.

Actions

Action	Description
Send	Sends the current message.
Clear Queue	Removes waiting messages from the queue.
Process Queue	Sends messages that are in the queue.
Reset Number Sent Today	Resets this information to zero.
Read Messages	Reads any messages immediately instead of waiting for the next Read Message Interval time.

Property	Value	Description
Status	text	Read-only field. Indicates the condition of the component at last polling. {ok} indicates that the component is polling successfully. {down} indicates that polling is unsuccessful, perhaps because of an incorrect property. {disabled} indicates that the `Enable` property is set to `false`. fault indicates another problem.
Fault Cause	text	Read-only field. Indicates why the network, component, or extension is in fault.
Enabled	`true` or `false`	Activates and deactivates use of the function.
Transport Type	n/a	Gprs Sms Transport or Serial Sms Transport.
Transport	additional properties	See Transport.
Monitor	additional properties	See sms-BasicPingMonitor
Signal Strength	read-only	Indicates signal strength.
Max Queue Size	number	Defines how many SMS may be collect in the queue before the next poll time. At the next poll time, all queued SMS are sent.
Queue Size	read-only	Displays how many SMSs are currently in the queue (waiting to be sent). To clear the queue at any time, right-click the appropriate outgoing account property and click Actions > Clear Queue.
Process Queue Retry Interval	hours: minutes: seconds	After a Process Queue failure, this is the time to wait before initiating a Process Queue retry.
Max Sendable Per Day	number	Limits the number of SMS that may be sent in one day.
Number Sent Today	read-only	Displays the number already sent today.
Last Message Sent Time	read-only	Displays the time at which last message was sent.
Use Escape Characters	`true` or `false`	Allows to name characters with spaces and special symbols.
Read Messages Interval	hours: minutes: seconds	Defines as the time for which the system waits to read message.

Transport

You use the Transport object to configure the system’s serial properties.

Property	Value	Description
Serial Port Config	read-only	Summarizes the serial settings.
Status	read-only	Indicates the condition of the network, device or component at the last check. `{ok}` indicates that the component is licensed and polling successfully. `{down}` indicates that the last check was unsuccessful, perhaps because of an incorrect property, or possibly loss of network connection. `{disabled}` indicates that the `Enable` property is set to `false`. `{fault}` indicates another problem. Refer to `Fault Cause` for more information.
Port Name	text string	String for the serial port, as known to the host platform.
Baud Rate	drop-down list (defaults to `Baud9600`)	Defines communication speed in bits per second.
Data Bits	drop-down list (defaults to `Data Bits8`)	Defines the number of bits required to encode a character (a byte).
Stop Bits	drop-down list (defaults to `Stop Bit1`)	Defines the number of bits that indicate the end of a character.
Parity	drop-down list (defaults to `None`)	Defines the odd or even requirement of a transmitted byte of data for the purpose of error detection.
Flow Control Mode	drop-down	Manages the data between two devices so that data can be handled at an efficient pace.
Inter Message Delay	hours, minutes, seconds (defaults to 0.3 seconds)	Defines the amount of time between messages.
Delete Read Messages	`true` or `false`	Eliminates read messages.

sms-SmsService

Actions

Transport

Related Links