Changes

no edit summary
Line 1: Line 1: −
{{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.
configurations, monitor and issue commands to the router.
+
 
 +
This manual page provides an overview of the Mobile Utilities page in {{{name}}} devices.
    
==SMS Utilities==
 
==SMS Utilities==
Line 14: Line 18:  
[[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%;">
Line 24: Line 28:  
     <tr>
 
     <tr>
 
         <td><b>Change I/O state</b></td>
 
         <td><b>Change I/O state</b></td>
         <td>ioset</td>
+
         <td><i>ioset</i></td>
 
         <td>Changes the state of a selected output.</td>
 
         <td>Changes the state of a selected output.</td>
 
     </tr>|}}
 
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><b>Change mobile settings</b></td>
 
         <td><b>Change mobile settings</b></td>
         <td>cellular</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><b>Force SIM switch</b></td>
 
         <td><b>Force SIM switch</b></td>
         <td>switch_sim</td>
+
         <td><i>switch_sim</i></td>
 
         <td>Switches from using one SIM card to another.</td>
 
         <td>Switches from using one SIM card to another.</td>
 
     </tr>|}}
 
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><b>FW upgrade from server</b></td>
 
         <td><b>FW upgrade from server</b></td>
         <td>fw_upgrade</td>
+
         <td><i>fw_upgrade</i></td>
 
         <td>Upgrades the device's firmware (provided a new version is available on the FOTA server).</td>
 
         <td>Upgrades the device's firmware (provided a new version is available on the FOTA server).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Get list of profiles</b></td>
 
         <td><b>Get list of profiles</b></td>
         <td>profdisp</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>gpson</td>
+
         <td><i>gpson</i></td>
 
         <td>Turns GPS on.</td>
 
         <td>Turns GPS on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>GPS coordinates</b></td>
 
         <td><b>GPS coordinates</b></td>
         <td>gps</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>
         <td>ipunblock</td>
+
         <td><i>ipunblock</i></td>
 
         <td>Unblocks Web/SSH access for devices that were blocked for too many unsuccessful connection attempts. Send the SMS text to unblock all blocked devices or include the IP address of a single blocked device after the SMS text. For example:
 
         <td>Unblocks Web/SSH access for devices that were blocked for too many unsuccessful connection attempts. Send the SMS text to unblock all blocked devices or include the IP address of a single blocked device after the SMS text. For example:
 
             <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>
Line 69: Line 83:  
     <tr>
 
     <tr>
 
         <td><b>I/O status</b></td>
 
         <td><b>I/O status</b></td>
         <td>iostatus</td>
+
         <td><i>iostatus</i></td>
 
         <td>Sends a status report message on the state of the device's inputs and outputs.</td>
 
         <td>Sends a status report message on the state of the device's inputs and outputs.</td>
 
     </tr>|}}
 
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><b>Manage OpenVPN</b></td>
 
         <td><b>Manage OpenVPN</b></td>
         <td>vpnon</td>
+
         <td><i>vpnon</i></td>
 
         <td>Turns a selected OpenVPN instance on. Include the name of the OpenVPN instance that you wish to turn on after the rule's SMS text:
 
         <td>Turns a selected OpenVPN instance on. Include the name of the OpenVPN instance that you wish to turn on after the rule's SMS text:
 
             <ul>
 
             <ul>
Line 84: Line 98:  
     <tr>
 
     <tr>
 
         <td><b>Manage OpenVPN</b></td>
 
         <td><b>Manage OpenVPN</b></td>
         <td>vpnoff</td>
+
         <td><i>vpnoff</i></td>
 
         <td>Turns a selected OpenVPN instance off. Include the name of the OpenVPN instance that you wish to turn off after the rule's SMS text:
 
         <td>Turns a selected OpenVPN instance off. Include the name of the OpenVPN instance that you wish to turn off after the rule's SMS text:
 
             <ul>
 
             <ul>
Line 93: Line 107:  
     </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>Monitoring status</b></td>
 
         <td><b>Monitoring status</b></td>
         <td>monitoring_status</td>
