Changes

Template:Networking rutos manual cloud solutions (view source)

Revision as of 15:23, 28 June 2024

3,498 bytes added ,  28 June
no edit summary
Line 1: Line 1: −
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.04.1
+
| series = {{{series}}}
−
| series     = {{{series}}}
+
| name  = {{{name}}}
 +
| fw_version ={{Template: Networking_device_manual_latest_fw
 +
| series = {{{series}}}
 +
| 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_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_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
 
__TOC__
 
__TOC__
 +
==Summary==
 +
 +
The <b>Cloud Solutions</b> section is used to configure how the device will connect to certain cloud management systems.
   −
==Summary==
+
This chapter of the user manual provides an overview of the Cloud Solutions page for {{{name}}} devices.
   −
The <b>Cloud Solutions</b> section is used to configure how the device will connect to certain cloud management systems. This chapter is an overview of the Cloud Solutions section for {{{name}}} routers.
+
<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
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
Line 21: Line 30:  
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:
   −
{{#ifeq:{{{series}}}| RUTX |
+
[[File:Networking_rutos_manual_setup_wizard_rms_{{{rms}}}_v4.png|border|class=tlt-border]]
−
[[File:Networking_rutx_manual_cloud_solutions_rms_connected_v1.png]]
  −
|
  −
[[File:Networking_trb_manual_cloud_solutions_rms_connected_v1.png]]
  −
}}
      
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 53: Line 58:  
         <td>integer [0..65535]; default: <b>15009</b></td>
 
         <td>integer [0..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>Port number for connecting to RMS. If you're using regular RMS, just leave the default port (<i>15009</i>).</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>
 
</table>
 
</table>
Line 60: Line 70:  
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:
   −
{{#ifeq:{{{series}}}| RUTX |
+
[[File:Networking_rutos_manual_cloud_solutions_rms_disconnected_rms_{{{rms}}}_v5.png|border|class=tlt-border]]
−
[[File:Networking_rutx_manual_cloud_solutions_rms_disconnected_v1.png]]
+
 
−
|
+
To speed up the process by initiating an immediate connection attempt, click the <b>Connect</b> button.
−
[[File:Networking_trb_manual_cloud_solutions_rms_disconnected_v1.png]]
+
 
−
}}
+
[[File:Networking_rutos_manual_cloud_solutions_rms_connect_{{{rms}}}_v3.png|border|class=tlt-border]]
−
To speed up the process by initiating an immediate connection attempt, click the 'Connect' button.
+
 
 +
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_{{{rms}}}_v3.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_unregister_{{{rms}}}_v3.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 71: Line 88:  
==Azure IoT Hub==
 
==Azure IoT Hub==
   −
<b>Azure IoT Hub</b> is a cloud-based, real-time IoT management platform that 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.
 +
 
 +
By default, the Azure IoT list is empty. To add a new connection, enter a custom name and click the 'Add' button.
 +
 
 +
[[File:Networking_rutos_manual_cloud_solutions_azure_iot_hub_add.png|border|class=tlt-border]]
   −
{{#ifeq: {{{modem}}} | 1 |
+
===Modify Azure IoTHub===
−
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_modify.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 85: Line 105:  
     </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>
 +
        <td>Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Connection name.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Enable Direct Methods</td>
 +
         <td>off {{!}} <span style="color:red">on</span>; default: <b>off</b></td>
 +
         <td>Enable Direct Method feature set.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:red">Device Model ID</span></td>
 +
        <td>string; default: <b>dtmi:Teltonika:genericDevice;1</b></td>
 +
        <td>Model ID of the Digital Twins Definition Language.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Connection type</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>Connection type to an existing IoT Hub.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Connection String</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Connection string based on primary key used in API calls which allows device to communicate with IoT Hub.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:blue">ID Scope</span></td>
 +
        <td>string; default: <b>none</b></td>
 +
        <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>Connection string</td>
+
         <td><span style="color:blue">Registration ID</span></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><span style="color:blue">Global Device Endpoint</span></td>
 +
        <td>string; default: <b>global.azure-devices-provisioning.net</b></td>
 +
        <td>Destination for messages sent by IoT devices to the Azure IoT Hub.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Message Type</td>
+
         <td><span style="color:blue">Attestation mechanism</span></td>
−
         <td>GSM values <nowiki>|</nowiki> MQTT messages; default: <b>GSM values</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>Values that are to be sent to the Azure server.</td>
+
         <td>Method used to confirm a device's identity in Device Provisioning Service.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Message sending interval (sec.)</td>
+
         <td><span style="color:brown">X.509 Certificate</span></td>
−
         <td>integer; default: <b>300</b></td>
+
         <td>-interactive button; default: <b></b></td>
−
         <td>Device data sending frequency in seconds. Minimum value is 10 s.</td>
+
         <td>Upload the "leaf" certificate file.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Mobile Interface</td>
+
         <td><span style="color:brown">X.509 Private Key</span></td>
−
         <td>mobile interface; default: <b>mobs1a1</b></td>
+
         <td>-interactive button; default: <b></b></td>
−
         <td>Interface name for which IP address and sent/received bytes should be selected.</td>
+
         <td>Upload the "leaf" key file.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>GSM Values</td>
+
         <td><span style="color:orange">Symmetric Key</span></td>
−
        <td>IMSI <nowiki>|</nowiki> IP Address <nowiki>|</nowiki> RSRP <nowiki>|</nowiki> ICCID <nowiki>|</nowiki> Bytes received <nowiki>|</nowiki> Cell ID <nowiki>|</nowiki> RSCP <nowiki>|</nowiki> PIN state <nowiki>|</nowiki> Manufacturer <nowiki>|</nowiki> 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>The the derived device key from the DPS Primary Key.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</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]]
+
==Cloud of Things==
 +
 
 +
The <b>Cloud of Things</b> is an IoT cloud platform which provides the possibility to remotely monitor, manage and control your connected devices and machines – plug-and-play, without extensive installation.
 +
 
 +
[[File:Networking_rutos_manual_cloud_solutions_cloud_of_things_v1.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 127: Line 184:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Enable Azure IoT Hub monitoring</td>
+
         <td>Enable</td>
 
         <td>off | 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>Turns the Cloud of Things service on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Connection string</td>
+
         <td>Server Address</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>
  −
    </tr>
  −
    <tr>
  −
        <td>Message Type</td>
  −
        <td>{{{#ifeq:{{{modem}}}|1|GSM values <nowiki>|</nowiki>|}} MQTT messages; default: <b>{{{#ifeq:{{{modem}}}|1|GSM values|MQTT messages|}}</b></td>
  −
        <td>Values that are to be sent to the Azure server.</td>
  −
    </tr>
  −
    <tr>
  −
        <td>MQTT Host</td>
   
         <td>ip | host; default: <b>none</b></td>
 
         <td>ip | host; default: <b>none</b></td>
−
         <td>MQTT broker's IP address or hostname.</td>
+
         <td>Cloud of Things server IP address or hostname.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>MQTT Port</td>
+
         <td>Interval</td>
−
         <td>integer [0..65535]; default: <b>none</b></td>
+
         <td>integer; default: <b>none</b></td>
−
         <td>MQTT broker's IP port number.</td>
+
         <td>Push connection interval in minutes.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
−
         <td>Topic</td>
+
         <td>Reset Auth</td>
−
         <td>string; default: <b>none</b></td>
+
         <td>- (interactive button)</td>
−
         <td>MQTT topic to be used for publishing the data.</td>
+
         <td>Resets authentication data so that device could be re-registered on the Cloud of Things Device Management platform.</td>
−
    </tr>
  −
    <tr>
  −
        <td>Username</td>
  −
        <td>string; default: <b>none</b></td>
  −
        <td>Username used for authentication to the MQTT broker.</td>
  −
    </tr>
  −
    <tr>
  −
        <td>Password</td>
  −
        <td>string; default: <b>none</b></td>
  −
        <td>Password used for authentication to the MQTT broker.</td>
   
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 172: Line 209:  
<b>Cumulocity IoT</b> is a cloud-based, real-time IoT management platform that's also compatible with Teltonika-Networks devices.
 
<b>Cumulocity IoT</b> is a cloud-based, real-time IoT management platform that's also compatible with Teltonika-Networks devices.
   −
The figure and table below provides explanations for Cumulocity configuration parameters. For a detailed configuration guide, [[Cumulocity Configuration|click here]].
+
The figure and table below provide explanations for Cumulocity configuration parameters available on the device. For a detailed configuration guide, [[Cumulocity Configuration|click here]].
   −
[[File:Networking_rutos_manual_cloud_solutions_cumulocity_modem_{{{modem}}}.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_cloud_solutions_cumulocity_v1.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 195: Line 232:  
         <td>Server Address</td>
 
         <td>Server Address</td>
 
         <td>host; default: <b>none</b></td>
 
         <td>host; default: <b>none</b></td>
−
         <td>Your Cumulocity server's hostname. It should match the <i>Environment name</i> from the Cumulocity registration.<br>For example: <i><nowiki>teltonika-networks.</nowiki><b><nowiki>eu-latest.cumulocity.com</nowiki></b></i></td>
+
         <td>Hostname of your Cumulocity server. It should match the <i>Environment name</i> from the Cumulocity registration.<br>For example: <i><nowiki>teltonika-networks.</nowiki><b><nowiki>eu-latest.cumulocity.com</nowiki></b></i></td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 201: Line 238:  
         <td>integer; default: <b>none</b></td>
 
         <td>integer; default: <b>none</b></td>
 
         <td>Connection push interval in minutes. This field defines how often the device will try to connect to the Cumulocity server.</td>
 
         <td>Connection push interval in minutes. This field defines how often the device will try to connect to the Cumulocity server.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Reset Auth</td>
 +
        <td>- (interactive button)</td>
 +
        <td>Resets authentication for this device. If you click this, you'll have to authorize this from Cumulocity dashboard before it can successfully connect to the server.</td>
 +
    </tr>
 +
</table>
 +
 +
==ThingWorx==
 +
 +
[[File:Networking_rutos_manual_cloud_solutions_thingworx_modem_{{{modem}}}.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 ThingWorx service on or off.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Server Address</td>
 +
        <td>ip | host; default: <b>none</b></td>
 +
        <td>Thingworx server IP address or hostname.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Server Port</td>
 +
        <td>integer [0..65535]; default: <b>none</b></td>
 +
        <td>Thingworx server's port number.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Thing Name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Thing name defined in ThingWorx CP.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Application Key</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Application key generated in ThingWorx CP.</td>
 
     </tr>{{#ifeq:{{{modem}}}|1|
 
     </tr>{{#ifeq:{{{modem}}}|1|
 
     <tr>
 
     <tr>
 
         <td>Mobile Interface</td>
 
         <td>Mobile Interface</td>
 
         <td>network interface; default: <b>mob1s1a1</b></td>
 
         <td>network interface; default: <b>mob1s1a1</b></td>
−
         <td>Interface whose GSM parameters will be sent to the Cumulocity server for monitoring.</td>
+
         <td>Interface whose GSM parameters will be sent to the ThingWorx server for monitoring.</td>
 +
    </tr>|}}
 +
</table>
 +
{{#switch:{{{series}}}
 +
|RUTX|RUTM=
 +
==Greengrass==
 +
 
 +
[[File:Networking_rutos_manual_cloud_solutions_greengrass_v1.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 
     </tr>
 
     </tr>
−
|}}<tr>
+
    <tr>
−
         <td>Reset Auth</td>
+
        <td>Enable</td>
−
         <td>- (interactive button)</td>
+
        <td>off {{!}} on; default: <b>off</b></td>
−
         <td>Resets authentication for this device. If you click this, you'll have to authorize this from Cumulocity dashboard before it can successfully connect to the server.</td>
+
        <td>Turns the AWS Greengrass service on or off.</td>
 +
    </tr>
 +
    <tr>
 +
         <td>Config file</td>
 +
         <td>.tar.gz file; default: <b>none</b></td>
 +
         <td>Core-specific config file.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
|#default=}}
    
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/70424...128194"

Navigation menu