Difference between revisions of "Template:FMA SMS/GPRS command list"

 
(68 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Template:FMB FW development notice}}
 
{{Template:FMB FW development notice}}
  
Read chapter 5.10 to know how to construct a proper SMS message and send it to {{{model|FMA1YX}}} device. All commands are case sensitive. While {{{model|FMA1YX}}} operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to {{{model|FMA1YX}}} device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter).  {{{model|FMA1YX}}} will receive the SMS when it wakes up (exits deep sleep mode).
+
Click [[FMA120 GSM settings, SMS part|Here]] to know how to construct a proper SMS message and send it to {{{model|FMA1YX}}} device. All commands are case sensitive. While {{{model|FMA1YX}}} operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to {{{model|FMA1YX}}} device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter).  {{{model|FMA1YX}}} will receive the SMS when it wakes up (exits deep sleep mode).
  
  
Line 12: Line 12:
 
! style="width: 50px; background: black; color: white;" | Response
 
! style="width: 50px; background: black; color: white;" | Response
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getinfo|getinfo]]''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getstatus|getstatus]]''
| style="text-align: left; vertical-align: top;" | Device runtime system information.
+
| style="text-align: left; vertical-align: top;" | Modem Status information.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getver|getver]]''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getweektime|getweektime]]''
| style="text-align: left; vertical-align: top;" | Returns code version, device IMEI, modem app version, RTC time, Init time, Uptime and BT MAC address.
+
| style="text-align: left; vertical-align: top;" | Current device time, Day of Week and amount of minutes passed since start of week
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
! style="text-align: left; vertical-align: top;" | ''[[FMB getstatus|getstatus]]''
 
| style="text-align: left; vertical-align: top;" | Modem Status information.
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getgps|getgps]]''
+
! style="text-align: left; vertical-align: top;" | ''[[FMB getops|getops]]''
| style="text-align: left; vertical-align: top;" | Current GPS data, date and time.
+
| style="text-align: left; vertical-align: top;" | List of currently available GSM operator
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | {{{cmd_getio|''[[FMB getio|getio]]''}}}
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getcfgtime|getcfgtime]]''
| style="text-align: left; vertical-align: top;" | Readout analog input,digital input and output.
+
| style="text-align: left; vertical-align: top;" | Date and Time of last successful configuration
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB ggps|ggps]]''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA ggps|ggps]]''
 
| style="text-align: left; vertical-align: top;" | Returns location information with Google maps link.
 
| style="text-align: left; vertical-align: top;" | Returns location information with Google maps link.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB readio|readio]] #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getgps|getgps]]''
| style="text-align: left; vertical-align: top;" | Returns IO status, # AVL ID.
+
| style="text-align: left; vertical-align: top;" | Current GPS data, date and time.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
Line 44: Line 40:
 
| style="text-align: left; vertical-align: top;" | No
 
| style="text-align: left; vertical-align: top;" | No
 
|-
 
|-
 
+
! style="text-align: left; vertical-align: top;" | ''resetprof''
! style="text-align: left; vertical-align: top;" | ''[[FMA getweektime|getweektime]]''
+
| style="text-align: left; vertical-align: top;" | Reset all FLASH1 profile configuration to default profile
| style="text-align: left; vertical-align: top;" | Current device time, Day of Week and amount of minutes passed since start of week
+
| style="text-align: left; vertical-align: top;" | No
 +
|-
 +
! style="text-align: left; vertical-align: top;" | ''[[FMA getver|getver]]''
 +
| style="text-align: left; vertical-align: top;" | Device / Modem / Code version information.
 +
| style="text-align: left; vertical-align: top;" | Yes
 +
|-
 +
! style="text-align: left; vertical-align: top;" | ''[[FMA getinfo|getinfo]]''
 +
| style="text-align: left; vertical-align: top;" | Device runtime system information.
 +
| style="text-align: left; vertical-align: top;" | Yes
 +
|-
 +
! style="text-align: left; vertical-align: top;" | ''deleterecords''
 +
| style="text-align: left; vertical-align: top;" | Delete all records saved on FLASH
 +
| style="text-align: left; vertical-align: top;" | Yes
 +
|-
 +
! style="text-align: left; vertical-align: top;" | ''[[FMA getio|getio]]''
 +
