Difference between revisions of "Template:FMA SMS/GPRS command list"
(50 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). | |
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 getstatus|getstatus]]'' |
| style="text-align: left; vertical-align: top;" | Modem Status 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 | ||
Line 24: | Line 24: | ||
| 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 getcfgtime|getcfgtime]]'' |
| style="text-align: left; vertical-align: top;" | Date and Time of last successful configuration | | 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;" | ''[[ | + | ! 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 getgps|getgps]]'' |
| style="text-align: left; vertical-align: top;" | Current GPS data, date and time. | | 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;" | ''[[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;" | Device runtime system information. | ||
| 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 getver|getver]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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;" | {{{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;" | 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 readio|readio]] #'' |
| style="text-align: left; vertical-align: top;" | Returns IO status, # AVL ID. | | 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;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''cpureset'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" | Resets device. |
− | + | | 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 resetprof|resetprof]]'' |
− | | style="text-align: left; vertical-align: top;" | | + | | style="text-align: left; vertical-align: top;" | Reset all FLASH1 profile configuration to default profile |
− | + | | 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;" | Returns selected parameter value, # param [[ | + | |
+ | |||
+ | ! 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;" | ''[[FMA getparam 1271 | + | ! style="text-align: left; vertical-align: top;" | ''[[FMA getparam 1271 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;" | X values can be 1,2,3. | ||
| 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;" | 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 93: | Line 77: | ||
| 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 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 102: | Line 86: | ||
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;" | ''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;" | Yes | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | | + | ! 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="text-align: left; vertical-align: top;" | Yes | ||
+ | |- | ||
+ | ! style="text-align: left; vertical-align: top;" | ''[[FMB battery|setdigout X Z Y]]'' | ||
+ | | style="text-align: left; vertical-align: top;" | set selected digital output<br/> | ||
+ | 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;" | ''readops'' | ||
| style="text-align: left; vertical-align: top;" | 1 – send first 20 operator codes<br/> | | style="text-align: left; vertical-align: top;" | 1 – send first 20 operator codes<br/> | ||
2 – send from 21<sup>st</sup> to 40<sup>th</sup> operator codes.<br/> | 2 – send from 21<sup>st</sup> to 40<sup>th</sup> operator codes.<br/> | ||
Line 110: | Line 113: | ||
| style="text-align: left; vertical-align: top;" | No | | style="text-align: left; vertical-align: top;" | No | ||
|- | |- | ||
− | ! style="text-align: left; vertical-align: top;" | '' | + | ! style="text-align: left; vertical-align: top;" | ''sn #'' |
| style="text-align: left; vertical-align: top;" | Static navigation, 1 – enable, 0 – disable | | 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;" | ''[[FMB setkey|setkey]] # #'' | ||
+ | | 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;" | ''[[FMB delkey|delkey]] #'' | ||
+ | | style="text-align: left; vertical-align: top;" | Remove existing keyword.<br/> | ||
+ | 1.# - old keyword. | ||
| style="text-align: left; vertical-align: top;" | Yes | | style="text-align: left; vertical-align: top;" | Yes | ||
|- | |- | ||
Line 126: | Line 140: | ||
| style="text-align: left; vertical-align: top;" | No | | style="text-align: left; vertical-align: top;" | No | ||
|- | |- | ||
− | ! style=" | + | |} |
− | + | ||
− | + | {{{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;" | ''[[ | + | ! style="text-align: left; vertical-align: top;" | ''[[FMB btgetlist|btgetlist]] #'' |
− | | style="text-align: left; vertical-align: top;" | | + | | 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 13:47, 22 August 2018
Read chapter 5.10 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 |
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 |
getio | Readout analog input,digital input and output. | Yes |
readio # | Returns IO status, # AVL ID. | Yes |
cpureset | Resets device. | No |
resetprof | Reset all FLASH1 profile configuration to default profile | No |
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. |
Yes |
flush #,#,#,#,#,#,# | Initiates all data sending to specified target server. 1.# - IMEI. |
No |
deleterecords | Delete all records saved on FLASH | Yes |
setdigout ## Y1 Y2 | Set digital output. 1.# – 0 or 1 (0 - OFF or 1 – ON) for DOUT1. |
Yes |
setdigout X Z Y | set selected digital output X – number of Digital output (1 – digital output 1; 2 – digital output 2). |
Yes |
readops | 1 – send first 20 operator codes 2 – send from 21st to 40th operator codes. |
No |
sn # | Static navigation, 1 – enable, 0 – disable | Yes |
setkey # # | Add new or change current configuration keyword. 1.# - old keyword (if adding new keyword space). |
Yes |
delkey # | Remove existing keyword. 1.# - old keyword. |
Yes |
banlist # | Banned operators information. | Yes |
crashlog # | Device last information before unexpected reset. | Yes |
delete_all_sms | Deletes all SMS | No |
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 |