Jump to Content

Home Documentation Recipes APIs & SDKs

Documentation

Home Documentation Recipes APIs & SDKs

Getting started with formant

Overview
System requirements
Receiving the introductory email
Setting up your device
Ingesting telemetry data
Viewing data in Formant
Commands
Teleoperation
Setting up your Formant organization
Fleet management

The Formant Agent

The Formant agent
Advanced agent provisioning
Video encoding with the Formant agent
Environment variables for the agent
Terminal and port forwarding security
Set custom directories for agent data operations
Agent FAQ

Formant Analytics

Analytics overview
Create an Analytics view and add modules
Custom SQL queries in Formant Analytics
Task summaries
- Create a task summary
FAQs & troubleshooting
- Data not showing up in Formant Analytics

Embedded views

Embedded views
Embed a Formant view in an external site
Publish a module
Custom CSS variables
Generate an auth token for an embedded view
Teleoperate from an embedded view

Legacy experience

Overview
Create a view and add modules
The overview page
Teleoperation

Advanced modules

Overview
3D scene module
Command buttons module
Heatmap module
Realtime video module
ROS diagnostic message module
Stream last value table module
Terminal module
Add a custom module

Identity and Access Management (IAM)

Single sign-on
- Configure Google SSO
- Configure OpenID Connect (OIDC) SSO
Audit changes to your Formant organization

Build a custom portal

Build a white-labeled robotics interface
Create a custom workflow email template

Applying Formant

Incident management
Fleet observability

Advanced Telemetry Guide

Data ingestion from a device
Data ingestion from anywhere
Data visualization
- Default visualization types
- Custom views
Telemetry streams FAQ
Data export
Data FAQ
Data share
- Share with external users
- Deep Linking - Share with Formant users
Adapters

Advanced Teleoperation Guide

Introduction
Sending more than two images
Handle disconnections safely
Adding a custom view to the sidebar

Working with the Formant app

Upload files to Formant Cloud
Hot keys

Integrations

Overview
Send events to PagerDuty
Trigger webhooks from events
Send events to Slack
Integrate with Google Sheets
Event-triggered SMS alerts

Tutorials

Install docker-based TurtleBot3 simulator
Assign v4l2 device a static name
Video: Custom Teleoperation View

FAQ & Troubleshooting

Overview
Telemetry
- FAQs
- Troubleshooting
Teleoperation
- FAQs
- Troubleshooting
  - Issues connecting to device via teleop
  - RTSP camera not working
Formant web app
- FAQs
- Troubleshooting
Formant agent
- FAQs
- Troubleshooting
APIs & SDKs
- FAQs
- Troubleshooting

Data ingestion from a device

Updated 6 months ago

Fleet observability

Data ingestion from anywhere