Line 8: |
Line 8: |
| | | |
| ''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: | | ''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 interfaces|command line interface]]''' | + | *a RUTxxx router |
| + | *knowledge on how to login via a '''[[Command line interfaces|command line interface]]''' |
| | | |
| ==gsmctl options== | | ==gsmctl options== |
Line 20: |
Line 21: |
| | | |
| 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: | | 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: |
− | * <span style="color:blue;">options</span> are highlighted in blue | + | |
− | * <span style="color:red;">responses</span> are highlighted in red | + | *<span style="color:blue;">options</span> are highlighted in blue |
− | * <span style="color:purple;">additional parameters</span> are highlighted in purple | + | *<span style="color:red;">responses</span> are highlighted in red |
| + | *<span style="color:purple;">additional parameters</span> are highlighted in purple |
| + | |
| ---- | | ---- |
| '''Two execution methods''' | | '''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: | | 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''''' | + | *short version: '''''gsmctl -i''''' |
| + | *long version: '''''gsmctl --imei''''' |
| | | |
| In both cases, you just type 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 window. | | In both cases, you just type 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 window. |
Line 35: |
Line 39: |
| | | |
| 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: | | 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''''' | + | *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. | | 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. |
Line 62: |
Line 67: |
| | | |
| '''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) |
| | | |
| | | |
Line 71: |
Line 77: |
| '''Usage syntax''': | | '''Usage syntax''': |
| | | |
− | gsmctl <span style="color:blue;">-i</span>, <span style="color:blue;">--bsent</span> <span style="color:purple;"><INTERFACE></span> | + | gsmctl <span style="color:blue;">-e</span>, <span style="color:blue;">--bsent</span> <span style="color:purple;"><INTERFACE></span> |
| | | |
| Where ''<INTERFACE>'' is the name of a network interface. | | Where ''<INTERFACE>'' is the name of a network interface. |
Line 83: |
Line 89: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * An integer number representing '''bytes''' (not bits) sent | + | |
| + | *An integer number representing '''bytes''' (not bits) sent |
| | | |
| | | |
Line 104: |
Line 111: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * An integer number representing '''bytes''' (not bits) received | + | |
| + | *An integer number representing '''bytes''' (not bits) received |
| | | |
| | | |
Line 121: |
Line 129: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * connected | + | |
− | * disconnected | + | *connected |
| + | *disconnected |
| | | |
| | | |
Line 139: |
Line 148: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * registered (home) | + | |
− | * registered (roaming) | + | *registered (home) |
− | * unregistered | + | *registered (roaming) |
− | * searching | + | *unregistered |
− | * unknown | + | *searching |
| + | *unknown |
| | | |
| | | |
Line 160: |
Line 170: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 15 digit sequence of decimal numbers | + | |
| + | *a 15 digit sequence of decimal numbers |
| | | |
| | | |
Line 177: |
Line 188: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 19 or 20 digit sequence of decimal numbers | + | |
| + | *a 19 or 20 digit sequence of decimal numbers |
| | | |
| | | |
Line 194: |
Line 206: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a string of letters and digits representing the model name | + | |
| + | *a string of letters and digits representing the model name |
| | | |
| | | |
Line 211: |
Line 224: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a string of letters and digits representing the manufacturer's name | + | |
| + | *a string of letters and digits representing the manufacturer's name |
| | | |
| | | |
Line 228: |
Line 242: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 15 digit sequence of decimal numbers | + | |
| + | *a 15 digit sequence of decimal numbers |
| | | |
| | | |
Line 245: |
Line 260: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a string of letters and digits representing the revision number (firmware version) | + | |
| + | *a string of letters and digits representing the revision number (firmware version) |
| | | |
| | | |
Line 262: |
Line 278: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 15 digit (or less) sequence of decimal numbers | + | |
| + | *a 15 digit (or less) sequence of decimal numbers |
| | | |
| | | |
Line 279: |
Line 296: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * inserted | + | |
− | * not inserted | + | *inserted |
| + | *not inserted |
| | | |
| | | |
Line 297: |
Line 315: |
| | | |
| '''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 314: |
Line 333: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number ranging from -124 to 0 | + | |
− | * service mode not supported (this response is returned when the router's current service mode is not WCDMA) | + | *an integer number ranging from -124 to 0 |
| + | *service mode not supported (this response is returned when the router's current service mode is not WCDMA) |
| | | |
| | | |
Line 332: |
Line 352: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number ranging from -20 to 0 | + | |
− | * service mode not supported (this response is returned when the router's current service mode is not WCDMA) | + | *an integer number ranging from -20 to 0 |
| + | *service mode not supported (this response is returned when the router's current service mode is not WCDMA) |
| | | |
| | | |
Line 350: |
Line 371: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number ranging from >= -80 to <= -100 (dBm) | + | |
− | * service mode not supported (this response is returned when the router's current service mode is not LTE) | + | *an integer number ranging from >= -80 to <= -100 (dBm) |
| + | *service mode not supported (this response is returned when the router's current service mode is not LTE) |
| | | |
| | | |
Line 368: |
Line 390: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a real number ranging from 0.0 to 20.0 (dB) | + | |
− | * service mode not supported (this response is returned when the router's current service mode is not LTE) | + | *a real number ranging from 0.0 to 20.0 (dB) |
| + | *service mode not supported (this response is returned when the router's current service mode is not LTE) |
| | | |
| | | |
Line 386: |
Line 409: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number ranging from <= - 20 to >= -10 (dB) | + | |
− | * service mode not supported (this response is returned when the router's current service mode is not LTE) | + | *an integer number ranging from <= - 20 to >= -10 (dB) |
| + | *service mode not supported (this response is returned when the router's current service mode is not LTE) |
| | | |
| | | |
Line 404: |
Line 428: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 7 digit sequence of decimal numbers indicating the cell ID | + | |
− | * N/A - returned when the SIM card is not inserted or unregistered | + | *a 7 digit sequence of decimal numbers indicating the cell ID |
| + | *N/A - returned when the SIM card is not inserted or unregistered |
| | | |
| | | |
Line 422: |
Line 447: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a string of text representing the network operator's name | + | |
− | * N/A - returned when the SIM card is not connected to any operator | + | *a string of text representing the network operator's name |
| + | *N/A - returned when the SIM card is not connected to any operator |
| | | |
| | | |
Line 440: |
Line 466: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a 6 digit sequence of decimal numbers | + | |
− | * N/A - returned when the SIM card is not connected to any operator | + | *a 6 digit sequence of decimal numbers |
| + | *N/A - returned when the SIM card is not connected to any operator |
| | | |
| | | |
Line 458: |
Line 485: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * NOSERVICE - NOSERVICE mode | + | |
− | * GSM - GSM/GPRS/EDGE mode | + | *NOSERVICE - NOSERVICE mode |
− | * WCDMA - WCDMA/HSDPA/HSPA mode | + | *GSM - GSM/GPRS/EDGE mode |
− | * TDSCDMA - TDSCDMA mode | + | *WCDMA - WCDMA/HSDPA/HSPA mode |
− | * LTE - LTE mode | + | *TDSCDMA - TDSCDMA mode |
− | * CDMA - CDMA mode | + | *LTE - LTE mode |
− | * EVDO - EV-DO/eHRPD mode | + | *CDMA - CDMA mode |
− | * CDMA-EVDO - CDMA/EV-DO(eHRPD) mode | + | *EVDO - EV-DO/eHRPD mode |
| + | *CDMA-EVDO - CDMA/EV-DO(eHRPD) mode |
| | | |
| ===Get module temperature=== | | ===Get module temperature=== |
Line 481: |
Line 509: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number representing the module's current temperature (in 0.1 degrees Celsius (°C)) | + | |
| + | *an integer number representing the module's current temperature (in 0.1 degrees Celsius (°C)) |
| | | |
| | | |
Line 498: |
Line 527: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * an integer number representing the amount of PIN/PUK attempts left | + | |
− | * N/A - returned when the SIM card is not inserted | + | *an integer number representing the amount of PIN/PUK attempts left |
| + | *N/A - returned when the SIM card is not inserted |
| | | |
| | | |
Line 516: |
Line 546: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * response syntax: ''+QNWINFO: <Act>,<oper>,<band>,<channel>'' <br> Where: | + | |
− | ** '''''<Act>''''' - service mode | + | *response syntax: ''+QNWINFO: <Act>,<oper>,<band>,<channel>'' <br> Where: |
− | ** '''''<oper>''''' - operator number | + | **'''''<Act>''''' - service mode |
− | ** '''''<band>''''' - frequency band used | + | **'''''<oper>''''' - operator number |
− | ** '''''<channel>''''' - channel ID | + | **'''''<band>''''' - frequency band used |
| + | **'''''<channel>''''' - channel ID |
| | | |
| | | |
Line 537: |
Line 568: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * | + | |
| + | * |
| | | |
| | | |
Line 554: |
Line 586: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * | + | |
| + | * |
| | | |
| | | |
Line 571: |
Line 604: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * OK | + | |
| + | *OK |
| | | |
| | | |
Line 591: |
Line 625: |
| ... | | ... |
| '''Possible responses''': | | '''Possible responses''': |
− | * a list of options that can be used with ''gsmctl'' | + | |
| + | *a list of options that can be used with ''gsmctl'' |
| | | |
| | | |
Line 608: |
Line 643: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * a string type output indicating the ''gsmctl'' version | + | |
| + | *a string type output indicating the ''gsmctl'' version |
| | | |
| ==SMS management options== | | ==SMS management options== |
Line 631: |
Line 667: |
| Status: read | | Status: read |
| Text: Hello | | Text: Hello |
− | </span>
| |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * five lines of string type output indicating the following information related to the SMS message: | + | |
− | ** Index - an integer number indicating the position of the message in the SMS message list | + | *five lines of string type output indicating the following information related to the SMS message: |
− | ** Date - the date the message was received | + | **Index - an integer number indicating the position of the message in the SMS message list |
− | ** Sender - sender's phone number | + | **Date - the date the message was received |
− | ** Status - indicates whether the message has been previously read. (Possible values: ''read'' or ''new'') | + | **Sender - sender's phone number |
− | ** Text - the body of the message | + | **Status - indicates whether the message has been previously read. (Possible values: ''read'' or ''new'') |
− | * no message - indicates that an SMS message with the specified ''<INDEX>'' does not exist | + | **Text - the body of the message |
− | * out of range - indicates that the specified ''<INDEX>'' is out of range of the SMS message list | + | *no message - indicates that an SMS message with the specified ''<INDEX>'' does not exist |
| + | *out of range - indicates that the specified ''<INDEX>'' is out of range of the SMS message list |
| | | |
| | | |
Line 663: |
Line 699: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * multiple entries comprised of five lines of string type output indicating the following information related to an SMS message: | + | |
− | ** Index - an integer number indicating the position of the message in the SMS message list | + | *multiple entries comprised of five lines of string type output indicating the following information related to an SMS message: |
− | ** Date - the date the message was received | + | **Index - an integer number indicating the position of the message in the SMS message list |
− | ** Sender - sender's phone number | + | **Date - the date the message was received |
− | ** Text - the body of the message | + | **Sender - sender's phone number |
− | ** Status - indicates whether the message has been previously read. (Possible values: ''read'' or ''new'') | + | **Text - the body of the message |
| + | **Status - indicates whether the message has been previously read. (Possible values: ''read'' or ''new'') |
| | | |
| | | |
Line 687: |
Line 724: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * two lines of string type output | + | |
− | ** Used - used memory space (integer) | + | *two lines of string type output |
− | ** Total - total memory space (integer) | + | **Used - used memory space (integer) |
| + | **Total - total memory space (integer) |
| | | |
| | | |
Line 707: |
Line 745: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * OK - indicates that the message with specified <INDEX> has been deleted successfully | + | |
− | * out of range - indicates that the specified <INDEX> is out of range of the SMS message list | + | *OK - indicates that the message with specified <INDEX> has been deleted successfully |
| + | *out of range - indicates that the specified <INDEX> is out of range of the SMS message list |
| | | |
| | | |
Line 726: |
Line 765: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
− | * | + | |
| + | * |
| | | |
| | | |
Line 744: |
Line 784: |
| | | |
| '''Possible responses''': | | '''Possible responses''': |
| + | |
| * | | * |
| | | |
Line 764: |
Line 805: |
| ==See also== | | ==See also== |
| | | |
− | * [[AT Commands]] | + | *[[AT Commands]] |