Teltonika Networks Wiki

Changes

Template:Gsmctl commands (view source)

Revision as of 10:22, 22 November 2023

2,039 bytes added ,  10:22, 22 November 2023
no edit summary
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 52:  
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===
 
===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.
 
To obtain the IP address of a network interface, use '''''-p''''' or '''''--ip''''' options.
 
   
 
   
Line 63: Line 68:  
'''Example''': obtaining the IP address of the mobile connection 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>
+
  root@Teltonika:~# gsmctl <span style="color:blue;">-p</span> <span style="color:purple;">wwan0</span>
 
  <span style="color:red;">10.139.75.221</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.  
−
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)
  −
 
      
===Get number of bytes sent===
 
===Get number of bytes sent===
Line 103: Line 86:  
'''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;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span>
+
  root@Teltonika:~# gsmctl <span style="color:blue;">-e</span> <span style="color:purple;">wwan0</span>
 
  <span style="color:red;">36335</span>
 
  <span style="color:red;">36335</span>
   Line 125: Line 108:  
'''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;">{{#ifeq:{{{series}}}|RUTOS|mob1s1a1|wwan0}}</span>
+
  root@Teltonika:~# gsmctl <span style="color:blue;">-r</span> <span style="color:purple;">wwan0</span>
 
  <span style="color:red;">92551</span>
 
  <span style="color:red;">92551</span>
   Line 251: Line 234:  
----
 
----
 
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 269: Line 251:  
===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;">--revision</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:
Line 322: Line 304:       −
===Get GSM signal (RSSI) level===
+
===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.
 +
 
 +
 
 +
{{#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.
Line 335: Line 363:  
  <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:
+
<b>Note</b>: From FW version <i>R_00.07.03</i> this argument returns all signal related values.  
 +
*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
 
  root@Teltonika:~# gsmctl -q
−
  RSSI: -69
+
  RSSI: -60
 
  RSRP: -103
 
  RSRP: -103
 
  SINR: 2
 
  SINR: 2
Line 345: Line 380:  
'''Possible responses''':
 
'''Possible responses''':
   −
*an integer number ranging from -113 to -51 (in dBm)
+
*an integer number ranging from -113 to -51 (in dBm)}}
      Line 552: Line 587:       −
===Get PIN/PUK count===
+
{{#ifeq:{{{series}}}|RUTOS
 +
|===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 PIN/PUK count:
 +
 
 +
root@Teltonika:~# gsmctl <span style="color:blue;">-B</span>
 +
<span style="color:red;">S1_PIN: 3 {{!}} S1_PUK: 10
 +
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.
 
To obtain the PIN/PUK count, use '''''-B''''' or '''''--pincount''''' options.
Line 568: Line 621:     
*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
+
*N/A - returned when the SIM card is not inserted}}
      −
===Get network information===
+
{{#ifeq:{{{series}}}|RUTOS
 +
|===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''':
 +
 +
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.
      Line 592: Line 664:  
**'''''<oper>''''' - operator number
 
**'''''<oper>''''' - operator number
 
**'''''<band>''''' - frequency band used
 
**'''''<band>''''' - frequency band used
−
**'''''<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===
Line 618: Line 686:  
  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 632: Line 701:  
  <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===
+
 
 +
{{#ifeq:{{{series}}}|RUTOS
 +
|===Get VoLTE state status===
 
----
 
----
 
To obtain the VoLTE state, use '''''-v''''' or '''''--volte_state''''' options.
 
To obtain the VoLTE state, use '''''-v''''' or '''''--volte_state''''' options.
Line 651: Line 722:  
*Active
 
*Active
 
*Inactive
 
*Inactive
 +
|===Print gsmctl version===
 +
----
 +
To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options.
 +
 +
'''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}}
      Line 706: Line 793:  
*Modem was reset
 
*Modem was reset
    +
{{#ifeq:{{{series}}}|RUTOS
 +
|===Debug the modem===
 +
----
 +
To debug the modem, use '''''-D''''' or '''''--debug''''' options. After the command is executed, modem will enable debug information.
 +
 +
<b>Note</b>: This argument is supported from FW version <i>R_00.07.03</i>.
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">-D</span>, <span style="color:blue;">--debug</span>
   −
===Shutdown the modem===
+
'''Example''': Enable debug information
 +
 
 +
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.
 
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 724: Line 822:  
'''Possible responses''':
 
'''Possible responses''':
   −
*OK
+
*OK}}
−
 
      
===List available options===
 
===List available options===
Line 739: Line 836:  
  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
−
   -p, --ip <INTERFACE>          Get IP of logical interface
+
   -F, --network                Get network information
 
   -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 747: Line 844:  
*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 911: Line 989:     
*If response in terminal "OK", SMS was sent successfully.
 
*If response in terminal "OK", SMS was sent successfully.
 +
    
==Auxiliary options==
 
==Auxiliary options==
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/104193...116381"