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

Concepts

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

Getting started with formant

  • Overview
  • Receiving the introductory email
  • Setting up your device
    • Install the Formant agent
  • Ingesting telemetry data
    • Add a ROS topic stream
    • Add a ROS localization stream
    • Add a ROS transform tree stream
    • Add a non-ROS data stream
    • Add a video stream
    • Add a file tail stream
    • Add a directory watch stream
  • Viewing data in Formant
    • The overview page
    • The timeline
    • Views and modules
    • Create a view and add modules
    • Events and notifications
    • Create an event and configure notifications
    • Create a custom event
  • Commands
    • Issue a command
    • Schedule a command
    • Intervention requests
  • Teleoperation
    • Telemetry vs. realtime data streams
    • Add a teleoperation image stream
    • Add a mouse click stream
    • Add an audio stream
    • Configure joystick control
    • Add a joint states stream
    • Add a geometry stream
    • Add a point cloud stream
    • Add a realtime odometry stream
    • Add a relocalization stream
    • Add a navigation stream
    • Using the localization and relocalization workflows
  • Setting up your organization
    • Add teammates
    • Configure access levels

Advanced Telemetry Guide

  • Data ingestion from a device
    • How telemetry streams work
    • Default streams
    • 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
  • 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

Advanced Teleoperation Guide

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

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
    • Update the agent
  • Environment variables for the agent
  • Agent FAQ
  • Terminal and port forwarding security
  • Expired key incident
  • Configuration Templates

Working with the Formant app

  • Device Groups
  • Device Configuration
  • Upload files to Formant Cloud
  • Delete a device
  • Hot keys

views and modules

  • Overview
  • 3D scene module
    • Add a 3D Scene module
    • 3D Scene configuration
    • Develop custom 3D Scene maps and layers
  • Analytics View
    • Add an Analytics view
    • Task summaries
    • Create a task summary
  • Add a custom module

Identity and Access Management (IAM)

  • Overview
  • Users, service accounts, and teams
  • Resources & roles
  • Custom roles
  • Scoping down access to specific entities
  • Single sign-on
    • Google SSO

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 alerts

FAQ & Troubleshooting

  • Overview
  • FAQs
    • Device states
    • Use formant.run_script in teleop
    • Logout due to inactivity
    • Stamp twist data
    • Overlay timestamp on video
    • Add a stream to the overview page
    • Add GeoJSON information to a location module
    • Change ROS workspace URI for agent after installation
    • Latency of Formant features
  • Troubleshooting
    • Troubleshooting an agent installation
    • How do I generate Formant agent logs?
    • Video performing poorly
    • Timeout error during SSH via fctl
    • ImportError: cannot import name 'cygrpc' from 'grpc._cython'
    • mv: cannot stat '/usr/lib/formant/sidecar/sudoers.d/formant': No such file or directory dpkg: error processing package formant-sidecar (--configure):
    • Cloud SDK not always returning all info
    • Formant agent occupies port 9090
    • Export Events not working

Data visualization

Suggest Edits

Updated over 1 year ago