This article applies to all TeamViewer IoT users.

The solution presented in this article requires TeamViewer IoT Agent v 1.1.102 (or higher). 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).

Installing the TeamViewer IoT Agent

To install the TeamViewer IoT agent on the remote device, follow this guide. Make sure to repeat these steps on every device you want to monitor with TeamViewer IoT.

  1. Open the TeamViewer IoT Dashboard under https://teamviewer-iot.com and log in with your TeamViewer account credentials.
  2. In the Home tab click on the Add Device button.
  3. Follow the steps outlined on the Add Device page to download & install the TeamViewer IoT Agent and to provision your device.
  4. Upon successful installation, use the Check Installation button on the TeamViewer IoT Dashboard.  Your device will be automatically added to the Devices tab in the TeamViewer IoT Dashboard and can be identified by its hostname.

    Note: The device will also be added to your TeamViewer Computers & Contacts list.

Upgrading the TeamViewer IoT Agent

To upgrade an existing version of the TeamViewer IoT Agent to the latest version, reference the agent upgrade article.

Activate Operating System Monitoring

TeamViewer IoT comes with a pre-configured monitor for monitoring the operating system of your IoT device. You can use this monitor to keep track of the following device operating system metrics:

  • 1 min load
  • 5 min load
  • 15 min load
  • Free Memory
  • Total Memory
  • Free Swap Memory
  • Total Swap Memory
  • Buffers Memory
  • Cached Memory
  • Number of CPU cores
  • User CPU Usage
  • Nice CPU Usage
  • System CPU Usage
  • Idle CPU Usage
  • Io Wait CPU Usage

To activate this operating system monitor, you will need to run the following command on the remote device:

sudo teamviewer-iot-agent enable monitoring

When enabled, your IoT device operating system metrics will automatically be added to the Metrics tab.  You will be able to add rules and view the metrics from the Dashboard.

For more information, see Getting started with TeamViewer IoT Cloud UI.

To disable operating system monitoring, run the following command on the remote device:

sudo teamviewer-iot-agent disable monitoring

De-provisioning an Agent and removing it from your Account

To de-provision the TeamViewer IoT agent from the remote device, run the de-provisioning command from your IoT device:

Note: All attached sensors and metrics on the dashboard will be automatically deleted.

sudo teamviewer-iot-agent unmanage

Alternatively, you can delete the device from your Computer & Contacts list. This will result in the same behavior as the de-provisioning command.

Note: For a complete list of TeamViewer IoT Agent commands, run this command:

sudo teamviewer-iot-agent --help

 

Version history
Revision #:
21 of 21
Last update:
September
Updated by:
 
Labels (4)