+
         <td><i>monitoring_status</i></td>
 
         <td>Sends a status report message that includes the RMS connection type, state and the device serial number and MAC address.</td>
 
         <td>Sends a status report message that includes the RMS connection type, state and the device serial number and MAC address.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>More</b></td>
 
         <td><b>More</b></td>
         <td>more</td>
+
         <td><i>more</i></td>
 
         <td>Displays next part of a composite response message (more than 160 characters).</td>
 
         <td>Displays next part of a composite response message (more than 160 characters).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>OpenVPN status</b></td>
 
         <td><b>OpenVPN status</b></td>
         <td>vpnstatus</td>
+
         <td><i>vpnstatus</i></td>
 
         <td>Sends a status report message on all OpenVPN connections.</td>
 
         <td>Sends a status report message on all OpenVPN connections.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Reboot</b></td>
 
         <td><b>Reboot</b></td>
         <td>reboot</td>
+
         <td><i>reboot</i></td>
 
         <td>Reboots the device.</td>
 
         <td>Reboots the device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Restore to default</b></td>
 
         <td><b>Restore to default</b></td>
         <td>restore</td>
+
         <td><i>restore</i></td>
 
         <td>Restores factory settings on the device.</td>
 
         <td>Restores factory settings on the device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>RMS action</b></td>
 
         <td><b>RMS action</b></td>
         <td>rms_on</td>
+
         <td><i>rms_on</i></td>
 
         <td>Turns RMS connection on.</td>
 
         <td>Turns RMS connection on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>RMS action</b></td>
 
         <td><b>RMS action</b></td>
         <td>rms_off</td>
+
         <td><i>rms_off</i></td>
 
         <td>Turns RMS connection off.</td>
 
         <td>Turns RMS connection off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>RMS connect</b></td>
 
         <td><b>RMS connect</b></td>
         <td>rms_connect</td>
