Line 1: |
Line 1: |
| + | <span style="color: red;">The information in this page is shown in accordance with firmware versions {{{fw_version}}}.</span> |
| + | |
| ==Introduction== | | ==Introduction== |
| | | |
Line 117: |
Line 119: |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-b</span>, <span style="color:blue;">--brecv</span> <span style="color:purple;"><INTERFACE></span> | + | gsmctl <span style="color:blue;">-r</span>, <span style="color:blue;">--brecv</span> <span style="color:purple;"><INTERFACE></span> |
| | | |
| Where ''<INTERFACE>'' is the name of a network interface. | | Where ''<INTERFACE>'' is the name of a network interface. |
Line 249: |
Line 251: |
| ---- | | ---- |
| To obtain the modem's serial number, use '''''-a''''' or '''''--serial''''' options. | | To obtain the modem's serial number, use '''''-a''''' or '''''--serial''''' options. |
| + | |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 261: |
Line 264: |
| '''Possible responses''': | | '''Possible responses''': |
| | | |
− | *a 15 digit sequence of decimal numbers | + | *a 15 digit sequence. |
| | | |
| | | |
| ===Get device revision number=== | | ===Get device revision number=== |
| ---- | | ---- |
− | To obtain the modem's revision number (firmware version), use '''''-y''''' or '''''--revision''''' options. | + | To obtain the modem's revision number (firmware version), use '''''-y''''' or '''''--firmware''''' options. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 331: |
Line 334: |
| root@Teltonika:~# gsmctl <span style="color:blue;">-q</span> | | root@Teltonika:~# gsmctl <span style="color:blue;">-q</span> |
| <span style="color:red;">-55</span> | | <span style="color:red;">-55</span> |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument returns all signal related values. Example: |
| + | |
| + | root@Teltonika:~# gsmctl -q |
| + | RSSI: -69 |
| + | RSRP: -103 |
| + | SINR: 2 |
| + | RSRQ: -16 |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
Line 340: |
Line 351: |
| ---- | | ---- |
| To obtain the router's current WCDMA [[RSCP]] level, use '''''-X''''' or '''''--rscp''''' options. | | To obtain the router's current WCDMA [[RSCP]] level, use '''''-X''''' or '''''--rscp''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this value has been moved under <span style="color:blue;">-q</span> argument. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 359: |
Line 372: |
| ---- | | ---- |
| To obtain the router's current WCDMA [[EC/IO]] level, use '''''-E''''' or '''''--ecio''''' options. | | To obtain the router's current WCDMA [[EC/IO]] level, use '''''-E''''' or '''''--ecio''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this value has been moved under <span style="color:blue;">-q</span> argument. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 378: |
Line 393: |
| ---- | | ---- |
| To obtain the router's current LTE [[RSRP_and_RSRQ|RSRP]] level, use '''''-W''''' or '''''--rsrp''''' options. | | To obtain the router's current LTE [[RSRP_and_RSRQ|RSRP]] level, use '''''-W''''' or '''''--rsrp''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this value has been moved under <span style="color:blue;">-q</span> argument. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 397: |
Line 414: |
| ---- | | ---- |
| To obtain the router's current [[SINR]] level, use '''''-Z''''' or '''''--sinr''''' options. | | To obtain the router's current [[SINR]] level, use '''''-Z''''' or '''''--sinr''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this value has been moved under <span style="color:blue;">-q</span> argument. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 416: |
Line 435: |
| ---- | | ---- |
| To obtain the router's current [[RSRP and RSRQ|RSRQ]] level, use '''''-M''''' or '''''--rsrq''''' options. | | To obtain the router's current [[RSRP and RSRQ|RSRQ]] level, use '''''-M''''' or '''''--rsrq''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this value has been moved under <span style="color:blue;">-q</span> argument. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 553: |
Line 574: |
| ---- | | ---- |
| To obtain information related to the mobile network information, use '''''-F''''' or '''''--network''''' options. | | To obtain information related to the mobile network information, use '''''-F''''' or '''''--network''''' options. |
| + | |
| + | |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 571: |
Line 594: |
| **'''''<channel>''''' - channel ID | | **'''''<channel>''''' - channel ID |
| | | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> the values are returned in a different format. Example: |
| + | |
| + | root@Teltonika:~# gsmctl -F |
| + | LTE | LTE_B3 | 24602 |
| | | |
| ===Get serving cell information=== | | ===Get serving cell information=== |
| ---- | | ---- |
− | To obtain the , use '''''-K''''' or '''''--serving''''' options. | + | To obtain the serving cell information, use '''''-K''''' or '''''--serving''''' options. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 587: |
Line 614: |
| <span style="color:red;">+SGCELLINFOEX:LTE,FDD LTE,246,02,1037079,109,4051,23,146,3,100,1850,19850,-63,-99,-13,199,19,4,255,-,-,4,-,0,-,0,0,0</span> | | <span style="color:red;">+SGCELLINFOEX:LTE,FDD LTE,246,02,1037079,109,4051,23,146,3,100,1850,19850,-63,-99,-13,199,19,4,255,-,-,4,-,0,-,0,0,0</span> |
| | | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> the values are returned in a different format. Example: |
| | | |
| + | root@Teltonika:~# gsmctl -K |
| + | Access tech: LTE | TDD mode: FDD | MCC: 246 | MNC: 2 | UE state: 3 |
| | | |
| ===Get neighbour cell information=== | | ===Get neighbour cell information=== |
| ---- | | ---- |
− | To obtain the , use '''''-I''''' or '''''--neighbour''''' options. | + | To obtain the neighbor cell information, use '''''-I''''' or '''''--neighbour''''' options. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 601: |
Line 631: |
| root@Teltonika:~# gsmctl <span style="color:blue;">-I</span> | | root@Teltonika:~# gsmctl <span style="color:blue;">-I</span> |
| <span style="color:red;">+QENG: "neighbourcell intra","LTE",522,269,-9,-87,-58,0,-,-,-,-,-</span> | | <span style="color:red;">+QENG: "neighbourcell intra","LTE",522,269,-9,-87,-58,0,-,-,-,-,-</span> |
| + | |
| + | ===Get VoLTE state status=== |
| + | ---- |
| + | To obtain the VoLTE state, use '''''-v''''' or '''''--volte_state''''' options. |
| + | |
| + | <b>Note</b>: This argument is supported from FW version <i>R_00.07.03</i>. |
| + | |
| + | '''Usage syntax''': |
| + | |
| + | gsmctl <span style="color:blue;">-v</span>, <span style="color:blue;">--volte_state</span> |
| + | |
| + | '''Example''': obtaining the VoLTE state. |
| + | |
| + | root@Teltonika:~# gsmctl -v |
| + | Active |
| + | |
| + | '''Possible responses''': |
| + | |
| + | *Active |
| + | *Inactive |
| | | |
| + | |
| + | ===Get operator station time=== |
| + | ---- |
| + | To obtain the operator station, use '''''-H''''' or '''''--modemtime''''' options with time argument (1 - GMT, 2 - local). |
| + | |
| + | '''Usage syntax''': |
| + | |
| + | gsmctl <span style="color:blue;">-H</span>, <span style="color:blue;">--modemtime</span> <span style="color:purple;"><1/2></span> |
| + | |
| + | '''Example''': obtaining the operator time |
| + | |
| + | root@Teltonika:~# gsmctl -H 1 |
| + | 22/12/01,12:27:14 |
| + | |
| + | |
| + | ===Get modem info in json format=== |
| + | ---- |
| + | To obtain the full modem information in JSON format, use '''''-E''''' or '''''--info''''' options. |
| + | |
| + | <b>Note</b>: This argument is supported from FW version <i>R_00.07.03</i>. |
| + | |
| + | '''Usage syntax''': |
| + | |
| + | gsmctl <span style="color:blue;">-E</span>, <span style="color:blue;">--info</span> |
| + | |
| + | '''Example''': obtaining the modem information |
| + | |
| + | root@Teltonika:~# gsmctl -E |
| + | { |
| + | "name": "Quectel EG06-E", |
| + | "model": "EG06-E", |
| + | "manuf": "Quectel", |
| + | "driver": "Quectel EG06 AT", |
| + | "usb_id": "3-1", |
| + | ... |
| + | |
| + | |
| + | ===Reboot the modem=== |
| + | ---- |
| + | To reboot the modem, use '''''-Q''''' or '''''--reboot''''' options. After the command is executed, the modem will start rebooting. |
| + | |
| + | '''Usage syntax''': |
| + | |
| + | gsmctl <span style="color:blue;">-Q</span>, <span style="color:blue;">--reboot</span> |
| + | |
| + | '''Example''': rebooting the modem |
| + | |
| + | root@Teltonika:~# gsmctl <span style="color:blue;">-Q</span> |
| + | <span style="color:red;">Modem was reset</span> |
| + | |
| + | '''Possible responses''': |
| + | |
| + | *Modem was reset |
| | | |
| | | |
Line 607: |
Line 710: |
| ---- | | ---- |
| To shutdown the modem, use '''''-D''''' or '''''--shutdown''''' options. After the command is executed, the modem will stay shut off up to a '''maximum of 60 s.''' and will then start up again. | | To shutdown the modem, use '''''-D''''' or '''''--shutdown''''' options. After the command is executed, the modem will stay shut off up to a '''maximum of 60 s.''' and will then start up again. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument was removed. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 646: |
Line 751: |
| ---- | | ---- |
| To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options. | | To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options. |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument was removed. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
Line 780: |
Line 887: |
| '''Possible responses''': | | '''Possible responses''': |
| | | |
− | * | + | *If response in terminal "OK", SMS was sent successfully. |
| | | |
| | | |
Line 787: |
Line 894: |
| | | |
| First you need to create a /tmp/.smstext file and append some text you want to send | | First you need to create a /tmp/.smstext file and append some text you want to send |
| + | |
| + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument has been removed. |
| | | |
| To send a base64 SMS message, use '''''-S -b''''' or '''''--sms --send-b64''''' options | | To send a base64 SMS message, use '''''-S -b''''' or '''''--sms --send-b64''''' options |
Line 792: |
Line 901: |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-S -b</span>, <span style="color:purple;"><NUMBER></span> | + | gsmctl <span style="color:blue;">-S -b,</span><span style="color:blue;">--sms --send-b64</span> <span style="color:purple;"><NUMBER></span> |
| | | |
| '''Example''': | | '''Example''': |
| | | |
− | root@Teltonika:~# gsmctl <span style="color:blue;"> -S -b</span>, <span style="color:purple;">+37061234567</span> | + | root@Teltonika:~# gsmctl <span style="color:blue;">-S -b</span> <span style="color:purple;">+37061234567</span> |
| <span style="color:red;"></span> | | <span style="color:red;"></span> |
| | | |
Line 813: |
Line 922: |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-A, --at</span>, <span style="color:purple;">'AT+command'</span> | + | gsmctl <span style="color:blue;">-A, --at</span> <span style="color:purple;">'AT+command'</span> |
| | | |
| '''Example''': | | '''Example''': |
| | | |
− | root@Teltonika:~# gsmctl <span style="color:blue;">-A</span>, <span style="color:purple;">'AT+CLCK="SC",2'</span> | + | root@Teltonika:~# gsmctl <span style="color:blue;">-A</span> <span style="color:purple;">'AT+CLCK="SC",2'</span> |
| <span style="color:red;"></span> | | <span style="color:red;"></span> |
| | | |