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

From Wiki Knowledge Base | Teltonika GPS
m
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|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.
 
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.
 +
 +
SMS command structure:
 +
<SMS login><space><SMS password><space><command><space><value>
 +
SMS command [[FMB getinfo|getinfo]] example:
 +
 +
*If you have set SMS login and password: <code>login pass getinfo</code>
 +
*If SMS login and password are not set leave two spaces before command: <code>&nbsp;  getinfo</code>
  
 
==Common commands==
 
==Common commands==
 
+
<table class="nd-othertables_2" style="width:65%">
{| class="wikitable"
+
<tr>
|+
+
        <th style="width:15%; text-align: center;">Command</th>
! style="width: 150px; background: black; color: white;" | Command
+
        <th style="width:30%; text-align: center;">Description</th>
! style="width: 500px; background: black; color: white;" | Description
+
        <th style="width:15%; text-align: center;">Response</th>
! style="width: 50px; background: black; color: white;" | Response
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''[[FM6_getstatus|getstatus]]''
+
        <td style="text-align: center;">''[[FM6_getstatus|getstatus]]''</td>
| style="text-align: left; vertical-align: top;" | Modem Status information.
+
        <td style="text-align: left;">Modem Status information</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | ''getrecord''
+
<tr>
| style="text-align: left; vertical-align: top;" | SMS command initiates saving and sending of high priority record.
+
        <td style="text-align: center;">''getrecord''</td>
| style="text-align: left; vertical-align: top;" | No
+
        <td style="text-align: left;">SMS command initiates saving and sending of high priority record</td>
|-
+
        <td style="text-align: center;">No</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getcfgtime|getcfgtime]]''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Date and Time of last successful configuration
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''[[FMB getcfgtime|getcfgtime]]''</td>
|-
+
        <td style="text-align: left;">Date and Time of last successful configuration</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getgps|getgps]]''
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Current GPS data and time
+
    </tr>
| style="text-align: left; vertical-align: top;" | Yes
+
<tr>
|-
+
        <td style="text-align: center;">''[[FMB getgps|getgps]]''</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getnmeainfo|getnmeainfo]]''
+
        <td style="text-align: left;">Current GPS data and time</td>
| style="text-align: left; vertical-align: top;" | Nmea error debug sms.
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Yes
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''cpureset''
+
        <td style="text-align: center;">''[[FMB getnmeainfo|getnmeainfo]]''</td>
| style="text-align: left; vertical-align: top;" | Reset CPU.
+
        <td style="text-align: left;">NMEA error debug SMS</td>
| style="text-align: left; vertical-align: top;" | No
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | ''defaultcfg''
+
<tr>
| style="text-align: left; vertical-align: top;" | Reset configuration to default.
+
        <td style="text-align: center;">''cpureset''</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: left;">Reset CPU</td>
|-
+
        <td style="text-align: center;">No</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getver|getver]]''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Device / Modem / Code version information.
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''defaultcfg''</td>
|-
+
        <td style="text-align: left;">Reset configuration to default</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getinfo|getinfo]]''
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Device runtime system information.
+
    </tr>
| style="text-align: left; vertical-align: top;" | Yes
+
<tr>
|-
+
        <td style="text-align: center;">''[[FMB getver|getver]]''</td>
! style="text-align: left; vertical-align: top;" | ''tacho_connect''
+
        <td style="text-align: left;">Device / Modem / Code version information</td>
| style="text-align: left; vertical-align: top;" | Connect to Web Tacho immediately.
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Yes
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''web_connect''
+
        <td style="text-align: center;">''[[FMB getinfo|getinfo]]''</td>
| style="text-align: left; vertical-align: top;" | Connect to Fota WEB immediately.
+
        <td style="text-align: left;">Device runtime system information</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | ''deleterecords''
+
<tr>
| style="text-align: left; vertical-align: top;" | Delete all records saved on FLASH.
+
        <td style="text-align: center;">''tacho_connect''</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: left;">Connect to Web Tacho immediately</td>
|-
+
        <td style="text-align: center;">Yes</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getio|getio]]''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Readout digital inputs and outputs, analog inputs.
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''web_connect''</td>
|-
+
        <td style="text-align: left;">Connect to Fota WEB immediately</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB banlist|banlist]]''
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Banlist information.
+
    </tr>
