Glossary

Glossary

October 9, 2020
TeamViewer IoT Documentation

This glossary is intended to assist you when using this documentation.

Used Terms

Heed the terms below to enhance your experience with this documentation.

Term Description
Internet of Things (IoT) A system of interrelated computing devices, e.g. remote controlling a fridge or a coffee maker.
Edge Device (device) The hardware which runs the TeamViewer IoT Solution (e.g. Starter Kit, Raspberry Pi). It is connected to the sensors and actuators.
TeamViewer IoT Agent (agent) The software of the TeamViewer IoT Solution. It runs on the Edge Device. It manages the sensors and actuators and enables remote access via internet (e.g. TeamViewer IoT Management Console).
TeamViewer Client The software to access your Edge Device remotely.
TeamViewer IoT Management Console (Management Console) A software which runs in a web browser. It lists all your devices, connected sensors and many more information.
TeamViewer IoT Edge Management (Edge Management) Feature of the TeamViewer IoT Management Console. It provides real-time visualization of your devices, connected sensors and many more information.
TeamViewer IoT Real Time Rule Engine (Real Time Rule Engine) Feature of the TeamViewer IoT Management Console. It provides notifications and alerts when defined conditions (rules) are met.
File Transfer Feature of the TeamViewer IoT Management Console. It provides a graphical user interface to transfer files from and to edge devices.
Widget Displays your IoT data (e.g. chart, gauge) when Edge Management is enabled.
MQTT Message Queuing Telemetry Transport is an open lightweight, publish-subscribe network protocol that transports messages between your devices.
MQTT-Broker A MQTT system consists of multiple clients – publishers or subscribers – that are configured to communicate with a server (broker).
SDK The TeamViewer IoT Software Development Kit is a collection of software. It enables advanced users to create custom applications within the TeamViewer IoT Solution, e.g. automation of processes.
API The TeamViewer IoT Application Programming Interface is a computing interface which defines interactions between selected TeamViewer IoT software intermediaries.
AWS Amazon Web Services. An on-demand service for cloud computing.
OPC UA Open Platform Communications Unified Architecture is a machine to machine communication protocol for industrial automation.
Webhook A webhook is a method of augmenting or altering the behavior of a web page or web application with custom callbacks. The format is JSON. The request is done as a HTTP POST request.
JSON JavaScript Object Notation is an open standard file format, and data interchange format, that uses human-readable text to store and transmit data objects (e.g. IoT data like temperature).
Endpoint The entry point to a service, a process, or a queue or topic destination in service-oriented architecture (e.g. a web page to use a webhook on).
GUI / gui Graphical User Interface (e.g. any visible element in your web browser and the web browser itself).
URL Uniform Resource Locator is a reference to a web resource that specifies its location on a computer network (e.g. https://www.teamviewer.com).
X11 X11 (X Window System) provides the basic framework for a GUI environment: drawing and moving windows on the display device and interacting with a mouse and keyboard.
Framebuffer The framebuffer is a portion of random-access memory containing a bitmap that drives a video display. With TeamViewer IoT, you can access the framebuffer of a edge device.
DIO Digital Input/Output
GPIO General Purpose Input/Output
APN Access Point Name is the name of a gateway between a GSM, GPRS, 3G or 4G mobile network and another computer network.
REST / RESTful Representational State Transfer is a software architectural style that defines a set of constraints to be used for creating Web services. Web services that conform to the REST architectural style, called RESTful Web services, provide interoperability between computer systems on the internet.
RSA Rivest–Shamir–Adleman is one of the first public-key cryptosystems and is widely used for secure data transmission.
MB Megabyte
GB Gigabyte
AES Advanced Encryption Standard is a specification for the encryption of electronic data.
SSH / ssh Secure Shell is a cryptographic network protocol for operating network services securely over an unsecured network.
CSR Certificate Signing Request is a message sent from an applicant to a certificate authority in order to apply for a digital identity certificate.

Used Formats

Heed the formats below to enhance your experience with this documentation.

Format Description / Usage
bold elements of the graphical user interface (e.g. button)
bold terms
emphasis highlighted text
monospace user input, file names, commands
teamviewer.com hyperlinks

For example: To save click OK.

For example: On the right side type into Filename the file name/var/etc/smb/smb.conf.

Notes and Tips

Heed this notice to avoid misuse of the software.
Follow this tip to learn a shortcut.

Command line

Commands to type in are displayed in a single line. You can copy and paste a given command when prompted.

ls -a

Some commands to type in are very long. They are displayed in a special box. The following example represents still one single line command. You can copy and paste the whole content when prompted.

mosquitto_pub -h localhost -p 18884 --cert clientCert.crt --key privkey.pem --cafile /var/lib/teamviewer-iot-agent/certs/TeamViewerAuthority.crt -t /v1.0/c6c5e217089743da8ec3f1d256fa99c2/sensor/d43862fd65ac4a0f9054cfe1749cad82/metric/create -m "{"metrics" : [{"matchingId" : "1", "valueUnit": "NoSI.Dimensionless.PERCENT", "name" : "CPUUsage" },{"matchingId" : "2","valueUnit": "NoSI.Dimensionless.PERCENT", "name" :"CPUIdle" }, {"matchingId" : "3", "valueType" : "integer" , "valueAnnotation": "goods per minute", "name" : "ShopFloor1"}]}"

Source code / File contents

Source codes or file contents are displayed in multiple lines. You can copy and paste a given content when prompted.

#include 
#include 

int main() {
	std::cout<<"Hello World"<<std::endl;
	return 0;
}

Troubleshoot

Heed the section Troubleshoot (if any) to solve problems while using the product.

Features of this documentation

The following features are enabled to assist you. The use is optional.

  • Click the printer symbol () next to a heading to print the current documentation or to save it as PDF.
  • Click the hash symbol (#) next to a heading to get the link of the current section.

Related posts

Want more? Exclusive deals, the latest news: Our Newsletter!