| style="text-align: left; vertical-align: top;" | Readout analog input,digital input and output.
 +
| style="text-align: left; vertical-align: top;" | Yes
 +
|-
 +
! style="text-align: left; vertical-align: top;" | ''[[FMA readio|readio]] #''
 +
| style="text-align: left; vertical-align: top;" | Returns IO status, # AVL ID.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
 
+
! style="text-align: left; vertical-align: top;" | ''[[FMA setdigout|setdigout]] ## Y1 Y2''
! style="text-align: left; vertical-align: top;" | ''[[FMB getrecord|tuscias]]''
+
| style="text-align: left; vertical-align: top;" | Set digital output.|<br/>
| style="text-align: left; vertical-align: top;" | SMS command iitiates saving and sending of high priority record
+
1.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT1.<br/>
| style="text-align: left; vertical-align: top;" | No
+
2.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT2.<br/>
 +
Y1 – timeout value for DOUT1 if needed (in seconds).<br/>
 +
Y2 – timeout value for DOUT2 if needed (in seconds).
 +
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
 
+
! style="text-align: left; vertical-align: top;" | ''[[FMA setdigout|setdigout]] X Z Y''
! style="text-align: left; vertical-align: top;" | ''[[FMB getimeiccid|tuscias]]''
+
| style="text-align: left; vertical-align: top;" | set selected digital output<br/>
| style="text-align: left; vertical-align: top;" | Reponse is sent to SMS/GPRS sender and to number which is provided.
+
X – number of Digital output (1 – digital output 1; 2 – digital output 2).<br/>
 +
Z – activate(1)/deactivate(0).<br/ >
 +
Y – activation/deactivation timeout.<br/>
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
 
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getparam|getparam]] #''
 
+
| style="text-align: left; vertical-align: top;" | Returns selected parameter value, # param [[FMA Device Family Parameter list|ID]].
 
 
! style="text-align: left; vertical-align: top;" | ''[[FMB allver|tuscias]]''
 
| style="text-align: left; vertical-align: top;" | Responds with information about hardware and firmware versions and storage space
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
 
+
! style="text-align: left; vertical-align: top;" | ''[[FMA getparam 1271 X/212 X|getparam 1271 X]]''
 
+
| style="text-align: left; vertical-align: top;" | X values can be 1,2,3.
 
 
! style="text-align: left; vertical-align: top;" | ''[[FMB getparam|getparam]] #''
 
| style="text-align: left; vertical-align: top;" | Returns selected parameter value, # param [[FMB Device Family Parameter list|ID]].
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA setparam|setparam]] # #''
 
| style="text-align: left; vertical-align: top;" | Sets selected parameter value.<br/>
 
| style="text-align: left; vertical-align: top;" | Sets selected parameter value.<br/>
 
1.# - ID value.<br/>
 
1.# - ID value.<br/>
Line 79: Line 93:
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB flush|flush]] #,#,#,#,#,#,#''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA flush|flush]] #,#,#,#,#,#,#''
 
| style="text-align: left; vertical-align: top;" | Initiates all data sending to specified target server.<br/>
 
| style="text-align: left; vertical-align: top;" | Initiates all data sending to specified target server.<br/>
 
1.# - IMEI.<br/>
 
1.# - IMEI.<br/>
Line 88: Line 102:
 
6.# - PORT.<br/>
 
6.# - PORT.<br/>
 
7.# - MODE (0-TCP/1-UDP).
 
7.# - MODE (0-TCP/1-UDP).
| style="text-align: left; vertical-align: top;" | No
 
|-
 
! style="text-align: left; vertical-align: top;" | ''[[FMB countrecs|tuscias]]''
 
