This article applies to TeamViewer IoT users who monitor their IoT networks.
The solution presented in this article requires the latest version of TeamViewer IoT Agent . To identify the version of your agent, run: sudo teamviewer-iot-agent info (an error, or no result, indicates an older version of the agent is installed).
Description
This article describes how to use the TeamViewer IoT Edge Device Management Application, which provides Real-Time Visualization on your IoT device, in addition to a setup Wizard to provision your sensor network.
Installation
The application requires 350MB free disk space for the following to be installed on the device:
- The latest version of TeamViewer IoT Agent
For details, reference: https://teamviewer-iot.com/ To identify the installed version, run the following command: (an error, or no result, indicates an older version of the agent is installed)
sudo teamviewer-iot-agent info
To enable the Edge Management application, use the following command:
sudo teamviewer-iot-agent install edge-management
Note: Docker engine will be installed automatically if it is not found on the device.
To start the application on default port 80, run the following command:
sudo teamviewer-iot-agent start edge-management
Port Configuration is Optional, Default port 80, to start application on alternate port run the following command:
sudo teamviewer-iot-agent start edge-management --port=8080
If you need to stop the application, use the following command:
sudo teamviewer-iot-agent stop edge-management
To update the Edge Management application please use the following command:
sudo teamviewer-iot-agent update edge-management
Uninstall Edge management
To uninstall Edge Management run the following command:
sudo teamviewer-iot-agent uninstall edge-management
Getting Started
After the installation is complete, you can use TeamViewer Client for Windows to remotely create secure applications, register sensors and metrics, and view real-time streaming data.
Note: Currently, Remote Access to TeamViewer IoT devices is only supported by TeamViewer Client for Windows.
To get started, log into your TeamViewer IoT Cloud Dashboard and Click on the Control button on the Devices page. This will open the TeamViewer Client and start a secure connection to your IoT device.
Creating Secure Clients, Sensors & Metrics
This application provides a GUI wizard for you to create secure clients and define sensors and metrics, as defined by the TeamViewer IoT MQTT API. You will need to then push your sensor data as specified in the MQTT API Push Metric Values section to visualize it in real-time.
Using the wizard, you can create new Clients or authorize existing ones.
Creating New Clients
You can create new Clients either automatically or by using an existing Certificate Signing Request (CSR). To create clients using a CSR, you must upload the CSR & the associated private key.
Once a secure Client has been created, you can download its credentials for use on remote devices (to easily integrate sensors on remote devices to your TeamViewer IoT Agent). Reference Remote Clients for details.
Once a secure Client has been created, you can use the wizard to define the sensors and metrics you want to connect. The wizard will provide you with the details and a template to use to push the sensors data as described in MQTT API Push Metric Values.
Authorizing Existing Clients
Any existing Client will automatically appear on your Clients lists. However, you must upload its Certificate credentials using the Clients page, to view it in real-time.
Viewing Data in Real-Time
Using the Metrics page, you can view a list of all your sensor metrics and quickly view each in real-time by clicking on the Metric name.
Note: All Clients/Sensor/Metric metadata shown in the application is the same as displayed in the TeamViewer IoT Cloud Dashboard.
Managing Certificates
All Client certificates, created by the application or uploaded by the user, are stored under:
/var/lib/docker/volumes/teamviewer-iot-edge-device-management-cert/_data
The certificate file names contain the Client Id, as shown in the template below, in case the certificates are needed on remote devices Reference Remote Clients for details.
Public Key: cert-clientId.pem
Private Key: key-clientId.pem
CAUTION: Do not rename, delete, or modify files under the cert/ directory. Doing so will cause data corruption.
