494
edits
Changes
Template:FMA SMS/GPRS command list (view source)
Revision as of 11:17, 22 August 2018
, 11:17, 22 August 2018Created page with "{{Template:FMB FW development notice}} All commands are case sensitive. When user tries to send SMS/GPRS message to {{{model|FMB1YX}}} that operates in Deep Sleep mode, it ca..."
{{Template:FMB FW development notice}}
All commands are case sensitive. When user tries to send SMS/GPRS message to {{{model|FMB1YX}}} that operates in Deep Sleep mode, it cannot arrive to {{{model|FMB1YX}}} device because the GSM/GPRS module is disabled most of the time. {{{model|FMB1YX}}} will receive the SMS/GPRS message when it exits Deep Sleep mode.<br/>If {{{model|FMB1YX}}} is in GPS Sleep or Online Deep Sleep mode, sent SMS/GPRS message will arrive to the device.
==Common commands==
{| 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 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;" | ''[[FMB getver|getver]]''
| 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;" | 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;" | ''[[FMB getgps|getgps]]''
| 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;" | {{{cmd_getio|''[[FMB 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;" | ''[[FMB ggps|ggps]]''
| 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;" | ''[[FMB 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;" | ''cpureset''
| style="text-align: left; vertical-align: top;" | Resets device.
| style="text-align: left; vertical-align: top;" | No
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB fwstats|fwstats]]''
| style="text-align: left; vertical-align: top;" | Get data about FW and restarts
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getrecord|getrecord]]''
| style="text-align: left; vertical-align: top;" | SMS command iitiates saving and sending of high priority record
| style="text-align: left; vertical-align: top;" | No
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getimeiccid|getimeiccid]]''
| style="text-align: left; vertical-align: top;" | Reponse is sent to SMS/GPRS sender and to number which is provided.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB allver|allver]]''
| 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;" | ''[[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;" | ''[[FMB setparam|setparam]] #:#''
| style="text-align: left; vertical-align: top;" rowspan="2" | Sets selected parameter value.<br/>
1.# - first [[FMB Device Family Parameter list|ID value]].<br/>
2.# - New first Parameter Value.<br/>
3.# - second [[FMB Device Family Parameter list|ID value]].<br/>
4.# - New second Parameter Value.<br/>
5.# - third [[FMB Device Family Parameter list|ID value]].<br/>
6.# - New third Parameter Value.<br/>
SMS command is limited to 160 characters.
| style="text-align: left; vertical-align: top;" rowspan="2" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#;#:#;…''
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB flush|flush]] #,#,#,#,#,#,#''
| style="text-align: left; vertical-align: top;" | Redirects device to other server.<br/>
1.# - IMEI.<br/>
2.# - APN.<br/>
3.# - LOGIN.<br/>
4.# - PASS.<br/>
5.# - IP.<br/>
6.# - PORT.<br/>
7.# - MODE (0-TCP/1-UDP).
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB countrecs|countrecs]]''
| 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;" | ''deleterecords''
| style="text-align: left; vertical-align: top;" | Delete all records from SD card.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="{{{hide_setdigout|}}}text-align: left; vertical-align: top;" | {{{cmd_setdigout|''[[FMB setdigout|setdigout]] ## Y1 Y2''}}}
| 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;" | Returns battery state info.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''wdlog''
| style="text-align: left; vertical-align: top;" | Returns all information about 'watch dogs' restarts.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''defaultcfg''
| style="text-align: left; vertical-align: top;" | Load default configuration.
| 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;" | Add new or change current configuration keyword. If device is locked, keyword cannot be changed.<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;" | ''[[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;" | Return black box information (HEX value of event ID and HEX value of custom data field (optional)).<br/>
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;" | ''[[FMB bbinfo|bbinfo]] #''
| style="text-align: left; vertical-align: top;" | Return same information as bbread command but additional all events timestamp is written in HEX.<br/>
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;" | ''sdformat''
| style="text-align: left; vertical-align: top;" | Format SD card.
| style="text-align: left; vertical-align: top;" | Yes
|-
|}
{{{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;" | ''btscan''
| style="text-align: left; vertical-align: top;" | Starts Bluetooth scan.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btvisible #''
| 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;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btrelease #''
| 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;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btunpair #''
| 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;" | Yes
|-
|}
{{{sect_obd|{{Template:FMB OBD SMS/GRPS commands}}}}}
{{{sect_can|{{Template:FMB CAN SMS/GRPS commands}}}}}
All commands are case sensitive. When user tries to send SMS/GPRS message to {{{model|FMB1YX}}} that operates in Deep Sleep mode, it cannot arrive to {{{model|FMB1YX}}} device because the GSM/GPRS module is disabled most of the time. {{{model|FMB1YX}}} will receive the SMS/GPRS message when it exits Deep Sleep mode.<br/>If {{{model|FMB1YX}}} is in GPS Sleep or Online Deep Sleep mode, sent SMS/GPRS message will arrive to the device.
==Common commands==
{| 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 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;" | ''[[FMB getver|getver]]''
| 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;" | 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;" | ''[[FMB getgps|getgps]]''
| 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;" | {{{cmd_getio|''[[FMB 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;" | ''[[FMB ggps|ggps]]''
| 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;" | ''[[FMB 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;" | ''cpureset''
| style="text-align: left; vertical-align: top;" | Resets device.
| style="text-align: left; vertical-align: top;" | No
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB fwstats|fwstats]]''
| style="text-align: left; vertical-align: top;" | Get data about FW and restarts
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getrecord|getrecord]]''
| style="text-align: left; vertical-align: top;" | SMS command iitiates saving and sending of high priority record
| style="text-align: left; vertical-align: top;" | No
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB getimeiccid|getimeiccid]]''
| style="text-align: left; vertical-align: top;" | Reponse is sent to SMS/GPRS sender and to number which is provided.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB allver|allver]]''
| 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;" | ''[[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;" | ''[[FMB setparam|setparam]] #:#''
| style="text-align: left; vertical-align: top;" rowspan="2" | Sets selected parameter value.<br/>
1.# - first [[FMB Device Family Parameter list|ID value]].<br/>
2.# - New first Parameter Value.<br/>
3.# - second [[FMB Device Family Parameter list|ID value]].<br/>
4.# - New second Parameter Value.<br/>
5.# - third [[FMB Device Family Parameter list|ID value]].<br/>
6.# - New third Parameter Value.<br/>
SMS command is limited to 160 characters.
| style="text-align: left; vertical-align: top;" rowspan="2" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#;#:#;…''
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB flush|flush]] #,#,#,#,#,#,#''
| style="text-align: left; vertical-align: top;" | Redirects device to other server.<br/>
1.# - IMEI.<br/>
2.# - APN.<br/>
3.# - LOGIN.<br/>
4.# - PASS.<br/>
5.# - IP.<br/>
6.# - PORT.<br/>
7.# - MODE (0-TCP/1-UDP).
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''[[FMB countrecs|countrecs]]''
| 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;" | ''deleterecords''
| style="text-align: left; vertical-align: top;" | Delete all records from SD card.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="{{{hide_setdigout|}}}text-align: left; vertical-align: top;" | {{{cmd_setdigout|''[[FMB setdigout|setdigout]] ## Y1 Y2''}}}
| 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;" | Returns battery state info.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''wdlog''
| style="text-align: left; vertical-align: top;" | Returns all information about 'watch dogs' restarts.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''defaultcfg''
| style="text-align: left; vertical-align: top;" | Load default configuration.
| 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;" | Add new or change current configuration keyword. If device is locked, keyword cannot be changed.<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;" | ''[[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;" | Return black box information (HEX value of event ID and HEX value of custom data field (optional)).<br/>
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;" | ''[[FMB bbinfo|bbinfo]] #''
| style="text-align: left; vertical-align: top;" | Return same information as bbread command but additional all events timestamp is written in HEX.<br/>
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;" | ''sdformat''
| style="text-align: left; vertical-align: top;" | Format SD card.
| style="text-align: left; vertical-align: top;" | Yes
|-
|}
{{{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;" | ''btscan''
| style="text-align: left; vertical-align: top;" | Starts Bluetooth scan.
| style="text-align: left; vertical-align: top;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btvisible #''
| 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;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btrelease #''
| 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;" | Yes
|-
! style="text-align: left; vertical-align: top;" | ''btunpair #''
| 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;" | Yes
|-
|}
{{{sect_obd|{{Template:FMB OBD SMS/GRPS commands}}}}}
{{{sect_can|{{Template:FMB CAN SMS/GRPS commands}}}}}
