Overview
The Viotel API connection supports the connection and transfer of Accelerometer, Tiltmeter, and Vibrating Wite data into iTwin IoT. This article will guide the user in setting up the API connection.
This article will cover the following topics:
Retrieving iTwin IoT Asset API Key
An API key from the iTwin IoT asset will be required in order to establish the data transfer connection between Viotel and iTwin IoT. This section will guide the user in retrieving an API key from iTwin IoT.
1. Navigate to the Asset that data will be pushed to in iTwin IoT. From any page, click on the "Configure" icon in the lower left side of the page.
2. The user will be directed to the "Asset Configuration" page. The API key will be available within a tile on this page. The API key can either be highlighted and copied, or the "Copy to Clipboard" button will save it for pasting in future steps.
myViotel Setup
Navigate to the Viotel device configuration and management software: https://my.viotel.co/.
Set up all projects and devices within the Viotel application. Please contact Viotel support with any questions regarding Viotel app login, project setup, or Device configuration.
Once configured, the API connection is ready to be set up in iTwin IoT.
iTwin IoT API Connection
1. Within the iTwin IoT application, begin by navigating to the Connectivity Module.
2. Click on the "+Connection" icon.
3. Select Viotel from the available Connections list on the left sidebar.
4. Click the "Select" icon on the Viotel tile.
5. Input the username and password login information for your myViotel account. Click the "Next" icon.
6. The next page will be the Edit Configuration page for the connection. The project dropdown will allow the user to select the name of the project to connect to in the Viotel application. If the dropdown does not populate with options, click "Apply" and navigate back to the Viotel connection to make the project selection. After selecting the project, click "Apply".
Once complete, Devices and Sensors will begin populating within the Connectivity module and observations will begin streaming from myViotel.
If a Viotel vibrating wire node is being connected via the API connection, please see the Vibrating Wire Sensor Configuration article for information about how to set up the device and sensor.