Augmented sessions for embedded devices provide an enhanced support experience to address physical challenges encountered with embedded devices. By leveraging TeamViewer Assist AR, this feature allows OEMs to integrate augmented reality (AR) support into their applications using the iotagentsdk. Here, you'll learn how to use and configure the Augmented Session feature effectively.

This article applies to all TeamViewer Embedded customers who purchased an Assist AR license. 

How it works

Step 1

The supporter initiates a TeamViewer embedded session.

Step 2

Problem recognition: The supporter identifies a potential physical issue, such as a loose cable or a leaking valve.

Step 3

Send Augmented session invite**: The supporter sends an Augmented Session invite to the machine.

Step 4

Waiting room: The supporter is redirected to a waiting room.

Step 5

Session invite presentation: The end user receives the session invite, typically via a URL (e.g. https://getassistar.teamviewer.com/s123456789).

Step 6

Join session: The end user scans or enters the session invite and joins the Assist AR session.

Availability and configuration

The Augmented session feature is enabled by default for all supporters starting from version 3.3.X.

How to turn off the feature

Debian package (.deb):

To disable the feature on Debian packages, run the following command:

sudo teamviewer-iot-agent configure set EnableAugmentRCSession 0

OEM packages:

To disable the feature on OEM packages, add line to agent.conf:

EnableAugmentRCSession = 0

Other packages:

To disable the feature on other packages, add the following line to global.conf:

[int32] EnableAugmentRCSession = 0

License information

Using the Augmented Session feature requires an Assist AR license. You can also test it by starting a 14-day trial Assist AR license.

End user configuration

The feature requires that the end user can see the invitation to the Assist AR session. It is crucial that an application presents the session invitation in a user-friendly format. If no endpoint displays the session invitation, the following pop-up will notify the user.

The iotagentsdk, starting from version 2.8, includes examples that handle the session invite, simplifying the integration process. For instance, the qt_simulate example demonstrates how to integrate the session invite into a Qt application and display the invite as a QR code. QR codes are particularly advantageous as they can be scanned with a mobile phone, directly opening the TeamViewer Assist AR app on Android or iOS devices, and guiding the user to the session.