Jump to content

RUTC40 Cloud Solutions

From Teltonika Networks Wiki
Main Page > RUTC Routers > RUTC40 > RUTC40 Manual > RUTC40 WebUI > RUTC40 Services section > RUTC40 Cloud Solutions


Summary

The Cloud Solutions section is used to configure how the device will connect to certain cloud management systems.

This chapter of the user manual provides an overview of the Cloud Solutions page for RUTC40 devices.

Note: Each Cloud Solutions service, except RMS, is additional software that can be installed from the System → Package Manager page.

RMS

RMS (Remote Management System) is a cloud system designed by Teltonika and intended for remote monitoring and management of Teltonika-Networks products.

In order to add a device(s) to RMS, get yourself acquainted by watching this instructional video and register an account by clicking here. Each unique device receives a free month-long RMS license when added to RMS for the first time.


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

Field: LAN MAC (Status section, RMS settings)

This field displays the unique identifier RMS (Remote Management System) uses to recognize the device on the platform.

  • Wired/Ethernet-only devices: the field shows the device's LAN MAC address.
  • Devices with mobile (cellular) connectivity: the field instead shows the device's IMEI (International Mobile Equipment Identity), since the device is identified by its cellular modem rather than its LAN interface.


Field Value Description
Connection type Enabled | Standby | Disabled; default: Enabled Defines how the device will connect to RMS:
  • Enabled - 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.
  • Standby - 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.
  • Disabled - 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.
Hostname host | ip; default: rms.teltonika.lt RMS server hostname. Unless you are hosting your own RMS server, you should leave the default value.
Port integer [1..65535]; default: 15009 RMS server port. Unless you are hosting your own RMS server, you should leave the default value.
Authentication code string; default: none Authentication code provided by RMS after adding the device.
Proxy settings Value Description
Enable proxy off | on; default: off Enable RMS connection through proxy.
Proxy address domain names or IP addresses; default: none Specify proxy address.
Proxy SOCKS5 port integer [1..65535]; default: 1080 SOCKS5 proxy server port.
Use credentials off | on; default: off Use credentials for SOCKS5 proxy connection.
SOCKS5 username string; default: none Specify username for SOCKS5 proxy connection.
SOCKS5 password string; default: none Specify password for SOCKS5 proxy connection.



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:

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 Reconnect button.

When the device is already connected a Reset button becomes visible. Use it to terminate the device's connection to RMS.

For more information on Teltonika Networks Remote Management System (RMS) refer to the RMS Manual or RMS FAQ pages.

Azure IoT Hub

Azure IoT Hub 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.

Modify Azure IoTHub

Field Value Description
Enable off | on; default: off Enable Azure IoT service.
Name string; default: none Connection name.
Enable Direct Methods off | on; default: off Enable Direct Method feature set.
Device Model ID string; default: dtmi:Teltonika:genericDevice;1 Model ID of the Digital Twins Definition Language.
Connection type Shared Access Signature (SAS) key | Device Provisioning Service (DPS); default: Shared Access Signature (SAS) key Connection type to an existing IoT Hub.
Connection String string; default: none Connection string based on primary key used in API calls which allows device to communicate with IoT Hub.
ID Scope string; default: none 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.
Registration ID string; default: none The registration ID is used to uniquely identify a device registration with the Device Provisioning Service.
Global Device Endpoint string; default: global.azure-devices-provisioning.net Destination for messages sent by IoT devices to the Azure IoT Hub.
Attestation mechanism X.509 certificates | Symmetric Key; default: X.509 certificates Method used to confirm a device's identity in Device Provisioning Service.
Use certificate files from device off | on; default: off Choose this option if you want to select certificate files from device. Certificate files can be generated here.
X.509 Certificate -interactive button; default: Upload the "leaf" certificate file.
X.509 Private Key -interactive button; default: Upload the "leaf" key file.
Symmetric Key string; default: none The the derived device key from the DPS Primary Key.

Cloud of Things

The Cloud of Things 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.

Field Value Description
Enable off | on; default: off Turns the Cloud of Things service on or off.
Cloud of Things status state; default: - Cloud of Things status.
Server Address ip | host; default: none Cloud of Things server IP address or hostname.
Interval integer [0..32767]; default: none Push connection interval in minutes.
Reset Auth - (interactive button) Resets authentication data so that device could be re-registered on the Cloud of Things Device Management platform.
Port integer [1..65535]; default: 8883 Cloud of Things server port.
QoS At least once (1) | At most once (0) | Exactly once (2); default: At least once (1) Quality of Service.
Keepalive integer [0..2147483647]; default: 60 Keepalive time in seconds.

