Add sensors with Easy Setup - TeamViewer Support
<main> <article class="userContent"> <p><br></p><p>The <strong>Easy Setup for adding sensors</strong> is intended to provide you with an intuitive and easy experience that will lead you through the setup steps in adding the sensors.</p><p>The Easy Setup contains 3 basic steps. Follow the sections in this article:</p><ol><li>Generate a Sensor Script</li><li>Enable the Sensor Script on the Edge Device</li><li>Assign the Sensor Script to the Edge Device</li></ol><p>The generated <strong>Sensor Script</strong> is a <strong>template</strong>.</p><p>The <strong>Sensor Script</strong> prints metric values of a sensor in <strong>JSON format</strong> and each metric is described as a variable that gets a random value in between 1 and 20.</p><p>If you don’t have a ready script, you might need to search for tutorials on how to read your sensor data, find a library or script that works with your sensor and make sure that your script’s output prints the JSON formatted example as presented in the template.</p><p>Then place the ready script on the edge device and provide the full path information into the configuration page.</p><p>📌<strong>Notes:</strong></p><ul><li>Most sensors will be detected automatically when connected to your Edge Device. Other sensors may not be detected automatically; please refer to the Owners Manual of said sensor to get more information on how to connect the sensor to the Edge Device properly.</li><li>You will get an error message if input values are not permissible. You’ll need to adjust them accordingly.</li></ul><p>There are thousands of different sensors in the world. Some of them would need special libraries or custom development to get a data from. If you have trouble with the setup of sensors, contact <a href="https://www.teamviewer.com/?_ga=2.157280568.2061074140.1679400704-933174053.1679400704" rel="nofollow noreferrer ugc">TeamViewer</a>.</p><p><br></p><h3></h3><h2 data-id="what-you-will-need">What you will need</h2><p>Make sure that you have prepared the following points:</p><ul><li>Your TeamViewer credentials.</li><li>The edge device is set up with a TeamViewer IoT Agent and <a href="https://community.teamviewer.com/English/kb/articles/109820-enable-the-edge-management" rel="nofollow noreferrer ugc">TeamViewer Edge Management is enabled</a>.</li><li><a href="https://community.teamviewer.com/English/kb/articles/109829-access-the-edge-device-via-remote-terminal" rel="nofollow noreferrer ugc">Access the Edge Device via Remote Terminal</a>.</li><li>File Transfer is enabled (see <a href="https://community.teamviewer.com/English/kb/articles/109865-enable-file-transfer" rel="nofollow noreferrer ugc">Enable File Transfer</a>).</li><li>A Sensor is connected to the device.</li><li>The edge device is connected to the internet.</li></ul><p><br></p><h3 data-id="-1"></h3><h2 data-id="generate-a-sensor-script">Generate a Sensor Script</h2><p>1. To log in to the <strong>IoT Management Console</strong>, open <a href="https://teamviewer-iot.com/?_ga=2.120259851.2061074140.1679400704-933174053.1679400704" rel="nofollow noreferrer ugc">https://teamviewer-iot.com</a> and use your TeamViewer account credentials.</p><p>2. From the left menu select <strong>Devices</strong>.</p><p>3. On the right side from the <strong>dropdown menu</strong> select <strong>Add Sensor</strong>.</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/9DLK3684QQYI/easy-setup-sensor-add-sensor.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png" alt="easy_setup_sensor-add_sensor.png" height="166" width="999" loading="lazy" data-display-size="large" data-float="none" srcset="https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=10/https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png 10w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=300/https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png 300w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=800/https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png 800w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1200/https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png 1200w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1600/https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png 1600w, https://us.v-cdn.net/6032394/uploads/9DLK3684QQYI/easy-setup-sensor-add-sensor.png"></img></a> </div> </div> <p>4. Click <strong>Easy Setup</strong>.</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/PX5G8048XTWN/easy-setup-sensor-easy-setup.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png" alt="easy_setup_sensor-easy_setup.png" height="366" width="998" loading="lazy" data-display-size="large" data-float="none" srcset="https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=10/https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png 10w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=300/https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png 300w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=800/https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png 800w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1200/https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png 1200w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1600/https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png 1600w, https://us.v-cdn.net/6032394/uploads/PX5G8048XTWN/easy-setup-sensor-easy-setup.png"></img></a> </div> </div> <p>5. From the <strong>dropdown menu</strong> select the <strong>device </strong>with the sensor you would like to add.</p><p>6. Type in a <strong>unique sensor name</strong>.</p><p>7. Click <strong>(+)</strong> to add a metric. To configure the metric, provide a <strong>metric name</strong> and a <strong>unique ID</strong>. The fields <strong>Value Type</strong> and <strong>Value Unit</strong> are optional. (When a metric becomes superfluous click on the <strong>bin icon</strong> to remove it.)</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/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png" alt="easy_setup_sensor-setup_sensor.png" height="560" width="999" loading="lazy" data-display-size="large" data-float="none" srcset="https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=10/https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png 10w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=300/https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png 300w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=800/https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png 800w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1200/https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png 1200w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1600/https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png 1600w, https://us.v-cdn.net/6032394/uploads/UV4W069HWAM1/easy-setup-sensor-setup-sensor.png"></img></a> </div> </div> <p>8. When all metrics are configured click <strong>Download the generated Template</strong>.</p><p>The <strong>downloaded zip file</strong> contains template examples for Python and Bash.</p><p>9. On your local PC extract the zip file.</p><p>10. Pick one of the extracted files as your <strong>Sensor Script</strong>.</p><p>Keep the <strong>Management Console</strong> open and continue with <strong>Enable the Sensor Script on the Edge Device.</strong></p><p><br></p><h3 data-id="-2"></h3><h2 data-id="enable-the-sensor-ccript-on-the-edge-device">Enable the Sensor Ccript on the Edge Device</h2><p>In this task, you’ll need to transfer the previously downloaded <strong>Sensor Script</strong> to the <strong>Edge Device</strong>. Then you’ll give the Sensor Script fitting permissions to be executed.</p><ol><li>Transfer the <strong>Sensor Script</strong> to your <strong>Edge Device</strong> by using the <a href="https://community.teamviewer.com/English/kb/articles/109866-transfer-files" rel="nofollow noreferrer ugc">Transfer Files feature</a>. Remember the full path (<code class="code codeInline" spellcheck="false" tabindex="0">FULLPATH</code>) of the Sensor Script on the Edge Device.</li><li>Access the edge device remotely (<a href="https://community.teamviewer.com/English/kb/articles/109829-access-the-edge-device-via-remote-terminal" rel="nofollow noreferrer ugc">Access the Edge Device via Remote Terminal</a>).</li><li>Give the Sensor Script <strong>fitting permissions</strong>. In the terminal type in the following command and press return. Replace <code class="code codeInline" spellcheck="false" tabindex="0">FULLPATH</code> with the full path from the previous step.</li></ol><pre class="code codeBlock" spellcheck="false" tabindex="0">sudo chmod +x FULLPATH </pre><p><br></p><h2 data-id="assign-the-sensor-script-to-the-edge-device">Assign the Sensor Script to the Edge Device</h2><p>After you <strong>enabled the Sensor Script on the Edge Device</strong> you’ll need to continue where you left off from <strong>Generate a Sensor Script</strong>.</p><p>1. Type in the <code class="code codeInline" spellcheck="false" tabindex="0">FULLPATH</code> you remembered from <strong>Enable the Sensor Script on the Edge Device</strong>.</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/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png" alt="easy_setup_sensor-add_sensor_script_path.png" height="265" width="998" loading="lazy" data-display-size="large" data-float="none" srcset="https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=10/https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png 10w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=300/https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png 300w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=800/https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png 800w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1200/https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png 1200w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1600/https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png 1600w, https://us.v-cdn.net/6032394/uploads/D367D210CTCT/easy-setup-sensor-add-sensor-script-path.png"></img></a> </div> </div> <p>2. Select the <strong>frequency</strong> by which the data will be sent to the <strong>TeamViewer IoT Cloud</strong>. It can be defined in seconds or minutes.</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/8FCWLZHAD55K/easy-setup-sensor-finish.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png" alt="easy_setup_sensor-finish.png" height="486" width="999" loading="lazy" data-display-size="large" data-float="none" srcset="https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=10/https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png 10w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=300/https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png 300w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=800/https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png 800w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1200/https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png 1200w, https://us.v-cdn.net/cdn-cgi/image/fit=scale-down,width=1600/https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png 1600w, https://us.v-cdn.net/6032394/uploads/8FCWLZHAD55K/easy-setup-sensor-finish.png"></img></a> </div> </div> <p>3. To finish the Easy Setup click <strong>Add</strong>.</p><p><br></p><h3 data-id="-3"></h3> </article> </main>
