Edge Device Management - Real Time Edge Visualization - TeamViewer Support
<main> <article class="userContent"> <p><em>This article applies to TeamViewer IoT users who monitor their IoT networks.</em></p><p><em>The solution presented in this article requires the latest version of TeamViewer IoT Agent . To identify the version of your agent, run: </em><strong><em>sudo teamviewer-iot-agent info </em></strong><em>(an error, or no result, indicates an older version of the agent is installed). </em></p><h2 data-id="description"><strong>Description</strong></h2><p>This article describes how to use the TeamViewer IoT Edge Device Management Application, which provides Real-Time Visualization on your IoT device, in addition to a setup Wizard to provision your sensor network.</p><h2 data-id="installation"><strong>Installation</strong></h2><p>The application requires <strong>350MB free disk space </strong>for the following to be installed on the device:</p><ul><li>The latest version of TeamViewer IoT Agent</li></ul><p>For details, reference:<a href="http:// /home/leaving?target=https%3A%2F%2Fteamviewer-iot.com%2F" rel="nofollow noreferrer ugc"> https://teamviewer-iot.com/</a> To identify the installed version, run the following command: <em>(an error, or no result, indicates an older version of the agent is installed)</em></p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent info </pre><p> To enable the <em>Edge Management</em> application, use the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent install edge-management </pre><p><strong><em>Note: </em></strong><em>Docker </em>engine will be installed automatically if it is not found on the device.</p><p>To start the application on default port 80, run the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent start edge-management </pre><p>Port Configuration is Optional, Default port 80, to start application on alternate port run the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent start edge-management --port=8080 </pre><p>If you need to stop the application, use the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent stop edge-management </pre><p>To update the <em>Edge Management</em> application please use the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent update edge-management </pre><h3 data-id="uninstall-edge-management"><strong>Uninstall Edge management</strong></h3><p>To uninstall <em>Edge Management</em> run the following command:</p><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo teamviewer-iot-agent uninstall edge-management </pre><h2 data-id="getting-started">Getting Started</h2><p>After the installation is complete, you can use <a href="https://community.teamviewer.com/English/home/leaving?target=https%3A%2F%2Fwww.teamviewer.com%2Fen%2Fdownload%2Fwindows%2F" rel="nofollow noreferrer ugc">TeamViewer Client for Windows</a> to remotely create secure applications, register sensors and metrics, and view real-time streaming data.</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6032394/uploads/lithium_attachments/11509i3314D6D2926646A7.jpg" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/lithium_attachments/11509i3314D6D2926646A7.jpg" alt="10_last picture.png" height="180" width="320" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><br></p><p><strong><em>Note: Currently, Remote Access to TeamViewer IoT devices is only supported by TeamViewer Client for Windows.</em></strong></p><p>To get started, log into your <a href="https://community.teamviewer.com/English/home/leaving?target=https%3A%2F%2Fteamviewer-iot.com%2F" rel="nofollow noreferrer ugc">TeamViewer IoT Cloud Dashboard</a> and Click on the <em>Control</em> button on the <em>Devices </em>page. This will open the <em>TeamViewer Client</em> and start a secure connection to your <em>IoT</em> device.</p><h3 data-id="creating-secure-clients-sensors-metrics">Creating Secure Clients, Sensors & Metrics</h3><p>This application provides a GUI wizard for you to create secure clients and define sensors and metrics, as defined by the TeamViewer IoT <a href="https://community.teamviewer.com/t5/TeamViewer-IoT-Knowledge-Base/Teamviewer-IoT-device-MQTT-API/ta-p/17116" rel="nofollow noreferrer ugc">MQTT API</a>. You will need to then push your sensor data as specified in the <a href="https://community.teamviewer.com/English/home/leaving?target=https%3A%2F%2Fdownload.teamviewer-iot.com%2Fdocs%2Fagentapi%2Findex.html%3F%23api-Metric-Sensor_Send_sensor_data" rel="nofollow noreferrer ugc">MQTT API Push Metric Values</a> section to visualize it in real-time.</p><p>Using the wizard, you can create new Clients or authorize existing ones.</p><h4 data-id="creating-new-clients">Creating New Clients</h4><p>You can create new Clients either automatically or by using an existing Certificate Signing Request (CSR). To create clients using a CSR, you must upload the CSR & the associated private key.</p><p>Once a secure Client has been created, you can download its credentials for use on remote devices (to easily integrate sensors on remote devices to your TeamViewer IoT Agent). Reference <a href="https://community.teamviewer.com/t5/TeamViewer-IoT-Knowledge-Base/Learn-how-to-set-up-Remote-Clients-to-integrate-your-IoT-Network/ta-p/37205" rel="nofollow noreferrer ugc">Remote Clients</a> for details.</p><p>Once a secure Client has been created, you can use the wizard to define the sensors and metrics you want to connect. The wizard will provide you with the details and a template to use to push the sensors data as described in <a href="https://community.teamviewer.com/English/home/leaving?target=https%3A%2F%2Fdownload.teamviewer-iot.com%2Fdocs%2Fagentapi%2Findex.html%3F%23api-Metric-Sensor_Send_sensor_data" rel="nofollow noreferrer ugc">MQTT API Push Metric Values</a>.</p><h4 data-id="authorizing-existing-clients">Authorizing Existing Clients</h4><p>Any existing Client will automatically appear on your Clients lists. However, you must upload its Certificate credentials using the <em>Clients </em>page, to view it in real-time.</p><h4 data-id="viewing-data-in-real-time">Viewing Data in Real-Time</h4><p>Using the <em>Metrics </em>page, you can view a list of all your sensor metrics and quickly view each in real-time by clicking on the Metric name.</p><p><strong>Note</strong>: All Clients/Sensor/Metric metadata shown in the application is the same as displayed in the <a href="https://community.teamviewer.com/English/home/leaving?target=https%3A%2F%2Fteamviewer-iot.com%2F" rel="nofollow noreferrer ugc">TeamViewer IoT Cloud Dashboard</a>. </p><h4 data-id="managing-certificates">Managing Certificates</h4><p>All Client certificates, created by the application or uploaded by the user, are stored under:</p><p>/var/lib/docker/volumes/teamviewer-iot-edge-device-management-cert/_data</p><p>The certificate file names contain the <strong>Client Id</strong>, as shown in the template below, in case the certificates are needed on remote devices<em> Reference </em><a href="https://community.teamviewer.com/t5/TeamViewer-IoT-Knowledge-Base/Learn-how-to-set-up-Remote-Clients-to-integrate-your-IoT-Network/ta-p/37205" rel="nofollow noreferrer ugc"><em>Remote Clients</em></a><em> for details.</em></p><pre class="code codeBlock" spellcheck="false" tabindex="0">Public Key: cert-clientId.pem Private Key: key-clientId.pem </pre><p><strong>CAUTION</strong>: Do not rename, delete, or modify files under the <strong>cert/</strong> directory. Doing so will cause data corruption.</p><p> </p> </article> </main>
