EN SMS Commands List Update PDF
EN SMS Commands List Update PDF
8/25/17
1
R&D department
8/25/17
Table of Contents
1 SMS......................................................................................................................................................................6
1.1 Commands...................................................................................................................................................6
1.1.1 Coords – current coordinates...............................................................................................................6
1.1.2 Version – FM device version.................................................................................................................7
1.1.3 Gsminfo – GSM/GPRS information......................................................................................................7
1.1.4 Imei.......................................................................................................................................................9
1.1.5 Reset.....................................................................................................................................................9
1.1.6 Connect – custom connection.............................................................................................................9
1.1.7 Econnect – emergency custom connection.........................................................................................9
1.1.8 Getapn – get APN parameters...........................................................................................................10
1.1.9 Setconnection – change connection configuration...........................................................................10
1.1.10 Switchip – switch primary IP and port.............................................................................................10
1.1.11 Setio – set outputs...........................................................................................................................11
1.1.12 Getio – read inputs/outputs states..................................................................................................11
1.1.13 Delrecords – delete all records........................................................................................................11
1.1.14 Modrev – modem revision...............................................................................................................11
1.1.15 Caninfo – can configuration info......................................................................................................12
1.1.16 Cansinfo – dual can configuration info.............................................................................................13
1.1.17 Getsd – SD card info.........................................................................................................................13
1.1.18 Clear obd – clear OBD values...........................................................................................................13
1.1.19 IEversion – TCO extender version....................................................................................................14
1.1.20 Tacho – tachograph status...............................................................................................................14
1.1.21 webcoords – Google maps hyperlink with coordinates ..................................................................14
1.1.22 setiotime – set output for temporary period...................................................................................15
1.1.23 Banned – temporary banned operators...........................................................................................17
1.1.24 accinfo..............................................................................................................................................17
1.1.25 accreset............................................................................................................................................18
1.1.26 lastchange........................................................................................................................................18
1.1.27 SMS during critical process .............................................................................................................18
1.1.28 setcfg................................................................................................................................................19
1.1.29 getcfg................................................................................................................................................20
1.1.30 setioparam.......................................................................................................................................21
1.1.31 getioparam.......................................................................................................................................23
1.1.32 setvalue – set specific IO values.......................................................................................................23
1.1.33 set3g.................................................................................................................................................24
1.1.34 get3g.................................................................................................................................................25
1.1.35 dfota – update modem firmware over the FTP or HTTP server.......................................................26
1.1.36 enginevolt – Automatic engine detection........................................................................................27
2
R&D department
8/25/17
3
R&D department
8/25/17
Change log
Date Version Description
2015-08-20 1.0 Initial draft;
2015-09-08 1.1 Added: SMS message: Imei - get IMEI number;
Added: Supported SMS commands table;
2015-11-12 1.2
Added: Description of setcfg, getcfg, setioparam and getioparam commands;
2015-11-25 1.3 Added: Description of setvalue command;
2016-03-10 1.4 Added: Description of set3g; get3g; dfota commands;
2016-05-30 1.5 Added: SMS message: Enginevolt - Automatic engine detection;
Added: SMS message: lcvselect - LCV auto select;
2016-06-30 1.6
Added: SMS message: getlog/stoplog - get device log remotely;
2016-08-01 1.7 Updated: Description of accinfo;
2016-09-02 1.8 Change log transferred into the document;
Corrections: Removed duplicate command in the “Supported SMS commands table”; “getlog“ SMS
2016-10-13 1.9 command description;
Added: Example for “cansinfo“ SMS command;
Added: SMS command: “info” - Customizable SMS command;
Corrections: Switchip command description improved;
2016-11-18 1.10 Corrections: Gsminfo command description improved;
Corrections: Added responses examples after unsuccessful operation for the Connect and Econnect
SMS commands;
2016-11-22 1.11 Added: “Ignore empty space before the SMS command” feature description;
2016-12-05 1.12 Added: SMS commands supported by the FM-Basic added to the “Supported SMS commands table”;
Removed: SMS command “Fastsleep” removed;
2016-12-12 1.13
Various minor error corrections and description improvements;
Improved “info” SMS command description;
2016-12-20 1.14
Improved “getlog/stoplog” SMS command description;
2017-01-05 1.15 Updated: “Supported SMS commands table”;
2017-01-30 1.16 Updated: SMS command “lcvselect” description;
Updated: “Supported SMS commands table”;
2017-02-14 1.17 Updated: SMS command “accinfo” description;
Added: USSD SMS command description;
2017-02-22 1.18 Updated: “Supported SMS commands table”;
Updated: “Setio – set outputs” SMS command description updated;
2017-03-09 1.19
Updated: “setcfg” command example updated;
Updated: Added one more response example for the “getlog” SMS command;
2017-03-29 1.20
Updated: “Supported SMS commands table”;
Added: “clear dtc” command description;
2017-05-18 1.21 Updated:Additional description for “setiotime” SMS command for stuck DOUT cases;
4
R&D department
8/25/17
5
R&D department
8/25/17
1 SMS
There is a possibility to send SMS message to FM device. FM device answers with SMS message too. This is an
easy way to quickly interact with FM device. SMS messages are used:
• to get specific information from FM device;
• to reconfigure some parameters of FM device;
• to influence FM device work.
1.1 Commands
Parameter Description
6
R&D department
8/25/17
state Current GPS/GLONASS state: 1-off, 2-on no fix, 3-on got fix, 4-not responding, 5-sleep, 6-
disabled.
Parameter Description
1 Bootloader version.
2 Firmware version.
3 Hardware version.
5 Voltage status: 0 – lower then 8 Volts (bad), 1- higher then 8 Volts (OK).
ST Start Time Date & time (GMT) from the last FM device reset/power ON.
GSM network
16 bit number thereby allowing 65536 location areas within one GSM
LAC Location Area Code
PLMN.
“” Network mode Current network mode. There are two possible values: GSM and 3G.
7
R&D department
8/25/17
The number of times when modem was turned ON and turned OFF
SP Status Pin
unsuccessfully.
GPRS service
General Packet Radio Status of GPRS. There are two possible values: 0 – no GPRS / 1 –
GPRS
Service attached to GPRS.
Reset
FM device last reset source. Possible causes: 08, 03, 01 – reset was
because of modem power loss; 04 – reset because of watchdog; 10 –
reset because of Firmware update;
8
R&D department
8/25/17
1.1.4 Imei
SMS message is used to get device IMEI number.
Example: pass imei
Response example: IMEI: 863071016796615
1.1.5 Reset
SMS message is used to reset FM device. Device will reboot, its configuration parameters will not be lost.
Example: pass reset
Response example: Resetting device
Parameter Description
Protocol The principal of communication. There are two available protocols: TCP and UDP.
Parameter Description
An Access Point Name (APN) is the name of a gateway between a GPRS (or 3G, etc.)
APN
mobile network and another computer network, frequently the public Internet.
9
R&D department
8/25/17
Protocol The principal of communication. There are two available protocols: TCP and UDP.
10
R&D department
8/25/17
Note
“Setio” SMS command will not work with several FM device configurations. If a DOUT is configured to “Blocking” and
driver registration is enabled and registration function is set to blocking / or “DOUT activation under conditions” enabled
and DOUT is set as an output channel, then “setio” SMS command will have no effect.
11
R&D department
8/25/17
Parameter Description
CAN enable 0 – CAN is disabled / 1 – CAN is enabled, FMS standard mode / 2 – CAN is enabled, LCV mode / 3 –
CAN is enabled, OBD mode / 4 – CAN is enabled, Tachograph mode.
Value Name
1 VAG
2 Mercedes
3 Citroen
4 Ford
5 Fiat
6 Opel
7 Renault
8 Toyota
9 FMS Tractor
* CAN mode is LCV, vehicle manufacture group Mercedes, type is merccedes1, can is in silent mode.
12
R&D department
8/25/17
Parameter Description
13
R&D department
8/25/17
0 Not available.
1 Everything is OK.
Parameter Description
14
R&D department
8/25/17
Parameter Description
Impulse resolution is 10 ms. Minimum impulse duration is 10 ms. If Eco-panel is connected, minimum resolution
and duration is 50 ms. When the FM device receive the setiotime it stores the status of DOUT’s and after the sequence
restores the previous status. If one setiotime interrupts another, the state is UNDEFINED ('1' or '0') after both
sequences are finished. Interrupt in this case means that several consecutive "setiotime" commands were
sent, one overlapping the other. Sending several "setiotime" commands in a fast succession will make the the
DOUT stuck, thus requiring a device reboot. It is highly recommended to at least wait until a response is
15
R&D department
8/25/17
received for the first sent "setiotime" command, before sending the next.
‘0’ means GND and ‘1’ means no GND.
If one of the DOUT is configured as LED, Buzzer blocking or Jamming block, setiotime is not possible to use.
Additional feature. It is possible to set a repeat amount of a sequence.
SMS format: pass setiotime 1 500 0 500 n=10,0 200 1 300 n=20
Description:
Parameter Description
Each single DOUT has 10 slots for impulses levels (high / low). No more than 10 can be defined for one DOUT.
Longest time possible is 999 999 999 ms. Max number of repeats is 9999.
Max impulse count – as many as you can fit into 160 symbols of SMS.
It is possible to interrupt a sequence with “pass setiotime 0 10,0 10” followed by setio SMS command “pass setio
1,1”. The sequence would be interrupted and the states of DOUT’s is defined that’s it.
It is possible to set only one of the DOUT.
SMS format example for set DOUT1: pass setiotime 1 500, 0 500
SMS format example for set DOUT2: pass setiotime 0 200, 1 300
Response example: setiotime set OK
If configuration SMS is incorrect, device will response: setiotime syntax error in DOUTX settings: error text
Where „DOUTX“ is DOUT1 or DOUT2. „Error text“ is described below in the table. It's minimal diagnostic when
something wrong with impulse set in SMS.
16
R&D department
8/25/17
other process controls output Means that other functionality is configured on DOUT's. For example: LED or
buzzer
wrong level Level can be only logical '1' or '0'. Other values is unacceptable
exceeded max slot For one output is possible to set maximum 10 slot. If this count is exceeded this
error is displayed
pulse is shorter than 10ms Pulse length less than 10 milliseconds was set. It's not acceptable
Parameter Description
ZZZ List of currently banned operators (which are still in the list).
1.1.24 accinfo
SMS message is used to check if accelerometer is calibrated for eco-driving functionality. Only state information
is should be interpreted.
Parameter Description
17
R&D department
8/25/17
1 – calibration started
2 – zero position calibration is in progress
3 – forward movement calibration paused
4 – forward calibration
5 – forward calibration in progress
6 – forward calibration in progress
11 – calibrated
1.1.25 accreset
SMS message is used to reset accelerometer (used for eco-driving functionality) calibration.
Example: pass accreset
Response example: Acc reset OK
1.1.26 lastchange
SMS message is used to know when was the last time device configuration or primary server IP changed.
Example: pass lastchange
If time is not synchronized, or changes occur during that time, SMS content will be:
Response example: lastchange ip: no time available; cfg: no time available
If time is available:
Response example: lastchange ip: 2015-11-09, 09:02; cfg: 2015-11-09, 10:02
Configuration change date and time will be updated during any type of configuration modification.
When device is connecting to GPRS and tries to open link (with different IP settings), IP change date and time will
be updated. When device reconnects to server with same IP but different Port, IP change date and time will not be
updated.
18
R&D department
8/25/17
• Firmware update
• Configuration update
• Tacho read
• Smart Card read
Response example: The device is busy with critical process. Please try again later.
1.1.28 setcfg
This SMS message is dedicated to change FM parameters. After SMS password, user inputs parameter ID and
parameter value:
password setcfg ParamID1 Value1, ParamID2 Value2, ParamID3 Value3, …
Examples:
password setcfg 101 wave, 102 pioneer, 103 , 100 1
Sets APN name: wave, APN user: pioneer, no APN password, Protocol: UDP
Only parameters provided with SMS are changed, others remain the same.
One SMS message can be 160 symbols long, so the maximum simultaneously transmitted parameters count in
SMS message are limited to one message length.
Setcfg command, allows user to change all parameters of the configuration except timetable (because it will not
19
R&D department
8/25/17
fit into one SMS message), passwords (configuration and SMS) and “enable SMS configuration”.
Following responses are provided for the number, which sent configuration by SMS:
• When successfully setting parameters for FM device: „Configuration parameter(s) was set!“
• Incorrect parameter setting: „Configuration parameter(s) was NOT set! Parameter No. 1 is incorrect“.
• Unsuccessful set-up, when parameters are locked: „Configuration parameter(s) was NOT set! Parameter No. 1 is
locked“
• Unsuccessful set-up, when setting IO parameters, but not every setting was provided by SMS: „Configuration
parameter(s) was NOT set! IO slot No. 9 is not fully set“.
• Unsuccessful set-up, when device is busy: „Configuration parameter(s) was NOT set! Device is busy try again
later“
• If SMS configuration is disabled in configuration tool: „You do not have permission to change the settings“.
SMS configuration feature is enabled/disabled in configuration tool, in Authorized numbers section, by putting a
checkbox by the „Enable SMS configuration“.
1.1.29 getcfg
Structure of getcfg SMS:
password getcfg id
This command is only used for getting the current status of the parameter selected. Maximum simultaneously
received parameters in one SMS message is limited by SMS message length (160 symbols).
Multiple parameter values can be requested in one SMS message and when response does not fit in one
message then in the end of the message there will be a phrase: “other values not fit”.
Example:
Request:
“password getcfg 100,101,102,110,120,111,121,130”
Response:
“ID:100,value:1; ID:101,value:aerospace; ID:102,value:laguna; ID:110,value:101.16.17.245; ID:120,value:23451;
ID:111,value:m2m.member.com; other values not fit”
Parameters configuration password and SMS password are not reachable with this SMS. In this case, the device
answer:
„ERROR: parameter(s) read is forbidden“
20
R&D department
8/25/17
1.1.30 setioparam
Structure of setioparam SMS:
password setioparam
id=id,profile=profile,enable=enable,level=level,delta=delta,average=average,eventon=eventon,include=include,prior
ity=priority,switch=switch,edge=edge
Example:
01234567890123456 setioparam
id=256,profile=4,enable=1,level=3500,delta=250,average=2000,eventon=2,include=1,priority=1,switch=1,edge=3
This SMS can be used in any way, but it must at least contain Id,profile and enable parameters. Shortest possible
message should be written this way:
Example:
If the short version is used the other parameters are set with old values. Id,profile and enable parameters are
mandatory to make a valid SMS command.
Note that only two spaces between password[space]setioparam[space]id are required. All other commands are
separated by comma.
SMS can be written in lower case and upper case letters. Therefore, setioparam SMS is not case sensitive.
If SMS command doesn’t define new values to level, delta, average, eventOn, include, priority, switch or edge
parameters, it will not be changed. Previous value will remain.
When the FM-device receives the SMS where the parameter enable is set to 1, it searches in the current
21
R&D department
8/25/17
If newly created IO event is not set to specific parameters it will be set to default. Default values are listed below:
For set enable, eventOn, include, priority, switch on edge it is necessary to indicate the state with a number:
3 – 3rd profile
4 – 4th profile
• If FM-device finds more than one IO parameters with the same ID it would answer:
“setioparam ERROR, more than one I/O with same ID”
• If user sent a SMS to disable (enable field = 0), and the parameter is not found as enabled, FM-device would
answer:
„setioparam ERROR, parameter is already disable“
22
R&D department
8/25/17
1.1.31 getioparam
Structure of getioparam SMS:
password getioparam id,profile
This command is only used for get the current status of the IO parameter selected.
• If IO parameter was enabled, the FM-device would answer:
Example: ‘‘id=28,profile=3,enable=1,level=0,delta=0,average=1000,eventon=2,include=0,priority=0,switch=0,edge=0”
*Value will be overwritten by valid message from CAN-Bus (if available in specific vehicle).
23
R&D department
8/25/17
In “command text” field there will be ID and its value separated by comma (,).
1.1.33 set3g
The structure of the command would be:
password set3g 1/0/2
The field enable/disable could have three values: ‘1’ means enabled, ‘0’ means disabled and ‘2’ means automatic. Only
current profile would be changed.
24
R&D department
8/25/17
1.1.34 get3g
The structure of the command would be:
password get3g
No fields are required to fill into the SMS
Following responses are provided for the number, which sent the get3g by SMS (response from FM device).
Response format:
automatic/disabled/enabled 3G mode, connected to 3G/GSM (1/2/3/4-profile)
• If device has enabled 3G and status is OK. For all examples current profile is 3:
“enabled 3G mode, connected to 3G (3-profile)”
25
R&D department
8/25/17
1.1.35 dfota – update modem firmware over the FTP or HTTP server
This SMS is used to update modem firmware of a device with 3G GSM modem. Firmwares of 3G modems are in
diff form so it only sends differences between new and current firmware. Because of this, current modem firmware has
to be known before the update. Binary file of Modem firmware must be placed in FTP or HTTP server before update.
<user_name> - String type, the user name for authentication. The maximum size of the parameter is 50 bytes
<password> - String type, the password for authentication. The maximum size of the parameter is 50 bytes
<server_URL> - String type, the IP address or domain name of the FTP server. The maximum size of the parameter is 50
bytes
<port> - Integer type, the port of the FTP server. The default value is 21. The range is 1 – 65535
<file_path> - String type, the file name in FTP server. The maximum size of the parameter is 50 bytes
<http_server_URL> - String type, the IP address or domain name of the HTTP server
<http_port> - Integer type, the port of the HTTP server. The default value is 80. The range is 1 – 65535
<http_file_path> - String type, the file name in HTTP server
26
R&D department
8/25/17
• ERROR: link string too short – when minimum link requirements are not met
• ERROR: wrong command syntax – something wrong with command syntax
• ERROR: DFOTA FW update process already started – when update process was started previously
• ERROR: other reason – when is another error not described above
After modem FW update is finished FM device responds (does not work on SMS via GPRS):
➢ Modem firmware updated successfully:
• Modem FW update process successful. Current modem version: xx
➢ Modem firmware update failed:
• Modem FW update process FAILED. Error code: xx
(error codes are specified in modem documentation)
If message structure is wrong, FM-device answers "Unknown command". If message structure is correct, then
after FM-device measured upper voltage level, device answers "Turn off engine". After this response, engine must be
turned off. When after 30 s, device measures lower voltage level. If engine detection is done, device answers "Engine
detection done". If engine detection is not successful, response from the device is "Engine detection error".
27
R&D department
8/25/17
Note
Enable IO parameters function requires the use of Protocol v1.1, without it enabled, this function will not work.
Additionally enough free IO slots must be available to accommodate the newly enable IO parameters.
SMS command
The structure of the command is:
password lcvselect distance,RPM,enableIO
<password> - String type, the password for authentication. The maximum size of the parameter is 50 bytes
<lcvselect> - Automatic select of correct LCV group and sub group combination command name.
<distance> - Distance travelled by a vehicle, which is currently displayed by the vehicle's odometer. Make sure to enter
the same value, it has to be a natural number. Error cannot exceed ± 1 km. Maximum value, which could be sent via SMS
is 21055406 km.
<RPM> - RPM value currently displayed in the vehicle's dashboard. Make sure to enter the same value, it has to be a
natural number. Error cannot exceed ± 100 rev/min. Maximum value, which could be sent via SMS is 8031 rev/min.
<enableIO> - Command to automatically enable IOs for the automatically selected LCV group. If command is not
included or a “0” is written, then the function will not automatically enable IO parameters. If “1” is selected, IOs will be
enabled if the condition are met.
Other examples:
• If you do not want to send distance and RPM values via SMS, the SMS command should look as follows:
28
R&D department
8/25/17
“pass lcvselect ,“
• If you want to send only RPM value, the SMS command should look as follows:
“pass lcvselect ,RPM“
• If you want to send only vehicle distance value, the SMS command should look as follows:
“pass lcvselect distance,“
• If you do not want to send distance and RPM values via SMS, but enable automatic IO selection, the SMS
command should look as follows:
“pass lcvselect ,,1”
Responses
If SMS structure is correct and LCV auto select process successful started, then the FM-device responds:
“LCV auto selection is in progress”
If SMS something went wrong and LCV auto select process cannot be started, the device responds with an error
message. One of these error messages can be received:
• “Unknown command” - LCV auto select SMS structure is incorrect.
• “Wrong CAN configuration” - Current FM device configuration is incompatible with LCV auto select feature.
Correct configuration options are described below in the “Configuration compatible with “LCV auto select”
feature” section.
• “LCV autoselection not started, try again” - This message signals that “LCV auto select” should be restarted.
• “Waiting for LCV autoselection start” - Currently a critical process (i.e. CFG task) is running in the FM device.
Within 2 minutes period device constantly checks process status. If it has concludes and there are no other
critical processes, then the auto select will start. User will be notified with the “LCV auto selection is in progress”
message. If critical processes are still running, then the auto select will not be started. User will get the “ LCV
autoselection not started, try again” message.
• “Parameters are out of ranges” - Distance and/or RPM value received via SMS are out of accepted range.
• “No CAN data were received” - No CAN data packets were received.
• “No valid matches were found” - LCV auto select task concluded, but it failed to find matches in our database.
• “Configured group: [Group]/[Subgroup],can1 ch:[number], can2 ch:[number],ERR: Not enough I/O slots ” -
group is selected, but there are not enough free IO slots to enable all the auto-select IOs, IOs are not enabled.
• “Configured group: [Group]/[Subgroup], Error: old I/O protocol is used” - protocol v1.1 was not enabled prior to
the SMS command.
•
Selection logic
“LCV auto select” feature is designed to choose the best group / sub-group combination for your specific
vehicle. In order to do so, it employs a rating system, where each CANbus parameter has its own weight coefficient.
Coefficient values within each sub-group are added together. This allows to compare different group / sub-group
combinations and select only the best ones.
CANbus parameters themselves also undergo a verification procedure. In order to add weight to a specific sub-
group, they have to have valid values. Valid value could mean that it has to be equal to something or it has to behave in a
certain faction, or it has to be in a valid range, etc. Rules for validation are defined internally.
29
R&D department
8/25/17
Currently, “Fuel”, “Vehicle distance”, “RPM” and “Wheel based speed” parameters are assigned different
coefficient values. Remaining CANbus parameters are rated lower.
After completing the selection process, the FM device will send a SMS message with the information about
selected group and sub-group. For example:
“Configured group: Ford/Ford2”
LCV group and subgroup will be configured automatically.
Notes
• LCV Auto select functionality does not interfere with IO list configuration unless enableIO command is used.
• LCV Auto select does not guarantee that all CAN IO parameters supported for currently selected LCV Group and Sub-
group will be available for this vehicle.
• EnableIO parameters are enabled in the active profile.
Parameter Description
IP 32-bit number, commonly known as an Internet Protocol address (xxx.xxx.xxx.xxx).
Port 16-bit number, commonly known as the port number (xxxxx).
Mode 1 – send full log to server. All other values reserved for future functionalities.
Time Time period for log sending. Defined in minutes. Range from 1 to 60 minutes.
When device gets this command, it should open a link with defined server and send log according to defined
mode. All other FM device processes (e.g. records sending, peripheral device communication) should keep working. Only
device restart can stop log data sending process.
If data sending is disabled by configuration, log will not be sent and the device's response will be: "Data sending
is disabled."
Log will be sent as ASCII. Log starts from device type [HCV/LCV/PRO], selected mode, defined time, bootloader
version, firmware version, hardware version, GSM signal level and Voltage status: 0 –lower than 8 Volts (bad), 1 –higher
than 8 Volts (OK) and device IMEI.
Getlog
This command initiates logging process.
Example: FMTco4 HCV BT, 100.101.102.103:1111, mode=1, time=3min; version:472C,00.02.25.21,431,26,1;
imei:868324027387005
30
R&D department
8/25/17
Responses:
• If getlog SMS format is correct, the device will respond: getlog ok
• If getlog SMS format is incorrect, the device will respond: getlog data incorrect
• If logging proces is already running, the device will respond: getlog already running
Stoplog
This SMS command stops log sending to the server.
Example: pass stoplog
Responses:
• When device gets this command and log sending is in progress, it should stop sending log to server and reply
with SMS: stoplog ok
• If device gets this command and the log is not running, then the reply should be: getlog already stopped
Disclaimer: In some cases remote debug might have to log data about many different events and processes. This would
force remote debug to generate large internal data streams. Device might not be able to sent it all via GPRS. This might
lead to data loss.
1.1.39 info – get some specific information from the FM device via SMS
This customizable SMS command with configurable set of parameters can be used to get some specific
information from the FM device via SMS.
Parameter Description
time Current GMT date and time
Current latitude and longitude separated by comma (,). Device will reply “GNSS data not
coords
available” if there will be no GNSS fix
alt Current altitude
sat Currently visible satellites
dir Current angle
speed Current speed, km/h
hdop Current HDOP level
Current GPS/GLONASS state: 1-off, 2-on no fix, 3-on got fix, 4-not responding, 5-sleep, 6-
gps
disabled.
eng Current engine state: 0 – OFF, 1 – ON.
blver Bootloader version
fwver Firmware version
hwver Hardware version
st Date & time (GMT) from the last FM device rest/power ON.
gsmlvl GSM signal level
op GSM operator number
lac Location Area Code
cid GSM Cell ID
modi The number of times when FM device has tried to initialize modem since start time.
modr The number of modem resets since start time.
modsp The number of times when modem was turned ON and turned OFF unsuccessfully.
31
R&D department
8/25/17
Parameter Description
gprs Status of GPRS. There are two possible values: 0-no GPRS, 1-attached to GPRS.
gprso The number of opened GPRS sessions.
gprsc The number of closed GPRS sessions.
gprse The number of GPRS errors.
lko The number of opened links.
lke The number of link errors.
lktmo The number of server response timeout.
FM4 device last reset source. Possible causes:
04 - reset pin; 08 - power on/down reset; 10 - software reset; 20 - independent watchdog; 40 -
rs window watchdog; 80 - Low power reset.
14 means 10 (software reset) + 04 (reset pin)
In other words FM device resets himself, for example after FW update.
p GPRS protocol version: 0 – standard protocol; 1 – extended protocol.
imei Device IMEI number
apn APN name
apnu APN username
apnp APN password
ip1 IP1 address and port number
ip2 IP2 address and port number
prot Currently set protocol: 0 - TCP or 1 - UDP.
modrev Used to get modem revision information.
Current tachograph status information: 0 – Not available; 1 – everything is OK; 2 – tacho
tacho parameters not configured; 3 – extender not responding; 4 – tacho task in progress; 5 – physical
connection OK, logical is not OK.
get3g Answer according to “get3g” SMS command description
gmap Hyperlink to Google maps with coordinates: latitude and longitude.
dout1
dout2
din1 Is used to get status about Dout1, Dout2, Din1, Din2, Din3, Din4, Ain1 and Ain2. Values: 1 –
din2
high, 0 – low. Analog inputs – millivolts.
din3
Response will contain only values of requested parameters.
din4
ain1
ain2
pwr Returns power supply voltage in millivolts.
bat Returns battery voltage in millivolts.
Used to get specific IO current value. [xxxxx] contains IO ID number.
Only activated in configuration IO data can be retrieved.
io[xxxxx] For multi-part IO elements, first IO ID should be requested.
IO parameters that are being reset with record sending should not be available, response would
be NA.
Password, command and command text are separated by space symbol. If there is no password, then you need
to write just space symbol before the command. Command text parameters are separated by semicolon (;) symbol.
Response command text parameters are separated by semicolon (;) symbol. All content of SMS command is not case
sensitive.
32
R&D department
8/25/17
Maximum length of a response is 160 symbols. If response is longer, then the device will send maximum 157
characters of response plus “#” symbol and two digits number that shows, which tag was last in the reply counting from
the beginning.
Example: pass info gmap;coords;IO123;pwr;st;time
Answer: https://www.google.com/maps/?q=54.7413016,25.2227550;54.7413016,25.2227550;0x4C5455313233343536
373839303132333400000000000000;11659;2016-12-13 11:20:02;#05
If some requested IO is not enabled in configuration or some tag is unknown, then the device will reply: NA
Example: pass info time;imei;eng;IO29;lktma
Answer: 2016-12-13 12:41:57;865789021340700;0;NA;NA
Operation principles
• USSD command is received through the SMS and then passed to the modem;
• USSD command is not affected or ignored by ongoing firmware, configuration updates or tacho and smart card
reading.
• After getting the response, the device transmits the answer to the sender of the SMS;
• Timeout of 120 seconds is used when waiting for the response from the GSM operator.
SMS command
Request SMS structure: pass ussd *command#
Where command is a set of digits and asterisk symbols (*). Command always begins with an asterisk symbol *
and is terminated by #. Inside, the command can have several asterisk symbols.
Correct command examples:
*485#
*52*452*4#
33
R&D department
8/25/17
Responses
• When the operator responds to the ussd command within 120 seconds, the answer is sent in the following
format: ussd response
• If * or # symbols are missing or command is blank in the request message: ussd bad format
• If the response is not received from the operator within 120 seconds: ussd timeout
• If there is an error with the GSM network operator: ussd modem error
SMS command
SMS command structure: pass clear DTC
Responses
• If command was performed successfully, response will be: DTC codes were cleared
• If DTC reading is not configured, response will be: DTC reading is not configured
1.1.42 doutreset
This SMS command allows to reset the state of activated DOUTs. This command works in correlation with
the “DOUT activation with conditions” functionality, and requires it to be enabled and configured to work.
SMS command
SMS command structure: pass doutreset
Responses
• If command was performed successfully, response will be: DOUT activation mechanism was reset
• If DOUTs are not active at the time, response will be : DOUT activation mechanism is inactive
• If the “DOUT activation with conditions” functionality is not configured, response will be : DOUT activation is not
configured
1.1.43 immobilizer
This SMS command allows to immobilize the vehicle. This functionality works in correlation with the
“Immobilizer” functionality, described in the “DOUT activation with conditions” document. If the
“Immobilizer” mode is not configured, the command will not work.
SMS command
SMS command structure: pass immobilizer <speed>
<speed> - describes the vehicle speed at which the progressive DOUTs must be toggled.
Responses
• If command was performed successfully, response will be: Immobilizer OK
34
R&D department
8/25/17
• If no custom DOUTs are configured, the device will respond with the following message: immobilizer is not
configured.
• If <speed> parameter was inputted incorrectly, only numbers from 1 to 250 can be sent, the response will be:
Invalid speed.
Responses
• If the immobilizer is successfully reset, the response will be: immobilizer reset
1.1.44 setdinmode
This SMS command allows to set the DIN3 mode to positive mode or ground mode.
SMS command
SMS command structure: pass setdinmode <DIN3 mode>
<DIN3 mode> - can have the following values:
·0 -Positive mode;
·1 – Ground mode;
Responses
· If DIN 3 was set to positive mode, response will be: DIN mode set: DIN3 – positive mode;
·If DIN 3 was set to ground mode, response will be: DIN mode set: DIN3 – Ground mode;
·If SMS command was sent for a FM device with a older hardware version, response will be: Configurable DIN
functionality is not available for your HW version;
1.1.45 getdinmode
This SMS command allows to receive information about the current configuration of the DIN3 mode.
SMS command
SMS command structure: pass getdinmode
<DIN3 mode> - can have the following values:
• 0 -Positive mode;
• 1 – Ground mode;
Responses
• If DIN 3 is set to positive mode, response will be : DIN3 – positive mode;
• If DIN 3 is set to ground mode, response will be: DIN3 – Ground mode;
• If SMS command was sent for a FM device with a older hardware version, response will be: Configurable DIN
functionality is not available for your HW version;
35
R&D department
8/25/17
36
R&D department
8/25/17
Violation/accident types:
• Over speeding;
• Extreme braking;
• Harsh braking;
• Harsh acceleration;
• DIN1;
• DIN2;
• DIN3;
• DIN4.
Examples:
Overspeeding (5)
DIN1 (2)
Harsh braking (8)
1.2.2 SMS alerts with date & time (FM4 devices only)
SMS message can be sent if one of the following SMS alerts is configured: overspeeding, power supply disconnecting,
DIN1, DIN2, DIN3, DIN4 (ignition). Purpose of this message is to inform when these events were triggered. Date & time
is GMT. To receive SMS alerts, "SMS Alert Number” must be configured.
“SMS Alert Number” can be configured via FM configurator. In the main configurator window, locate the “Authorized
numbers” section and click “Options. This will open the “Numbers window”. The second input field in this window is the
“SMS alert number”, the user must enter a number which will receive the SMS alerts.
Notes
When inputting the number, the “+” symbol should be replaced with “00”.
I/O parameters must be properly configured to be able to send SMS alerts, this means one of the previously mentioned
37
R&D department
8/25/17
Afterwards, when a I/O is triggered, the device will send an SMS alert to the number previously specified in the
“Authorized number”.
Notes
If the device was out of the GSM coverage, the FM device will accumulate events that will be sent as soon as GSM
connectivity is restored. The FM device can store up to 16 events. If the 16 event threshold is reached, the device will
start to overwrite oldest events. The device will send a report of all events in ONE message (as many, that can fit in 160
characters). Multiple events in one SMS message will be delimited by a semicolon symbol “;”.
Message format:
date1&time1-event1; date2&time2-event2; …
Examples:
2015.05.01 16:24:01-device disconnected;
2015.06.02 22:05:16-ignition: ON; 2015.06.02 22:05:35-DIN1: OFF;
2015.06.14 08:30:45-overspeed;
Additionally the SMS alert function now supports custom SMS text. Custom text fields appear after the “SMS alert”
checkbox is clicked. The maximum custom text length is 50 symbols, all previous rules apply.
38