This article applies to all TeamViewer IoT users.
ToC
TeamViewer IoT Agent
The TeamViewer IoT Agent is a software which provides remote access to a connected
device and offers an external CMI (Control and Monitoring Interface) that can be used to push sensor data to the TeamViewer IoT Cloud.
Getting Started
Installing
If you downloaded the package from the TeamViewer IoT dashboard, you can install the agent using
$ dpkg -i <package name>
If you received a device from an OEM partner (e.g © KUNBUS GmbH or © 2017 SYS TEC electronic GmbH) you can skip this step as the agent was installed by the device manufacturer.
Start agent
The agent has a command line user interface that you can use to interact with it. For the first start, run
teamviewer-iot-agent start
and follow the instructions on the screen.
$ [sudo] teamviewer-iot-agent start
The device is now assigned to your account.
Remote WebControl
Note: Currently it is only possible to use a recent Windows TeamViewer
Desktop Client to open a remote web control session.
After the agent is started and the assignment of the device is done, you can establish a connection by you double-clicking on the device entry in our Computers & Contacts list of the TeamViewer Desktop Client.
Monitoring
The teamviewer-iot-agent comes with an external CMI (Control and Monitoring Interface) that can be used to push sensor data to the TeamViewer IoT Cloud. Before you can use the TeamViewer IoT Cloud the device has to be provisioned.
After the device has been assigned to your account, use
teamviewer-iot-agent token
to create a temporary token. You have to enter this token within 120 seconds into the TeamViewer IoT dashboard to make your device available there. If you have to recreate this token you can use
teamviewer-iot-agent token
again.
For a complete provisioning guide, please refer to
http://www.teamviewer.com/link/?url=859364
Cloud Connection
Reporting data to the TeamViewer IoT Cloud is disabled by default. You can enable the connection by running the following command
$ teamviewer-iot-agent enable monitoring -i
To disable reporting into the Cloud call
$ teamviewer-iot-agent enable monitoring -i
Note: This command does not disable the API as it may be used for other
purposes, it only prevents sensor data to be transmitted into the TeamViewer IoT
Cloud.
System health monitoring
The teamviewer-iot-agent comes with a pre-configured monitor for monitoring the system health of the IoT device.
To activate this monitor, you will need to run the following command:
$ teamviewer-iot-agent enable monitoring -s
To stop this monitor, call the following command:
$ teamviewer-iot-agent disable monitoring -s
Working with ssh
If you like to start the agent on more than one device you can follow the
Steps mentioned below:
Your devices have to be in the same LAN as our TeamViewer Desktop Client:
1. Run the command:
$ ssh [user@]hostname '[sudo] teamviewer-iot-agent start -y -nw
Note: The "-y" means you directly accept the TeamViewer IoT EULA
2. In the Computers & Contacts list of the TeamViewer Desktop Client, click the
Add item icon.
3. Select Nearby contacts and devices. A list of all devices in the LAN with
TeamViewer installed will appear.
4. Locate the device host name in the list.
5. Double-click on the device host name and the device will be assigned to your account.
6. Double-click on the entry in our Computers & Contacts list to establish a
connection
Help
For more information about the IoT Agent and what you can do with it, call
$ man teamviewer-iot-agent
Authors
TeamViewer GmbH
License
If you want to use this software, you have to agree to the terms stated in
TeamViewer IoT End-User License Agreement