| style="text-align: left; vertical-align: top;" | Yes
+
<tr>
|-
+
        <td style="text-align: center;">''deleterecords''</td>
! style="text-align: left; vertical-align: top;" | ''crashlog''
+
        <td style="text-align: left;">Delete all records saved on FLASH</td>
| style="text-align: left; vertical-align: top;" | Crash log information.
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Yes
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''delete_all_sms''
+
        <td style="text-align: center;">''[[FMB getio|getio]]''</td>
| style="text-align: left; vertical-align: top;" | Delete all read SMS.
+
        <td style="text-align: left;">Readout digital inputs and outputs, analog inputs</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | ''[[FMB braminfo|braminfo]]''
+
<tr>
| style="text-align: left; vertical-align: top;" | BatRam info.
+
        <td style="text-align: center;">''[[FMB banlist|banlist]]''</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: left;">Banlist information</td>
|-
+
        <td style="text-align: center;">Yes</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getgnss|getgnss]]''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Current GNSS information.
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''crashlog''</td>
|-
+
        <td style="text-align: left;">Crash log information</td>
! style="text-align: left; vertical-align: top;" | ''resetlimits''
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Resets data counters.
+
    </tr>
| style="text-align: left; vertical-align: top;" | Yes
+
<tr>
|-
+
        <td style="text-align: center;">''delete_all_sms''</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB scanfms|scanfms]]''
+
        <td style="text-align: left;">Delete all read SMS</td>
| style="text-align: left; vertical-align: top;" | Shows FMS elements that can be read from vehicle
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" | Yes
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''[[FMB readio|readio #]]''
+
        <td style="text-align: center;">''[[FMB braminfo|braminfo]]''</td>
| style="text-align: left; vertical-align: top;" | Returns IO status, # AVL ID.
+
        <td style="text-align: left;">BatRam info</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | {{{cmd_setdigout|''[[FMB setdigout|setdigout]] XXXX Y1 Y2 Y3 Y4''}}}
+
<tr>
| 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/>3. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT3.<br/>4. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT4.<br/>Y1 – timeout value for DOUT1 if needed (in seconds).<br/>Y2 – timeout value for DOUT2 if needed (in seconds).<br/>Y3 – timeout value for DOUT3 if needed (in seconds).<br/>Y4 – timeout value for DOUT4 if needed (in seconds).}}}
+
        <td style="text-align: center;">''[[FMB getgnss|getgnss]]''</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: left;">Current GNSS information</td>
|-
+
        <td style="text-align: center;">Yes</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB getparam|getparam]] #''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Readout parameter value according entered ID.<br/># - ID value.
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''resetlimits''</td>
|-
+
        <td style="text-align: left;">Resets data counters</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#''
+
        <td style="text-align: center;">Yes</td>
| style="text-align: left; vertical-align: top;" rowspan="2" | Sets selected parameter value.<br/>
+
    </tr>
1.# - first [[FMB Device Family Parameter list|ID value]].<br/>
+
<tr>
2.# - New first Parameter Value.<br/>
+
        <td style="text-align: center;">''[[FMB scanfms|scanfms]]''</td>
3.# - second [[FMB Device Family Parameter list|ID value]].<br/>
+
        <td style="text-align: left;">Shows FMS elements that can be read from vehicle</td>
4.# - New second Parameter Value.<br/>
+
        <td style="text-align: center;">Yes</td>
5.# - third [[FMB Device Family Parameter list|ID value]].<br/>
+
    </tr>
6.# - New third Parameter Value.<br/>
+
<tr>
SMS command is limited to 160 characters.
+
        <td style="text-align: center;">''[[FMB readio|readio #]]''</td>
| style="text-align: left; vertical-align: top;" rowspan="2" | Yes
+
        <td style="text-align: left;">Returns IO status, # AVL ID</td>
|-
+
        <td style="text-align: center;">Yes</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB setparam|setparam]] #:#;#:#;…''
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''[[FMB flush|flush]] #,#,#,#,#,#,#''
+
        <td style="text-align: center;">{{{cmd_setdigout|''[[FMB setdigout|setdigout]] XXXX Y1 Y2 Y3 Y4''}}}</td>
