Szablon: Textcommands: Różnice pomiędzy wersjami
Linia 17: | Linia 17: | ||
|colspan="2"|<center>Available since firmware version: 3.0.0</center> | |colspan="2"|<center>Available since firmware version: 3.0.0</center> | ||
|- | |- | ||
|<b>RB900SG GET FW VERSION<CR><LF></b> | | <b>RB900SG GET FW VERSION<CR><LF></b> | ||
|Downloads the firmware version number of the microcontroller | | Downloads the firmware version number of the microcontroller | ||
|- | |- | ||
|Response | | Response | ||
|x.x.x<CR><LF> | | x.x.x<CR><LF> | ||
where x – version number | where x – version number | ||
|- | |- | ||
Linia 127: | Linia 127: | ||
| Response example | | Response example | ||
| 30.5 *C<CR><LF> | | 30.5 *C<CR><LF> | ||
|} | |||
==Allowlist commands== | |||
{| class="wikitable" | |||
!colspan="2"|PHONE ALLOWLIST Commands | |||
|- | |||
|colspan="2"|<center>Available since firmware version: 3.0.0</center> | |||
|- | |||
| <b>PHONE ALLOWLIST ENABLE<CR><LF><CR><LF></b> | |||
| Turns allowlist on | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| PHONE ALLOWLIST DISABLE<CR><LF> | |||
| Turns allowlist off | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| PHONE ALLOWLIST STATUS<CR><LF> | |||
| Returns information whether allowlist is on or off | |||
|- | |||
| Response | |||
| xxxxxxx<CR><LF> | |||
|- | |||
| Response example | |||
| DISABLE<CR><LF> | |||
|- | |||
| PHONE ALLOWLIST LIST<CR><LF> | |||
| Returns a list of numbers added to an allowlist | |||
|- | |||
| Response | |||
| Phone allow list is empty | |||
or | |||
xxxxxxxxx +xxxxxxxxxxxx xxxxxxxxxxxxxx<CR><LF> | |||
|- | |||
| Response example | |||
| Phone allow list is empty | |||
or | |||
123456789 +0012123456789<CR><LF> | |||
|- | |||
| PHONE ALLOWLIST ADD <phone_number><CR><LF> | |||
| Adds a <phone_number> to the allowlist | |||
Where: | |||
<phone_number> - phone numer in national or international format | |||
NOTE: it is recomended to add the numer in national and international format separately (without and with the area code) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| PHONE ALLOWLIST REMOVE <phone_number><CR><LF> | |||
| Removes the given <phone_number> from the allowlist | |||
Where: | |||
<phone_number> - phone numer in national or international format | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| PHONE ALLOWLIST CLEAR<CR><LF> | |||
| Removes all phone numbers from allowlist | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|} | |||
==Config commands== | |||
{| class="wikitable" | |||
!colspan="2"|CONFIG Commands | |||
|- | |||
|colspan="2"|<center>Available since firmware version: 3.0.0</center> | |||
|- | |||
| CONFIG SET APN <apn> <username> <password><CR><LF> | |||
| Sets <apn> | |||
Where: | |||
<apn> - string with Access Point Name | |||
<username> - apn username (optional) | |||
<password> - apn password (optional) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET APN<CR><LF> | |||
| Returns apn and username (optional) and password (optional) | |||
|- | |||
| Response | |||
| Xxxxxxxxx xxxxxxxx xxxxxxxx<CR><LF> | |||
|- | |||
| Response examples | |||
| internet <CR><LF> | |||
or | |||
internet username password<CR><LF> | |||
Where: | |||
internet is <apn> | |||
username is <username> | |||
password is <password> | |||
|- | |||
| CONFIG SET TCP PORTS <data_port> <config_port><CR><LF> | |||
| Sets TCP ports (data and config) | |||
Where: | |||
<data_port> - TCP data port (range from 0 to 65535) | |||
<config_port> - TCP port for remote configuration (range from 0 to 65535) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET TCP PORTS<CR><LF> | |||
| Returns TCP <data_port> and <config_port> ports | |||
|- | |||
| Response | |||
| xxx xxx<CR><LF> | |||
|- | |||
| Response example | |||
| 703 704<CR><LF> | |||
Where: | |||
703 is <data_port> and 704 is <config_port> | |||
|- | |||
| CONFIG SET SIM PIN <pin><CR><LF> | |||
| Sets the PIN code of the SIM card | |||
Where: | |||
<pin> - PIN code of the SIM card (range from 0000 to 9999) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET SIM PIN<CR><LF> | |||
| Returns the PIN code of the SIM card | |||
|- | |||
| Response | |||
| xxxx<CR><LF> | |||
|- | |||
| Response example | |||
| 1111<CR><LF> | |||
|- | |||
| CONFIG SET ANTENNA <type><CR><LF> | |||
| Sets the antenna to external or internal <type> | |||
Where: | |||
<type> - type of antenna, options: | |||
EXTERNAL | |||
INTERNAL | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET ANTENNA<CR><LF> | |||
| Returns the antenna type | |||
|- | |||
| Response | |||
| xxxxxxxxx<CR><LF> | |||
|- | |||
| Response example | |||
| EXTERNAL<CR><LF> | |||
|- | |||
| CONFIG SET PERIODIC REBOOT <time> <start_time><CR><LF> | |||
| Sets the periodic restart time | |||
Where: | |||
<time> - restart time in hours (from 0 to 8760). When it is set to 0, the device will not perform periodic reboot | |||
<start_time> - Unix time* - optional. If it is ommited, <start_time> equals device startup time | |||
* - there will be added also the HH:MM format option (under development) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET PERIODIC REBOOT<CR><LF> | |||
| Returns periodic restart time and start time in hours | |||
|- | |||
| Response | |||
| x xxxxxxxxxx<CR><LF>* | |||
* - there will be added also x xx:xx format option (under development) | |||
|- | |||
| Response example | |||
| 1 1619515560<CR><LF>* | |||
Where: | |||
1 is <time> | |||
1619515560 is <start_time> | |||
* - there will be added also 1 10:30 format option (under development) | |||
|- | |||
| CONFIG SET UART <configuration><CR><LF> | |||
| Configures UART | |||
Where: | |||
<configuration> - configuration string in the format xxxx abc where xxxx = baudrate, a = start bits, b = parity, c = stop bits | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET UART<CR><LF> | |||
| Returns UART configuration | |||
|- | |||
| Response | |||
| xxxx xxx<CR><LF> | |||
|- | |||
| Response example | |||
| 9600 8N1<CR><LF> | |||
Where: | |||
9600 is baudrate | |||
8 is start bits | |||
N is parity | |||
1 is stop bits | |||
|- | |||
| CONFIG SET TEXT INFO 1 <data><CR><LF> | |||
| Sets text information | |||
Where: | |||
<data> - string with additional comment (up to 128 characters) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET TEXT INFO 1<CR><LF> | |||
| Returns text information | |||
|- | |||
| Response | |||
| Xxxxxx<CR><LF> | |||
|- | |||
| Response example | |||
| Test comment<CR><LF> | |||
|- | |||
| CONFIG SET RTC SOURCE <source><CR><LF> | |||
| Sets the internal clock sync source | |||
Where: | |||
<source> - clock source, options: | |||
<b>GSM</b> | |||
(time from GSM network) | |||
<b>NTP ntp_addr ntp_port</b> | |||
(time from NTP server, ntp_addr – string with NTP server address, ntp_port – NTP port (range from 0 to 65535), optional, usually 123) | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| As above | |||
|- | |||
| CONFIG GET RTC SOURCE<CR><LF> | |||
| Returns the internal clock synchronization source | |||
|- | |||
| Response | |||
| xxx<CR><LF> | |||
|- | |||
| Response examples | |||
| GSM<CR><LF> | |||
or | |||
NTP ntp.elproma.com.pl 123<CR><LF> | |||
|- | |||
| CONFIG SET NETWORK SEARCH MODE <mode><CR><LF> | |||
| Sets the network search mode | |||
Where: | |||
<mode> - AUTO or 2G or 3G or 4G sets the search mode to auto, 2G (GSM) only, 3G (WCDMA) only or 4G (LTE) only | |||
|- | |||
| Response | |||
| OK<CR><LF> | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| Response | |||
| | |||
|- | |||
| Response example | |||
| | |||
|- | |||
|colspan="2"|<center>Available since firmware version: 3.0.3</center> | |||
|- | |||
| | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| | |||
| | |||
|- | |||
| | |||
| | |||
|} | |} |
Wersja z 15:23, 23 maj 2023
This page contains the list of text commands supported by {{{model}}} {{{type}}} and its description.
All below commands are available from 3.0.x modem firmware version. They can be send over USB, SMS or Teleorigin Manager.
Special characters: <EXT> - End of Text 0x03 character <CR> - Carriege Return 0x0D character <LF> - Line Feed 0x0A character
NOTE: <CR><LF> characters can be omitted when the command is sent via SMS and Teleorigin Manager („Console” tab).
Device commands
RB900SG Commands | |
---|---|
RB900SG GET FW VERSION<CR><LF> | Downloads the firmware version number of the microcontroller |
Response | x.x.x<CR><LF>
where x – version number |
Response example | 3.0.0<CR><LF> |
RB900SG GET IP<CR><LF> | Retrieves the IP address of the device |
Response | x.x.x.x<CR><LF> |
Response example | 10.43.210.2<CR><LF> |
RB900SG GET RTCTIME<CR><LF> | Gets device time in Unix time or unless the clock is out of sync then rtc time is equal uptime |
Response | xxxx<CR><LF> |
Response example | 868<CR><LF> |
RB900SG GET UPTIME<CR><LF> | Gets the number of seconds since the device startup |
Response | xxxx<CR><LF> |
Response example | 868<CR><LF> |
RB900SG RESET<CR><LF> | Resets the device |
Response | - |
Response example | - |
RB900SG TIME<CR><LF> | Returns the current time in human-readable version |
Response | Time: xxxxxxxxxx, mm-dd-yyyy hh:mm:ss<CR><LF> |
Response example | Time: 1619618224, 11-30-2021 13:57:04 <LF><CR><LF> |
RB900SG LOG PRINT<CR><LF> | Sends all entries from the event log |
Response | ------------------------------------------------------
Sep 12:30:05 - x.x.x<CR><LF> Sep 12:30:08 - SIM ready<CR><LF> Sep 12:30:09 - Cfg port opened<CR><LF> Sep 12:30:11 - PDP activated<CR><LF> |
Response example | ------------------------------------------------------
Sep 12:30:05 - x.x.x<CR><LF> Sep 12:30:08 - SIM ready<CR><LF> Sep 12:30:09 - Cfg port opened<CR><LF> Sep 12:30:11 - PDP activated<CR><LF> Sep 12:30:12 - IP: 46.77.88.87 Sep 12:30:14 - Sync to NTP |
RB900SG LOG FORMAT<CR><LF> | Removes all entries from the event log |
Response | OK<CR><LF> |
Response example | As above |
RB900SG GET HW VERSION<CR><LF> | Downloads the hardware version number of the device |
Response | x.x.x<CR><LF>
where x – version number |
Response example | 2.3.1<CR><LF> |
RB900SG BATTERY VOLTAGE<CR><LF> | Downloads battery voltage in volts |
Response | X.XX<CR><LF> |
Response example | 4.08<CR><LF> |
RB900SG GET TEMPERATURE<CR><LF> | Downloads temperature of the device |
Response | XX.X *C<CR><LF> |
Response example | 30.5 *C<CR><LF> |
Allowlist commands
PHONE ALLOWLIST Commands | |
---|---|
PHONE ALLOWLIST ENABLE<CR><LF><CR><LF> | Turns allowlist on |
Response | OK<CR><LF> |
Response example | As above |
PHONE ALLOWLIST DISABLE<CR><LF> | Turns allowlist off |
Response | OK<CR><LF> |
Response example | As above |
PHONE ALLOWLIST STATUS<CR><LF> | Returns information whether allowlist is on or off |
Response | xxxxxxx<CR><LF> |
Response example | DISABLE<CR><LF> |
PHONE ALLOWLIST LIST<CR><LF> | Returns a list of numbers added to an allowlist |
Response | Phone allow list is empty
or xxxxxxxxx +xxxxxxxxxxxx xxxxxxxxxxxxxx<CR><LF> |
Response example | Phone allow list is empty
or 123456789 +0012123456789<CR><LF> |
PHONE ALLOWLIST ADD <phone_number><CR><LF> | Adds a <phone_number> to the allowlist
Where: <phone_number> - phone numer in national or international format NOTE: it is recomended to add the numer in national and international format separately (without and with the area code) |
Response | OK<CR><LF> |
Response example | As above |
PHONE ALLOWLIST REMOVE <phone_number><CR><LF> | Removes the given <phone_number> from the allowlist
Where: <phone_number> - phone numer in national or international format |
Response | OK<CR><LF> |
Response example | As above |
PHONE ALLOWLIST CLEAR<CR><LF> | Removes all phone numbers from allowlist |
Response | OK<CR><LF> |
Response example | As above |
Config commands
CONFIG Commands | |
---|---|
CONFIG SET APN <apn> <username> <password><CR><LF> | Sets <apn>
Where: <apn> - string with Access Point Name <username> - apn username (optional) <password> - apn password (optional) |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET APN<CR><LF> | Returns apn and username (optional) and password (optional) |
Response | Xxxxxxxxx xxxxxxxx xxxxxxxx<CR><LF> |
Response examples | internet <CR><LF>
or internet username password<CR><LF> Where: internet is <apn> username is <username> password is <password> |
CONFIG SET TCP PORTS <data_port> <config_port><CR><LF> | Sets TCP ports (data and config)
Where: <data_port> - TCP data port (range from 0 to 65535) <config_port> - TCP port for remote configuration (range from 0 to 65535) |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET TCP PORTS<CR><LF> | Returns TCP <data_port> and <config_port> ports |
Response | xxx xxx<CR><LF> |
Response example | 703 704<CR><LF>
Where: 703 is <data_port> and 704 is <config_port> |
CONFIG SET SIM PIN <pin><CR><LF> | Sets the PIN code of the SIM card
Where: <pin> - PIN code of the SIM card (range from 0000 to 9999) |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET SIM PIN<CR><LF> | Returns the PIN code of the SIM card |
Response | xxxx<CR><LF> |
Response example | 1111<CR><LF> |
CONFIG SET ANTENNA <type><CR><LF> | Sets the antenna to external or internal <type>
Where: <type> - type of antenna, options: EXTERNAL INTERNAL |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET ANTENNA<CR><LF> | Returns the antenna type |
Response | xxxxxxxxx<CR><LF> |
Response example | EXTERNAL<CR><LF> |
CONFIG SET PERIODIC REBOOT | Sets the periodic restart time
Where:
|
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET PERIODIC REBOOT<CR><LF> | Returns periodic restart time and start time in hours |
Response | x xxxxxxxxxx<CR><LF>*
|
Response example | 1 1619515560<CR><LF>*
Where: 1 is
|
CONFIG SET UART <configuration><CR><LF> | Configures UART
Where: <configuration> - configuration string in the format xxxx abc where xxxx = baudrate, a = start bits, b = parity, c = stop bits |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET UART<CR><LF> | Returns UART configuration |
Response | xxxx xxx<CR><LF> |
Response example | 9600 8N1<CR><LF>
Where: 9600 is baudrate 8 is start bits N is parity 1 is stop bits |
CONFIG SET TEXT INFO 1 <CR><LF> | Sets text information
Where: - string with additional comment (up to 128 characters) |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET TEXT INFO 1<CR><LF> | Returns text information |
Response | Xxxxxx<CR><LF> |
Response example | Test comment<CR><LF> |
CONFIG SET RTC SOURCE <source><CR><LF> | Sets the internal clock sync source
Where: <source> - clock source, options: GSM (time from GSM network) NTP ntp_addr ntp_port (time from NTP server, ntp_addr – string with NTP server address, ntp_port – NTP port (range from 0 to 65535), optional, usually 123) |
Response | OK<CR><LF> |
Response example | As above |
CONFIG GET RTC SOURCE<CR><LF> | Returns the internal clock synchronization source |
Response | xxx<CR><LF> |
Response examples | GSM<CR><LF>
or NTP ntp.elproma.com.pl 123<CR><LF> |
CONFIG SET NETWORK SEARCH MODE <mode><CR><LF> | Sets the network search mode
Where: <mode> - AUTO or 2G or 3G or 4G sets the search mode to auto, 2G (GSM) only, 3G (WCDMA) only or 4G (LTE) only |
Response | OK<CR><LF> |
Response example | |
Response | |
Response example | |
Response | |
Response example | |
Response | |
Response example | |
Response | |
Response example | |
Response | |
Response example | |
Response | |
Response example | |
Response | |
Response example | |