Jump to content
  • EN

Template:Networking rutos manual cloud solutions: Difference between revisions

← Older editNewer edit →
VisualWikitext
No edit summary
No edit summary
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| name  = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
  | series = {{{series}}}
  | series = {{{series}}}
  | name  = {{{name}}}
  | name  = {{{name}}}
  }}
  }}
}}
}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} IoT Platforms (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}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} IoT Platforms (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} IoT Platforms (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>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} IoT Platforms (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
__TOC__
__TOC__
==Summary==
==Summary==
Line 14: Line 16:
This chapter of the user manual provides an overview of the Cloud Solutions page for {{{name}}} devices.
This chapter of the user manual provides an overview of the Cloud Solutions page for {{{name}}} devices.


<u><b>Note:</b> Each Cloud Solutions service, except RMS, is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
<u><b>Note:</b> Each Cloud Solutions service, except RMS, is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
| series    = {{{series}}}
}}


==RMS==
==RMS==
Line 28: Line 26:
The figure below is a screenshot of the RMS section taken from a device which has been connected to RMS:
The figure below is a screenshot of the RMS section taken from a device which has been connected to RMS:


[[File:Networking_rutos_manual_setup_wizard_rms_{{{rms}}}_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_setup_wizard_rms_settings.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 38: Line 36:
     <tr>
     <tr>
         <td>Connection type</td>
         <td>Connection type</td>
         <td>Enabled | Standby | Disabled; default: <b>Enabled</b></td>
         <td>Enabled {{!}} Standby {{!}} Disabled; default: <b>Enabled</b></td>
         <td>Defines how the device will connect to RMS:
         <td>Defines how the device will connect to RMS:
             <ul>
             <ul>
                 <li><b>Enabled</b> - the device attempts to connect to RMS every 2-5 minutes (every 2 minutes the first hour; then every 5 minutes). If it cannot connect for 14 days, it will enter Standby mode.</li>
                 <li><b>Enabled</b> - RMS functionality is always on. When disconnected from RMS, the device will try connecting every 2-5 minutes (every 2 minutes the first hour; then every 5 minutes). If the device is disconnected from RMS for 14 days, it will go into Standby mode. When trying to connect to rms without internet connection, the router will try to reestablish connection every 10 seconds.</li>
                 <li><b>Standby</b> - the device attempts to connect to RMS every 6 hours.</li>
                 <li><b>Standby</b> - The device tries to establish a connection with the server infrequently (6 hours in-between attempts). This is done in order to reduce mobile traffic. In order to start using RMS, user intervention is not necessary from the device's side. Worst case scenario - RMS connection will be established 6 hours after the device was added to RMS. {{#ifeq: {{{name}}} | RUT241 | <b>Note:</b> RMS is automatically set to Standby mode if the eSIM Bootstrap profile is installed on the device.|}}</li>
                 <li><b>Disabled</b> - RMS functionality is disabled.</li>
                 <li><b>Disabled</b> - RMS functionality is completely disabled; therefore, no connection attempts are made. In order to start using RMS, the user must enable the service on the device's side.</li>
             </ul>
             </ul>
         </td>
         </td>
Line 49: Line 47:
     <tr>
     <tr>
         <td>Hostname</td>
         <td>Hostname</td>
         <td>host | ip; default: <b>rms.teltonika.lt</b></td>
         <td>host {{!}} ip; default: <b>rms.teltonika.lt</b></td>
         <td>Address of the RMS server. If you're using regular RMS, just leave the default address (<i><nowiki>rms.teltonika.lt</nowiki></i>).</td>
         <td>RMS server hostname. Unless you are hosting your own RMS server, you should leave the default value.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Port</td>
         <td>Port</td>
         <td>integer [0..65535]; default: <b>15009</b></td>
         <td>integer [1..65535]; default: <b>15009</b></td>
         <td>Port number for connecting to RMS. If you're using regular RMS, just leave the default port (<i>15009</i>).</td>
         <td>RMS server port. Unless you are hosting your own RMS server, you should leave the default value.</td>
    </tr>
    <tr>
        <td>Authentication code</td>
        <td>string; default: <b>none</b></td>
        <td>Authentication code provided by RMS after adding the device.</td>
    </tr>
    <tr>
        <th>Proxy settings</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
        <td>Enable proxy</td>
        <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
        <td>Enable RMS connection through proxy.</td>
    </tr>
    <tr>
        <td><span style="color:blue">Proxy address</span></td>
        <td>domain names or IP addresses; default: <b>none</b></td>
        <td>Specify proxy address.</td>
    </tr>
    <tr>
        <td><span style="color:blue">Proxy SOCKS5 port</span></td>
        <td>integer [1..65535]; default: <b>1080</b></td>
        <td>SOCKS5 proxy server port.</td>
    </tr>
    <tr>
        <td><span style="color:blue">Use credentials</span></td>
        <td>off {{!}} <span style="color:green">on</span>; default: <b>off</b></td>
        <td>Use credentials for SOCKS5 proxy connection.</td>
    </tr>
    <tr>
        <td><span style="color:green">SOCKS5 username</span></td>
        <td>string; default: <b>none</b></td>
        <td>Specify username for SOCKS5 proxy connection.</td>
    </tr>
    <tr>
        <td><span style="color:green">SOCKS5 password</span></td>
        <td>string; default: <b>none</b></td>
        <td>Specify password for SOCKS5 proxy connection.</td>
     </tr>
     </tr>
</table>
</table>
Line 63: Line 101:
The RMS server waits for incoming connections. Since the device attempts to connect at a fixed interval, it may not connect instantly after you add it to RMS. While it is disconnected, you can check how much time is left until the next connection attempt in the Status section:
The RMS server waits for incoming connections. Since the device attempts to connect at a fixed interval, it may not connect instantly after you add it to RMS. While it is disconnected, you can check how much time is left until the next connection attempt in the Status section:


[[File:Networking_rutos_manual_cloud_solutions_rms_disconnected_rms_{{{rms}}}_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_cloud_solutions_rms_down.png|border|class=tlt-border]]


To speed up the process by initiating an immediate connection attempt, click the <b>Connect</b> button. Alternatively, when the device is already connected a <b>Disconnect</b> button becomes visible. Use it to terminate the device's connection to RMS.
To speed up the process by initiating an immediate connection attempt, click the <b>Connect</b> button.  


[[File:Networking_rutos_manual_cloud_solutions_rms_disconnect_{{{rms}}}_v1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_cloud_solutions_rms_connect.png|border|class=tlt-border]]
 
If a failure or unknown status occurs, there is an alternative to try to reconnect again, click the <b>Reconnect</b> button.
 
[[File:Networking_rutos_manual_cloud_solutions_rms_reconnect.png|border|class=tlt-border]]
 
When the device is already connected a <b>Reset</b> button becomes visible. Use it to terminate the device's connection to RMS.
 
[[File:Networking_rutos_manual_cloud_solutions_rms_reset.png|border|class=tlt-border]]


For more information on Teltonika Networks Remote Management System (RMS) refer to the <b>[[RMS Manual]]</b> or <b>[[RMS FAQ]]</b> pages.
For more information on Teltonika Networks Remote Management System (RMS) refer to the <b>[[RMS Manual]]</b> or <b>[[RMS FAQ]]</b> pages.
Line 75: Line 121:
<b>Azure IoT Hub</b> is Microsoft's ever-expanding set of cloud services to help your organization meet your business challenges. Azure IoT Hub is compatible with Teltonika Networks devices.
<b>Azure IoT Hub</b> is Microsoft's ever-expanding set of cloud services to help your organization meet your business challenges. Azure IoT Hub is compatible with Teltonika Networks devices.


{{#ifeq: {{{modem}}} | 1 |
By default, the Azure IoT list is empty. To add a new connection, enter a custom name and click the 'Add' button.
The figure and table below provides explanations for Azure IoT Hub configuration parameters when selected 'Message Type' is <i>GSM values</i>.


[[File:Networking_rutos_manual_cloud_solutions_azure_iot_hub_modem_1.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_cloud_solutions_azure_iot_hub_add.png|border|class=tlt-border]]
 
===Modify Azure IoTHub===
 
[[File:Networking_rutos_manual_cloud_solutions_azure_iot_hub_modify.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 87: Line 136:
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enable Azure IoT Hub monitoring</td>
         <td>Enable</td>
         <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns the Azure IoT Hub service on or off.</td>
         <td>Enable Azure IoT service.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Connection string</td>
         <td>Name</td>
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Unique connection string a.k.a. server address provided by the Azure Iot Hub service.</td>
         <td>Connection name.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Message Type</td>
         <td>Enable Direct Methods</td>
         <td>GSM values <nowiki>|</nowiki> MQTT messages; default: <b>MQTT messages</b></td>
         <td>off {{!}} <span style="color:red">on</span>; default: <b>off</b></td>
         <td>Values that are to be sent to the Azure server.</td>
         <td>Enable Direct Method feature set.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Message sending interval (sec.)</td>
         <td><span style="color:red">Device Model ID</span></td>
         <td>integer; default: <b>300</b></td>
         <td>string; default: <b>dtmi:Teltonika:genericDevice;1</b></td>
         <td>Device data sending frequency in seconds. Minimum value is 10 s.</td>
         <td>Model ID of the Digital Twins Definition Language.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Mobile Interface</td>
         <td>Connection type</td>
         <td>mobile interface; default: <b>mobs1a1</b></td>
         <td>Shared Access Signature (SAS) key {{!}} <span style="color:blue">Device Provisioning Service (DPS)</span>; default: <b>Shared Access Signature (SAS) key</b></td>
         <td>Interface name for which IP address and sent/received bytes should be selected.</td>
         <td>Connection type to an existing IoT Hub.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>GSM Values</td>
         <td>Connection String</td>
         <td>IMSI <nowiki>|</nowiki> IP Address <nowiki>|</nowiki> RSRP <nowiki>|</nowiki> ICCID {{#ifeq:{{{series}}}|TRB5||<nowiki>|</nowiki> Bytes received }}<nowiki>|</nowiki> Cell ID <nowiki>|</nowiki> RSCP <nowiki>|</nowiki> PIN state <nowiki>|</nowiki> Manufacturer <nowiki>|</nowiki>{{#ifeq:{{{series}}}|TRB5|| Bytes sent <nowiki>|</nowiki>}} RSRQ <nowiki>|</nowiki> Revision number <nowiki>|</nowiki> Serial number <nowiki>|</nowiki> ECIO <nowiki>|</nowiki> SINR <nowiki>|</nowiki>Data carrier type <nowiki>|</nowiki> Network link state <nowiki>|</nowiki> Operator <nowiki>|</nowiki> PIN count <nowiki>|</nowiki> Signal level <nowiki>|</nowiki> Model <nowiki>|</nowiki> Connection state <nowiki>|</nowiki> Temperature <nowiki>|</nowiki> IMEI <nowiki>|</nowiki> SIM card state; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Selects the mobile connection values that to be sent to the Azure IoT Hub service.</td>
         <td>Connection string based on primary key used in API calls which allows device to communicate with IoT Hub.</td>
     </tr>
     </tr>
</table>|}}The figure and table below provides explanations for Azure IoT Hub configuration parameters{{#ifeq:{{{modem}}}|1| when selected 'Message Type' is <i>MQTT messages</i>|}}.
[[File:Networking_rutos_manual_cloud_solutions_azure_iot_hub_modem_0.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <td><span style="color:blue">ID Scope</span></td>
      <th>Value</th>
        <td>string; default: <b>none</b></td>
      <th>Description</th>
        <td>Unique identifier that is assigned to an Azure IoT Hub during its creation and is used to uniquely identify the specific provisioning service the device will register through.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Enable Azure IoT Hub monitoring</td>
         <td><span style="color:blue">Registration ID</span></td>
        <td>off | on; default: <b>off</b></td>
        <td>Turns the Azure IoT Hub service on or off.</td>
    </tr>
    <tr>
        <td>Connection string</td>
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Unique connection string a.k.a. server address provided by the Azure Iot Hub service.</td>
         <td>The registration ID is used to uniquely identify a device registration with the Device Provisioning Service.</td>
    </tr>
    <tr>
        <td>Message Type</td>
        <td>{{#ifeq:{{{modem}}}|1|GSM values <nowiki>|</nowiki>|}} MQTT messages; default: <b>MQTT messages</b></td>
        <td>Values that are to be sent to the Azure server.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>MQTT Host</td>
         <td><span style="color:blue">Global Device Endpoint</span></td>
         <td>ip | host; default: <b>none</b></td>
         <td>string; default: <b>global.azure-devices-provisioning.net</b></td>
         <td>MQTT broker's IP address or hostname.</td>
         <td>Destination for messages sent by IoT devices to the Azure IoT Hub.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>MQTT Port</td>
         <td><span style="color:blue">Attestation mechanism</span></td>
         <td>integer [0..65535]; default: <b>none</b></td>
         <td><span style="color:brown">X.509 certificates</span> {{!}} <span style="color:orange">Symmetric Key</span>; default: <b>X.509 certificates</b></td>
         <td>MQTT broker's IP port number.</td>
         <td>Method used to confirm a device's identity in Device Provisioning Service.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Topic</td>
         <td><span style="color:brown">X.509 Certificate</span></td>
         <td>string; default: <b>none</b></td>
         <td>-interactive button; default: <b></b></td>
         <td>MQTT topic to be used for publishing the data.</td>
         <td>Upload the "leaf" certificate file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Username</td>
         <td><span style="color:brown">X.509 Private Key</span></td>
         <td>string; default: <b>none</b></td>
         <td>-interactive button; default: <b></b></td>
         <td>Username used for authentication to the MQTT broker.</td>
         <td>Upload the "leaf" key file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Password</td>
         <td><span style="color:orange">Symmetric Key</span></td>
         <td>string; default: <b>none</b></td>
         <td>string; default: <b>none</b></td>
         <td>Password used for authentication to the MQTT broker.</td>
         <td>The the derived device key from the DPS Primary Key.</td>
     </tr>
     </tr>
</table>
</table>
Line 284: Line 318:
     </tr>|}}
     </tr>|}}
</table>
</table>
{{#ifeq:{{{series}}}|RUTX|
{{#switch:{{{series}}}
|RUTX|RUTM=
==Greengrass==
==Greengrass==


Line 305: Line 340:
         <td>Core-specific config file.</td>
         <td>Core-specific config file.</td>
     </tr>
     </tr>
</table>|}}
</table>|#default=}}
 
==AWS IoT Core==
 
AWS IoT Core is a utility meant to interact with Amazon Web Services cloud platform. It provides AWS IoT Core Jobs support and AWS Provisioning that lets the device be controlled from AWS IoT Core platform by using device's API.
 
===AWS Job===
 
To add new 'AWS job', press <b>Add</b> button and enter Thing's name:
 
[[File:Networking_rutos_manual_cloud_solutions_aws_iot_core_add_v1.png|border|class=tlt-border]]
 
After that you will be redirected to AWS jobs thing configuration:
 
[[File:Networking_rutos_manual_cloud_solutions_aws_jobs_configuration_v1.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 the thing instance on or off.</td>
    </tr>
    <tr>
        <td>Thing's name</td>
        <td>string; default: <b>none</b></td>
        <td>Thing's name on AWS IoT Core platform.</td>
    </tr>
    <tr>
        <td>Endpoint</td>
        <td>domain; default: <b>none</b></td>
        <td>AWS IoT Core platform endpoint used to determine AWS account to connect to.</td>
    </tr>
    <tr>
        <td>CA file</td>
        <td>.ca file; default: <b>none</b></td>
        <td>AWS CA certificate obtained from AWS IoT Core platform.</td>
    </tr>
    <tr>
        <td>Provisioning</td>
        <td>provisioning configuration; default: <b>Basic provisioning</b></td>
        <td>AWS provisioning configuration to use. It can be configured in AWS provisiong page. If basic provisioning is used, Thing's certificate and private key must be uploaded.</td>
    </tr>
    <tr>
        <td>Thing's certificate</td>
        <td>.crt file; default: <b>none</b></td>
        <td>Thing's certificate obtained from AWS IoT Core platform.</td>
    </tr>
    <tr>
        <td>Thing's private key</td>
        <td>.key file; default: <b>none</b></td>
        <td>Thing's private key obtained from AWS IoT Core platform.</td>
    </tr>
    <tr>
        <td>Port</td>
        <td>integer [1..65535]; default: <b>8883</b></td>
        <td>MQTT port number.</td>
    </tr>
    <tr>
        <td>QoS</td>
        <td>At most once (0) {{!}} At least once (1); default: <b>At least once (1)</b></td>
        <td>MQTT Quality of Service. Allowed values:
        <ul>
            <li><b>0</b> - when we prefer that the message will not arrive at all rather than arrive twice</li>
            <li><b>1</b> - when we want the message to arrive at least once but don't care if it arrives twice (or more).</li>
        </ul>
        </td>
    </tr>
    <tr>
        <td>Keepalive</td>
        <td>integer [30..65535]; default: <b>120</b></td>
        <td>MQTT keepalive time in seconds.</td>
    </tr>
    <tr>
        <td>Max loops</td>
        <td>integer [10..200]; default: <b>50</b></td>
        <td>MQTT max loops - during initial subscription to topics the service has to wait for a successful subscription acknowledgement. The service performs mosquitto loops to wait for the answer. This option determines how many loops can be performed while waiting for subscription acknowledgement.</td>
    </tr>
</table>
 
===AWS Provisioning===
 
To add new 'AWS provisioning' template, press <b>Add</b> button and enter Template name:
 
[[File:Networking_rutos_manual_cloud_solutions_aws_iot_core_add_provisioning.png|border|class=tlt-border]]
 
After that you will be redirected to AWS provisioning configuration:
 
[[File:Networking_rutos_manual_cloud_solutions_aws_provisioning_configuration.png|border|class=tlt-border]]
 
<table class="nd-mantable">
    <tr>
        <th>Field</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
        <td>Template</td>
        <td>string; default: <b></b></td>
        <td>Name of Fleet provisioning template in AWS service.</td>
    </tr>
    <tr>
        <td>Fleet provisioning type</td>
        <td><span style="color:blue">Provisioning by claim</span> {{!}} Provisioning by trusted user; default: <b>Provisioning by claim</b></td>
        <td></td>
    </tr>
    <tr>
        <td>Creation type</td>
        <td>CreateKeysAndCertificate {{!}} CreateCertificateFromCsr; default: <b>CreateKeysAndCertificate</b></td>
        <td>Specifies the AWS API to be used for certificate creation.</td>
    </tr>
    <tr>
        <td><span style="color:blue">Provisioning claim certificate</span></td>
        <td>.crt file; default: <b>none</b></td>
        <td>Provisioning claim certificate</td>
    </tr>
    <tr>
        <td><span style="color:blue">Provisioning claim private key</span></td>
        <td>.key file; default: <b>none</b></td>
        <td>Provisioning claim private key</td>
    </tr>
    <tr>
        <td><span style="color:red">Access key</span></td>
        <td>string (Values of 20 symbols are accepted. Following characters are accepted: A-Z0-9); default: <b>none</b></td>
        <td>Trusted user's access key.</td>
    </tr>
    <tr>
        <td><span style="color:red">Secret key</span></td>
        <td>string (Values of 40 symbols are accepted); default: <b>none</b></td>
        <td>Trusted user's secret key.</td>
    </tr>
    <tr>
        <td>Parameters</td>
        <td>string (Following characters are accepted: a-zA-Z0-9:%_-); default: <b>none</b></td>
        <td>Parameters which will be sent along with the certificate creation request. They will be formatted as JSON values ("Key": "Value").</td>
    </tr>
</table>


[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Template:Networking_rutos_manual_cloud_solutions"