| style="text-align: left; vertical-align: top;" | Returns records number.
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''deleterecords''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA readops|readops]] #''
| style="text-align: left; vertical-align: top;" | Delete all records from SD card.
+
| style="text-align: left; vertical-align: top;" | 1 – send first 20 operator codes<br/>
| style="text-align: left; vertical-align: top;" | Yes
+
2 send from 21<sup>st</sup> to 40<sup>th</sup> operator codes.<br/>
|-
+
3 send all other operator codes.
! style="{{{hide_setdigout|}}}text-align: left; vertical-align: top;" | {{{cmd_setdigout|''[[FMB setdigout|setdigout]] ## Y1 Y2''}}}
+
| style="text-align: left; vertical-align: top;" | No
| style="{{{hide_setdigout|}}}text-align: left; vertical-align: top;" | Set digital output.{{{txt_setdigout|<br/>1.# 0 or 1 (0 - OFF or 1 – ON) for DOUT1.<br/>2.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT2.<br/>Y1 – timeout value for DOUT1 if needed (in seconds).<br/>Y2 timeout value for DOUT2 if needed (in seconds).}}}
 
| style="{{{hide_setdigout|}}}display: none; text-align: left; vertical-align: top;" | Yes
 
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB battery|battery]]''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA sn|sn]] #''
| style="text-align: left; vertical-align: top;" | Returns battery state info.
+
| style="text-align: left; vertical-align: top;" | Static navigation, 1 – enable, 0 – disable
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''wdlog''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA banlist|banlist]] #''
| style="text-align: left; vertical-align: top;" | Returns all information about 'watch dogs' restarts.
+
| style="text-align: left; vertical-align: top;" | Banned operators information.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''defaultcfg''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA crashlog|crashlog]] #''
| style="text-align: left; vertical-align: top;" | Load default configuration.
+
| style="text-align: left; vertical-align: top;" | Device last information before unexpected reset.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB setkey|setkey]] # #''
+
! style="text-align: left; vertical-align: top;" | ''delete_all_sms''
| style="text-align: left; vertical-align: top;" | Add new or change current configuration keyword. If device is locked, keyword cannot be changed.<br/>
+
| style="text-align: left; vertical-align: top;" | Deletes all SMS
1.# - old keyword (if adding new keyword space).<br/>
+
| style="text-align: left; vertical-align: top;" | No
2.# - new keyword.
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
! style="text-align: left; vertical-align: top;" | ''[[FMB delkey|delkey]] #''
 
| style="text-align: left; vertical-align: top;" | Remove existing keyword (If device is locked, keyword cannot be changed).<br/>
 
1.# - old keyword.
 
| style="text-align: left; vertical-align: top;" | Yes
 
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB bbread|bbread]] #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA lvcangetprog|lvcangetprog]]''
| style="text-align: left; vertical-align: top;" | Return black box information (HEX value of event ID and HEX value of custom data field (optional)).<br/>
+
| style="text-align: left; vertical-align: top;" | CAN Program Number request by SMS
1.# - returns entered number of latest events. When # is omitted the latest events are packed to single SMS.
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB bbinfo|bbinfo]] #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA lvcansetprog |lvcansetprog]] #''
| style="text-align: left; vertical-align: top;" | Return same information as bbread command but additional all events timestamp is written in HEX.<br/>
+
| style="text-align: left; vertical-align: top;" | Set LVCAN program number.
1.# - returns entered number of latest events. When # is omitted the latest events are packed to single SMS.
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''sdformat''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA lvcangetinfo|lvcangetinfo]]''
| style="text-align: left; vertical-align: top;" | Format SD card.
+
| style="text-align: left; vertical-align: top;" | Get LV-CAN info by SMS.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
|}
+
! style="text-align: left; vertical-align: top;" | ''getcontsens''
 
+
| style="text-align: left; vertical-align: top;" | Get IDs of connected temperature sensors.
{{{sect_features|{{Template:FMB Features SMS/GRPS commands}}}}}
 
 
 
==Commands related to Bluetooth==
 
 
 
{| class="wikitable"
 
|+
 
! style="width: 150px; background: black; color: white;"  | Command
 
! style="width: 500px; background: black; color: white;" | Description
 
! style="width: 50px; background: black; color: white;" | Response
 
|-
 
! style="text-align: left; vertical-align: top;" | ''[[FMB btgetlist|btgetlist]] #''
 
| style="text-align: left; vertical-align: top;" | Returns requested Bluetooth list. <br/># - 0,1 or 2 (0 – Discovered, 1 – Paired, 2 – Connected).
 
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''btscan''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA faultcode|faultcode]]''
| style="text-align: left; vertical-align: top;" | Starts Bluetooth scan.
+
| style="text-align: left; vertical-align: top;" | Read DTC
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''btvisible #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA setkey|setkey]] # #''
| style="text-align: left; vertical-align: top;" | Sets Bluetooth to visible with TMO. <br/># - visibility TMO (from 1 to 255 seconds).
+
| style="text-align: left; vertical-align: top;" | Add new or change current configuration keyword.<br/>
 +
