Line 18: |
Line 18: |
| ''gsmctl'' commands are used in tandem with various options that specify what type of action should be executed. | | ''gsmctl'' commands are used in tandem with various options that specify what type of action should be executed. |
| ---- | | ---- |
− |
| |
| '''Example structure''' | | '''Example structure''' |
| | | |
Line 51: |
Line 50: |
| | | |
| This section overviews basic ''gsmctl'' options, usually related to obtaining certain modem related information. | | This section overviews basic ''gsmctl'' options, usually related to obtaining certain modem related information. |
| + | |
| + | ===Get IP address of logical interface=== |
| + | ---- |
| + | To obtain the IP address of a network interface, use '''''-p''''' or '''''--ip''''' options. |
| + | |
| + | '''Usage syntax''': |
| + | |
| + | gsmctl <span style="color:blue;">-p</span>, <span style="color:blue;">--ip</span> <span style="color:purple;"><INTERFACE></span> |
| + | |
| + | Where ''<INTERFACE>'' is the name of a network interface. |
| + | |
| + | '''Example''': obtaining the IP address of the mobile connection interface: |
| + | |
| + | root@Teltonika:~# gsmctl <span style="color:blue;">-p</span> <span style="color:purple;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span> |
| + | <span style="color:red;">10.139.75.221</span> |
| + | |
| + | |
| + | Where '''''mob1s1a1''''' is the name of the mobile interface when the connection type is set to QMI (default). You can get names of existing interfaces from '''''/etc/config/network''''' file. |
| + | |
| + | '''Example''': |
| + | root@Teltonika:~# cat /etc/config/network |
| + | config interface '<span style="color:purple;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span>' |
| + | option proto '{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}' |
| + | option modem '1-1.4' |
| + | option metric '1' |
| + | option sim '1' |
| + | option pdp '1' |
| + | option auth 'none' |
| + | |
| + | config interface '<span style="color:purple;">{{#ifeq:{{{series}}}|RUTOS|mob1s2a1|wwan}}</span>' |
| + | option proto '{{#ifeq:{{{series}}}|RUTOS|mob1s2a1|wwan0}}' |
| + | option modem '1-1.4' |
| + | option metric '1' |
| + | option sim '2' |
| + | option pdp '1' |
| + | |
| + | '''Possible responses''': |
| + | |
| + | *IP address (32-bit numeric address written as four numbers separated by periods) |
| | | |
| | | |
Line 65: |
Line 103: |
| '''Example''': obtaining the number of bytes sent (TX bytes) by the mobile connection interface: | | '''Example''': obtaining the number of bytes sent (TX bytes) by the mobile connection interface: |
| | | |
− | root@Teltonika:~# gsmctl <span style="color:blue;">-e</span> <span style="color:purple;">wwan0</span> | + | root@Teltonika:~# gsmctl <span style="color:blue;">-e</span> <span style="color:purple;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span> |
| <span style="color:red;">36335</span> | | <span style="color:red;">36335</span> |
| | | |
Line 87: |
Line 125: |
| '''Example''': obtaining the number of bytes received (RX bytes) by the mobile connection interface: | | '''Example''': obtaining the number of bytes received (RX bytes) by the mobile connection interface: |
| | | |
− | root@Teltonika:~# gsmctl <span style="color:blue;">-r</span> <span style="color:purple;">wwan0</span> | + | root@Teltonika:~# gsmctl <span style="color:blue;">-r</span> <span style="color:purple;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span> |
| <span style="color:red;">92551</span> | | <span style="color:red;">92551</span> |
| | | |
Line 213: |
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 234: |
Line 273: |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-y</span>, <span style="color:blue;">--firmware</span> | + | gsmctl <span style="color:blue;">-y</span>, <span style="color:blue;">--revision</span> |
| | | |
| '''Example''': obtaining the modem's revision number: | | '''Example''': obtaining the modem's revision number: |
Line 282: |
Line 321: |
| *not inserted | | *not inserted |
| | | |
− |
| |
− | ===Get PIN state===
| |
− | ----
| |
− | To obtain the PIN state of the SIM card currently in use, use '''''-u''''' or '''''--pinstate''''' options.
| |
− |
| |
− | '''Usage syntax''':
| |
− |
| |
− | gsmctl <span style="color:blue;">-u</span>, <span style="color:blue;">--pinstate</span>
| |
− |
| |
− | '''Example''': obtaining the PIN state:
| |
− |
| |
− | root@Teltonika:~# gsmctl <span style="color:blue;">-u</span>
| |
− | <span style="color:red;">OK</span>
| |
− |
| |
− | '''Possible responses''':
| |
− |
| |
− | *OK
| |
− | *SIM not inserted.
| |
| | | |
| ===Get GSM signal (RSSI) level=== | | ===Get GSM signal (RSSI) level=== |
Line 314: |
Line 335: |
| <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. | + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument returns all signal related values. Example: |
− | *Example for <b>3G</b> network type:
| |
| | | |
| root@Teltonika:~# gsmctl -q | | root@Teltonika:~# gsmctl -q |
− | RSSI: -67 | + | RSSI: -69 |
− | RSCP: -68
| |
− | ECIO: -5
| |
− | | |
− | *Example for <b>4G</b> network type:
| |
− | root@Teltonika:~# gsmctl -q
| |
− | RSSI: -60
| |
| RSRP: -103 | | RSRP: -103 |
| SINR: 2 | | SINR: 2 |
Line 546: |
Line 560: |
| gsmctl <span style="color:blue;">-B</span>, <span style="color:blue;">--pincount</span> | | gsmctl <span style="color:blue;">-B</span>, <span style="color:blue;">--pincount</span> |
| | | |
− | '''Example''': obtaining PIN/PUK count: | + | '''Example''': obtaining the |
| | | |
| root@Teltonika:~# gsmctl <span style="color:blue;">-B</span> | | root@Teltonika:~# gsmctl <span style="color:blue;">-B</span> |
− | <span style="color:red;">S1_PIN: 3 | S1_PUK: 10 | + | <span style="color:red;">3</span> |
− | S2_PIN: 3 | S2_PUK: 10</span>
| |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
| | | |
| *an integer number representing the amount of PIN/PUK attempts left | | *an integer number representing the amount of PIN/PUK attempts left |
| + | *N/A - returned when the SIM card is not inserted |
| | | |
| | | |
Line 560: |
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 582: |
Line 598: |
| root@Teltonika:~# gsmctl -F | | root@Teltonika:~# gsmctl -F |
| LTE | LTE_B3 | 24602 | | LTE | LTE_B3 | 24602 |
− |
| |
| | | |
| ===Get serving cell information=== | | ===Get serving cell information=== |
Line 603: |
Line 618: |
| root@Teltonika:~# gsmctl -K | | root@Teltonika:~# gsmctl -K |
| Access tech: LTE | TDD mode: FDD | MCC: 246 | MNC: 2 | UE state: 3 | | Access tech: LTE | TDD mode: FDD | MCC: 246 | MNC: 2 | UE state: 3 |
− |
| |
| | | |
| ===Get neighbour cell information=== | | ===Get neighbour cell information=== |
Line 617: |
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=== | | ===Get VoLTE state status=== |
Line 694: |
Line 707: |
| | | |
| | | |
− | ===Debug the modem=== | + | ===Shutdown the modem=== |
| ---- | | ---- |
− | To debug the modem, use '''''-D''''' or '''''--debug''''' options. After the command is executed, modem will enable debug information. | + | 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>: This argument is supported from FW version <i>R_00.07.03</i>. | + | <b>Note</b>: From FW version <i>R_00.07.03</i> this argument was removed. |
| | | |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-D</span>, <span style="color:blue;">--debug</span> | + | gsmctl <span style="color:blue;">-D</span>, <span style="color:blue;">--shutdown</span> |
| | | |
− | '''Example''': Enable debug information | + | '''Example''': shutting down the modem |
| | | |
| root@Teltonika:~# gsmctl <span style="color:blue;">-D</span> | | root@Teltonika:~# gsmctl <span style="color:blue;">-D</span> |
| + | <span style="color:red;">OK</span> |
| + | |
| + | '''Possible responses''': |
| + | |
| + | *OK |
| | | |
| | | |
Line 721: |
Line 739: |
| root@Teltonika:~# gsmctl <span style="color:blue;">-h</span> | | root@Teltonika:~# gsmctl <span style="color:blue;">-h</span> |
| <span style="color:red;">usage: gsmctl OPTIONS | | <span style="color:red;">usage: gsmctl OPTIONS |
− | -F, --network Get network information | + | -p, --ip <INTERFACE> Get IP of logical interface |
| -e, --bsent <INTERFACE> Get number of bytes sent | | -e, --bsent <INTERFACE> Get number of bytes sent |
| -r, --brecv <INTERFACE> Get number of bytes recieved</span> | | -r, --brecv <INTERFACE> Get number of bytes recieved</span> |
Line 729: |
Line 747: |
| *a list of options that can be used with ''gsmctl'' | | *a list of options that can be used with ''gsmctl'' |
| | | |
| + | |
| + | ===Print gsmctl version=== |
| + | ---- |
| + | 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''': |
| + | |
| + | gsmctl <span style="color:blue;">-v</span>, <span style="color:blue;">--version</span> |
| + | |
| + | '''Example''': obtaining the ''gsmctl'' version |
| + | |
| + | root@Teltonika:~# gsmctl <span style="color:blue;">-v</span> |
| + | <span style="color:red;">GSMCTL version: 0.2b</span> |
| + | |
| + | '''Possible responses''': |
| + | |
| + | *a string type output indicating the ''gsmctl'' version |
| | | |
| ==SMS management options== | | ==SMS management options== |
Line 874: |
Line 911: |
| | | |
| *If response in terminal "OK", SMS was sent successfully. | | *If response in terminal "OK", SMS was sent successfully. |
− |
| |
| | | |
| ==Auxiliary options== | | ==Auxiliary options== |