+
         <td><i>rms_connect</i></td>
 
         <td>Forces the device to connect to RMS. This action is analogous to clicking the 'Connect' button in the Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS page]].</td>
 
         <td>Forces the device to connect to RMS. This action is analogous to clicking the 'Connect' button in the Cloud Solutions → [[{{{name}}}_Cloud_Solutions#RMS|RMS page]].</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>RMS status</b></td>
 
         <td><b>RMS status</b></td>
         <td>rms_status</td>
+
         <td><i>rms_status</i></td>
 
         <td>Sends a status report message on the state of the connection to RMS.</td>
 
         <td>Sends a status report message on the state of the connection to RMS.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Send status</b></td>
 
         <td><b>Send status</b></td>
         <td>status</td>
+
         <td><i>status</i></td>
 
         <td>Sends a status report message.</td>
 
         <td>Sends a status report message.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>SSH access control</b></td>
 
         <td><b>SSH access control</b></td>
         <td>sshon</td>
+
         <td><i>sshon</i></td>
 
         <td>Turns remote and local (by default) SSH access on. This rule can be modified to only include local SSH access.</td>
 
         <td>Turns remote and local (by default) SSH access on. This rule can be modified to only include local SSH access.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>SSH access control</b></td>
 
         <td><b>SSH access control</b></td>
         <td>sshoff</td>
+
         <td><i>sshoff</i></td>
 
         <td>Turns SSH access off.</td>
 
         <td>Turns SSH access off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Switch mobile data</b></td>
 
         <td><b>Switch mobile data</b></td>
         <td>mobileon</td>
+
         <td><i>mobileon</i></td>
 
         <td>Turns mobile data usage on.</td>
 
         <td>Turns mobile data usage on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Switch mobile data</b></td>
 
         <td><b>Switch mobile data</b></td>
         <td>mobileoff</td>
+
         <td><i>mobileoff</i></td>
 
         <td>Turns mobile data usage off.</td>
 
         <td>Turns mobile data usage off.</td>
 
     </tr>{{#ifeq: {{{wifi}}} | 1 |
 
     </tr>{{#ifeq: {{{wifi}}} | 1 |
 
     <tr>
 
     <tr>
 
         <td><b>Switch WiFi</b></td>
 
         <td><b>Switch WiFi</b></td>
         <td>wifion</td>
+
         <td><i>wifion</i></td>
 
         <td>Turns the WiFi radio on.</td>
 
         <td>Turns the WiFi radio on.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Switch WiFi</b></td>
 
         <td><b>Switch WiFi</b></td>
         <td>wifioff</td>
+
         <td><i>wifioff</i></td>
 
         <td>Turns the WiFi radio off.</td>
 
         <td>Turns the WiFi radio off.</td>
 
     </tr>|}}
 
     </tr>|}}
 
     <tr>
 
     <tr>
 
         <td><b>UCI API</b></td>
 
         <td><b>UCI API</b></td>
         <td>uci</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>
 
         <td><b>Wake on LAN</b></td>
 
         <td><b>Wake on LAN</b></td>
         <td>wakeup</td>
+
         <td><i>wakeup</i></td>
 
         <td>Sends a magic packet that "wakes up" a specified device from standby mode. If you have multiple Wake-on-LAN-capable devices, you will have to create a separate rule with a different SMS text for each one. Configuration for each device must include the MAC address of that device.</td>
 
         <td>Sends a magic packet that "wakes up" a specified device from standby mode. If you have multiple Wake-on-LAN-capable devices, you will have to create a separate rule with a different SMS text for each one. Configuration for each device must include the MAC address of that device.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Web access control</b></td>
 
         <td><b>Web access control</b></td>
         <td>webon</td>
+
         <td><i>webon</i></td>
 
         <td>Turns remote and local (by default) HTTP and HTTPS access on. This rule can be modified to only include local HTTP/HTTPS access.</td>
 
         <td>Turns remote and local (by default) HTTP and HTTPS access on. This rule can be modified to only include local HTTP/HTTPS access.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td><b>Web access control</b></td>
 
         <td><b>Web access control</b></td>
         <td>weboff</td>
+
         <td><i>weboff</i></td>
 
         <td>Turns HTTP and HTTPS access off. This rule can also modified to turn of either HTTP or HTTPS separately.</td>
 
         <td>Turns HTTP and HTTPS access off. This rule can also modified to turn of either HTTP or HTTPS separately.</td>
 
     </tr>
 
     </tr>
Line 211: Line 235:  
===Modify SMS Rule===
 
===Modify SMS Rule===
 
----
 
----
Every SMS rule can be edited to your liking. If a rule does not meet your requirements, click the click the 'Edit' button next to it. Below are examples of what the configuration page for the <i>reboot</i> rule looks like.
+
Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button located next to it:
 +
 
 +
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_edit_button.png|border|class=tlt-border]]
 +
 
 +
After this you should redirected to configuration page for that rule. Below are examples of what the configuration page for the <i>reboot</i> rule looks like.
    
<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>
Line 223: Line 251:  
     <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>
Line 237: Line 267:  
Most rules are configured in a similar manner. However, the configuration does differ from rule to rule, depending on a rule's purpose (selected 'Action'). If you run into trouble when configuring a rule, hover your mouse cursor over the name of a field to see a hint that explains what that field does.
 
Most rules are configured in a similar manner. However, the configuration does differ from rule to rule, depending on a rule's purpose (selected 'Action'). If you run into trouble when configuring a rule, hover your mouse cursor over the name of a field to see a hint that explains what that field does.
   −
===Change mobile data settings (cellular) rule===
+
===Change mobile settings (cellular) rule===
 
----
 
