Difference between revisions of "Gsmctl commands"
| Line 63: | Line 63: | ||
'''Possible responses''': | '''Possible responses''': | ||
* IP address (32-bit numeric address written as four numbers separated by periods) | * IP address (32-bit numeric address written as four numbers separated by periods) | ||
| + | |||
===Get number of bytes sent=== | ===Get number of bytes sent=== | ||
| Line 83: | Line 84: | ||
'''Possible responses''': | '''Possible responses''': | ||
* An integer number representing '''bytes''' (not bits) sent | * An integer number representing '''bytes''' (not bits) sent | ||
| + | |||
===Get number of bytes received=== | ===Get number of bytes received=== | ||
| Line 103: | Line 105: | ||
'''Possible responses''': | '''Possible responses''': | ||
* An integer number representing '''bytes''' (not bits) received | * An integer number representing '''bytes''' (not bits) received | ||
| + | |||
===Get network connection state=== | ===Get network connection state=== | ||
| Line 120: | Line 123: | ||
* connected | * connected | ||
* disconnected | * disconnected | ||
| + | |||
===Get network link state=== | ===Get network link state=== | ||
| Line 140: | Line 144: | ||
* searching | * searching | ||
* unknown | * unknown | ||
| + | |||
===Get device IMEI=== | ===Get device IMEI=== | ||
| Line 156: | Line 161: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get SIM ICCID=== | ===Get SIM ICCID=== | ||
| Line 172: | Line 178: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get device model=== | ===Get device model=== | ||
| Line 188: | Line 195: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get device manufacturer=== | ===Get device manufacturer=== | ||
| Line 204: | Line 212: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get device serial number=== | ===Get device serial number=== | ||
| Line 220: | Line 229: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get device revision number=== | ===Get device revision number=== | ||
| Line 236: | Line 246: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get IMSI=== | ===Get IMSI=== | ||
| Line 252: | Line 263: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get SIM card state=== | ===Get SIM card state=== | ||
| Line 268: | Line 280: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get GSM signal (RSSI) level=== | ===Get GSM signal (RSSI) level=== | ||
| Line 284: | Line 297: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get WCDMA RSCP level=== | ===Get WCDMA RSCP level=== | ||
| Line 300: | Line 314: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get WCDMA EC/IO level=== | ===Get WCDMA EC/IO level=== | ||
| Line 316: | Line 331: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get LTE RSRP level=== | ===Get LTE RSRP level=== | ||
| Line 332: | Line 348: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get LTE SINR level=== | ===Get LTE SINR level=== | ||
| Line 348: | Line 365: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get LTE RSRQ level=== | ===Get LTE RSRQ level=== | ||
| Line 364: | Line 382: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get cell ID parameter=== | ===Get cell ID parameter=== | ||
| Line 380: | Line 399: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get name of operator used=== | ===Get name of operator used=== | ||
| Line 396: | Line 416: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get operator number=== | ===Get operator number=== | ||
| Line 412: | Line 433: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get data carrier type=== | ===Get data carrier type=== | ||
| Line 428: | Line 450: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get module temperature=== | ===Get module temperature=== | ||
| Line 444: | Line 467: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get PIN/PUK count=== | ===Get PIN/PUK count=== | ||
| Line 460: | Line 484: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get network information=== | ===Get network information=== | ||
| Line 476: | Line 501: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get serving cell information=== | ===Get serving cell information=== | ||
| Line 492: | Line 518: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Get neighbour cell information=== | ===Get neighbour cell information=== | ||
| Line 508: | Line 535: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Shutdown the modem=== | ===Shutdown the modem=== | ||
| Line 524: | Line 552: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===List available options=== | ===List available options=== | ||
| Line 540: | Line 569: | ||
'''Possible responses''': | '''Possible responses''': | ||
* | * | ||
| + | |||
===Print gsmctl version=== | ===Print gsmctl version=== | ||
Revision as of 13:33, 30 July 2018
Introduction
gsmctl is an SSH command used to communicate with a RUTxxx router's modem. In other words, gsmctl relays AT commands (a set of instructions used to control a modem) to the router's modem; thus, providing the user with a way to control and obtain information from the modem via SSH. This can be used to either obtain certain modem related variables (signal strength, operator, connection state, etc.) or to execute certain actions (sending SMS messages, changing the frequency band, etc.).
This article provides a complete overview on gsmctl commands available in RUTxxx routers.
Prerequisites
gsmctl commands can be used on all RUTxxx routers via any type of command line interface (CLI) supported by the router. So all you need is:
- a RUTxxx router
- knowledge on how to login via a command line interface
gsmctl options
gsmctl commands are used in tandem with various options that specify what type of action should be executed.
Example structure
Individual options are described in separate subsections of this article. To find the information you are looking for faster, refer to the table of contents at the top of the page or use your browser's "Find in page" feature (Control + F).
Each option is presented with its usage syntax and an example command. For easier differentiation of the different elements that make up the examples, different colors are used:
- options are highlighted in blue
- responses are highlighted in red
- additional parameters are highlighted in purple
Two execution methods
Each option can be executed in two distinct ways. One is shorter, the other is longer and more descriptive. For example, to obtain the modem's IMEI you can either use:
- short version: gsmctl -i
- long version: gsmctl --imei
In both cases, enter the desired command and press the "Enter" key on your keyboard to execute that command. The response will be printed out as a standard output (stdout) string in your terminal.
Combined options
Multiple options can be combined together to obtain more than one parameter at a time. For example, to obtain the name of the operator used, signal strength and connection type with one command you can use one of the following:
- short version: gsmctl -oqt
- long version: gsmctl --operator --signal --conntype
Note that in the shorter version multiple options can be used together with one hyphen (-) symbol with no spacing, while in the longer version different options must be separated by spaces and before each option a double hyphen (--) is required.
Basic options
This subsection 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 -p, --ip <INTERFACE>
Where <INTERFACE> is the name of a network interface.
Example: obtaining the IP address of the mobile connection interface:
root@Teltonika:~# gsmctl -p wwan0 10.139.75.221
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.
Possible responses:
- IP address (32-bit numeric address written as four numbers separated by periods)
Get number of bytes sent
To obtain the number of bytes sent (TX bytes) by a network interface, use -e or --bsent options.
Usage syntax:
gsmctl -i, --bsent <INTERFACE>
Where <INTERFACE> is the name of a network interface.
Example: obtaining the number of bytes sent (TX bytes) by the mobile connection interface:
root@Teltonika:~# gsmctl -e wwan0 36335
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.
Possible responses:
- An integer number representing bytes (not bits) sent
Get number of bytes received
To obtain the number of bytes received (RX bytes) by a network interface, use -r or --brecv options.
Usage syntax:
gsmctl -b, --brecv <INTERFACE>
Where <INTERFACE> is the name of a network interface.
Example: obtaining the number of bytes received (RX bytes) by the mobile connection interface:
root@Teltonika:~# gsmctl -r wwan0 92551
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.
Possible responses:
- An integer number representing bytes (not bits) received
Get network connection state
To obtain the network connection state, use -j or --connstate options.
Usage syntax:
gsmctl -j, --connstate
Example: obtaining the current network connection state:
root@Teltonika:~# gsmctl -j connected
Possible responses:
- connected
- disconnected
Get network link state
To obtain the registration state of the mobile network, use -g or --netstate options.
Usage syntax:
gsmctl -g, --netstate
Example: obtaining the registration state of the mobile network:
root@Teltonika:~# gsmctl -g registered (home)
Possible responses:
- registered (home)
- registered (roaming)
- unregistered
- searching
- unknown
Get device IMEI
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get SIM ICCID
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get device model
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get device manufacturer
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get device serial number
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get device revision number
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get IMSI
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get SIM card state
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get GSM signal (RSSI) level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get WCDMA RSCP level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get WCDMA EC/IO level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get LTE RSRP level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get LTE SINR level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get LTE RSRQ level
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get cell ID parameter
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get name of operator used
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get operator number
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get data carrier type
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get module temperature
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get PIN/PUK count
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get network information
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get serving cell information
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Get neighbour cell information
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Shutdown the modem
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
List available options
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
Print gsmctl version
To obtain the , use - or -- options.
Usage syntax:
gsmctl -, --
Example: obtaining the
root@Teltonika:~# gsmctl -
Possible responses:
SMS management options
Read SMS by index
List SMS by type
Print SMS memory usage
Delete SMS by index
Send SMS
