A tour of thin-edge.io

tip

User Context

You can customize the documentation and commands shown on this page by providing relevant settings which will be reflected in the instructions. It makes it even easier to explore and use thin-edge.io.

Loading user context...

The user context will be persisted in your web browser's local storage.

After following this tutorial you will have an overview of the installation and configuration of thin-edge.io. As an example, a Raspberry Pi is used. This tutorial explains in small steps to reach the goal of sending data to Cumulocity IoT and performing some additional device management tasks.

Introduction

thin-edge.io is an open-source project to provide a cloud-agnostic edge framework. It is much more generic than the device management agent, so it can connect to multiple IoT cloud platforms, and it allows flexible logic executed on the device. It is optimized for a very small footprint and high performance.

The Raspberry PI is a relatively simple and cheap device but powerful. Therefore it is ideal for testing and try-outs and some production use cases.

Prerequisite

To follow this guide, you only need the following:

• A Cumulocity IoT Trial tenant.

• A Raspberry Pi (any model is fine) with RaspberryPi OS installed, for other boards and OS'es have a look here

• Updated device

  sudo apt-get update && sudo apt-get upgrade

Steps

This tutorial is divided into small steps. The first three steps are needed to install and connect to Cumulocity IoT. The last three are optional but needed to get a good overview of the capabilities of thin-edge.io.

• Step 1 Install thin-edge.io
• Step 2 Configure and Connect to Cumulocity IoT
• Step 3 Sending Device Data
• Step 4 Monitor the device
• Step 5 Add software management
• Step 6 Manage configuration files
• Step 7 Manage Log Files

Step 1 Install thin-edge.io

The easiest way is to use the installation script with this command:

curl

curl -fsSL https://thin-edge.io/install.sh | sh -s

wget

wget -O - https://thin-edge.io/install.sh | sh -s

After a successful installation, it is possible to use thin-edge.io via the CLI and use the tedge commands.

info

For more information about the installation, please have a look here for more information.

Tedge CLI

In the previous step, the CLI tool is installed, which is a very powerful

The usage is as follows:

tedge [OPTIONS] [SUBCOMMAND]

and -h can be used to see the help for the latest subcommand.

When running this command something similar like the following will be displayed:

tedge -h

Output

tedge is the cli tool for thin-edge.io

USAGE:
    tedge [OPTIONS] [SUBCOMMAND]

OPTIONS:
        --config-dir <CONFIG_DIR>    [env: TEDGE_CONFIG_DIR, default: /etc/tedge]
    -h, --help                       Print help information
        --init                       Initialize the tedge
    -V, --version                    Print version information

SUBCOMMANDS:
    cert          Create and manage device certificate
    config        Configure Thin Edge
    connect       Connect to connector provider
    disconnect    Remove bridge connection for a provider
    help          Print this message or the help of the given subcommand(s)
    init          Initialize Thin Edge
    mqtt          Publish a message on a topic and subscribe a topic
    reconnect     Reconnect command, calls disconnect followed by connect

Here is an overview of the commands for the CLI tool.

The CLI will be used to configure the thin-edge.io installation on the device in the next steps.

Step 2 Configure and Connect to Cumulocity IoT

To connect the device to the Cumulocity IoT it needs to be configured.

This URL is needed to allow the upload of the certificate to the specific tenant and the registration of the device. It can be configured via:

sudo tedge config set c8y.url "undefined"

Certificate

thin-edge.io connects via MQTT protocol using a X.509 certificate for authentication. To do so, a certificate must be trusted by Cumulocity IoT. A certificate is trusted when it is added to the trusted certificates and is in an activated state.

First, we need to create the device certificate locally (If the device certificate is already uploaded, directly via the UI to Cumulocity IoT this step can be skipped).

sudo tedge cert create --device-id "undefined"

The device id is a unique identifier e.g. the MAC address that identifies the physical device.

The certificate is uploaded to the Cumulocity IoT Tenant via:

sudo tedge cert upload c8y --user "undefined"

If the password prompt appears, enter your password.

info

In a production environment, it is not recommended to use the above self-signed certificate, which is for demo purposes. If you plan to use this tutorial as a basis for production, please have a look here: Registering devices using certificates.

Connect

We now are ready to connect the device to Cumulocity IoT. This can be achieved via:

sudo tedge connect c8y

When the connection is established, the device will be created in Cumulocity IoT. When you go to Device Management → Devices → All devices, the device is visible in the list.