----
The Change mobile data settings rule is exceptional to most of the other rules as it does not perform a single action like turning specific services On/Off or getting status updates. It designed to change mobile data settings and it's '''SMS text''' can't be described by a single string because the message depends on what configurations you want to change. For example, you can send a message that will change your APN only, you can send a message that will change APN and mobile service mode, or even a message that will change every single mobile setting.
+
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}}}_{{{dualmodem}}}.png|border|class=tlt-border]]
 +
 
 +
Below is the full list of parameters that can be changed with this rule.
   −
<table class="nd-mantable">
+
<table class="nd-othertables_2" style="width: 100%;">
 
     <tr>
 
     <tr>
         <th>Field</th>
+
         <th width=20%>Parameter</th>
         <th>Description</th>
+
         <th width=50%>Description</th>
         <th>Explanation</th>
+
         <th width=30%>SMS text example</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable</td>
+
         <td><b>apn=</b></td>
         <td>This check box will enable or disable the Change mobile data settings function</td>
+
         <td>Sets APN.</td>
         <td>Allows you to change mobile settings via SMS</td>
+
         <td><i>cellular apn=internet</i></td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Action</td>
+
         <td><b>auto_apn=</b></td>
         <td>The action to be performed when this rule is met.</td>
+
         <td>Turns auto APN on or off. Possible values are 0/1.</td>
         <td>Changes the specified mobile settings</td>
+
         <td><i>cellular auto_apn=1</i></td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>SMS text</td>
+
         <td><b>dialnumber=</b></td>
         <td>SMS text that will trigger the rule</td>
+
         <td>Sets Dialing number.</td>
         <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter. default: '''cellular'''. '''Detailed explanations on how to use this function are presented in the table below'''</td>
+
         <td><i>cellular dialnumber=*99***1#</i></td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Authorization method</td>
+
         <td><b>auth_mode=</b></td>
        <td>What kind of authorization to use for SIM management</td>
+
         <td>Sets the authentication method. Possible values are:
         <td>Possible values:
+
            <ul>
        <li>No authorization</li>
+
                <li><i>none</i></li>
        <li>By serial</li>
+
                <li><i>pap</i></li>
        <li>By router admin password; default: '''By router admin password'''</li>
+
                <li><i>chap</i></li>
 +
            </ul>
 
         </td>
 
         </td>
 +
        <td><i>cellular auth_method=pap</i></td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Allowed users</td>
+
         <td><b>service=</b></td>
        <td>White list of allowed users</td>
+
         <td>Sets the service mode. Possible values are:
         <td>Possible values:
+
            <ul>
        <li>From all numbers</li>
+
                {{#ifeq:{{{2g}}}|1|<li>2g</li>|}}
        <li>From group</li>
+
                {{#ifeq:{{{3g}}}|1|<li>3g</li>|}}
        <li>From single number; default: '''From all numbers'''</li>
+
                {{#ifeq:{{{4g}}}|1|<li>lte</li>|}}
 +
                <li>auto</li>
 +
            </ul>
 
         </td>
 
         </td>
 +
        <td><i>cellular service=auto</i></td>
 
     </tr>
 
     </tr>
</table>
  −
  −
The default '''SMS text''' for the Change mobile data settings rule is '''cellular''' but it is only an indication text and does not include any specific parameters to be changed. The list of parameters that can be changed and explanations on how to incorporate them into the '''"cellular"''' message is presented in the table below.
  −
  −
<table class="nd-mantable" >
   
     <tr>
 
     <tr>
         <th>Parameter</th>
+
         <td><b>username=</b></td>
         <th>Value</th>
+
         <td>Sets the user name for PAP or CHAP authentication.</td>
         <th>Description</th>
+
         <td><i>cellular username=user</i></td>
        <th>Default message example</th>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>apn=</td>
+
         <td><b>password=</b></td>
        <td>e.g., internet</td>
+
         <td>Sets the password for PAP or CHAP authentication.</td>
         <td>Sets APN</td>
+
         <td><i>cellular password=pass</i></td>
         <td>'''cellular apn=internet'''</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>dialnumber=</td>
+
         <td><b>roaming=</b></td>
        <td>e.g., *99***1#</td>
+
         <td>Turns mobile data roaming on or off.  Possible values are:
        <td>Sets Dialing number</td>
+
            <ul>
         <td>'''cellular dialnumber=*99***1#'''</td>
+
                <li><i>0</i> - for off.</li>
    </tr>
+
                <li><i>1</i> - for on.</li>
    <tr>