1.# - old keyword (if adding new keyword space).<br/>
 +
2.# - new keyword.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''btrelease #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA delkey|delkey]] #''
| style="text-align: left; vertical-align: top;" | Disconnects from current device and pauses auto connect functionality for TMO. <br/># - none or TMO (from 1 to 255 seconds).
+
| style="text-align: left; vertical-align: top;" | Delete configuration keyword.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
! style="text-align: left; vertical-align: top;" | ''btunpair #''
+
! style="text-align: left; vertical-align: top;" | ''[[FMA dtcinfo|dtcinfo]] #''
| style="text-align: left; vertical-align: top;" | Unpair Bluetooth device. <br/># - all, BT address (all – unpair all devices, BT address – unpair only specified MAC address).
+
| style="text-align: left; vertical-align: top;" | DTC information.
 
| style="text-align: left; vertical-align: top;" | Yes
 
| style="text-align: left; vertical-align: top;" | Yes
 
|-
 
|-
 
|}
 
|}
 
{{{sect_obd|{{Template:FMB OBD SMS/GRPS commands}}}}}
 
 
{{{sect_can|{{Template:FMB CAN SMS/GRPS commands}}}}}
 

Latest revision as of 08:51, 23 August 2018


Click Here to know how to construct a proper SMS message and send it to FMA1YX device. All commands are case sensitive. While FMA1YX operates in Deep Sleep mode and user tries to send SMS message it cannot arrive to FMA1YX device, because GSM/GPRS module is disabled most of the time (wake up depends on Send Period parameter). FMA1YX will receive the SMS when it wakes up (exits deep sleep mode).


SMS command list

Command Description Response
getstatus Modem Status information. Yes
getweektime Current device time, Day of Week and amount of minutes passed since start of week Yes
getops List of currently available GSM operator Yes
getcfgtime Date and Time of last successful configuration Yes
ggps Returns location information with Google maps link. Yes
getgps Current GPS data, date and time. Yes
cpureset Resets device. No
resetprof Reset all FLASH1 profile configuration to default profile No
getver Device / Modem / Code version information. Yes
getinfo Device runtime system information. Yes
deleterecords Delete all records saved on FLASH Yes
getio Readout analog input,digital input and output. Yes
readio # Returns IO status, # AVL ID. Yes
setdigout ## Y1 Y2 Set digital output.|

1.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT1.
2.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT2.
Y1 – timeout value for DOUT1 if needed (in seconds).
Y2 – timeout value for DOUT2 if needed (in seconds).

Yes
setdigout X Z Y set selected digital output

X – number of Digital output (1 – digital output 1; 2 – digital output 2).
Z – activate(1)/deactivate(0).
Y – activation/deactivation timeout.

Yes
getparam # Returns selected parameter value, # param ID. Yes
getparam 1271 X X values can be 1,2,3. Yes
setparam # # Sets selected parameter value.

1.# - ID value.
2.# - New first Parameter Value.

Yes
flush #,#,#,#,#,#,# Initiates all data sending to specified target server.

1.# - IMEI.
2.# - APN.
3.# - LOGIN.
4.# - PASS.
5.# - IP.
6.# - PORT.
7.# - MODE (0-TCP/1-UDP).

Yes
readops # 1 – send first 20 operator codes

2 – send from 21st to 40th operator codes.
3 – send all other operator codes.

No
sn # Static navigation, 1 – enable, 0 – disable Yes
banlist # Banned operators information. Yes
crashlog # Device last information before unexpected reset. Yes
delete_all_sms Deletes all SMS No
lvcangetprog CAN Program Number request by SMS Yes
lvcansetprog # Set LVCAN program number. Yes
lvcangetinfo Get LV-CAN info by SMS. Yes
getcontsens Get IDs of connected temperature sensors. Yes
faultcode Read DTC Yes
setkey # # Add new or change current configuration keyword.

1.# - old keyword (if adding new keyword space).
2.# - new keyword.

Yes
delkey # Delete configuration keyword. Yes
dtcinfo # DTC information. Yes