Cumulocity

Cumulocity IoT is a cloud-based, real-time IoT management platform that's also compatible with Teltonika-Networks devices.

The figure and table below provide explanations for Cumulocity configuration parameters available on the device. For a detailed configuration guide, click here.

Field Value Description
Enable off | on; default: off Turns the Cumulocity service on or off.
Use SSL/TLS off | on; default: off Turn SSL/TLS protocol support on or off. For improved security it is advised to enable this option.
Server Address host; default: none Hostname of your Cumulocity server. It should match the Environment name from the Cumulocity registration.
For example: teltonika-networks.eu-latest.cumulocity.com
Interval integer; default: none Connection push interval in minutes. This field defines how often the device will try to connect to the Cumulocity server.
Reset Auth - (interactive button) 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.
Port integer [1..65535]; default: 8883 Cumulocity server port.
QoS At least once (1) | At most once (0) | Exactly once (2); default: At least once (1) Quality of Service.
Keepalive integer [0..2147483647]; default: 60 Keepalive time in seconds.

ThingWorx

Field Value Description
Enable off | on; default: off Turns the ThingWorx service on or off.
Server Address ip | host; default: none Thingworx server IP address or hostname.
Server Port integer [0..65535]; default: none Thingworx server's port number.
Thing Name string; default: none Thing name defined in ThingWorx CP.
Application Key string; default: none Application key generated in ThingWorx CP.
Mobile Interface network interface; default: mob1s1a1 Interface whose GSM parameters will be sent to the ThingWorx server for monitoring.

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 Add button and enter Thing's name:

After that you will be redirected to AWS jobs thing configuration:

Field Value Description
Enable off | on; default: off Turns the thing instance on or off.
Thing's name string; default: none Thing's name on AWS IoT Core platform.
Endpoint domain; default: none AWS IoT Core platform endpoint used to determine AWS account to connect to.
Use certificate files from device off | on; default: off Choose this option if you want to select certificate files from device. Certificate files can be generated here.
CA file .ca file; default: none AWS CA certificate obtained from AWS IoT Core platform.
Provisioning provisioning configuration; default: Basic provisioning 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.
Thing's certificate .crt file; default: none Thing's certificate obtained from AWS IoT Core platform.
Thing's private key .key file; default: none Thing's private key obtained from AWS IoT Core platform.
Port integer [1..65535]; default: 8883 MQTT port number.
QoS At most once (0) | At least once (1); default: At least once (1) MQTT Quality of Service. Allowed values:
  • 0 - when we prefer that the message will not arrive at all rather than arrive twice
  • 1 - when we want the message to arrive at least once but don't care if it arrives twice (or more).
Keepalive integer [30..65535]; default: 120 MQTT keepalive time in seconds.
Max loops integer [10..200]; default: 50 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.

AWS Provisioning

To add new 'AWS provisioning' template, press Add button and enter Template name:

After that you will be redirected to AWS provisioning configuration:

Field Value Description
Template string; default: Name of Fleet provisioning template in AWS service.
Fleet provisioning type Provisioning by claim | Provisioning by trusted user; default: Provisioning by claim
Creation type CreateKeysAndCertificate | CreateCertificateFromCsr; default: CreateKeysAndCertificate Specifies the AWS API to be used for certificate creation.
Use certificate files from device off | on; default: off Choose this option if you want to select certificate files from device. Certificate files can be generated here.
Provisioning claim certificate .crt file; default: none Provisioning claim certificate
Provisioning claim private key .key file; default: none Provisioning claim private key
Access key string (Values of 20 symbols are accepted. Following characters are accepted: A-Z0-9); default: none Trusted user's access key.
Secret key string (Values of 40 symbols are accepted); default: none Trusted user's secret key.
Parameters string (Following characters are accepted: a-zA-Z0-9:%_-); default: none Parameters which will be sent along with the certificate creation request. They will be formatted as JSON values ("Key": "Value").

Greengrass V2

