Template:Networking rutos manual mobile utilities: Difference between revisions
Template:Networking rutos manual mobile utilities (view source)
Revision as of 08:21, 2 July 2024
, 2 Julyno edit summary
No edit summary |
No edit summary |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 11: | Line 11: | ||
==Summary== | ==Summary== | ||
The <b>Mobile Utilities</b> page is used to configure various SMS{{# | The <b>Mobile Utilities</b> page is used to configure various SMS{{#switch:{{{name}}}| TRB255 | TRB256= | #default= 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. | This manual page provides an overview of the Mobile Utilities page in {{{name}}} devices. | ||
Line 19: | Line 19: | ||
The <b>SMS Utilities</b> section contains a list of rules that perform certain actions when they are activated by SMS messages. | The <b>SMS Utilities</b> section contains a list of rules that perform certain actions when they are activated by SMS messages. | ||
[[File: | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_sms_rules_v1.png|border|class=tlt-border]] | ||
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. | 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. | ||
Line 260: | Line 260: | ||
===Modify SMS Rule=== | ===Modify SMS Rule=== | ||
---- | ---- | ||
Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button | Every SMS rule can be edited to your liking. To begin configuring a rule, click the click the 'Edit' button under "Actions" column: | ||
[[File: | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_edit_button_v1.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. | 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. | ||
Line 268: | Line 268: | ||
<b>General settings</b> | <b>General settings</b> | ||
---- | ---- | ||
[[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general_dualmodem_{{{dualmodem}}} | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_general_dualmodem_{{{dualmodem}}}_v3.png|border|class=tlt-border]] | ||
<ol> | <ol> | ||
<li>The <b>Enable</b> slider turn the rule on or off. In order to use a rule, this slider must be set to 'on'. By default, all existing SMS rules are turned on.</li> | <li>The <b>Enable</b> slider turn the rule on or off. In order to use a rule, this slider must be set to 'on'. By default, all existing SMS rules are turned on.</li> | ||
<li>The <b>Action</b> dropdown selection specifies which action should be performed when the rule is executed.</li> | <li>The <b>Action</b> dropdown selection specifies which action should be performed when the rule is executed.</li> | ||
{{#ifeq: {{{dualmodem}}} | 1 |<li>The <b>Receiving modem</b>, which is used to receive the message.</li>|}} | |||
<li>The <b>SMS text</b> field specifies the text that will trigger the rule upon receiving a message.</li> | <li>The <b>SMS text</b> field specifies the text that will trigger the rule upon receiving a message.</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>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>Message forwarding</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>Message forwarding</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> | {{#ifeq: {{{dualmodem}}} | 1 |<li>The <b>Modem</b>, which is used to get information from or managed for change mobile settings action.</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> | |||
</ol> | </ol> | ||
<b>Authorization</b> | <b>Authorization</b> | ||
---- | ---- | ||
[[File: | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_authorization_v1.png|border|class=tlt-border]] | ||
<ol> | <ol> | ||
Line 296: | Line 296: | ||
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}}}_{{{dualmodem}}}.png|border|class=tlt-border]] | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_cellular_dualsim_{{{dualsim}}}_{{{dualmodem}}}_v2.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. | ||
Line 365: | Line 365: | ||
</td> | </td> | ||
<td><i>cellular roaming=0</i></td> | <td><i>cellular roaming=0</i></td> | ||
</tr> | |||
<tr> | |||
<td><b>interface=</b></td> | |||
<td>Specifies the interface where changes should occur.</td> | |||
<td><i>cellular apn=internet,interface=mob1s1a1</i></td> | |||
</tr> | </tr> | ||
</table> | </table> | ||
Line 388: | Line 393: | ||
The <b>UCI API</b> rule is used to configure any parameters on the device. | The <b>UCI API</b> rule is used to configure any parameters on the device. | ||
[[File: | [[File:Networking_rutos_manual_mobile_utilities_sms_utilities_modify_sms_rule_uci_{{{dualmodem}}}_v4.png|border|class=tlt-border]] | ||
---- | ---- | ||
The following are syntax examples for the UCI API rule: | The following are syntax examples for the UCI API rule: | ||
Line 401: | Line 406: | ||
<td>uci <b>get</b> <config>.<section>.<option_name></td> | <td>uci <b>get</b> <config>.<section>.<option_name></td> | ||
<td>Returns the value of a single configuration option.</td> | <td>Returns the value of a single configuration option.</td> | ||
<td><li><i>uci get network.wan.ipaddr</i></li>Returns the router's WAN IP address.</td> | <td><ul><li><i>uci get network.wan.ipaddr</i></li></ul>Returns the router's WAN IP address.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>uci <b>set</b> <config>.<section>.<option_name>="value"</td> | <td>uci <b>set</b> <config>.<section>.<option_name>="value"</td> | ||
<td>Sets the value of a specified configuration option.</td> | <td>Sets the value of a specified configuration option.</td> | ||
<td><li><i>uci set network.mobile.apn=example</i></li>Changes mobile APN value to "example".</td> | <td><ul><li><i>uci set network.mobile.apn=example</i></li></ul>Changes mobile APN value to "example".</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>uci <b>show</b> <config></td> | <td>uci <b>show</b> <config></td> | ||
<td>Returns the contents of a config file</td> | <td>Returns the contents of a config file</td> | ||
<td><li><i>uci show openvpn</i></li>Returns the contents of the "openvpn" config file.</td> | <td><ul><li><i>uci show openvpn</i></li></ul>Returns the contents of the "openvpn" config file.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>uci <b>show</b> <config>.<section></td> | <td>uci <b>show</b> <config>.<section></td> | ||
<td>Returns the exact part (section) of a config file.</td> | <td>Returns the exact part (section) of a 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> | <td><ul><li><i>uci show network.lan</i></li></ul>Returns the configuration of the "lan" section from the "network" config file.</td> | ||
</tr> | </tr> | ||
<!-- | <!-- | ||
Line 440: | Line 445: | ||
API allows creating, reading, updating, or deleting configurations using the allowed API endpoints from a list. | API allows creating, reading, updating, or deleting configurations using the allowed API endpoints from a list. | ||
[[File:Networking rutos manual mobile utilities sms utilities modify sms rule api | [[File:Networking rutos manual mobile utilities sms utilities modify sms rule api {{{dualmodem}}}_v3.png|border|class=tlt-border]] | ||
---- | ---- | ||
The following are syntax examples for the API rule: | The following are syntax examples for the API rule: | ||
Line 453: | Line 458: | ||
<td>api <b>get</b> <method>.<config>.<section></td> | <td>api <b>get</b> <method>.<config>.<section></td> | ||
<td>Returns specified config options.</td> | <td>Returns specified config options.</td> | ||
<td><li><i>api get /auto_reboot/periodic/config</i></li>Returns periodic reboot options.</td> | <td><ul><li><i>api get /auto_reboot/periodic/config</i></li></ul>Returns periodic reboot options.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>api <b>post</b><method> <config>.<section>.<option_name>="value"</td> | <td>api <b>post</b><method> <config>.<section>.<option_name>="value"</td> | ||
<td>Sets the value of a specified configuration option.</td> | <td>Sets the value of a specified configuration option.</td> | ||
<td><li><i>api post /auto_reboot/periodic/config {"data": {"action": "1", "period": "week", "days": ["mon"], "time": ["12:00"]}}</i></li>Creates a periodic reboot configuration with options to reboot device every monday on 12:00.</td> | <td><ul><li><i>api post /auto_reboot/periodic/config {"data": {"action": "1", "period": "week", "days": ["mon"], "time": ["12:00"]}}</i></li></ul>Creates a periodic reboot configuration with options to reboot device every monday on 12:00.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>api <b>put</b> <method> <config>.<section>.<option_name>="value"</td> | <td>api <b>put</b> <method> <config>.<section>.<option_name>="value"</td> | ||
<td>Edits a specified config options.</td> | <td>Edits a specified config options.</td> | ||
<td><li><i>api put /auto_reboot/periodic/config/{id} {"data": { "enable": "1"}}</i></li>Sets a specified periodic reboot config to enabled.</td> | <td><ul><li><i>api put /auto_reboot/periodic/config/{id} {"data": { "enable": "1"}}</i></li></ul>Sets a specified periodic reboot config to enabled.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>api <b>delete</b> <method> <config>.<section>.<config_id></td> | <td>api <b>delete</b> <method> <config>.<section>.<config_id></td> | ||
<td>Deletes a specified configuration.</td> | <td>Deletes a specified configuration.</td> | ||
<td><li><i>api delete /auto_reboot/periodic/config/{id}</i></li>Deletes a specified periodic reboot configuration.</td> | <td><ul><li><i>api delete /auto_reboot/periodic/config/{id}</i></li></ul>Deletes a specified periodic reboot configuration.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 556: | Line 561: | ||
<tr> | <tr> | ||
<td>Send mobile message to a group</td> | <td>Send mobile message to a group</td> | ||
<td>http://<span> | <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 567: | Line 571: | ||
<tr> | <tr> | ||
<td>Delete mobile message</td> | <td>Delete mobile message</td> | ||
<td>http://<span> | <td>http://<span>style="color: black;">192.168.1.1</span>/cgi-bin/sms_delete?username=user1&password=user_pass&number=1 | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 619: | Line 622: | ||
<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|border|class=tlt-border]] | [[File:Networking_rutos_manual_mobile_utilities_sms_gateway_auto_reply_dualmodem_{{{dualmodem}}}_v1.png|border|class=tlt-border]] | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 659: | Line 662: | ||
<td>default: '''Everyone'''</td> | <td>default: '''Everyone'''</td> | ||
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | <td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | ||
<ul> | |||
<li>Everyone</li> | |||
<li>Listed numbers</li> | |||
<li>From user group</li> | |||
</ul> | |||
</td> | </td> | ||
</tr> | </tr> | ||
Line 713: | Line 717: | ||
<td>default: '''Everyone'''</td> | <td>default: '''Everyone'''</td> | ||
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | <td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | ||
<ul> | |||
<li>Everyone</li> | |||
<li>Listed numbers</li> | |||
<li>From phone group</li> | |||
</ul> | |||
</td> | </td> | ||
</tr> | </tr> | ||
Line 727: | Line 732: | ||
<td>HTTPS certificate verification</td> | <td>HTTPS certificate verification</td> | ||
<td>default: '''Ignore'''</td> | <td>default: '''Ignore'''</td> | ||
<td>Select whether to ignore or verify server certificate. Available options: <li>Ignore</li> <li>Verify</li> | <td>Select whether to ignore or verify server certificate. Available options: <ul><li>Ignore</li> <li>Verify</li></ul> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 733: | Line 738: | ||
<td>Method</td> | <td>Method</td> | ||
<td>default: '''Get'''</td> | <td>default: '''Get'''</td> | ||
<td>Choose witch HTTP request method will be used. Available options: <li>Get</li> <li>Post</li> | <td>Choose witch HTTP request method will be used. Available options: <ul><li>Get</li> <li>Post</li></ul> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 811: | Line 816: | ||
<td>default: '''Everyone'''</td> | <td>default: '''Everyone'''</td> | ||
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | <td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | ||
<ul> | |||
<li>Everyone</li> | |||
<li>Listed numbers</li> | |||
<li>From user group</li> | |||
</ul> | |||
</td> | </td> | ||
</tr> | </tr> | ||
Line 861: | Line 867: | ||
<td>default: '''Everyone'''</td> | <td>default: '''Everyone'''</td> | ||
<td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | <td>Specifies whether to auto reply to every phone number or just just specified phone numbers. Available options: | ||
<ul> | |||
<li>Everyone</li> | |||
<li>Listed numbers</li> | |||
<li>From user group</li> | |||
</ul> | |||
</td> | </td> | ||
</tr> | </tr> | ||
Line 987: | Line 994: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
<td>off | <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td> | ||
<td>Turns SMPP on or off.</td> | <td>Turns SMPP on or off.</td> | ||
</tr> | </tr> | ||
Line 1,007: | Line 1,014: | ||
<tr> | <tr> | ||
<td>Modem</td> | <td>Modem</td> | ||
<td>Primary modem | <td>Primary modem {{!}} Secondary modem; default: <b>Primary modem</b></td> | ||
<td>Modem that will be used for SMPP server communications.</td> | <td>Modem that will be used for SMPP server communications.</td> | ||
</tr>|}} | </tr>|}} | ||
<tr> | |||
<td><span style="color:blue">Use TLS/SSL</span></td> | |||
<td>off {{!}} <span style="color:red">on</span>; default: <b>off</b></td> | |||
<td>Mark to use TLS/SSL for connection.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:red">CA file</span></td> | |||
<td>-interactive button; default: <b></b></td> | |||
<td>Upload CA file.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:red">Certificate file</span></td> | |||
<td>-interactive button; default: <b></b></td> | |||
<td>Upload certificate file.</td> | |||
</tr> | |||
<tr> | |||
<td><span style="color:red">Key file</span></td> | |||
<td>-interactive button; default: <b></b></td> | |||
<td>Upload key file.</td> | |||
</tr> | |||
</table> | </table> | ||
{{#switch:{{{name}}}| TRB255 | TRB256 | #default = | {{#switch:{{{name}}}| TRB255 | TRB256 = | #default = | ||
==Call Utilities== | ==Call Utilities== | ||