The rules and requirements that must be followed when sending commands are described in this article.
The list of SMS commands for legacy S-23xx and S-25xx device models is available at this link.
¶ Contents
| Name | Communication channel |
Example | |
|---|---|---|---|
| Command | Response | ||
| Section "System Commands" | |||
| Request Device Model and Version | Any | *?V |
*#V:S-2651:01.00.72:13.05.20:RU |
| Request IMEI | Any | *?S |
*#S:866123456789123 |
| Request ICCID | Any | *?ICCID |
*#ICCID 897010123456789123 |
| USSD Request | Any | *?USSD *100# |
*#USSD 1200.20RUB. |
| Request GNSS Version | Any | *?VGPS |
*#VGPS S-2435,01.01.20,30.04.20,B05V01SIM868 |
| Reboot Device | Any | *!DEV_RESET |
*@DEV_RESET |
| Server Synchronization | Any | *!SYNC 1 |
see command description |
| Resend Data | Any | *!REP_FL 1,09.04.18/13:00:59,10.04.18/03:00:00 |
*@REP_FL OK |
| Resend Data from SD Card | Any | *!REP_SD 1,02.06.20,03.06.20 |
*@REP_SD OK |
| Adjust Time | Any | *!SETTIME +300 |
*@SETTIME OK |
| Adjust Counters | Any | *!SETP 4:234.7 |
*@SETP OK |
| Reset CAN Bus Accumulated Counters | Any | *!CAN DATARESET |
*@CAN OK,DATARESET |
| Section "Diagnostics" | |||
| Request Status | SMS | *?A |
Message M:111 |
| Request/Forward Status via SMS | SMS | *?ES |
Message M:114 |
| Internet USB BT |
*?ES +71112223344 |
see command description | |
| Request Location | SMS | *?POS |
see command description |
| Request LBS Data | SMS | *?LBS |
Message M:112 |
| Request Parameter Values | Any | *?DATA 21,22 |
*#DATA 21:0026,22:0010 |
| Forward Data to Interface | Any | *!UC RS485,3101066С |
*@UC RS485,3E01060AE803A00F69 |
| Forward Data via Bluetooth LE | Any | *!BLE CNCT,11:22:33:44:55:66*!BLE DATA,STR,"Hello!"0D |
see command description |
| Section "Remote Control" | |||
| Connect to Configurator (RCS) | Any | *!CNCT_RCS rcs.navtelecom.ru,8100,43644176 |
see command description |
| Firmware Update (RFU) | Any | *!CNCT_RFU 89.208.152.55,9100,LAST |
see command description |
| Connect to DRC Service | Any | *!CNCT_DRC |
*@CNCT_DRC OK |
| Control Outputs | Any | *!SETOUT 1Y,2N |
*@SETOUT OK,1Y,2N |
| Switch a Single Output On/Off | Internet USB BT |
*!1Y |
see command description |
| Buzzer Control | Any | *!BEEP 20,3,100,1000 |
*@BEEP OK |
| Disable Input | Internet USB BT |
*!OFF2 |
see command description |
| Enable Input | Internet USB BT |
*!ON2 |
see command description |
| Switch SIM Card | Any | *!CHNGSIM |
*@CHNGSIM 1->2 |
| Section "Identification" | |||
| Section "Security Mode" | |||
| Section "Driver Display" | |||
| Section "Auto Informer" | |||
| Section "Camera" | |||
| Section "Accelerometer" | |||
| Section "1-Wire Temperature" | |||
| Section "Passenger Counter" | |||
| Section "Complex Events" | |||
| Send Parameters to the Program | Any | *!CEVT 1,0x10,,-12,"654" |
*@CEVT |
¶ System Commands
¶ Request Device Model and Version
(back to contents)In response to the request, the device sends its model, firmware version and firmware release date.
¶ Request/Command
*?V
¶ Response
*#V:S-2651:01.00.72:13.05.20:RU
| Format | |
*#V:<n>:<v1>.<v2>.<v3>:<d>.<m>.<y>:<loc> |
|
| Parameter | Description |
<n> |
device model (6 characters) |
<v1>.<v2>.<v3> |
firmware version 2 characters per part |
<d>.<m>.<y> |
day, month and year of the software version respectively, 2 characters each |
<loc> |
firmware language version, 2 characters |
¶ Request IMEI
(back to contents)In response, the device sends the unique identifier (IMEI) number of the device
¶ Request/Command
*?S
¶ Response
*#S:866123456789123
| Format | |
*#S:<i> |
|
| Parameter | Description |
<i> |
IMEI (device identification number) |
¶ Request ICCID
(back to contents)In response, the device sends the ICCID number of the SIM card installed in the device
¶ Request/Command
*?ICCID
¶ Response
*#ICCID 897010123456789123
| Format | |
*#ICCID<s><id> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<id> |
ICCID (SIM card identification number) |
¶ USSD Request
(back to contents)The device forwards the USSD request received in the command to the mobile network operator and sends the response back to the user. This command can be used to check the SIM card balance.
¶ Request/Command
*?USSD *100#
| Format | |
*?USSD<s><code> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<code> |
USSD request code string |
¶ Response
*#USSD 1200.20RUB.
| Format | |
*#USSD<s><string> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<string> |
mobile network operator response string |
¶ Request GNSS Version
(back to contents)In response, the device sends the navigation receiver version number.
¶ Request/Command
*?VGPS
¶ Response
*#VGPS S-2435,01.01.20,30.04.20,B05V01SIM868
| Format | |
*#VGPS<s><n>,<v1>.<v2>.<v3>,<d>.<m>.<y>,<gps_ver> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<n> |
device model (6 characters) |
<v1>.<v2>.<v3> |
device software version indices, 2 characters each |
<d>.<m>.<y> |
day, month and year of this device software version, 2 characters each |
<gps_ver> |
navigation receiver model and version |
¶ Reboot Device
(back to contents)The command restarts the device software
¶ Request/Command
*!DEV_RESET
¶ Response
*@DEV_RESET
¶ Server Synchronization
(back to contents)(Clear black box data queue; Reset device memory)
This command stops sending old telemetry from the device black box to the server. The telemetry messages are not deleted from memory. If necessary they can be uploaded to the server using the command for resending telemetry from the black box (Resend Data).
¶ Request/Command
*!SYNC 1
| Format | |
*!SYNC<s><index> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<index> |
index of the server specified in the device settings (starting from 1) |
¶ SMS Response
| Format | |
| Message "M:111" (description) | |
| Event Codes (full list) | |
5393 |
Synchronization with server 1 |
5394 |
Synchronization with server 2 |
5395 |
Synchronization with server 3 |
¶ Internet, BT, USB Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
5393 |
Synchronization with server 1 |
5394 |
Synchronization with server 2 |
5395 |
Synchronization with server 3 |
¶ Resend Data
(back to contents)Upon receiving the command, the device starts sending telemetry from its internal memory for the period specified in the command.
¶ Request/Command
*!REP_FL 1,09.04.18/13:00:59,10.04.18/03:00:00
*!REP_FL 1,09.04.18,10.04.18
| Format | |
*!REP_FL<s><srvindex>,<leftdate>/<lefttime>,<rightdate>/<righttime> |
|
| Parameter | Description |
<s> |
parameter separator, space |
/ |
date and time field separator |
<srvindex> |
server index for resending in text format:0 – all servers;1..3 – server index. |
<leftdate> |
start date of the requested telemetry interval in text format (UTC): DD.MM.YY. |
<lefttime> |
(optional) Start time of the requested telemetry interval in text format (UTC): HH:MM:SS.An omitted parameter is treated as «00:00:00». |
<rightdate> |
end date of the requested telemetry interval in text format (UTC): DD.MM.YY. |
<righttime> |
(optional) End time of the requested telemetry interval in text format (UTC): HH:MM:SS.An omitted parameter is treated as «23:59:59». |
¶ Response
*@REP_FL OK
| Format | |
*@REP_FL<s><result> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<result> |
Command processing result (ASCII):OK - command executed;FAIL - command execution error. |
¶ Resend Data from SD Card
(back to contents)Upon receiving the command, the device starts sending telemetry from the SD memory card installed in the device for the period specified in the command. Data is uploaded one day at a time.
It is important to specify an end date one day later than the requested upload period. For example, to upload telemetry for 02.06.2020, specify 02.06.20 as the period start date (left boundary) and 03.06.20 as the period end date (right boundary) in the command.
¶ Request/Command
*!REP_SD 1,02.06.20,03.06.20
| Format | |
*!REP_SD<s><srvindex>,<leftdate>,<rightdate> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<srvindex> |
server index for resending in text format:0 – all servers;1..3 – server index. |
<leftdate> |
start date of the requested telemetry interval in text format (UTC): DD.MM.YY. |
<rightdate> |
end date of the requested telemetry interval in text format (UTC): DD.MM.YY. |
¶ Response
*@REP_SD OK
| Format | |
*@REP_SD<s><result> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<result> |
Command processing result (ASCII):OK - command executed;FAIL - command execution error. |
¶ Adjust Time
(back to contents)The command adjusts the device time by the specified number of seconds.
¶ Request/Command
*!SETTIME +300
| Format | |
*!SETTIME<s><offset> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<offset> |
signed offset in seconds in text format. For example: +60 or -30. |
¶ Response
*@SETTIME OK
| Format | |
*@SETTIME<s><ans> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ans> |
response:OK - time synchronized;FAIL - synchronization error. |
¶ Adjust Counters
(back to contents)The command changes the current value of the engine hour, mileage, counter input and similar counters.
¶ Request/Command
*!SETP 1:0
*!SETP 4:234.7
| Format | |
*!SETP<s><param>:<value> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<param> |
parameter to change:1 - engine hours;4 - mileage;5 - pulse counter 1;6 - pulse counter 2;7 - pulse counter 3;8 - pulse counter 4;9 - pulse counter 5;10 - pulse counter 6;13 - total fuel consumption (CAN);14 - total mileage (CAN);15 - total engine operating time (CAN). |
<value> |
Value to set, the range depends on the selected parameter: - If param=4 or param=14, enter a positive decimal number (the fractional part is separated by a PERIOD, for example: 0.0 or 999999.9).- In all other cases enter an integer from 0 to 4294967295. |
¶ Response
*@SETP OK
| Format | |
*@SETP<s><ans> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ans> |
response:OK - value set successfully;FAIL - error setting value. |
¶ Reset CAN Bus Accumulated Counters
(back to contents)The command resets to 0 the current values of accumulated counters received from the CAN Bus (engine hours, mileage, consumption, etc.)
¶ Request/Command
*!CAN DATARESET
¶ Response
*@CAN OK,DATARESET
| Format | |
*@CAN<s><ans>,DATARESET |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ans> |
response:OK - values reset successfully;FAIL - error resetting values. |
¶ Diagnostics
(back to contents)¶ Request Status
(back to contents)In response to the request, the device sends a message containing the current time, event, basic information about the device input and output states and navigation information
¶ Request/Command
*?A
¶ SMS Response
| Format | |
| Message "M:111" (description) | |
| Event Codes (full list) | |
40962 |
Request current asset status |
¶ Internet, BT, USB Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
40962 |
Request current asset status |
¶ Forward Status via SMS
(back to contents)(Determine the SIM card phone number)
In response to the request, the device sends a message containing the device model, firmware version, IMEI number, device time and date when the response was sent and a hyperlink to Google Maps showing the current asset location.
¶ SMS
If the request is sent via SMS, the response is sent via SMS to the number of the sender.
¶ Request/Command
*?ES
¶ Response
| Format | |
| Message "M:114" (description) |
¶ Internet, BT, USB
If the request is sent via Internet/USB/BT, the device confirms receipt of the command via Internet/USB/BT and then sends message "M:114" via SMS to the phone number specified in the command (this allows the SMS recipient to determine the device phone number).
¶ Request/Command
*?ES +71112223344
| Format | |
*?ES<sp><c> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<c> |
phone number in international format to which the SMS response must be sent. |
¶ Response
*#ES +71112223344
| Format | |
*#ES<sp><c> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<c> |
phone number in international format to which the SMS response must be sent. |
¶ Forwarded SMS Message
| Format | |
| Message "M:114" (description) |
¶ (SMS) Request Location
(back to contents)SMS request for the current location as a hyperlink to Google Maps
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
*?POS
¶ Response
19.46.00 (+3) 17/08/2019 GPS_TIMER http://maps.google.ru/maps?&hl=ru=+55.796593,+37.717445&ie=UTF8&output=html&zoom=0&p=OO
| Format | |
<hour>.<min>.<sec><s>(+<p>)<s><d>/<m>/<y><s><event><s><gmap> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<hour>.<min>.<sec> |
current device time |
(+<p>) |
device time zone |
<d>/<m>/<y> |
device day, month and year |
<event> |
alias of the latest device event (full list) |
<gmap> |
hyperlink to Google Maps with the latest valid device coordinates |
¶ (SMS) Request LBS Data
(back to contents)In response, the device sends information about the nearest mobile network base stations if it is registered on the network.
This command is not available via Internet, Bluetooth, USB channels.
This information can be used to estimate the device location through an LBS service.
¶ Request/Command
*?LBS
¶ Response
| Format | |
| Message "M:112" (description) |
¶ Request Parameter Values
(back to contents)The request returns the current value of one or more telemetry parameters.
The parameter number in the request is:
- The field number in the FLEX protocol description (see Appendix A.1)
- A special identifier from the list
¶ Request/Command
*?DATA 21,22
| Format | |
*?DATA<s><id1>,<id2>, ... ,<idN> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<idX> |
FLEX protocol field identifier represented as a decimal number (ASCII) |
¶ Response
*#DATA 21:0026,22:0010
| Format | |
*#DATA<s><id1>:<data1>,<id2>:<data2>,...,<idN>:<dataN> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<idX> |
FLEX protocol field identifier represented as a decimal number (ASCII) |
<dataX> |
parameter value is represented in one of two forms:
|
If the specified FLEX field contains multiple parameters, they are returned as a single data block. The lowest-order parameter is placed on the right and the highest-order parameter on the left.
For example, request field #77 (LBS Data):
*?DATA 77
Response:
*#DATA 77:62D649E3B6006300FA6C0300007ABDB7006300FA6C0300007ABECA006300FA6C0300007AC2
Breakdown:
Time=62D649E3
C3_Rx=B6; C3_MNC=0063; C3_MCC=00FA, C3_LAC=6C03; C3_CID=00007ABD
C2_Rx=B7; C2_MNC=0063; C2_MCC=00FA, C2_LAC=6C03; C2_CID=00007ABE
C1_Rx=CA; C1_MNC=0063; C1_MCC=00FA, C1_LAC=6C03; C1_CID=00007AC2
¶ Forward Data to Interface
(back to contents)The command sends arbitrary data to an external sensor through the RS-232 or RS-485 interface. Obtain the format and contents of the message for the sensor connected to the interface from the sensor manufacturer.
After sending data, the device «listens» to the interface for 500 ms and returns the response from the sensor.
If no response is received within 500 ms, the response field contains an empty string.
¶ Request/Command
*!UC RS485,3101066C
*!UC RS485,"AT"0D0A
| Format | |
*!UC<s><i>,<msg> |
|
| Parameter | Description |
<s> |
Parameter separator, space |
<i> |
Interface:RS485 - device RS-485 interface;RS232 - device RS-232 interface. |
<msg> |
Data packet to send in one of two forms: HEX - hexadecimal data in ASCII encoding Example: TEXT - a text string in quotation marks with optional non-printable characters. The device converts the text to hexadecimal data before sending.*!UC RS485,3101066CText must be enclosed in quotation marks, while non-printable characters must be represented without quotation marks as hexadecimal data in ASCII encoding. Example 1: *!UC RS485,"HELLO"Example 2: *!UC RS485,"AT+VERSION"0D0A |
¶ Response
*@UC RS485,3E01060AE803A00F69
*@UC RS485,"OK
"
*@UC RS485,
| Format | |
*@UC<s><i>,<ans> |
|
| Parameter | Description |
<s> |
Parameter separator, space |
<i> |
Interface:RS485 - device RS-485 interface;RS232 - device RS-232 interface. |
<ans> |
Received response in HEX or TEXT format. The response format matches the command format. (if no response was received – an empty string) |
¶ Forward Data via Bluetooth LE
(back to contents)
BLE Command Family detailed description¶ Remote Control
(back to contents)¶ Connect to Configurator (RCS)
(back to contents)Command for remotely connecting the device to the configurator through the RCS server.
A detailed description of the connection procedure is provided in the "Remote Connection" article.
¶ Request/Command
*!CNCT_RCS rcs.navtelecom.ru,8100,43644176
*!CNCT_RCS 89.208.152.55,8100,43644176,internet.mts.ru,mts,mts
| Format | |
*!CNCT_RCS<s><ip>,<port>,<commID>,<apn>,<login>,<password> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ip> |
DNS name or IP address of the RCS server |
<port> |
RCS server port |
<commID> |
session identifier for connecting to the configurator (unique for each connection) |
<apn> |
(optional) Mobile network operator access point name |
<login> |
(optional) Mobile network operator login |
<password> |
(optional) Mobile network operator password |
If the
<apn>,<login>,<password>parameters are omitted from the command, the device connects to the service using the operator parameters from its own settings, or determines them automatically from network registration data.
¶ SMS Response
The device responds only if an error occurs.
If the command is processed successfully, the device does not send an SMS response. A successful connection between the device and the configurator serves as confirmation.
| Format | |
<ip>:<port> not responding |
|
| Parameter | Description |
<ip> |
DNS name or IP address of the RCS server specified in the command |
<port> |
RCS server port specified in the command |
¶ Internet, BT, USB Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
41484 |
Command to connect to the server for communication with the configurator |
¶ Firmware Update (RFU)
(back to contents)When the command is received, the device connects to the Remote Firmware Update service (RFU) and downloads either the latest release firmware or the firmware version specified in the command. If the connection fails during the download, the device firmware is not updated. After several unsuccessful attempts to resume the firmware download, the device terminates the update procedure and continues operating with the previous version.
It is recommended to check the device firmware version with the
*?Vcommand no earlier than 30 minutes after sending the update command.
¶ Request/Command
*!CNCT_RFU 89.208.152.55,9100,LAST
*!CNCT_RFU 89.208.152.55,9100,02.01.02
*!CNCT_RFU 89.208.152.55,9100,LAST,internet.mts.ru,mts,mts
| Format | |
*!CNCT_RFU<s><ip>,<port>,<firmware>,<apn>,<login>,<password> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ip> |
DNS name or IP address of the RFU server |
<port> |
RFU server port |
<firmware> |
Requested firmware version, for example: 02.01.00.To request the latest version, use the LAST keyword. |
<apn> |
(optional) Mobile network operator access point name |
<login> |
(optional) Mobile network operator login |
<password> |
(optional) Mobile network operator password |
If the
<apn>,<login>,<password>parameters are omitted from the command, the device connects to the service using the operator parameters from its own settings, or determines them automatically from network registration data.
¶ SMS Responses
Possible responses are listed below:
- The firmware update command has been accepted and the device is attempting to connect to the specified server.
Start connect to <ip>: <port> |
|
| Parameter | Description |
<ip> |
DNS name or IP address of the RCS server specified in the command |
<port> |
RCS server port specified in the command |
- Confirmation that the firmware was downloaded successfully through the RFU service and will be installed.
Firmware OK |
- An error was detected while downloading the firmware.
Firmware <string> error <error code> |
|
| Parameter | Description |
<string> |
Firmware version string |
<error code> |
Detected error code or description |
- The specified server and port do not respond to connection requests.
<ip>:<port> not responding |
|
| Parameter | Description |
<ip> |
DNS name or IP address of the RCS server specified in the command |
<port> |
RCS server port specified in the command |
¶ Internet, BT, USB Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
41483 |
Command to connect to the server to change firmware (firmware download started) |
41480 |
Command to write the program followed by a reboot (firmware update) |
¶ Connect to DRC Service
(back to contents)Command for an on-demand device connection to the DRC service. The command can specify how long the device must remain connected to DRC.
¶ Request/Command
*!CNCT_DRC
*!CNCT_DRC 300
| Format | |
*!CNCT_DRC<s><time>,<ip>,<port>,<cmd> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<time> |
(optional) Time in seconds. If specified, the device connects to DRC and maintains the connection for the specified time. |
<ip> |
(optional) DRC server address |
<port> |
(optional) DRC server port |
<cmd> |
(optional) Command to send to the DRC service |
¶ Response
*@CNCT_DRC OK
| Format | |
*@CNCT_DRC<s><ans> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<ans> |
Response:OK - “Command accepted”;FAIL - “Error, the command will not be executed”. |
¶ Control Outputs
(back to contents)The device output control command switches one or more outputs on or off simultaneously.
¶ Request/Command
*!SETOUT 1Y,2N
*!SETOUT 1Y,2N,4Y
| Format | |
*!SETOUT<s><num><new_state>,<num><new_state>... |
|
| Parameter | Description |
<s> |
parameter separator, space |
<num> |
Number of the output whose state must be changed. Numbering starts from 1. |
<new_state> |
Output state to set:Y - switch on;N - switch off. |
The command can set the states of several outputs simultaneously. The states of outputs whose numbers are not specified in the command remain unchanged.
¶ Response
*@SETOUT OK,1Y,2N
| Format | |
*@SETOUT<s><result>,<num><cur_state>,<num><cur_state>... |
|
| Parameter | Description |
<s> |
parameter separator, space |
<result> |
Command processing result:OK - command executed;FAIL - command execution error. |
<num> |
Output number. Numbering starts from 1. |
<cur_state> |
Current output state:Y - switched on;N - switched off. |
¶ Switch a Single Output On/Off
(back to contents)The command switches on or off the single output specified in the command.
This command is not available via SMS channel.
¶ Request/Command
*!1Y
| Format | |
*!<num><new_state> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<num> |
Number of the output whose state must be changed. Numbering starts from 1. |
<new_state> |
Output state to set:Y - switch on;N - switch off. |
¶ Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
41232 |
Output O1 switched on |
41234 |
Output O1 switched off |
41248 |
Output O2 switched on |
41250 |
Output O2 switched off |
41264 |
Output O3 switched on |
41266 |
Output O3 switched off |
41280 |
Output O4 switched on |
41282 |
Output O4 switched off |
¶ Buzzer Control
(back to contents)Controls a buzzer without a built-in oscillator connected to output "O1". When the command is received, the buzzer generates sounds with the specified tone and duration.
The command can be executed only if:
- OutputO1is configured as "Buzzer".
- The "Buzzer with a built-in oscillator" checkbox is cleared!
¶ Request/Command
*!BEEP 20,3,100,1000
| Format | |
*!BEEP<s><count>,<group>,<interval>,<freq> |
|
| Parameter | Description |
<s> |
Parameter separator - space |
<count> |
Number of pulses in each pulse group. If the value is >=32 the indication is continuous. |
<group> |
Number of groups in the audible indication. |
<interval> |
Duration of each group in 1/128-second units (1 = 8ms). |
<freq> |
Frequency of each audible indication pulse (Hz). |
¶ Response
*@BEEP OK
| Format | |
*@BEEP<s><result> |
|
| Parameter | Description |
<s> |
parameter separator, space |
<result> |
Command processing result:OK - command executed;FAIL - command execution error. |
¶ Disable Input
(back to contents)(disable input)
The command disables an input so that no events are generated when it is triggered.
The command remains in effect until the input is enabled with the corresponding command or until the device is rebooted.
This command is not available via SMS channel.
¶ Request/Command
*!OFF 2
| Format | |
*!OFF<s><index> |
|
| Parameter | Description |
<s> |
Parameter separator, space |
<index> |
Index of the input to be disabled (1 to 9). |
¶ Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
45057 |
Input №1 disabled by command |
45058 |
Input №2 disabled by command |
45059 |
Input №3 disabled by command |
45060 |
Input №4 disabled by command |
45061 |
Input №5 disabled by command |
45062 |
Input №6 disabled by command |
45063 |
Input №7 disabled by command |
45064 |
Input №8 disabled by command |
45065 |
Sensor №9 disabled by command (accelerometer, SHx sensors) |
¶ Enable Input
(back to contents)The command enables an input that was previously disabled by command.
This command is not available via SMS channel.
¶ Request/Command
*!ON 2
| Format | |
*!ON<s><index> |
|
| Parameter | Description |
<s> |
Parameter separator, space |
<index> |
Index of the input to be enabled (1 to 9). |
¶ Response
| Format | |
Standard telemetry message *@C (described in the data exchange protocol) |
|
| Event Codes (full list) | |
45073 |
Input №1 enabled by command |
45074 |
Input №2 enabled by command |
45075 |
Input №3 enabled by command |
45076 |
Input №4 enabled by command |
45077 |
Input №5 enabled by command |
45078 |
Input №6 enabled by command |
45079 |
Input №7 enabled by command |
45080 |
Input №8 enabled by command |
45081 |
Sensor №9 enabled by command (accelerometer) |
¶ Switch SIM Card
(back to contents)(switch SIM card)
The command forces the active SIM card to change (switch) on devices with 2 SIM cards.
¶ Request/Command
*!CHNGSIM
¶ Response
*@CHNGSIM 1->2
| Format | |
*@CHNGSIM<s><x>-><y> |
|
| Parameter | Description |
<s> |
Parameter separator, space |
-> |
Separator characters |
<x> |
Currently active SIM card:1 – SIM 1 (External),2 – SIM 2 (Internal). |
<y> |
SIM card to switch to:1 – SIM 1 (External),2 – SIM 2 (Internal). |
¶ Identification
(back to contents)¶ Add Trusted Key
The command adds the key/card code with the specified number to the device list of trusted keys.
If the key list has not been created in advance in the device settings using the configurator, the command will not be executed.
¶ Request/Command
- Format:
*!SETTM<s><num>,<addr>,<mode> - Description:
<s>- parameter separator - space.
<num>- key/card number in the configuration from 1 to 510 (from 1 to 16 for 242x, 241x series devices).
<addr>- key/card code (12 characters).
<mode>- action performed when the code for this key(card) is read:
NOACT – no action;
GUARD – changes the security mode;
IMMOB – immobilizer. - Example:
*!SETTM 1,0002de031122,NOACT
¶ Response
- Format:
*@SETTM<s><res>,<code> - Description:
<s>- parameter separator - space
<res>- command execution result:
OK - command executed successfully;
FAIL - command not executed, error.
<code>- (optional parameter) additional error code:
1 - module busy;
2 - invalid TM key number;
3 - no parameters;
4 - invalid operating mode. - Example:
*@SETTM FAIL,2
¶ Request Key/Card Code
In response to a request from the monitoring system or via USB, the device sends the last key/card code received over the 1-Wire interface.
The last key/card code read is stored in the device until it is rebooted. This request does not indicate whether the key(card) is currently present.
This command is not available via SMS channel.
¶ Request/Command
- Example:
*?TM
¶ Response
- Format:
*#TM<key> - Description:
<key>- Key code in HEX without the family code and checksum.
The code contains zero values if the device has not read a key over 1-Wire since it was switched on.
¶ Request RFID Tag Code
In response to a request from the monitoring system or via USB, the device sends the last radio tag (RFID) code received over the RS-485 or RS-232 interface.
The last RFID tag code received is stored in the device until it is rebooted. This request does not indicate whether the key(card) is currently present.
This command is not available via SMS channel.
¶ Request/Command
- Example:
*?ERFT
¶ Response
- Format:
*#ERFT<ID><pwr> - Description:
<ID>- radio tag identifier in HEX. Contains zero values if the device has not received radio tag information over RS-485/232 since it was switched on.
<pwr>- Radio tag signal strength in dBm
¶ Security Mode
(back to contents)¶ Switch Modes
Universal command for switching between security/monitoring modes. Modes are switched if the security functions are enabled in the device settings.
¶ Request/Command
- Format:
*!M<s><x> - Description:
<s>- parameter separator - space
<x>- device operating mode to switch to:
G – security;
O – monitoring. - Example:
*!M G
¶ Response
- Format:
*@M<s><x>,<e>,<i> - Description:
<s>- parameter separator - space.
<x>- configured device operating mode:
G – security;
O – monitoring.
<e>- reason why the device did not switch to security mode:
1 – security mode is disabled in the device configuration;
2 – the mode switching lockout timeout has not expired;
3 – the do not switch to security mode while the ignition is on setting is enabled;
4 – the device is already in this mode;
5 – the do not switch to security mode if a security sensor has been triggered setting is enabled.
<i>- aliases of triggered sensors separated by -/:
INx – input lines (IN1, IN2...);
VOLT – power supply voltage sensor;
ENG – engine operation sensor. - Example:
*@M O,5,IN2/VOLT
¶ Request Current Mode
In response to the request, the device sends its current operating mode.
¶ Request/Command
- Example:
*?M
¶ Response
- Format:
*#M<s><x> - Description:
<s>- parameter separator - space
<x>- configured device operating mode:
G – security;
O – monitoring. - Example:
*#M G
¶ Driver Display
(back to contents)¶ Send Message
The command sends arbitrary text to the driver display.
¶ Request/Command
- Format:
*!DV0000<s><message> - Description:
<s>- parameter separator "space"
<message>- text message (up to 139 characters). - Example:
*!DV0000 Hello
¶ Response
- Format:
*@DV - Description:
<result>- command execution result:
"no value" - command executed successfully.
0 - operation with the display is not configured.
1 - message sending error. - Example:
*@DV
*@DV0
¶ Request/Command
- Format:
DV<s><message> - Description:
<s>- parameter separator "space"
<message>- text message (up to 139 characters). - Example:
DV Hello
¶ Response
- Format:
DV:<s><ans> - Description:
<ans>- command execution result:
OK – message accepted.
BUSY – message not accepted because the previous message has not been sent to the display.
NO DV – the device is not configured to work with the display.
INVALID MSG – message length = 0.
NOT CONNECTED - no connection to the display - Example:
DV: OK
¶ Auto Informer
(back to contents)¶ Change Route
The command changes the route specified in the settings. The route number in the command must match the number in the configuration.
The command remains in effect until the device is rebooted. After the reboot, the default route specified in the setting is selected.
¶ Request/Command
- Format:
*!AINF<s>ROUTE,<route> - Description:
<s>- parameter separator - space.
<route>- route number and letter as specified in the device configuration - Example:
*!AINF ROUTE,123A
¶ Response
- Format:
*@AINF<s>ROUTE,<result> - Description:
<s>- parameter separator - space
<result>- command execution result:
OK - command executed successfully.
BUSY - command cannot be executed because the previous command has not finished.
INVALIDROUTE - route is invalid.
NO ROUTE - route not found.
NO ZONES - failed to load the stop list. - Example:
*@AINF ROUTE,OK
¶ Play Audio File
The command plays the audio file with the identifier specified in the command through the line output.
Identifiers are assigned to each audio file when ".wav" files are uploaded to the SD card through the configurator in the audio file list editing window.
¶ Request/Command
- Format:
*!AINF<s>PLAY,<sound_id> - Description:
<s>- parameter separator - space.
<sound_id>– audio file identifier (1 to 65535).
When
sound_id=0, playback of the current audio file stops.
- Example:
*!AINF PLAY,12
¶ Response
- Format:
*@AINF<s>PLAY,<result> - Description:
<s>- parameter separator - space.
<result>- command execution result:
OK — command executed successfully.
BUSY - command cannot be executed because the previous command has not finished.
INVALID SOUND — failed to play the audio file.
NO SOUND - audio file not found. - Example:
*@AINF PLAY,OK
¶ Change Auto Informer Mode
The command changes the Auto Informer operating mode:
"Automatic mode" - the Auto Informer changes the current stop and plays audio recordings based on the device location;
"Manual mode" - the driver changes the current stop manually.
¶ Request/Command
- Format:
*!AINF<s>MODE,<mode> - Description:
<s>- parameter separator - space
<mode>- «Auto Informer» function operating mode:
0 – automatic mode;
1 – manual mode. - Example:
*!AINF MODE,0
¶ Response
- Format:
@AINF<s>MODE,<result> - Description:
<s>- parameter separator - space
<result>- command execution result:
OK - command executed successfully.
BUSY - command cannot be executed because the previous command has not finished.
INVALID ROUTE - route is invalid. - Example:
@AINF MODE,OK
¶ Select Current Stop
The command starts audio file playback and/or changes the information on the display for the stop whose number is specified in the command for the current route.
Stop identifiers are assigned automatically in the configurator according to their order within the route.
¶ Request/Command
- Format:
*!AINF<s>STOP,<stop> - Description:
<s>- parameter separator - space
<stop>- stop identifier (1 to 65534).
When
stop=0, the device records departure from the current stop.
- Example:
*!AINF STOP,15
¶ Response
- Format:
*@AINF<s>STOP,<result> - Description:
<s>- parameter separator - space
<result>- command execution result:
OK - command executed successfully.
BUSY - command cannot be executed because the previous command has not finished.
INVALID ROUTE - route is invalid.
INVALID MODE - manual mode is not enabled.
NOSTOP – stop not found. - Example:
*!@AINF STOP,NOSTOP
¶ Camera
(back to contents)¶ Take Photo
The command takes one or more photos using the connected camera.
¶ Request/Command
- Format:
*!DCAM<s>SS[<s><n><s><m>] - Description:
<s>- parameter separator - space
<n>- (optional) Number of photos. If omitted, the value is assumed to be1.
<m>- (optional) Interval between photos in seconds. If omitted, the value is assumed to be1. - Example:
*!DCAM SS
*!DCAM SS 3 5
¶ Response
- Format:
*@DCAM<s>SS:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
OK - Command executed successfully
BUSY - Command cannot be executed at this time
NO CAMERA - Device is not configured to work with the camera
NOT CONNECTED - No connection to the camera
TURNED OFF - Automatic shooting is disabled
DISK ERROR - SD card operation error
SS ERROR - Error receiving an image from the camera - Example:
*@DCAM SS: OK
¶ Accelerometer
(back to contents)¶ (SMS) Calibration Status
In response to the request, the device sends the calibration status of the built-in accelerometer
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
- Example:
CALIB ACL ?
¶ Response
- Format:
CALIB<s>ACL:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
"Accelerometer calibration is not supported";
"Accelerometer is not calibrated";
"Offset-calibrated";
"Axis-calibrated". - Example:
CALIB<s>ACL: Axis-calibrated
¶ (SMS) Start GNSS Calibration
When the SMS command is received, the device starts accelerometer calibration, which is performed automatically while the vehicle is moving. In response messages, the device reports successful completion of calibration stages or errors that prevented accelerometer calibration.
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
- Example:
CALIB ACL G
¶ Response
- Format:
CALIB<s>ACL:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
"Accelerometer calibration is not supported";
"Static GNSS calibration started";
"Dynamic GNSS calibration started";
"Calibration completed";
"Error: failed to measure gravity";
"Error: vehicle was moving (vibrating heavily)". - Example:
CALIB ACL: Calibration completed.
¶ (SMS) Start Standalone Calibration
When the SMS command is received, the device starts accelerometer calibration during which the vehicle must perform a series of accelerations and braking maneuvers.
Legacy calibration algorithm. GNSS calibration is recommended.
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
- Example:
CALIB ACL S
¶ Response
- Format:
CALIB<s>ACL:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
"Accelerometer calibration is not supported";
"Static calibration started";
"Dynamic calibration started";
"Calibration completed";
"Error: failed to measure gravity";
"Error: vehicle was moving (vibrating heavily)";
"Error: vehicle did not start moving";
"Error: acceleration/braking was not sharp enough". - Example:
CALIB ACL: Calibration completed.
¶ (SMS) Cancel Calibration
When the SMS command is received, the device stops the calibration process if it was started earlier but has not yet been completed by the device.
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
- Example:
CALIB ACL R
¶ Response
- Format:
CALIB<s>ACL:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
"Accelerometer calibration is not supported";
"Calibration canceled". - Example:
CALIB ACL: Calibration canceled
¶ (SMS) Reset Calibration
When the SMS command is received, the device deletes the accelerometer calibration data from device memory.
This command is not available via Internet, Bluetooth, USB channels.
¶ Request/Command
- Example:
CALIB ACL E
¶ Response
- Format:
CALIB<s>ACL:<s><ans> - Description:
<s>- parameter separator - space
<ans>- command execution result:
"Calibration reset" - Example:
CALIB ACL: Calibration reset
¶ Calibration Command
Universal accelerometer calibration command sent from the monitoring server or through the configurator command window.
This command is not available via SMS channel.
¶ Request/Command
- Format:
*!ACL_C:G<param> - Description:
<param>- parameter that defines command operation:
0 – start accelerometer calibration;
2 – cancel calibration started earlier;
3 – start accelerometer calibration using GNSS data;
4 – erase the current calibration - Example:
*!ACL_C:G3
¶ Response
- Format:
*@ACL_C:G<result> - Description:
<result>- Command execution result.
0 – unknown command;
1 – command executed successfully;
2 – error: vehicle was moving or vibrating heavily;
3 – dynamic calibration started;
4 – error: vehicle did not start moving;
5 – calibration completed;
6 – error: insufficient number and/or intensity of acceleration/braking maneuvers;
7 – dynamic check started;
8 – calibration must be repeated;
9 – calibration completed correctly;
: – error: failed to measure gravity;
; – GNSS calibration started. - Example:
*@ACL_C:G5
¶ Calibration Status
Request the accelerometer calibration status from the monitoring server or through the configurator command window.
This command is not available via SMS channel.
¶ Request/Command
- Example:
*!ACL_C:С
¶ Response
- Format:
*@ACL_C:С<result> - Description:
<result>- Command execution result.
1 – accelerometer is not calibrated;
2 – accelerometer is not calibrated, GNSS calibration is in progress;
0xAA .. .. .. – accelerometer is offset-calibrated, internal calibration values in HEX;
0xBB .. .. .. – accelerometer is axis-calibrated, internal calibration values in HEX; - Example:
*@ACL_C:С2
¶ Reset Calibration
Command for deleting accelerometer calibration data from device memory, sent from the monitoring server or through the configurator command window.
This command is not available via SMS channel.
¶ Request/Command
- Example:
*!ACL_C:S0
¶ Response
- Format:
*@ACL_C:S<result> - Description:
<result>- Command execution result.
1 – command executed successfully. - Example:
*@ACL_C:S1
¶ 1-Wire Temperature
(back to contents)¶ Request Sensor Codes
The request returns information about temperature sensors connected via the 1-Wire interface. Depending on the request parameter, it returns either the codes of all sensors on the line or only those not included in the device settings.
¶ Request/Command
- Format:
*?TM<s><rt> - Description:
<s>- parameter separator – space
<rt>- request type:
TSV – request all visible temperature sensors;
TSU – request all visible unconfigured temperature sensors. - Example:
*?TM TSV
*?TM TSU
¶ Response
- Format:
*#TM<s><rt>,<num>:<tkey>,<num>:<tkey>,… - Description:
<s>- parameter separator – space;
<rt>- request type:
TSV – all visible temperature sensors;
TSU – all visible unconfigured temperature sensors;
<num>- sensor slot sequence number in text format (for example “1”). A total of 8 slots are available for temperature sensor codes;
<tkey>- sensor code as a HEX string. - Example:
*#TM TSV,1:00000B4BB3E2,2:00000B4BF688,3:000000000000,4:000000000000, ...
*#TM TSU,1:000000000000,2:00000B4BF688,3:000000000000,4:000000000000, ...
¶ Save Sensor Codes
Upon receiving the command, the device saves the sensor codes previously obtained with the *?TM TSU command to memory.
The device reboots after the codes are saved.
¶ Request/Command
- Example:
*!TM SAVE
¶ Response
- Format:
*@TM<s>SAVE,<num>:<tkey>,<num>:<tkey>, … - Description:
<s>- parameter separator – space;
<num>- sensor slot sequence number in text format (for example “1”). A total of 8 slots are available for temperature sensor codes;
<tkey>- sensor code as a HEX string. - Example:
*@TM SAVE,1:00000B4BB3E2,2:00000B4BF688,3:000000000000,4:000000000000, ...
¶ Passenger Counter
(back to contents)¶ Reboot
Command for forcing the «Avtokonduktor» passenger counter to reboot through the device output line.
The output line must be configured as "Avtokonduktor" and connected to the dedicated controller input.
¶ Request/Command
- Example:
*!ACOND RESET
¶ Response
- Format:
*@ACOND<s><ans> - Description:
<s>- parameter separator – space;
<ans>- Command response:
OK – command accepted;
NOINIT - device is not configured to work with the counter;
FAIL - unknown command. - Example:
*@ACOND OK
¶ Complex Events
(back to contents)¶ Send Parameters to the Program
(back to contents)The command sends arbitrary parameter values to the Complex Events program
¶ Request/Command
*!CEVT 1,0x10,,-12,"654"
| Format | |
*!CEVT<s><param1>[,<param2>,<param3>,<param4>,<param5>] |
|
| Parameter | Description |
<s> |
Parameter separator - space |
<param1> |
Value set at the param1 output of the CMD function.Any value is converted to an INT32 number. An empty value (an omitted parameter) is treated as 0. Three notation formats are available for sending values to the program: Decimal: 123, -123Hexadecimal: 0x123Text: "hi!" |
<param2> |
see <param1> |
<param3> |
see <param1> |
<param4> |
see <param1> |
<param5> |
see <param1> |
¶ Response
*@CEVT