| style="text-align: left; vertical-align: top;" | Redirects device to other server.<br/>
+
        <td style="text-align: left;">Set digital output{{{txt_setdigout|<br/>
1.# - IMEI.<br/>
+
1. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT1<br/>
2.# - APN.<br/>
+
2. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT2<br/>
3.# - LOGIN.<br/>
+
3. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT3<br/>
4.# - PASS.<br/>
+
4. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT4<br/>
5.# - IP.<br/>
+
Y1 – timeout value for DOUT1 if needed (in seconds)<br/>
6.# - PORT.<br/>
+
Y2 – timeout value for DOUT2 if needed (in seconds)<br/>
7.# - MODE (0-TCP/1-UDP).
+
Y3 – timeout value for DOUT3 if needed (in seconds)<br/>
| style="text-align: left; vertical-align: top;" | Yes
+
Y4 – timeout value for DOUT4 if needed (in seconds)}}}</td>
|-
+
        <td style="text-align: center;">Yes</td>
|}
+
    </tr>
 +
<tr>
 +
        <td style="text-align: center;">''[[FMB getparam|getparam]] #''</td>
 +
        <td style="text-align: left;">Readout parameter value according entered ID.<br/># - ID value</td>
 +
        <td style="text-align: center;">Yes</td>
 +
    </tr>
 +
<tr>
 +
        <td style="text-align: center;">''[[FMB setparam|setparam]] #:#''</td>
 +
        <td style="text-align: left;" 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</td>
 +
        <td style="text-align: center;" rowspan="2">Yes</td>
 +
    </tr>
 +
<tr>
 +
        <td style="text-align: center;">''[[FMB setparam|setparam]] #:#;#:#;…''</td>
 +
    </tr>
 +
<tr>
 +
        <td style="text-align: center;">''[[FMB flush|flush]] #,#,#,#,#,#,#''</td>
 +
        <td style="text-align: left;">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)</td>
 +
        <td style="text-align: center;">Yes</td>
 +
    </tr>
 +
</table>
  
 
==Commands related to features==
 
==Commands related to features==
 
+
<table class="nd-othertables_2" style="width:65%">
{| class="wikitable"
+
<tr>
|+
+
        <th style="width:10%; text-align: center;">Command</th>
! style="width: 150px; background: black; color: white;" | Command
+
        <th style="width:25%; text-align: center;">Description</th>
! style="width: 500px; background: black; color: white;" | Description
+
        <th style="width:10%; text-align: center;">Response</th>
! style="width: 50px; background: black; color: white;" | Response
+
    </tr>
|-
+
<tr>
! style="text-align: left; vertical-align: top;" | ''[[FMB odoset|odoset]]:#''
+
        <td style="text-align: center;">''[[FMB odoset|odoset]]:#''</td>
| style="text-align: left; vertical-align: top;" | Set total odometer value.<br/># - new odometer value in m.
+
        <td style="text-align: left;">Set total odometer value<br/># - new odometer value in m</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">Yes</td>
|-
+
    </tr>
! style="text-align: left; vertical-align: top;" | ''[[FMB odoget|odoget]]''
+
<tr>
| style="text-align: left; vertical-align: top;" | Display current odometer value.
+
        <td style="text-align: center;">''[[FMB odoget|odoget]]''</td>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: left;">Display current odometer value</td>
|-
+
        <td style="text-align: center;">Yes</td>
! style="text-align: left; vertical-align: top;" | ''[[FMB odinfo|odinfo]]''
+
    </tr>
| style="text-align: left; vertical-align: top;" | Odometer Debug info.
+
<tr>
| style="text-align: left; vertical-align: top;" | Yes
+
        <td style="text-align: center;">''[[FMB odinfo|odinfo]]''</td>
|-
+
        <td style="text-align: left;">Odometer Debug info</td>
|}
+
        <td style="text-align: center;">Yes</td>
 +
    </tr>
 +
</table>
  
 
{{{sect_can|{{Template:FMB640 CAN SMS/GRPS commands}}}}}
 
{{{sect_can|{{Template:FMB640 CAN SMS/GRPS commands}}}}}

Revision as of 18:41, 1 September 2020

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
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
scanfms 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 or 1 (0 - OFF or 1 – ON) for DOUT1
2. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT2
3. # – 0 or 1 (0 - OFF or 1 – ON) for DOUT3
4. # – 0 or 1 (0 - OFF or 1 – ON) 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

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

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