Install TeamViewer IoT Agent

No ratings

This article applies to all TeamViewer IoT users.

Installation

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 account credentials.
  2. In the Home tab click on the Add Device button. iot-connect-device.png
  3. Select the platform of the remote device and download and install the agent.
  4. Run the provisioning command teamviewer-iot-agent-config.
    • You will be prompted with a Device ID and Token ID. Tokens are 8 characters long, case-sensitive, only alphanumeric strings. Make sure to note them down.Whatisiot1.png

    Note: Token ID is only valid for 120 seconds. If you need to get the token again, use teamviewer-iot-agent-config -t.

  5. Go back to the TeamViewer IoT dashboard and enter the provided Device ID and Token ID.
  6. The device will be automatically added to the Devices tab in the TeamViewer IoT dashboard. Whatisiot2.png

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

  7. The TeamViewer IoT Agent is now installed on the remote device and allows to add custom monitors and for remote access. You can find the device in the Devices tab named according to the hostname.

Activate Operating System Monitoring

TeamViewer IoT comes with a pre-configured monitor for monitoring the operating system of the 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:

teamviewer-iot-mon-agent-config start

When enabled, you see operating system specific metrics in the TeamViewer IoT web interface under the Metrics tab. For more information, see https://community.teamviewer.com/t5/IoT-Knowledge-Base/Getting-started-with-TeamViewer-IoT-Cloud-UI/....

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

teamviewer-iot-mon-agent-config stop

De-provision Agent and remove from dashboard

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

sudo teamviewer-iot-agent-config -u

in the command prompt of the remote device. Sensors and metrics on the dashboard will be automatically deleted.

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

Version history
Revision #:
8 of 8
Last update:
3 weeks ago
Updated by:
 
Labels (1)
Contributors