9,312
edits
Changes
Template:Networking rutos manual mobile utilities (view source)
Revision as of 17:38, 16 December 2021
, 17:38, 16 December 2021no edit summary
{{Template:Networking_rutos_manual_fw_disclosure
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05.1
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| series = {{{series}}}
}}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} SMS Utilities (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} SMS Utilities (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==
{{{name}}} routers have an extensive amount of various SMS control utilities. SMS Utilities can be used to set/get
The <b>Mobile Utilities</b> page is used to configure various SMS and Call related device control options and to read, send and manage SMS messages and SMS storage space.
This manual page provides an overview of the Mobile Utilities page in {{{name}}} devices.
==SMS Utilities==
==SMS Utilities==
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_sms_rules.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_sms_rules.png|border|class=tlt-border]]
The entire list contains more than 20 rules, but it does not all possible SMS action. You can also create custom rules or modify existing rules. All possible SMS rule actions, their default SMS texts and descriptions are listed in the table below.
The entire list contains more than 20 rules, but it does not include all possible SMS actions. You can also create custom rules or modify existing rules. All possible SMS rule actions, their default SMS texts and descriptions are listed in the table below.
<table class="nd-othertables_2" style="width: 100%;">
<table class="nd-othertables_2" style="width: 100%;">
<td><i>cellular</i></td>
<td><i>cellular</i></td>
<td>Is used to configure the device's mobile data connection. [[#Change_mobile_settings_.28cellular.29_rule|Click here]] for more information on this rule.</td>
<td>Is used to configure the device's mobile data connection. [[#Change_mobile_settings_.28cellular.29_rule|Click here]] for more information on this rule.</td>
<tr>
<td><b>Change profile</b></td>
<td><i>no default text</i></td>
<td>Is used to change profiles on the device. Include the name of the profile that you wish to change to after the rule's SMS text, for example if SMS text is set to <i>changeprof</i>:
<ul>
<li><i>changeprof default</i></li>
<li><i>changeprof custom</i></li>
</ul>
</td>
</tr>
</tr>{{#ifeq: {{{dualsim}}} | 1 |
</tr>{{#ifeq: {{{dualsim}}} | 1 |
<tr>
<tr>
<td><i>profdisp</i></td>
<td><i>profdisp</i></td>
<td>Sends a list of configuration profiles existing on the device.</td>
<td>Sends a list of configuration profiles existing on the device.</td>
</tr>
</tr>{{#ifeq: {{{gps}}} | 1 |
<tr>
<tr>
<td><b>GPS control</b></td>
<td><b>GPS control</b></td>
<td><i>gps</i></td>
<td><i>gps</i></td>
<td>Sends the device's current GPS coordinates.</td>
<td>Sends the device's current GPS coordinates.</td>
</tr>
</tr>|}}
<tr>
<tr>
<td><b>IP unblock</b></td>
<td><b>IP unblock</b></td>
<ul>
<ul>
<li><i>ipunblock</i> - clears the block list (unblocks Web/SSH access for all previously blocked devices).</li>
<li><i>ipunblock</i> - clears the block list (unblocks Web/SSH access for all previously blocked devices).</li>
<li><i>ipunblock 192.168.1.2</i> - removes this IP address from the block list (unblock Web/SSH access for that device).</li>
<li><i>ipunblock 192.168.1.2</i> - removes this IP address from the block list (unblocks Web/SSH access for that device).</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
<tr>
<tr>
<td><b>Mobile data limit status</b></td>
<td><b>Mobile Data limit status</b></td>
<td><i>no default text</i></td>
<td><i>no default text</i></td>
<td>Sends a status report message that includes data limit usage information for mobile network interfaces (that have [[{{{name}}}_Interfaces#Mobile_Data_Limit|Mobile Data Limit]] enabled) </td>
<td>Sends a status report message that includes data limit usage information for mobile network interfaces (that have [[{{{name}}}_Interfaces#Mobile_Data_Limit|Mobile Data Limit]] enabled) </td>
</tr>
<tr>
<td><b>Mobile Data usage reset</b></td>
<td><i>no default text</i></td>
<td>Resets mobile data usage for specified interface.</td>
</tr>
</tr>
<tr>
<tr>
<td><b>UCI API</b></td>
<td><b>UCI API</b></td>
<td><i>uci</i></td>
<td><i>uci</i></td>
<td>Is used to change the configuration settings on the device. [[Click here|#UCI_API_rule]] for more information on the UCI API rule.</td>
<td>Is used to change the configuration settings on the device. [[#UCI_API_rule|Click here]] for more information on the UCI API rule.</td>
</tr>
<tr>
<td><b>Restore to user's defaults</b></td>
<td><i>userdefaults</i></td>
<td>Restores user's default configuration on the device. [[{{{name}}}_Backup#Create_default_configuration|Click here]] for more information on User's default configuration.</td>
</tr>
</tr>
<tr>
<tr>
<b>General settings</b>
<b>General settings</b>
----
----
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general_{{{dualmodem}}}.png|border|class=tlt-border]]
<ol>
<ol>
<li>The <b>Get status via SMS after reboot</b> slider specifies whether the device should send a status report message after an action is executed. The name of this slider may differ from rule to rule and it is only available for some rules.</li>
<li>The <b>Get status via SMS after reboot</b> slider specifies whether the device should send a status report message after an action is executed. The name of this slider may differ from rule to rule and it is only available for some rules.</li>
<li>The <b>Send status SMS to other number</b> slider specifies whether the device should send a status report message to another number (besides the original sender). Setting this slider to 'on' will prompt you to enter an additional phone number(s) of the status message recipient(s).</li>
<li>The <b>Send status SMS to other number</b> slider specifies whether the device should send a status report message to another number (besides the original sender). Setting this slider to 'on' will prompt you to enter an additional phone number(s) of the status message recipient(s).</li>
{{#ifeq: {{{dualmodem}}} | 1 |<li>The <b>Modem</b> option is used to specify which modem to get<nowiki>/</nowiki>set information to<nowiki>/</nowiki>from.</li>
<li>The <b>Gateway modem</b> option is used to specify which modem to use for sending SMS.</li>|}}
<li>The <b>Message text</b> box is used to modify the text that should be included in an SMS rule's response message.</li>
<li>The <b>Message text</b> box is used to modify the text that should be included in an SMS rule's response message.</li>
</ol>
</ol>
The <b>Change mobile settings</b> rule is used to change the configuration settings of the mobile data connection. The usage of this rule is a bit more complex because the SMS text in and of itself does nothing, as you must also specify the parameters and values that you wish to set. For example, you can send a message that will change your APN only or a message that will change multiple parameters at once.
The <b>Change mobile settings</b> rule is used to change the configuration settings of the mobile data connection. The usage of this rule is a bit more complex because the SMS text in and of itself does nothing, as you must also specify the parameters and values that you wish to set. For example, you can send a message that will change your APN only or a message that will change multiple parameters at once.
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}_{{{dualmodem}}}.png|border|class=tlt-border]]
Below is the full list of parameters that can be changed with this rule.
Below is the full list of parameters that can be changed with this rule.
<td>Sets APN.</td>
<td>Sets APN.</td>
<td><i>cellular apn=internet</i></td>
<td><i>cellular apn=internet</i></td>
</tr>
<tr>
<td><b>auto_apn=</b></td>
<td>Turns auto APN on or off. Possible values are 0/1.</td>
<td><i>cellular auto_apn=1</i></td>
</tr>
</tr>
<tr>
<tr>
<td>Sets the service mode. Possible values are:
<td>Sets the service mode. Possible values are:
<ul>
<ul>
<li>3gonly</li>
{{#ifeq:{{{2g}}}|1|<li>2g</li>|}}
<li>4gonly</li>
{{#ifeq:{{{3g}}}|1|<li>3g</li>|}}
{{#ifeq:{{{4g}}}|1|<li>lte</li>|}}
<li>auto</li>
<li>auto</li>
</ul>
</ul>
Each example above contains a single parameter but you can also send out multiple parameters in one message. For example:
Each example above contains a single parameter but you can also send out multiple parameters in one message. For example:
cellular apn=internet service=3gonly
cellular apn=internet service=3g
This message would set your APN to "internet" and the service mode of the mobile connection to "3G Only". You can also send a message that would include all of the parameters above:
This message would set your APN to "internet" and the service mode of the mobile connection to "3G Only". You can also send a message that would include all of the parameters above:
cellular apn=internet dialnumber=*99***1# auth_mode=pap service=3gonly username=user password=pass roaming=0
cellular apn=internet auth_mode=pap service=3g username=user password=pass roaming=0
<b>Note:</b> only "apn=" or "auto_apn=" is required in a message. For example, to set custom APN:
cellular apn=internet
or if you want to turn auto APN on:
cellular auto_apn=1
===UCI API rule===
===UCI API rule===
<td><li><i>uci show network.lan</i></li>Returns the configuration of the "lan" section from the "network" config file.</td>
<td><li><i>uci show network.lan</i></li>Returns the configuration of the "lan" section from the "network" config file.</td>
</tr>
</tr>
<!--
<tr>
<tr>
<td>uci <b>delete</b> <config>.<section></td>
<td>uci <b>delete</b> <config>.<section></td>
<td><li><i>uci delete dhcp.lan.force</i></li>Deletes the "force" option for DHCP server of the "lan" interface (which in turn disables the "Force DHCP" function of that DHCP server).</td>
<td><li><i>uci delete dhcp.lan.force</i></li>Deletes the "force" option for DHCP server of the "lan" interface (which in turn disables the "Force DHCP" function of that DHCP server).</td>
</tr>
</tr>
-->
</table>
</table>
<b>Post/Get</b> allows you to perform action requests by writing them in the URL after your device’s IP address.
<b>Post/Get</b> allows you to perform action requests by writing them in the URL after your device’s IP address.
[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_post_get_dualmodem_{{{dualmodem}}}.png]]
[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_post_get_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Send mobile message</td>
<td>Send mobile message to a single number</td>
<td>http://<span
<td>http://<span
style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage
style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&number=0037060000001&text=testmessage
</td>
</tr>
<tr>
<td>Send mobile message to a group</td>
<td>http://<span
style="color: black;">192.168.1.1</span>/cgi-bin/sms_send?username=user1&password=user_pass&group=group_name&text=testmessage
</td>
</td>
</tr>
</tr>
<b>Auto reply</b> allows you to configure automatic replying to SMS messages that the router receives.
<b>Auto reply</b> allows you to configure automatic replying to SMS messages that the router receives.
[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_auto_reply_dualmodem_{{{dualmodem}}}.png]]
[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_auto_reply_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>Field name</th>
<th>Field</th>
<th>Value</th>
<th>Value</th>
<th>Description</th>
<th>Description</th>
For example, a valid number would be <b>0037012345678</b> (370 is country code and 12345678 is the receiver's phone number, all preceded by 00)
For example, a valid number would be <b>0037012345678</b> (370 is country code and 12345678 is the receiver's phone number, all preceded by 00)
===SMPP===
----
<b>Short Message Peer-to-Peer</b> (<b>SMPP</b>) is a protocol used for exchanging SMS messages between Short Message Service Centers (SMSC) and/or External Short Messaging Entities (ESME). The figure below is an example of the SMPP section and the table below provides information on the configuration fields contained in that section:
[[File:Networking_rutos_manual_mobile_utilities_sms_gateway_smpp_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>Turns SMPP on or off.</td>
</tr>
<tr>
<td>User name</td>
<td>string; default: <b>admin</b></td>
<td>User name used for authentication on the SMPP server.</td>
</tr>
<tr>
<td>Password</td>
<td>string; default: <b>admin01</b></td>
<td>Password used for authentication on the SMPP server.</td>
</tr>
<tr>
<td>Server port</td>
<td>integer [0..65535]; default: <b>2775</b></td>
<td>SMPP server port.</td>
</tr>{{#ifeq: {{{dualmodem}}} | 1 |
<tr>
<td>Modem</td>
<td>Primary modem <nowiki>|</nowiki> Secondary modem; default: <b>Primary modem</b></td>
<td>Modem that will be used for SMPP server communications.</td>
</tr>|}}
</table>
{{#ifeq:{{{name}}}| TRB255| |
{{#ifeq:{{{name}}}| TRB255| |
==Call Utilities==
==Call Utilities==
Just like SMS Utilities, Call Utilities provide you with the possibility to issue certain commands to the router from
Just like SMS Utilities, Call Utilities provide you with the possibility to issue certain commands to the router from your mobile phone. The list of possible rules is of course shorter because you can only make one type of call. Keep that in mind when creating Call Utilities rules because one call will trigger all of the enabled rules at once.
your mobile phone. The list of possible rules is of course shorter because you can only make one type of call. Keep that
in mind when creating Call Utilities rules because one call will trigger all of the enabled rules at once.
===Call Rules===
===Call Rules===
----
----
To create a new rule, select an 'Action' and click the 'Add' button. The new rule will appear in the 'Call Rules' list. Click the 'Edit' button next to it to configure the rule.
To create a new rule, select an 'Action' and click the 'Add' button. After this, a new configuration window should appear.
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_edit_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_general.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_authorization.png|border|class=tlt-border]]
}}
===Incoming Calls===
----
Call Configuration also has similar Authorization settings.
This option specifies the action to be performed on incoming calls. Call utilities rules will keep getting executed while the call is active.
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_authorization.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_incoming_calls.png|border|class=tlt-border]]
==Messages==
==Messages==
With the help of the '''Messages''' window you can read and send SMS messages.
With the help of the <b>Messages</b> window you can read and send SMS messages.
===Read SMS===
===Read SMS===
----
----
In the '''Read SMS''' tab you can read and delete received/stored SMS messages. The layout is simple, there is a list of received SMS messages and you can choose how many entries of that list should be visible at one time with SMS per page drop box in the top left corner of the page and there is a Search field to help you navigate more efficiently through the list of messages in the top right corner of the page.
In the <b>Read SMS</b> section you can read and delete received/stored SMS messages. The layout is simple, there is a list of received SMS messages and you can choose how many entries of that list should be visible at one time with SMS per page drop box in the top left corner of the page and there is a Search field to help you navigate more efficiently through the list of messages in the top right corner of the page.
[[File:Networking_rutos_manual_mobile_utilities_messages_read_messages_dualmodem_1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_messages_read_messages_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
===Send Messages===
===Send Messages===
----
----
The Send Messages tab let's you send SMS messages from the router‘s SIM card.
The <b>Send Messages</b> section lets you send SMS messages from the router‘s SIM card.
[[File:Networking_rutos_manual_mobile_utilities_messages_send_messages_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mobile_utilities_messages_send_messages_dualmodem_{{{dualmodem}}}.png|border|class=tlt-border]]
All you have to do is enter the recipient’s phone number, type in your message and hit the '''Send''' button.
All you have to do is enter the recipient’s phone number, type in your message and hit the <b>Send</b> button.
===Storage===
===Storage===
</tr>
</tr>
<tr>
<tr>
<td>Save messages on SIM</td>
<td>Save messages to</td>
<td>off | on; default: <b>on</b></td>
<td>SIM card | Modem storage; default: <b>SIM card</b></td>
<td>If this is enabled, messages from SIM card will not be removed after they have been read</td>
<td>Specify location where to save messages</td>
</tr>
</tr>
<tr>
<tr>
<td>Memory</td>
<td>-</td>
<td>SIM card memory</td>
<td> -</td>
<td>Information about used/available SIM card memory</td>
<td>Information about used/available SIM card memory</td>
</tr>
</tr>
<tr>
<tr>
<td>Leave free space</td>
<td>Leave free space</td>
<td>default: '''5'''</td>
<td>integer; default: <b>5</b></td>
<td>How much memory (number of messages) should be left free</td>
<td>How much memory (number of messages) should be left free</td>
</tr>
</tr>
