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

Getting started with formant

  • Overview
  • System requirements
  • Receiving the introductory email
  • Setting up your device
    • Create a device
    • Install the Formant agent
    • Install the Formant agent via Docker
    • Install the Formant agent via Docker (ROS 2)
    • Delete a device
  • 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
    • Configure a stream
    • Configure stream ingestion rate
    • How telemetry streams work
    • Default streams
    • On-demand streams
    • Orientation and Altitude
  • Viewing data in Formant
    • The overview page
    • The device sidebar
    • The timeline
    • Views and modules
      • Create a view and add modules
      • Advanced modules
    • Events and notifications
      • Create an event and configure notifications
      • Create a custom event
    • Annotations and annotation templates
    • Multi-device observability
    • Formant Analytics
  • Commands
    • Create a command template
    • Issue a command
    • Schedule a command
    • Intervention requests
  • Teleoperation
    • Set up real-time connections
    • Build a teleoperation interface
    • Add a URDF file
  • Setting up your Formant organization
    • Configure access levels
      • Create and apply tags
    • Users, roles, and teams
      • Create a user
      • Create a custom role
      • Create a team
      • Create a service account
    • Protect your users' Personally Identifiable Information (PII)
  • Fleet management
    • Create a device configuration template
    • Create a device group
    • Create a channel

The Formant Agent

  • The Formant agent
  • Advanced agent provisioning
    • Install the Formant agent via Apt
    • Re-provisioning an agent
    • Bulk provisioning
    • Automated provisioning
  • Video encoding with the Formant agent
    • Reduce bandwidth in constrained situations
    • Bypass Formant video encoder
    • Video no longer ingesting
    • Video performing poorly
    • Generate media encoder logs
    • Images black, glitchy, out of order when ingesting pre-encoded video
  • 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
    • Query events in Analytics
    • Query datapoints in Analytics
    • Querying entities in 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
    • Telemetry vs. realtime data streams
    • Add a teleoperation image stream
    • Add a real-time numeric stream
    • Add a mouse click stream
    • Add an audio stream
    • Configure joystick control
      • Joystick: Twist messages
      • Joystick: Joy messages
    • Add a joint states stream
    • Add a point cloud stream
    • Add a realtime odometry stream
    • Add buttons to your teleoperation interface
    • Configure localization for teleoperation
    • Add a relocalization stream
    • Localization and relocalization workflows
    • Create a teleoperation interface
    • Monitor network statistics during teleoperation

Advanced modules

  • Overview
  • 3D scene module
    • Add and configure a 3D Scene module
    • Plan a mission
    • Marker arrays in the Scene module
    • Develop custom 3D Scene maps and layers
  • 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
    • 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
  • Data share
    • Share with external users
    • Deep Linking - Share with Formant users
  • Adapters
    • Add an adapter
    • ROS 2 Adapter
      • ROS 2 Getting Started Guide
    • JSON decomposition adapter
    • ROS service adapter
    • ZeroMQ adapter

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
      • Handling text logs in Formant
      • Hardware acceleration of video encoding without Jetson GPU
      • Overlay timestamp on video
      • Change ROS workspace URI for agent after installation
      • Add GeoJSON information to a location module
      • Latency of Formant features
      • Reduce the density of point cloud data
      • Create view of a particular stream from all devices in a group
      • Visualize a numeric without a chart
      • Does map consume bandwidth even though ROS topic is not updating?
      • Change time zone in observability
      • Resize and reorder modules in a device view
    • Troubleshooting
      • Module shows “Seek” even though data is ingested
      • Cannot add multiple topics to a stream
      • ROS topic cannot be ingested as both image and video
      • Cannot access directory watch files
      • I don't see ROS data in Formant
  • Teleoperation
    • FAQs
      • Use formant.run_script in teleop
      • Difference in video quality between telemetry and teleoperation
      • Stamp twist data
    • Troubleshooting
      • Issues connecting to device via teleop
      • RTSP camera not working
  • Formant web app
    • FAQs
      • Supported browser
      • Searching events
      • Logout due to inactivity
      • Send a text message from Formant with more data
      • Disable and remove notifications for old interventions
      • Enable command buttons only during interventions
      • Create annotation when template does not exist
      • Pull reports from Formant
      • Exporting asset data to external cloud storage
    • Troubleshooting
      • Position layer is at 0 in 3D Scene module
      • Scheduled command sends unexpected parameter
      • Overview page: map displays devices in wrong location
      • Value does not persist in view despite 'persist last known value'
      • Can't export images, video, JSON via Google Cloud Platform integration
      • Export Events not working
      • Can't mark notifications as read
      • 3D Scene: Only first field in marker array rendered
      • 3D Scene: Realtime odometry doesn't work in teleop
      • Cannot delete group
  • Formant agent
    • FAQs
      • Link roslaunch with Docker
      • Does the agent restart adapters?
      • Device states
    • Troubleshooting
      • Troubleshooting an agent installation
      • Generate Formant agent logs
      • Datapoint not being uploaded
      • Error: context deadline exceeded
      • ImportError in Formant agent log: cannot import name 'cygrpc' from 'grpc._cython'
      • Error installing or uninstalling agent: mv: cannot stat '/usr/lib/formant/sidecar/sudoers.d/formant': No such file or directory dpkg: error processing package formant-sidecar (--configure):
      • Formant agent occupies port 9090
      • Cannot connect to Formant agent on different network
      • Error invoking Docker in Formant terminal
      • Expired key incident
  • APIs & SDKs
    • FAQs
      • Programmatically update tags on a device
      • Forward a local web page or port to your client device
      • Add dropdown to selection intervention request
      • Get the name of a user's role using the Admin API
    • Troubleshooting
      • post_text data gets truncated
      • Using getLatestTelemetry in Data SDK isn't updating
      • Error 422 when creating device with fctl
      • Cloud SDK not always returning all info
      • Timeout error during SSH via fctl

Data ingestion from a device

Suggest Edits

Updated over 1 year ago