GSM Setup
The GSM task is part of the GSM optional add-on module. You will need to have your software re-registered with the GSM task enabled before it can be installed.
The GSM task uses a GSM modem to send and receive SMS messages. Please contact Patriot sales or Patriot support for a list of supported modems.
A SIM card will be required for the modem. As the modem will be sending and receiving SMS messages only, a pre pay SIM card or a contract with low SMS rates is preferred.
GSM Modem
A GSM Modem is required to communicate with the GSM service provider. Our currently recommended GSM modem is the Teltonika TRM240
This modem is multi band, so will work in all countries. Drivers must be installed for use by USB.
If you are using any other type of GSM modem, these may or may not work correctly with the Patriot GSM task. We generally won't provide support on any other types of modems.
The Teltonika TRM240 and FX30S LTE M1 modems use a default baud rate of 115200.
Installing the GSM Task
The GSM task can be run on any machine running the Patriot Task Service. Ordinarily, the task should run on the primary Patriot server.
System Menu Item > Tasks > Task Settings
Please read TASK SETTINGS for general information about adding tasks.
Add a new instance of the GSM task by selecting it from the Task Type drop down list.
There are two variants of Patriot GSM task: GSM & GSM Extended. The GSM Extended task adds support for Unicode characters (i.e. non Latin characters) and long (concatenated) messages and is recommended in most cases.
Click the next button to continue. The GSM task settings form will be displayed.
GSM Task Settings
Some settings are only applicable to the GSM task while others are only applicable to the GSM Extended task variant. Only applicable settings will be displayed on the task settings form.
Enter a Description of the task, e.g. SMS
The Task No. will default to the next free task number.
Select the Computer that this task is to be run on. This will default to the computer you are currently on. The chosen computer must be equipped with the GSM hardware.
Backup: Check this box if you wish this task to be defined as a backup task.
Text log Filter level can be use for task troubleshooting purposes. It should be left to the default None.
Enter a System Account No. The system account number is used to log any task errors and other system generated signals. The default is GSMF000101. If this account does not already exist you will need to set it up as a template under Maintenance > Clients > Templates, and import the System Generated Event Types.
Header Message is short text message prepended to all automated SMS messages
Number to Use specifies which user contact number to use when sending automated messages
Prefix is prepended to the destination number of all automated SMS messages - usually a country or area code
Init Parameters for the GSM Extended task variant should normally be left empty. For the GSM task variant leave this as default, except for the +CSCA="..." section. You will need to change the number in quotes to the Short Message Service Center (SMSC) number of the service provider you are using. Patriot Support may be able to provide this for you, otherwise an internet search should provide it. The number must be in full international format, beginning with a +.
Network Number (GSM Extended only) is the short Message Service Center (SMSC) number of the service provider you are using. Patriot Support may be able to provide this for you, otherwise an internet search should provide it. The number must be in full international format, beginning with a +.
Message Wait Time (GSM Extended only) is the minimum time to wait (in seconds) between sending messages. If you experience problems sending messages in high volumes it is recommended to set a message wait time of 1 second or more. The default value is 0 s (messages will be sent as fast as possible). The maximum value is 15 s
Modem Timeout (GSM Extended only) is the maximum wait time (in milliseconds) for modem response before resending command. Errors may be logged if you set a timeout too short for your modem. The default value is 300 ms.
Read Storages (GSM Extended only) controls which message storages are monitored for incoming messages. Your modem may not support all of the available options. Patriot recommends using 'Receive Storages' unless a different storage is required.
- Receive Storages - All Receive storages supported by the modem. (Recommended)
- Read Storages - All Read storages supported by the modem.
- SIM - The SIM card storage only
- Device - The modem device storage only
- Combined - Device combined storage, typically SIM and Device together.
Attempts is the maximum number of times the system will attempt to send an SMS message if the first attempt is not successful. If all attempts fail, the system will wait the time specified in the Retry Wait field before trying again. This cycle will be repeated a maximum number times as set in the Retries field. Check the box to continue trying indefinitely.
Set the Comm Port and other serial port settings according to those specified by the GSM modem driver software.
Send Open/Close With Recent Alarm
Causes any set and unset signals received from a client to trigger automated messages to response members when received within a short period of an alarm event. The time period can be set via the Within Time(Min) setting in Patriots System Wide Messaging Settings.
For this option to work you must enable the Send Open/Close With Recent Alarm setting in System Wide Data Service Settings and also enable this setting in GSM task settings.
Recv. Message Type
The GSM task supports a few different received message formats. These can be used by mobile users and devices to acknowledge alarms, or to report alarm and location data.
In addition to the Standard Received Message Types, GSM supports the following received message types:
- Geonovo - Receive alarm & location SMS from Geonovo lone worker devices.
- Life Watch - Receive alarm & location SMS from Life Watch lone worker devices.
- Minor Planet - Receive location SMS from Minor Planet devices.
- Mobile Workforce - Receive alarm SMS from Mobile Workforce devices.
- OVLS - Receive alarm & location SMS from OVLS enabled alarm panels and devices.
- Guardian- Receive alarm & location SMS from Guardian devices.
Click Save to save task settings
Testing the GSM Task
Restart Patriot.
Then click onto the text log browse or diagnostic window for the task, it will take approximately 20 seconds to initialise the modem, then you should see something similar in your text log,
Modem Initialized
<0A>+CSQ: 31,0<0D>
<0D>
AT+CSDH=1;+CMGF=1;+CSCA="+6421600600";+CMEE=1;+CSQ
<0A>AT+CSDH=1;+CMGF=1;+CSCA="+6421600600";+CMEE=1;+CSQ<0D>
AT+CSDH=1;+CMGF=1;+CSCA="+6421600600";+CMEE=1;+CSQ
Registered
OK
<0A>OK<0D>
<0A><0D>
+CREG: 0,1
<0A>+CREG: 0,1<0D>
<0D>
AT+CREG?
<0A>AT+CREG?<0D>
Pin OK
+CPIN: READY
<0A>+CPIN: READY<0D>
<0D>
AT+CPIN?
AT+CPIN?<0D>
If your text log appears different, and contains error messages, there may be an error in the task settings, or there may be a problem with your modem. See - If the Modem Won't Initialise in the GSM FAQ.
With the modem initialised correctly, next check the signal strength. Bring up the Task Manager program, select Active Tasks, highlight the GSM task, then press the raw data button, then verify that the signal strength is showing Acceptable or Excellent. If it shows Bad or Marginal, you probably have a signal strength problem. Try moving the aerial (or SAMBA modem) to a different spot
Next, manually test sending an SMS message. Go into the Database administrator, into the Paging Queue, and manually insert a GMS message. Then watch the text log to see if the message is successfully sent. If you see errors in the text log, these can sometimes come from the service provider. The definition of the errors can be found in the Falcom and SAMBA manuals, otherwise contact Patriot support at support@patriotsystems.com for help.
Once you have GSM setup correctly and sending out message successfully, remember to turn off the Log to Text File in the GSM task if this has been enabled.