Step 3 Sending Device Data

Once your device is configured and connected to Cumulocity IoT, you can start sending measurements, events or alarms. In the standard configuration, you can not connect externally to the mosquito broker and thus the messages have to be sent directly from the device itself.

Below shows some examples on how to publish an MQTT message via the command line:

tedge

tedge mqtt pub '{{TOPIC}}' '{{PAYLOAD}}'

mosquitto

mosquitto_pub -t '{{TOPIC}}' -m '{{PAYLOAD}}'

mqtt

Publish topic

{{TOPIC}}

Payload

{{PAYLOAD}}

thin-edge.io comes with a tedge-mapper daemon. This process collects the data from the te/# topics and translates them to the tedge payloads on the c8y/# topics which are mapped directly to Cumulocity IoT. The mapper translates simple JSON to the desired target payload for Cumulocity IoT.

Sending measurements

Measurements within Cumulocity IoT represent regularly acquired readings and statistics from sensors.

A simple single-valued measurement like a temperature measurement can be represented in thin-edge.io JSON as follows:

{"temperature": 25}

With the key-value pair representing the measurement type and the numeric value of the measurement. The endpoint that is supervised by the tedge-mapper for measurements is:

te/+/+/+/+/m/+

The temperature measurement described above can be sent as follows:

tedge

tedge mqtt pub 'te/device/main///m/' '{
  "temperature": 25
}'

mosquitto

mosquitto_pub -t 'te/device/main///m/' -m '{
  "temperature": 25
}'

mqtt

Publish topic

te/device/main///m/

Payload

{
  "temperature": 25
}

Sending events

Events are used to pass real-time information, which is not just plain sensor values, through Cumulocity IoT.

A simple event can be represented in thin-edge.io JSON as follows:

{
  "text": "A door was closed"
}

The endpoint that is supervised by the tedge-mapper for events is:

te/+/+/+/+/e/+

So the door open event described above can be sent as follows:

tedge

tedge mqtt pub 'te/device/main///e/door' '{
  "text": "A door was closed"
}'

mosquitto

mosquitto_pub -t 'te/device/main///e/door' -m '{
  "text": "A door was closed"
}'

mqtt

Publish topic

te/device/main///e/door

Payload

{
  "text": "A door was closed"
}

info

The command does not provide the time property, so the current timestamp will be injected by the mapper. However an explicit time can be given as a Unix timestamp, as in "time": 1706794400, or using RFC 3339, as in "time":"2024-02-01T13:32:19+00:00".

When you go to events (Device management → your device → events), you should see this:

Step 4 Monitor the device

With thin-edge.io device monitoring, you can collect metrics from the device and forward these device metrics to Cumulocity IoT.

Device monitoring can be enabled by installing a community package, tedge-collectd-setup, which will install collectd and configure some sensible defaults including monitoring of cpu, memory and disk metrics.

Debian/Ubuntu

sudo apt-get install tedge-collectd-setup

RHEL/Fedora/RockyLinux

sudo dnf install tedge-collectd-setup

Alpine

sudo apk add tedge-collectd-setup

What you should see by now is that data arrives on the collectd/# topics. You can check that via:

tedge

tedge mqtt sub 'collectd/#'

mosquitto

mosquitto_sub -t 'collectd/#'

mqtt

Subscribe: topic

collectd/#

The output will be similar like:

Output

INFO: Connected
[collectd/raspberrypi/df-root/percent_bytes-used] 1667205183.407:11.7998857498169
[collectd/raspberrypi/memory/percent-used] 1667205183.408:4.87045198079293
[collectd/raspberrypi/cpu/percent-active] 1667205184.398:1.52284263959391

note

The default collectd settings, /etc/collectd/collectd.conf, use conservative interval times, e.g. 10 mins to 1 hour depending on the metric. This is done so that the metrics don't consume unnecessary IoT resources both on the device and in the cloud. If you want to push the metrics more frequently then you will have to adjust the Interval settings either globally or on the individual plugins. Make sure you restart the collectd service after making any changes to the configuration.

The tedge-mapper-collectd service subscribes to the collectd/# topics and translates them to the tedge payloads, then the respective cloud mappers will translate the thin-edge.io messages to the format dictated by each cloud.

As an example, you can inspect the Cumulocity IoT translated metrics using the following command:

tedge

tedge mqtt sub 'c8y/#'

mosquitto

mosquitto_sub -t 'c8y/#'

