219
edits
Changes
Template:Gsmctl commands (view source)
Revision as of 10:22, 22 November 2023
, 10:22, 22 November 2023no edit summary
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.
{{#ifeq:{{{series}}}|RUTOS| |
===Get IP address of logical interface===
----
<b>Note</b>: From FW version <i>R_00.07.03</i> this option is deprecated. IP addresses can be called with `ubus call network.interface.<interface> status`.
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;">wwan0</span>
<span style="color:red;">10.139.75.221</span>
Where '''''wwan0''''' is the name of the mobile interface when the connection type is set to QMI (default). You can use the '''''ifconfig''''' command to check the names of existing network interfaces.
}}
===Get number of bytes sent===
===Get number of bytes sent===
===Get device revision number===
===Get device revision number===
----
----
To obtain the modem's revision number (firmware version), use '''''-y''''' or '''''--firmware''''' options.
To obtain the modem's revision number (firmware version), use '''''-y''''' or {{#ifeq:{{{series}}}|RUTOS|'''''--firmware'''''|'''''--revision''''' }} options.
'''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;">{{#ifeq:{{{series}}}|RUTOS|'''''--firmware'''''|'''''--revision''''' }}</span>
'''Example''': obtaining the modem's revision number:
'''Example''': obtaining the modem's revision number:
*SIM not inserted.
*SIM not inserted.
===Get GSM signal (RSSI) level===
{{#ifeq:{{{series}}}|RUTOS
|===Get GSM signal (RSSI) level===
----
To obtain the router's current signal strength ([[RSSI]]) value, use '''''-q''''' or '''''--signal''''' options.
'''Usage syntax''':
gsmctl <span style="color:blue;">-q</span>, <span style="color:blue;">--signal</span>
*Example for <b>3G</b> network type:
root@Teltonika:~# gsmctl -q
RSSI: -67
RSCP: -68
ECIO: -5
*Example for <b>4G</b> network type:
root@Teltonika:~# gsmctl -q
RSSI: -60
RSRP: -103
SINR: 2
RSRQ: -16
'''Possible responses''':
*an integer number ranging from -113 to -51 (in dBm)
|===Get GSM signal (RSSI) level===
----
----
To obtain the router's current signal strength ([[RSSI]]) value, use '''''-q''''' or '''''--signal''''' options.
To obtain the router's current signal strength ([[RSSI]]) value, use '''''-q''''' or '''''--signal''''' options.
'''Possible responses''':
'''Possible responses''':
*an integer number ranging from -113 to -51 (in dBm)
*an integer number ranging from -113 to -51 (in dBm)}}
===Get PIN/PUK count===
{{#ifeq:{{{series}}}|RUTOS
|===Get PIN/PUK count===
----
----
To obtain the PIN/PUK count, use '''''-B''''' or '''''--pincount''''' options.
To obtain the PIN/PUK count, use '''''-B''''' or '''''--pincount''''' options.
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;">S1_PIN: 3 {{!}} S1_PUK: 10
S2_PIN: 3 | S2_PUK: 10</span>
S2_PIN: 3 {{!}} S2_PUK: 10</span>
'''Possible responses''':
*an integer number representing the amount of PIN/PUK attempts left
|===Get PIN/PUK count===
----
To obtain the PIN/PUK count, use '''''-B''''' or '''''--pincount''''' options.
'''Usage syntax''':
gsmctl <span style="color:blue;">-B</span>, <span style="color:blue;">--pincount</span>
'''Example''': obtaining the
root@Teltonika:~# gsmctl <span style="color:blue;">-B</span>
<span style="color:red;">3</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}}
{{#ifeq:{{{series}}}|RUTOS
|===Get network information===
----
To obtain information related to the mobile network information, use '''''-F''''' or '''''--network''''' options.
'''Usage syntax''':
===Get network information===
gsmctl <span style="color:blue;">-F</span>, <span style="color:blue;">--network</span>
'''Example''': obtaining mobile network information:
root@Teltonika:~# gsmctl <span style="color:blue;">-F</span>
<span style="color:red;">LTE {{!}} LTE_B3 {{!}} 24602</span>
'''Possible responses''':
*response syntax: ''<Act>,<oper>,<band>'' <br> Where:
**'''''<Act>''''' - service mode
**'''''<oper>''''' - operator number
**'''''<band>''''' - frequency band used
|===Get network information===
----
----
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''':
**'''''<oper>''''' - operator number
**'''''<oper>''''' - operator number
**'''''<band>''''' - frequency band used
**'''''<band>''''' - frequency band used
**'''''<channel>''''' - channel ID
**'''''<channel>''''' - channel ID}}
*Active
*Active
*Inactive
*Inactive
|===Get VoLTE state status===
|===Print gsmctl version===
===Print gsmctl version===
----
----
To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options.
To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options.
'''Possible responses''':
'''Possible responses''':
*a string type output indicating the ''gsmctl'' version
*a string type output indicating the ''gsmctl'' version}}
===Get operator station time===
===Get operator station time===
*Modem was reset
*Modem was reset
{{#ifeq:{{{series}}}|RUTOS
===Debug the modem===
|===Debug the modem===
----
----
To debug the modem, use '''''-D''''' or '''''--debug''''' options. After the command is executed, modem will enable debug information.
To debug the modem, use '''''-D''''' or '''''--debug''''' options. After the command is executed, modem will enable debug information.
root@Teltonika:~# gsmctl <span style="color:blue;">-D</span>
root@Teltonika:~# gsmctl <span style="color:blue;">-D</span>
|===Shutdown the modem===
----
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.
'''Usage syntax''':
gsmctl <span style="color:blue;">-D</span>, <span style="color:blue;">--shutdown</span>
'''Example''': shutting down the modem
root@Teltonika:~# gsmctl <span style="color:blue;">-D</span>
<span style="color:red;">OK</span>
'''Possible responses''':
*OK}}
===List available options===
===List available options===