+
            </ul>
        <td>auth_mode=</td>
  −
        <td>
  −
        <li>none</li>
  −
        <li>pap</li>
  −
        <li>chap</li>
  −
        </td>
  −
        <td>Sets Authentication method</td>
  −
        <td>'''cellular auth_method=pap'''</td>
  −
    </tr>
  −
    <tr>
  −
        <td>service=</td>
  −
        <td>
  −
        <li>3gonly</li>
  −
        <li>4gonly</li>
  −
        <li>auto</li>
   
         </td>
 
         </td>
         <td>Sets the mobile Service mode</td>
+
         <td><i>cellular roaming=0</i></td>
        <td>'''cellular service=auto'''</td>
  −
    </tr>
  −
    <tr>
  −
        <td>username=</td>
  −
        <td>e.g., user</td>
  −
        <td>Sets the user name for PAP or CHAP authentication</td>
  −
        <td>'''cellular username=user'''</td>
  −
    </tr>
  −
    <tr>
  −
        <td>password=
  −
        <td>e.g., pass</td>
  −
        <td>Sets the password for PAP or CHAP authentication</td>
  −
        <td>'''cellular password=pass'''</td>
  −
    </tr>
  −
    <tr>
  −
        <td>roaming=</td>
  −
        <td>'''0''' for OFF; '''1''' for ON</td>
  −
        <td>Turn Mobile data roaming ON or OFF</td>
  −
        <td>'''cellular roaming=0'''</td>
   
     </tr>
 
     </tr>
 
</table>
 
</table>
   −
Each of the above examples contain a single parameter but you can send out multiple parameters in one message. For example, '''"cellular apn=internet service=3gonly"'''. This message would set your APN to "internet" and your Service mode 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"'''
+
Each example above contains a single parameter but you can also send out multiple parameters in one message. For example:
 +
 
 +
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:
 +
 
 +
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===
 
----
 
----
The <b>UCI API</b> rule lets you set or get any parameter from the router's configuration files.
+
The <b>UCI API</b> rule is used to configure any parameters on the device.
 +
 
 +
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_uci.png|border|class=tlt-border]]
 +
----
 +
The following are syntax examples for the UCI API rule:
   −
<table class="nd-mantable">
+
<table class="nd-othertables_2" style="width: 100%;">
 
     <tr>
 
     <tr>
         <th>Field</th>
+
         <th width=30%>Structure example</th>
         <th>Description</th>
+
         <th width=35%>Description</th>
         <th>Explanation, notes</th>
+
         <th width=35%>SMS text example</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable</td>
+
         <td>uci <b>get</b> <config>.<section>.<option_name></td>
         <td>This will enable or disable the UCI API function</td>
+
         <td>Returns the value of a single configuration option.</td>
         <td>Allows you to set or get any configurations from the router</td>
+
         <td><li><i>uci get network.wan.ipaddr</i></li>Returns the router's WAN IP address.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Action</td>
+
         <td>uci <b>set</b> <config>.<section>.<option_name>="value"</td>
         <td>The action to be performed when this rule is met.</td>
+
         <td>Sets the value of a specified configuration option.</td>
         <td>Sets or sends you any specified configurations of the router</td>
+
         <td><li><i>uci set network.mobile.apn=example</i></li>Changes mobile APN value to "example".</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>SMS text</td>
+
         <td>uci <b>show</b> <config></td>
        <td>SMS text that will trigger the rule</td>
+
         <td>Returns the contents of a config file</td>
        <td>SMS text can contain letters, numbers, spaces and special symbols. Capital letters also matter'''Detailed explanations on how to use this function are presented in the table below'''</td>
+
         <td><li><i>uci show openvpn</i></li>Returns the contents of the "openvpn" config file.</td>
    </tr>
  −
    <tr>
  −
         <td>Modem</td>
  −
         <td>Select which modem you want to use</td>
  −
        <td>Which modem is configured</td>
  −
    </tr>
  −
    <tr>
  −
        <td>Authorization method</td>
  −
        <td>What kind of authorization to use for SIM management</td>
  −
        <td>Possible values: No authorization | By serial | By router admin password; default: '''By router admin password'''</td>
  −
    </tr>
  −
    <tr>
  −
        <td>Allowed users</td>
  −
        <td>White list of allowed users</td>
  −
        <td>Possible values: From all numbers | From group | From single number; default: '''From all numbers'''</td>
  −
