|
|
| (19 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{Template:FMB FW development notice}} | | {{Template:FMB640_SMS/GPRS_command_list|model=FMB640}} |
| | | [[Category:FMB640 Manual]] |
| All commands are case sensitive. When user tries to send SMS/GPRS message to {{{model|FMB640}}} that operates in Deep Sleep mode, it cannot arrive to {{{model|FMB640}}} device because the GSM/GPRS module is disabled most of the time. {{{model|FMB640}}} will receive the SMS/GPRS message when it exits Deep Sleep mode.<br/>If {{{model|FMB640}}} 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 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 getweektime|getweektime]]''
| |
| | 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 getops|getops]]''
| |
| | style="text-align: left; vertical-align: top;" | List of currently used and available GSM operators
| |
| | style="text-align: left; vertical-align: top;" | Yes
| |
| |-
| |
| ! style="text-align: left; vertical-align: top;" | ''[[FMB readops|readops]]#''
| |
| | style="text-align: left; vertical-align: top;" | Emergency gsm operator readout from active profile.<br/>
| |
| # - 1,2,3.<br/>
| |
| 1 – operators [1-20].<br/>
| |
| 2 – operators [21-40] <br/>
| |
| 3 – operators [41-50]<br/>
| |
| | 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="text-align: left; vertical-align: top;" | {{{cmd_setdigout|''[[FMB setdigout|setdigout]] ## Y1 Y2''}}}
| |
| | style="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;" | ''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
| |
| |-
| |
| |}
| |
| | |
| ==Commands related to features==
| |
| | |
| {| 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 fc_reset|fc_reset]]''
| |
| | style="text-align: left; vertical-align: top;" | Resets fuel consumption parameters.
| |
| | style="text-align: left; vertical-align: top;" | Yes
| |
| |-
| |
| ! style="text-align: left; vertical-align: top;" | ''[[FMB towingreact|towingreact]]''
| |
| | style="text-align: left; vertical-align: top;" | Towing reactivation.
| |
| | style="text-align: left; vertical-align: top;" | Yes
| |
| |-
| |
| ! style="text-align: left; vertical-align: top;" | ''[[FMB odoset|odoset]]:#''
| |
| | style="text-align: left; vertical-align: top;" | Set total odometer value.<br/># - new odometer value in km.
| |
| | style="text-align: left; vertical-align: top;" | Yes
| |
| |-
| |
| ! style="text-align: left; vertical-align: top;" | ''[[FMB odoget|odoget]]''
| |
| | style="text-align: left; vertical-align: top;" | Display current odometer value.
| |
| | style="text-align: left; vertical-align: top;" | Yes
| |
| |-
| |
| |}
| |
| | |
| ==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_can|{{Template:FMB CAN SMS/GRPS commands}}}}}
| |
All commands are case sensitive. When user tries to send SMS/GPRS message to FMB640 that operates in Deep Sleep mode, it cannot arrive to FMB640 device because the GSM/GPRS module is disabled most of the time. FMB640 will receive the SMS/GPRS message when it exits Deep Sleep mode.
If FMB640 is in GPS Sleep or Online Deep Sleep mode, sent SMS/GPRS message will arrive to the device.
SMS command structure:
<SMS login><space><SMS password><space><command><space><value>
SMS command getinfo example:
- If you have set SMS login and password:
login pass getinfo
- If SMS login and password are not set leave two spaces before command:
getinfo
Common commands
| Command |
Description |
Response |
| getstatus |
Modem Status information |
Yes |
| getrecord |
SMS command initiates saving and sending of high priority record |
No |
| getcfgtime |
Date and Time of last successful configuration |
Yes |
| getgps |
Current GPS data and time |
Yes |
| getnmeainfo |
NMEA error debug SMS |
Yes |
| cpureset |
Reset CPU |
No |
| defaultcfg |
Reset configuration to default |
Yes |
| getver |
Device / Modem / Code version information |
Yes |
| getimeiccid |
Gets IMEI and CCID |
Yes |
| getinfo |
Device runtime system information |
Yes |
| tacho_connect |
Connect to Web Tacho immediately |
Yes |
| web_connect |
Connect to Fota WEB immediately |
Yes |
| deleterecords |
Delete all records saved on FLASH |
Yes |
| getio |
Readout digital inputs and outputs, analog inputs |
Yes |
| banlist |
Banlist information |
Yes |
| crashlog |
Crash log information |
Yes |
| delete_all_sms |
Delete all read SMS |
Yes |
| braminfo |
BatRam info |
Yes |
| getgnss |
Current GNSS information |
Yes |
| resetlimits |
Resets data counters |
Yes |
| getlimits |
Gets home/roaming uploaded data information |
Yes |
| scanfms |
Shows EV FMS elements that can be read from vehicle |
Yes |
| scanevfms |
Shows FMS elements that can be read from vehicle |
Yes |
| readio # |
Returns IO status, # AVL ID |
Yes |
| setdigout XXXX Y1 Y2 Y3 Y4 |
Set digital output
1. # – 0; 1 or ? (0 - OFF, 1 – ON or ? – Ignore) for DOUT1
2. # – 0; 1 or ? (0 - OFF, 1 – ON or ? – Ignore) for DOUT2
3. # – 0; 1 or ? (0 - OFF, 1 – ON or ? – Ignore) for DOUT3
4. # – 0; 1 or ? (0 - OFF, 1 – ON or ? – Ignore) for DOUT4
Y1 – timeout value for DOUT1 if needed (in seconds)
Y2 – timeout value for DOUT2 if needed (in seconds)
Y3 – timeout value for DOUT3 if needed (in seconds)
Y4 – timeout value for DOUT4 if needed (in seconds) |
Yes |
| getparam # |
Readout parameter value according entered ID. # - ID value |
Yes |
| setparam #:# |
Sets selected parameter value
1.# - first ID value
2.# - New first Parameter Value
3.# - second ID value
4.# - New second Parameter Value
5.# - third ID value
6.# - New third Parameter Value
SMS command is limited to 160 characters |
Yes |
| setparam #:#;#:#;… |
| flush #,#,#,#,#,#,# |
Redirects device to other server
1.# - IMEI
2.# - APN
3.# - LOGIN
4.# - PASS
5.# - IP
6.# - PORT
7.# - MODE (0-TCP/1-UDP) |
Yes |
| klinecheck |
The command returns the status of Kline and privacy mode, as well as the main elements of Kline IO. |
Yes |
| getcfgtime |
Date and Time of last successful configuration |
Yes |
Commands related to features
| Command |
Description |
Response |
| odoset:# |
Set total odometer value # - new odometer value in m |
Yes |
| odoget |
Display current odometer value |
Yes |
| odinfo |
Odometer Debug info |
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 |
Commands related to LV-CAN200/ALL-CAN300
| Command |
Description |
Response |
| lvcansetprog #
| Set program number to LV-CAN200/ ALL-CAN300 that is connected to FMx640. # - 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 FMx640
| 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
|