TeamViewer IoT Documentation

The software development kits (SDK) are collections of software development tools in a installable package.

The SDKs enable advanced users to create custom applications within the TeamViewer IoT Solution, e.g. automation of processes.

The following SDKs are available:

• C
• Node / JavaScript
• Python

The TeamViewer IoT C-SDK is a development kit to facilitate integration of sensors to the IoT Agent MQTT API to allow for secure data registration and transfer to your TeamViewer IoT Cloud.

See:

• Download the C-SDK
• Set up the C-SDK with Visual Studio

What you will need

Make sure that you have prepared the following points:

• TeamViewer C-SDK has been downloaded.
• Microsoft Visual Studio is installed.

Setup

1. On your PC open Visual Studio.
2. Create or open a C project you would like to use to create solutions for your edge device.
3. Open the Solution Explorer (default: CRTL+ALT+L).
4. Right click the project name and from the popup menu select Properties.
5. On the left side click General > C/C++.
6. On the right side click Additional Include Directories then select Edit from the drop-down-menu.

7. Add the directory /include/ from the downloaded SDK to the project and click OK.
8. On the left side click Linker > General.
9. On the right side click Additional Library Directories then select Edit from the drop-down-menu.

10. Add the directories which contain the library files from the downloaded SDK to the project and click OK.
11. In the Properties dialog click OK.

The TeamViewer IoT Node-SDK (JavaScript) is a development kit to facilitate the integration of sensors to the IoT Agent MQTT API to allow for secure data registration and transfer to your TeamViewer IoT Cloud.

See:

• Set up the Node-SDK (Linux)

What you will need

Make sure that you have prepared the following points:

• Node.js 6.14.0 (Recommended version 8.3.0) or newer Long Term Support (LTS) version is installed on the device – see https://nodejs.org/en/blog/release/v8.3.0/ for more information.
• Access the Edge Device via Remote Terminal.

Setup

1. Access the edge device remotely (Access the Edge Device via Remote Terminal).
2. Download the SDK on the edge device. In the terminal type in the following command and press return.

wget https://download.teamviewer-iot.com/sdks/nodejs/v1.0.3/teamviewer-iot-sdk-nodejs-v1.0.3.tar.gz

2. Extract and install the SDK. In the terminal type in the following commands and press return.

sudo tar -zxvf teamviewer-iot-sdk-nodejs-v1.0.3.tar.gz

cd teamviewer-iot-sdk-nodejs

sudo npm install

3. Optional: run the SDKs’ examples. In the terminal type in the following command and press return.

sudo node ./examples/create_metric.js

The TeamViewer IoT Python-SDK is a development kit to facilitate the integration of sensors to the IoT Agent MQTT API to allow for secure data registration and transfer to your TeamViewer IoT Cloud.

See:

• Set up the Python-SDK (Linux)

What you will need

Make sure that you have prepared the following points:

• python 2.7.9 or version 3 is installed on the device (see https://www.python.org/downloads/).
• Access the Edge Device via Remote Terminal.

Setup

1. Access the edge device remotely (Access the Edge Device via Remote Terminal).
2. Download the SDK files. In the terminal type in the following command and press return.

wget https://download.teamviewer-iot.com/sdks/python/v1.1.0/teamviewer_iot_python_sdk-1.1.0-py3-none-any.whl

3. Install the SDK. In the terminal type in the following command and press return.

sudo pip3 install teamviewer_iot_python_sdk-1.1.0-py3-none-any.whl

4. Extract the package files. In the terminal type in the following command and press return.

unzip teamviewer_iot_python_sdk-1.1.0-py3-none-any.whl -d

teamviewer_iot_python_sdk

5. Optional: Run the SDK example. In the terminal type in the following command and press return.

cd teamviewer_iot_python_sdk

sudo python3 ./examples/create_metric.py

For the Node-Red programming environment, TeamViewer provides a plugin which can be used to interact with TeamViewer IoT Agent.

The plugin enables advanced users to create sensors/metrics and to push data to the TeamViewer IoT Cloud. The plugin is available at the Node-Red Flows and can be installed directly from the Node-Red environment.

See:

• Set up the TeamViewer IoT Node-Red Plugin
• Application Development with the TeamViewer IoT Node-Red Plugin

What you will need

Make sure that you have prepared the following points:

• Access the Edge Device via Remote Terminal.
• On the edge device Node-Red is installed (see https://nodered.org/).

Setup

1. Access the edge device remotely (Access the Edge Device via Remote Terminal).
2. Edit the ~/.node-red/settings.js file in your user directory and uncomment the contextStorage section.

contextStorage: {
 default: {
  module:"localfilesystem"
 },
},

Note: The location of the file is depending how you start the node-red. Could be under root or your user directory.

3. Install Teamviewer IoT Node-Red Plugin directly from the Node-Red environment.

Access your Node-Red webpage. From the menu, select Manage Palette, search for “teamviewer” and click Install.

4. Alternatively, install Teamviewer IoT Node-Red Plugin using npm by running in terminal the command:

npm install @teamviewer/node-red-contrib-teamviewer-iot

 

What you will need

Make sure that you have prepared the following points:

• Your TeamViewer credentials.
• Access the Edge Device via Remote AppControl.
• The edge device is set up with the TeamViewer IoT Node-Red Plugin.

1. Open the node-red web interface from your web browser and in the left panel you will find the teamviewer iot node. Configure it as described in the help window.

2. Use the TeamViewer IoT node to create instances in TeamViewer IoT Cloud.
3. Each node represents a TeamViewer IoT Metric in Node-Red environment.
4. Each Metric needs to be assigned to a Sensor.
5. For each Sensor, select or add a Client.
6. The green dot at the node indicates a successful connection to the TeamViewer IoT Agent.
7. In the TeamViewer IoT Cloud, the created sensors and metrics can be seen.