Jump to Content
Formant
HomeDocumentationRecipesAPIs & SDKsDiscussions
Log InFormant
Log In
HomeDocumentationRecipesAPIs & SDKsDiscussions

Concepts

  • Concepts Roadmap (start here)
  • Devices & Groups
  • Agent
  • Ingestion, Streams, Datapoints, and Assets
  • Views and Modules
  • Tags
  • Events
  • Commands
  • Teleoperation
  • Adapters
  • 3D Viewer

Quickstart Guide

  • Quickstart overview
  • Adding teammates
  • Installing the agent on your first robot
  • Hot keys
  • Next steps

Telemetry Data Guide

  • Data ingestion from a device
    • How telemetry streams work
    • Default streams
    • Device telemetry configuration
    • Hardware streams
    • Directory watch streams
    • Ingesting ROS topic data
    • Ingesting ROS localization data
    • Ingesting ROS transform tree data
    • Ingesting from Python
    • Configuring stream rate (Throttling)
    • Orientation and Altitude
    • On-demand streams
    • Restrict stream rate
  • Data ingestion from anywhere
    • Ingest from the Cloud SDK
    • Ingest from Capture
    • Ingest from SMS
    • Ingest from fctl
  • Data visualization
    • Default visualization types
    • Custom views
  • Telemetry streams FAQ
  • Data export
    • How data export works
    • From the web application
    • Using the Cloud SDK
    • Export to Google Sheets
    • Export to AWS S3
    • Export to local machine
  • Data FAQ
  • Events, interventions and alerts
    • Intervention Requests
    • Events & alerts
  • Mission and data annotations
  • Commands
    • Create custom commands
    • Scheduling Commands
  • Data share
    • Share with external users
    • Deep Linking - Share with Formant users
  • Ingesting ROS2 Data with the Formant ROS2 Adapter

Teleoperation Guide

  • Introduction
  • Navigation
    • Configuring ROS localization and relocalization streams
    • Using the localization and relocalization workflows
  • URDF
  • Teleop connectivity
  • Sending more than two images
  • Handle disconnections safely
  • Adding a custom view to the sidebar
  • Mouse Clicks
  • Video Configuration for Teleoperation
  • Configuring an Audio stream
  • Adding Joysticks

The Formant Agent

  • Installing the Formant agent
  • Advanced agent provisioning
    • Installing the Formant agent using Docker
    • Agent installation with Apt
    • Re-provisioning an agent
    • Bulk provisioning
    • Automated provisioning
  • Formant agent management
    • Managing a native installation
    • Managing a docker installation
  • Environment variables for the agent
  • Troubleshooting an agent installation
  • Agent FAQ
  • Terminal and port forwarding security
  • Expired key incident
  • Configuration Templates

Working with the Formant app

  • Device Groups
  • Device Configuration
  • Uploading Files to Formant Cloud

Identity and Access Management (IAM)

  • Overview
  • Users & teams
  • Resources & roles
  • Custom roles
  • Scoping down access to specific entities

SSH & VPN

  • SSH to your robot
  • Troubleshooting SSH connectivity
  • Setting up VPN tunnel over SSH to your robot

Tutorials

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

Integrations

  • Overview
  • Send events to PagerDuty
  • Trigger Webhooks from events
  • Send events to Slack
  • Integrate with Google Sheets
  • Event triggered SMS messages

Data visualization

Suggest Edits

Updated about 1 year ago