AWS IoT Greengrass V2 is an open-source edge runtime and cloud service by Amazon Web Services that lets devices run software components deployed from the cloud, process data locally and stay in sync with AWS IoT Core. Greengrass V2 is compatible with Teltonika Networks devices.

The Greengrass V2 page is divided into five tabs: Overview, Core, Connection, Logging and Effective configuration. The Overview tab displays the current state of the Greengrass runtime. All information in this tab is read-only and can be updated with the 'Refresh' buttons.

Overview

State

The state the Greengrass Nucleus reports for this core device.

Field Value Description
Service state; default: - Whether Greengrass V2 is enabled, whether the service is running and whether the Nucleus has started reporting its state.
Device health state; default: - The health the Nucleus reports for this core device, based on the state of the components it runs.
Nucleus version string; default: - Version of the installed Greengrass Nucleus (core runtime).
Components string; default: - Counted by the Nucleus over the components it runs, including its own services.
State reported at date and time; default: - The Nucleus refreshes the state it reports every 60 seconds, so it can lag behind the device.

Cloud connection

The connection between the Greengrass Nucleus and AWS IoT Core.

Field Value Description
Cloud configuration state; default: - Whether the Nucleus has the credentials and endpoints it needs to reach AWS IoT Core.
MQTT connection state; default: - Whether the Nucleus is connected to AWS IoT Core over MQTT.
Thing name string; default: - The name this device is registered under in AWS IoT Core.
AWS region string; default: - AWS region in which the IoT Thing is registered, e.g., us-east-1.
Data endpoint host; default: - AWS IoT Core data endpoint the device connects to.

Deployment

The deployment the Greengrass Nucleus is applying, or the one it applied last. Deployments are created in AWS IoT Core and cannot be started from here.

Field Value Description
Deployment state state; default: - Whether a deployment is being applied to this device right now.
Last change string; default: - When the deployment state last changed on this device.

Components

Components deployed to this device. Root components are the ones a deployment targets directly, the rest were installed as their dependencies. To scroll hold Shift + Scroll mouse wheel.

Field Value Description
Component string; default: - Component name, e.g., aws.greengrass.Nucleus.
Version string; default: - Installed component version.
Status state; default: - Current lifecycle state of the component, e.g., RUNNING, FINISHED or BROKEN.
Origin string; default: - Whether the component is targeted by a deployment or was installed as a dependency of one that is.
Status codes string; default: - Status codes reported by the component, if any.
Reason string; default: - Explanation of the current status. Usually shown when a component has failed.

Nucleus services

Services the Greengrass Nucleus runs itself, such as the ones that apply deployments and report telemetry. They are not part of a deployment.

Field Value Description
Service string; default: - Name of the Nucleus service, e.g., DeploymentService or TelemetryAgent.
Version string; default: - Version of the service. Built-in Nucleus services may display 0.0.0 or -, because they are versioned together with the Nucleus itself.
Status state; default: - Current lifecycle state of the service, e.g., RUNNING, FINISHED.
Status codes string; default: - Status codes reported by the service, if any.
Reason string; default: - Explanation of the current status. Usually shown when a service has failed.

Core

The Core tab is used to configure the Greengrass Nucleus: how the device is provisioned in AWS IoT and how many system resources the runtime may use.

Provisioning

Provisioning configuration.

Field Value Description
Enable off | on; default: off Enable Greengrass V2.
Custom configuration off | on; default: off When enabled, allows uploading a custom Greengrass Nucleus configuration file instead of using the configuration generated from the fields on this page.
Custom configuration file -(interactive button) Upload the custom Greengrass configuration file.
Provisioning Manual | Fleet; default: Manual Method used to provision Greengrass devices.
Template string; default: none Name of the fleet provisioning template created in AWS IoT.
Template parameters Parameter: string; Value: string; default: none Parameters to provide to the fleet provisioning template. Use %serial% or %mac% to auto fill with the device's serial number or MAC address.
AWS region AWS regions; default: us-east-1 Specify the AWS region that Greengrass should use.
Thing's name string; default: none Thing’s name on AWS IoT Core platform.
Credential endpoint host; default: none AWS IoT credentials provider endpoint for your AWS account.
Data endpoint host; default: none AWS IoT Core data endpoint for your AWS account.
Token exchange role alias string; default: none Allows the device to securely access AWS services using temporary credentials.
Use certificate files from device off | on; default: off Choose this option if you want to select certificate files from device instead of uploading them. Certificate files can be generated here.
CA file -(interactive button) AWS CA certificate obtained from AWS IoT Core platform.
Certificate -(interactive button) Provide the device certificate required for AWS IoT authentication.
Private key -(interactive button) Provide the private key associated with the device certificate.

