Getting Started

Everything you need to know to get started with Formant.

    Device, agent & configuration

    Device

    A device is a machine running a Formant Agent that has been provisioned for a specific organization. It communicates to the Formant Cloud. 

    A device deployed within an organization can be viewed from the Device page under the Settings tab. From this page, one can view their list of devices, add new devices (individually or in bulk), and drill down to a single device in order to manage settings at a device-specific level.

    Each device has a unique name that is meaningful to your team, which will be displayed in the UI.  

    Formant Agent

    The Formant Agent is a software component that acts as the managed entry point from your application to the Formant Cloud.

    It is responsible for authentication, buffering, and transformation of your data from the device into Formant Cloud. It acts as the managed entry point from your application to the Formant Cloud. It is responsible for authentication, buffering, transformation, and in-flight compression of your data at the edge.

    The agent has built-in support for consuming ROS topics and data from the filesystem (e.g. new files in a directory). It also runs as a local server, exposing an API over both gRPC and HTTP endpoints for your application to interact with directly.

    Each agent maintains a set of cryptographic credentials for authentication and identification. 

    Info

    To learn more about installing Formant agent on your robot, please visit our help page on installing the first Formant agent

    Device Configuration

    A ‘configuration’ is a group of settings that you can apply across devices, individually, or in bulk.  Configuration allows one to dictate what data should be ingested from your application; at what rate it should do so; how it should buffer said data; what metadata (tags) it should apply; along with other options. Any changes to the agent’s configuration are versioned, saved to the cloud, and synchronized to the agent the next time it has internet access. 

    The configuration lets you ensure that multiple devices share the same settings.  You can create, edit, and delete configurations, as well as apply them to new or existing devices using the Formant Web Interface or Formant Command Line Interface. 

    Interested in learning more?

    To learn more about configuration, please visit our help page on configuring the Formant agent


    © 2020 Formant • 1999 Bryant St · San Francisco, CA 94110