mqtt

Subscribe: topic

c8y/#

The output will be similar like:

Output

INFO: Connected
[c8y/measurement/measurements/create] {"type":"ThinEdgeMeasurement","time":"2022-10-31T08:35:44.398000001Z","cpu":{"percent-active":{"value":1.26262626262626}},"memory":{"percent-used":{"value":4.87024847292786}}}
[c8y/measurement/measurements/create] {"type":"ThinEdgeMeasurement","time":"2022-10-31T08:35:45.398000001Z","memory":{"percent-used":{"value":4.87024847292786}},"cpu":{"percent-active":{"value":1.01522842639594}}}
[c8y/measurement/measurements/create] {"type":"ThinEdgeMeasurement","time":"2022-10-31T08:35:46.398000001Z","memory":{"percent-used":{"value":4.87024847292786}},"cpu":{"percent-active":{"value":0.759493670886076}}}
[c8y/measurement/measurements/create] {"type":"ThinEdgeMeasurement","time":"2022-10-31T08:35:47.398000001Z","memory":{"percent-used":{"value":4.87024847292786}},"cpu":{"percent-active":{"value":2.01005025125628}}}
[c8y/measurement/measurements/create] {"type":"ThinEdgeMeasurement","time":"2022-10-31T08:35:48.398000001Z","memory":{"percent-used":{"value":4.87004496506279}},"cpu":{"percent-active":{"value":0.254452926208651}}}

The monitoring data will appear in Cumulocity IoT on the device in the measurement section.

Edit Collectd

To change the monitored data, it is needed to change the collectd.conf. This can be done via Cumulocity IoT, and step 6 explains how to do it.

Step 5 Add software management

Software management takes care of allowing installation and management of any type of software from Cumulocity IoT. Since the type is generic, any type of software can be managed. In thin-edge.io this can be extended with plugins. For every software type, a particular plugin is needed.

The following plugins do exist:

• Docker
• APT
• Docker-compose
• Snap

To use those plugins they need to be copied to the following folder:

/etc/tedge/sm-plugins/

The APT plugin (provided by the tedge-apt-plugin package) is installed by default. You can find the other plugins in the repository. Make sure to disconnect/reconnect the device after adding plugins via:

sudo tedge reconnect c8y

Adding new software into the software repository in Cumulocity IoT

1. Go to Cumulocity IoT

2. Go to Management → Software repository (left in the menu) and click Add software at the right of the top menu bar.

3. In the dialog box, enter a name for the software and confirm it by clicking Add new, a description and its version.

4. thin-edge.io contains a default plugin supporting debian packages from both apt repositories as well as remote locations. If you prefer to use packages from an apt repository, select the Provide a file path option and give an empty space (' ').

   

   If you would like to use other sources (eg. a file uploaded to your cloud or an external source), provide the full URL to the file. If you would like to upload your binaries, select Upload a binary option and upload the file to Cumulocity IoT software repository.

5. Press Add Software button.

Installing software on a device

1. Go to Cumulocity IoT

2. Click All devices in the Devices menu, select the desired device from the device list and open its Software tab.

   The Software tab shows a list of all available software installed on the device. If a given software has a type, it will be displayed next to its name. It is possible to search for a particular software by its name or filter the list by software type.

3. Click on Install software, on the bottom of the page

4. Find/select the software which was added to the repository in the previous step.

5. Select the right version and click on install

6. Then click on apply changes, the software will be installed.

When a different version of the already installed software needs to be installed, choose in step 4 the installed software from the list and in step 5 the desired version.

Find more information about how to manage the software on a device.

How to develop your own plugins is described here.

Step 6 Manage configuration files

With thin-edge.io it is possible to manage config files on a device by using the Cumulocity IoT configuration management feature as a part of Device Management.

This functionality is directly installed with the initial script. However, it is needed to configure its configuration file to add the entries for the configuration files which need to be managed.

As an example you can copy the following content to add some new configuration files which can be retrieved or applied to the device:

file: /etc/tedge/plugins/tedge-configuration-plugin.toml

files = [
    { path = '/etc/tedge/tedge.toml' },
    { path = '/etc/tedge/mosquitto-conf/c8y-bridge.conf', type = 'c8y-bridge.conf' },
    { path = '/etc/tedge/mosquitto-conf/tedge-mosquitto.conf', type = 'tedge-mosquitto.conf' },
    { path = '/etc/mosquitto/mosquitto.conf', type = 'mosquitto.conf' }
]