Limits and resources

Limits applied to the Greengrass Nucleus and the components it runs.

Field Value Description
Deployment polling frequency integer [1..86400]; default: none How often (in seconds) the device polls AWS IoT Core for deployment notifications.
Component store max size integer [1024..1099511627776]; default: none The maximum size (in bytes) on disk of the component store, which comprises component recipes and artifacts.
CPU limit decimal/number [0.1..256]; default: none The maximum amount of CPU time that the Greengrass Nucleus and its components can use. Fractional values are accepted.
Memory limit integer [1024..1073741824]; default: none The maximum amount of RAM (in kilobytes) that the Greengrass Nucleus and its components can use.
JVM options string; default: none Java virtual machine options passed to the Greengrass Nucleus, for example heap size or garbage collector settings.

Connection

The Connection tab is used to configure how the Greengrass Nucleus connects to AWS IoT Core over MQTT, and to set up a network proxy if the device reaches AWS through one.

MQTT

MQTT settings used by the Greengrass Nucleus to communicate with AWS IoT Core.

Field Value Description
MQTT port integer [1..65535]; default: none The port to use for MQTT connections.
MQTT keep alive timeout integer [0..3600000]; default: none The amount of time in milliseconds between each PING message that the client sends to keep the MQTT connection alive. Must not be smaller than the MQTT ping timeout.
MQTT ping timeout integer [0..1800000]; default: none The amount of time in milliseconds that the client waits to receive a PING acknowledgement from the server. Must not be greater than the MQTT keep alive timeout.
MQTT operation timeout integer [0..1800000]; default: none The amount of time in milliseconds that the client waits for MQTT operations (such as CONNECT or PUBLISH) to complete.
Max in flight publishes integer [1..100]; default: none The maximum number of unacknowledged MQTT QoS 1 messages that can be in flight at the same time.
Max message size (bytes) integer [0..2621440]; default: none The maximum size of an MQTT message in bytes.
Max publish retry integer [0..1000000 or -1 for unlimited retries is accepted]; default: none The maximum number of times to retry a message that fails to publish. The -1 means retry unlimited times.

Network proxy

Proxy that the Greengrass Nucleus uses to reach AWS services.

Field Value Description
Proxy URL url; default: none The URL of the proxy server in the scheme://host:port format.
Proxy username string; default: none The user name that authenticates the proxy server.
Proxy password string; default: none The password that authenticates the proxy server.
No proxy addresses ip | host; default: none Addresses that are reached without going through the proxy server.

Logging

The Logging tab is used to configure Greengrass Nucleus logging and to view or download the log files stored on the device.

Log configuration

Configure the Greengrass Nucleus logging settings.

Field Value Description
Log level Debug | Info | Warn | Error; default: Info Sets the Greengrass Nucleus logging level.
Log format Text | JSON; default: Text Sets the data format of the logs.
Log output File | Syslog; default: File Sets where the Greengrass Nucleus writes its logs.
Log directory string; default: none Directory where log files are stored, e.g., /greengrass/v2/logs.
Log file size integer [1..102400]; default: none The maximum size of each log file (in kilobytes). After a log file exceeds this maximum file size, the AWS IoT Greengrass Core software creates a new log file.
Log total size integer [1..1048576]; default: none The maximum total size of log files (in kilobytes). After a component's total size of log files exceeds this maximum size, the oldest log files are deleted.

Log file review

Select a Greengrass log file and review its contents.

Field Value Description
Log file log files; default: aws.greengrass.Nucleus.log Select which Greengrass log file to display.
(log file link) -(interactive button) Opens or downloads the selected log file.

Effective configuration

The configuration the Greengrass Nucleus is running with. It is assembled from the settings on the other pages together with the deployments received from AWS IoT Core, and cannot be edited here. Passwords are masked.

Field Value Description
Refresh -(interactive button) Reloads the configuration currently applied on the device.
Download -(interactive button) Downloads the effective configuration as a YAML file.
Copy -(interactive button) Copies the effective configuration to the clipboard.