From an external application, you can send a user to a teleoperation view. For example, you can build a Teleoperate button into your application which, when clicked, sends the user to a Formant-powered teleoperation view.

The end user will be able to view real-time data and teleoperate the designated device, but will not be able to edit the view, thus allowing the administrator to design the experience for the user.

This guide will teach you how to link to, authenticate, and teleoperate a device in an external application.

Step 1: Generate embed URL

1. Go to https://teleop.formant.io and navigate to the device and teleoperation view for which you want to generate a link.
2. In the teleoperation header, click the Share button:

3. Copy the URL and link to it from your external application:

Step 2: Generate authentication token

When the end user clicks your Teleoperate button, you'll have to generate an authentication token with the appropriate permissions and access levels. To do so, you'll use the Login Embed method of the Auth endpoint.

Follow the instructions in Generate an auth token for an embedded view.

📘

Set your service account role to Operator or Administrator

To teleoperate a device, the service account you use to generate the authentication token must have a role of at least Operator.

If using a custom role, see Create a custom role for further instructions.

Once you've generated your authentication token, add it to the URL to authenticate the user's teleoperation session.

See also

• Getting Started: Teleoperation
• Build a teleoperation interface

👋

If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].