Where:

• path is the full path to the configuration file.
• type is a unique alias for each file entry which will be used to represent that file in Cumulocity UI.

Then navigate to Cumulocity IoT Device Management and the desired device. Open its Configuration tab. You can find tedge-configuration-plugin and more are listed as supported configuration types, as declared in the plugin configuration file. Here you can save the configuration files into the repository or download them.

Change configuration files via Cumulocity IoT.

If there is a need to change one or more configuration files, there is more than one option to follow:

• Create a whole new configuration file
• Change an existing configuration file

In this tutorial the last option is explained, there are some steps to be taken:

1. Save the configuration file to the repository (Device management → configuration. In the list of configuration files pick a file to change and click on Save to repository).
2. Go to Management → configuration snapshots repository.
3. Download the configuration file which needs to be changed (the one you saved to the repository in step 1).
4. Edit this file as needed.
5. Click on Add configuration snapshot (top right).
6. Fill the fields, make sure the device type is thin-edge.io, select the right Configuration type and add the (just edited) configuration file and click on Add configuration.
7. Go back to the device and then to the configuration. In the Available supported configuration you will see the configuration file which was just created. When you click on it, you will see the content.
8. Then click on send configuration to device the configuration file is uploaded to the device.
9. If you then click on get snapshot from device (select the right configuration file in device-supported configurations), you will see the change of the configuration file.

Change collectd configuration file via Cumulocity IoT

To change the collectd metrics of the device, which are displayed in Cumulocity IoT, the next steps are needed. These are similar to the steps in the previous paragraphs.

1. Add a new entry to the files section of the plugin's configuration file

   file: /etc/tedge/plugins/tedge-configuration-plugin.toml

   files = [
     # ...
     {path = '/etc/collectd/collectd.conf', type = 'collectd.conf'},
   ]

2. Save the configuration file to the repository

3. Go to Management → configuration snapshots repository

4. Download the configuration file which needs to be changed

5. Edit this file as needed

6. Click on Add configuration snapshot (top right)

7. Fill in the fields, make sure the device type is thin-edge.io and select the right Configuration type and add the (just edited) configuration file then click on Add configuration

8. Go back to the device and then to the configuration. In the Available supported configuration you will see the configuration file which was just created. When you click on it, you will see the content

9. Then click on send configuration to the device the configuration file is uploaded to the device.

10. If you then click on get snapshot from device (select the right configuration file in device supported configurations), you will see the change of the configuration file.

Step 7 Manage Log Files

With thin-edge.io it is possible to request log files from a device by using the Cumulocity IoT log request feature as a part of Device Management.

This functionality is also installed by default but some configuration is needed to indicate which log files the plugin should manage.

Log files can be added by creating or editing the following file with the given contents:

file: /etc/tedge/plugins/tedge-log-plugin.toml

files = [
  { type = "software-management", path = "/var/log/tedge/agent/workflow-software_*" },
  { type = "mosquitto", path = "/var/log/mosquitto/mosquitto.log" },
  { type = "daemon", path = "/var/log/daemon.log" },
  { type = "user", path = "/var/log/user.log" },
  { type = "apt-history", path = "/var/log/apt/history.log" },
  { type = "apt-term", path = "/var/log/apt/term.log" },
  { type = "auth", path = "/var/log/auth.log" },
  { type = "dpkg", path = "/var/log/dpkg.log" },
  { type = "kern", path = "/var/log/kern.log" }
]

To see the content of the log files in Cumulocity IoT, take the following steps:

1. Go to device management and select the right device.

2. Select Logs. In this screen, you can request Log files

3. Click on Request log file(the top right).

4. In the next screen you can select a date range and a type of log.

5. Then click on Request log file.

6. Refresh the page.

7. Click on the requested log file, you should see something similar to this:

If tedge-log-plugin.toml is added to the tedge-configuration-plugin.toml it is possible to do the administration from there.

However, keep in mind that the daemon has to be restarted every time the /etc/tedge/plugins/tedge-log-plugin.toml is touched via the command line.

Final remarks and summary

With this getting started tutorial you gained some insights on how to install and configure thin-edge.io on a Raspberry Pi.

If you didn't try the optional steps in this tutorial, it might be a nice idea to work on these as you then get a better insight into the device management capabilities of thin-edge.io. Other things you can work on are capabilities like working with child devices, building your own plugin etc. Tutorials for that can be found here.