Difference between revisions of "Template:FMA SMS/GPRS command list"
(Created 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...") |
|||
(78 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Template:FMB FW development notice}} | {{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" | {| class="wikitable" | ||
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;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB getinfo|getinfo]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB getstatus|getstatus]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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 | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB getgps|getgps]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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 | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | {{{cmd_getio|''[[FMB getio|getio]]''}}} |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! 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;" | 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;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB readio|readio]] #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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 | ||
|- | |- | ||
Line 40: | Line 44: | ||
| style="text-align: left; vertical-align: top;" | No | | 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;" | ''[[ | ||
− | | style="text-align: left; vertical-align: top;" | | ||
| style="text-align: left; vertical-align: top;" | Yes | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | |
− | | style="text-align: left; vertical-align: top;" | | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB getrecord|getrecord]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | '' | + | |
− | | style="text-align: left; vertical-align: top;" | | + | ! 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | |
− | | style="text-align: left; vertical-align: top;" | | + | |
+ | |||
+ | ! 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | |
− | | style="text-align: left; vertical-align: top;" | Returns | + | |
+ | |||
+ | ! 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;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" rowspan="2" | Sets selected parameter value.<br/> |
− | 1.# | + | 1.# - first [[FMB Device Family Parameter list|ID value]].<br/> |
− | 2.# | + | 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;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#;#:#;…'' |
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB flush|flush]] #,#,#,#,#,#,#'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" | Redirects device to other server.<br/> |
1.# - IMEI.<br/> | 1.# - IMEI.<br/> | ||
2.# - APN.<br/> | 2.# - APN.<br/> | ||
Line 104: | Line 97: | ||
| style="text-align: left; vertical-align: top;" | Yes | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB countrecs|countrecs]]'' |
− | | style="text-align: left; vertical-align: top;" | 1 – | + | | style="text-align: left; vertical-align: top;" | Returns records number. |
− | 2 – | + | | style="text-align: left; vertical-align: top;" | Yes |
− | + | |- | |
− | | style="text-align: left; vertical-align: top;" | | + | ! 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;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''wdlog'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''defaultcfg'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB setkey|setkey]] # #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB delkey|delkey]] #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" | Remove existing keyword (If device is locked, keyword cannot be changed).<br/> |
− | | style="text-align: left; vertical-align: top;" | | + | 1.# - old keyword. |
+ | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB bbread|bbread]] #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB bbinfo|bbinfo]] #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''sdformat'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" | Format SD card. |
| style="text-align: left; vertical-align: top;" | Yes | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | |} |
− | | style="text-align: left; vertical-align: top;" | | + | |
+ | {{{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;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''btscan'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''btvisible #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''btrelease #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''btunpair #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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 | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
|} | |} | ||
+ | |||
+ | {{{sect_obd|{{Template:FMB OBD SMS/GRPS commands}}}}} | ||
+ | |||
+ | {{{sect_can|{{Template:FMB CAN SMS/GRPS commands}}}}} |
Revision as of 10:17, 22 August 2018
All commands are case sensitive. When user tries to send SMS/GPRS message to FMB1YX that operates in Deep Sleep mode, it cannot arrive to FMB1YX device because the GSM/GPRS module is disabled most of the time. FMB1YX will receive the SMS/GPRS message when it exits Deep Sleep mode.
If FMB1YX is in GPS Sleep or Online Deep Sleep mode, sent SMS/GPRS message will arrive to the device.
Common commands
Command | Description | Response |
---|---|---|
getinfo | Device runtime system information. | Yes |
getver | Returns code version, device IMEI, modem app version, RTC time, Init time, Uptime and BT MAC address. | Yes |
getstatus | Modem Status information. | Yes |
getgps | Current GPS data, date and time. | Yes |
getio | Readout analog input,digital input and output. | Yes |
ggps | Returns location information with Google maps link. | Yes |
readio # | Returns IO status, # AVL ID. | Yes |
cpureset | Resets device. | No |
fwstats | Get data about FW and restarts | Yes |
getrecord | SMS command iitiates saving and sending of high priority record | No |
getimeiccid | Reponse is sent to SMS/GPRS sender and to number which is provided. | Yes |
allver | Responds with information about hardware and firmware versions and storage space | Yes |
getparam # | Returns selected parameter value, # param ID. | Yes |
setparam #:# | Sets selected parameter value. 1.# - first ID value. |
Yes |
setparam #:#;#:#;… | ||
flush #,#,#,#,#,#,# | Redirects device to other server. 1.# - IMEI. |
Yes |
countrecs | Returns records number. | Yes |
deleterecords | Delete all records from SD card. | 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). |
|
battery | Returns battery state info. | Yes |
wdlog | Returns all information about 'watch dogs' restarts. | Yes |
defaultcfg | Load default configuration. | Yes |
setkey # # | Add new or change current configuration keyword. If device is locked, keyword cannot be changed. 1.# - old keyword (if adding new keyword space). |
Yes |
delkey # | Remove existing keyword (If device is locked, keyword cannot be changed). 1.# - old keyword. |
Yes |
bbread # | Return black box information (HEX value of event ID and HEX value of custom data field (optional)). 1.# - returns entered number of latest events. When # is omitted the latest events are packed to single SMS. |
Yes |
bbinfo # | Return same information as bbread command but additional all events timestamp is written in HEX. 1.# - returns entered number of latest events. When # is omitted the latest events are packed to single SMS. |
Yes |
sdformat | Format SD card. | Yes |
Command | Description | Response |
---|---|---|
fc_reset | Resets fuel consumption parameters. | Yes |
towingreact | Towing reactivation. | Yes |
auto_calibrate:set | Calibrate position if car accelerate straight to > 30 km/h for 5 sec. | Yes |
auto_calibrate:get | Returns the state of calibration. | Yes |
odoset:# | Set total odometer value. # - new odometer value in km. |
Yes |
odoget | Display current odometer value. | Yes |
on_demand_trackingX | X=0 – Stops Tracking on Demand functionality. X=1 – Starts Tracking on Demand functionality. X=2 – Generates one high priority record and inititates data sending to server. |
Yes |
Command | Description | Response |
---|---|---|
btgetlist # | Returns requested Bluetooth list. # - 0,1 or 2 (0 – Discovered, 1 – Paired, 2 – Connected). |
Yes |
btscan | Starts Bluetooth scan. | Yes |
btvisible # | Sets Bluetooth to visible with TMO. # - visibility TMO (from 1 to 255 seconds). |
Yes |
btrelease # | Disconnects from current device and pauses auto connect functionality for TMO. # - none or TMO (from 1 to 255 seconds). |
Yes |
btunpair # | Unpair Bluetooth device. # - all, BT address (all – unpair all devices, BT address – unpair only specified MAC address). |
Yes |
Command | Description | Response |
---|---|---|
obdinfo | If connected with Blue-tooth OBD dongle displays all available information from OBD. | Yes |
faultcodes | If connected with Blue-tooth OBD dongle display all visible fault codes. | Yes |
cleardtc | Clears all vehicle stored fault codes. | No |
getvin | Get vehicle VIN code, if OBD dongle is connected. | Yes |
Command | Description | Response |
---|---|---|
lvcansetprog # | Set program number to LV-CAN200/ ALL-CAN300 that is connected to FMB1YX. # three digit number that identity vehicle. |
Yes |
lvcansimpletacho # | Add or remove simpletacho start byte. # - 0 or 1 (0 – don’t add start byte, 1 – add start byte). |
No |
lvcangetprog | Get program number from LV-CAN200/ ALL-CAN300 that is connected to FMB1YX. | Yes |
lvcangetinfo | Get information about connected LV-CAN200/ALL-CAN300. | Yes |
lvcanclear # | Clear Total Mileage (counted), Engine Work Time (counted), Fuel Consumed (counted) parameters values. # - parameter (0 – Engine work time (counted), 1 – Fuel Consumed (counted), 2 – Vehicle Mileage (counted)).. |
Yes |
allcanmode | Turn on ALL-CAN300 mode. | Yes |
lvcanmode | Turn on LV-CAN200 mode. | Yes |
lvcanfaultcodes | Read DTC fault codes. | Yes |