</table>
  −
 
  −
The following are syntax examples for the UCI API rule:
  −
 
  −
<table class="nd-mantable">
  −
    <tr>
  −
        <th>Field</th>
  −
        <th>Description</th>
  −
        <th>Explanation, notes</th>
  −
    </tr>
  −
    <tr>
  −
        <td>uci get config.section.option"</td>
  −
        <td>Returns config option value</td>
  −
        <td>'''uci get network.wan.ipaddr''' - returns the router's WAN IP address</td>
   
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>uci set config.section.option="value"</td>
+
         <td>uci <b>show</b> <config>.<section></td>
         <td>Sets config option</td>
+
         <td>Returns the exact part (section) of a config file.</td>
         <td>'''"uci set network.mobile.apn=example"''' - Changes mobile APN to example</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 show config</td>
+
         <td>uci <b>delete</b> <config>.<section></td>
         <td>Returns the contents of a config file</td>
+
         <td>Deletes the specified section in a configuration file. To avoid operation issues, please use this command to delete optional configuration sections only (not mandatory ones).</td>
         <td>'''uci show openvpn''' - returns the contents of the openvpn config file</td>
+
         <td><li><i>uci delete network.lan4</i></li>Deletes a network interface called "lan4".</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>uci show config.section</td>
+
         <td>uci <b>delete</b> <config>.<section>.<option_name></td>
         <td>Returns the exact part of a config file (either section or the exact option value)</td>
+
         <td>Deletes the specified configuration option. To avoid operation issues, please use this command to delete optional configuration options only (not mandatory ones).</td>
         <td>'''uci show network.ppp''' - returns the contents of the ppp interface section from the network config file</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>
   −
As you can see, the UCI rule requires that you know the names of the configuration files and the names of the sections and parameters that they hold. You can find the config file list and some examples of UCI usage in general in our '''[[UCI command usage]]''' article.
+
The UCI rule requires that you know the names of the configuration files and sections and parameters contained within them. You can find the config file list and some examples of the UCI system usage in our <b>[[UCI command usage]]</b> article.
    
===Custom Rules===
 
===Custom Rules===
 
----
 
----
If default rules do not suit your purposes, you can also configure custom SMS rules. To do so, go to the bottom of the
+
If none of the default rules suit your purposes, you can also configure custom ones. To do so, scroll down to the very bottom of the SMS Utilities page, where you will find the <b>Add Rule</b> section. Enter a custom SMS text, select an Action and click the 'Add' button:
SMS Utilities page, where you will find the '''Add Rule''' tab. Write SMS text, select an Action and press the '''Add'''
  −
button located next to it.
      
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_add_rule.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_add_rule.png|border|class=tlt-border]]
  −
Configuring a new rule is very similar to editing default rules: you are provided with a list of '''Actions''', other
  −
fields are generated in accordance with which '''Action''' you choose.
      
==SMS Gateway==
 
==SMS Gateway==
Line 437: Line 421:  
<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">
Line 497: Line 481:  
</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>
Line 561: Line 551:  
<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">
Line 825: Line 815:  
<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>
Line 891: Line 881:     
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]]
   −
Then you should be redirected to that rule's configuration page. The Call Configuration window is similar to SMS Configuration but less complex.
+
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_authorization.png|border|class=tlt-border]]
 +
}}
   −
[[File:Networking_rutos_manual_mobile_utilities_call_utilities_call_configuration_general.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===
Line 943: Line 971:  
     </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>Delete forwarded messages</td>
+
         <td>Memory</td>
        <td>off | on; default: <b>off</b></td>
+
         <td>-</td>
        <td>If enabled, all forwarded messages will be automatically deleted</td>
  −
    </tr>{{#ifeq: {{{dualmodem}}} | 1 |
  −
    <tr>
  −
        <td>Modem</td>
  −
        <td> Primary modem {{!}} Secondary modem; default: '''Primary modem'''</td>
  −
        <td>Which modem is used</td>
  −
    </tr>|}}
  −
    <tr>
  −
         <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>

Navigation menu