Changes

2,904 bytes added ,  08:52, 30 August 2018
no edit summary
Line 42: Line 42:  
==Basic options==
 
==Basic options==
   −
This subsection 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===
 
===Get IP address of logical interface===
Line 572: Line 572:  
'''Possible responses''':
 
'''Possible responses''':
 
* OK
 
* OK
 +
    
===List available options===
 
===List available options===
 
----
 
----
To obtain the , use '''''-''''' or '''''--''''' options.
+
Using '''''-h''''' or '''''--help''''' options prints of all available ''gsmctl'' options with descriptions and usage syntax examples.
    
'''Usage syntax''':
 
'''Usage syntax''':
   −
  gsmctl <span style="color:blue;">-</span>, <span style="color:blue;">--</span>
+
  gsmctl <span style="color:blue;">-h</span>, <span style="color:blue;">--help</span>
 
  −
'''Example''': obtaining the
     −
root@Teltonika:~# gsmctl <span style="color:blue;">-</span>
+
'''Example''': printing a list of available ''gsmctl'' options
<span style="color:red;"></span>
      +
root@Teltonika:~# gsmctl <span style="color:blue;">-h</span>
 +
<span style="color:red;">usage: gsmctl OPTIONS
 +
  -p, --ip <INTERFACE>          Get IP of logical interface
 +
  -e, --bsent <INTERFACE>      Get number of bytes sent
 +
  -r, --brecv <INTERFACE>      Get number of bytes recieved</span>
 +
  ...
 
'''Possible responses''':
 
'''Possible responses''':
*  
+
* a list of options that can be used with ''gsmctl''
       
===Print gsmctl version===
 
===Print gsmctl version===
 
----
 
----
To obtain the , use '''''-''''' or '''''--''''' options.
+
To find out the current ''gsmctl'' version, use '''''-v''''' or '''''--version''''' options.
    
'''Usage syntax''':
 
'''Usage syntax''':
   −
  gsmctl <span style="color:blue;">-</span>, <span style="color:blue;">--</span>
+
  gsmctl <span style="color:blue;">-h</span>, <span style="color:blue;">--help</span>
   −
'''Example''': obtaining the  
+
'''Example''': obtaining the ''gsmctl'' version
   −
  root@Teltonika:~# gsmctl <span style="color:blue;">-</span>
+
  root@Teltonika:~# gsmctl <span style="color:blue;">-v</span>
  <span style="color:red;"></span>
+
  <span style="color:red;">GSMCTL version: 0.2b</span>
    
'''Possible responses''':
 
'''Possible responses''':
*
+
* a string type output indicating the ''gsmctl'' version
    
==SMS management options==
 
==SMS management options==
   −
 
+
This section overviews ''gsmctl'' options related to SMS management. Every SMS related command uses the '''''"-S"''''' or '''''"--sms"''''' along with another option.
    
===Read SMS by index===
 
===Read SMS by index===
 
----
 
----
 +
To read a single SMS message, use '''''-S -r''''' or '''''--sms --read''''' options. Additionally you have to specify the '''''<INDEX>''''' of the message that you wish to read. The ''<INDEX>'' is an integer number that defines the position of a message in the SMS message list. It can range from 1 to however many messages your SMS memory can store.
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">-S -r</span>, <span style="color:blue;">--sms --read</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
       
===List SMS by type===
 
===List SMS by type===
 
----
 
----
 +
 +
To read a single SMS message, use '''''- -''''' or '''''-- --''''' options
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">- -</span>, <span style="color:blue;">-- --</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
       
===Print SMS memory usage===
 
===Print SMS memory usage===
 
----
 
----
 +
 +
To read a single SMS message, use '''''- -''''' or '''''-- --''''' options
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">- -</span>, <span style="color:blue;">-- --</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
       
===Delete SMS by index===
 
===Delete SMS by index===
 
----
 
----
 +
 +
To read a single SMS message, use '''''- -''''' or '''''-- --''''' options
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">- -</span>, <span style="color:blue;">-- --</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
       
===Send SMS===
 
===Send SMS===
 
----
 
----
 +
 +
To read a single SMS message, use '''''- -''''' or '''''-- --''''' options
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">- -</span>, <span style="color:blue;">-- --</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
       
===Send SMS encoded in base64===
 
===Send SMS encoded in base64===
 
----
 
----
 +
 +
To read a single SMS message, use '''''- -''''' or '''''-- --''''' options
 +
 +
'''Usage syntax''':
 +
 +
gsmctl <span style="color:blue;">- -</span>, <span style="color:blue;">-- --</span>
 +
 +
'''Example''':
 +
 +
root@Teltonika:~# gsmctl <span style="color:blue;"></span>
 +
<span style="color:red;"></span>
 +
 +
'''Possible responses''':
 +
*
    
==Auxiliary options==
 
==Auxiliary options==

Navigation menu