Getting Started

Everything you need to know to get started with Formant.

    Installing on the first robot

    Formant data platform requires an agent to be installed on the robot. The agent is a software component that acts as the managed entry point from your application to the Formant Cloud. When the first user logs in for the first time, they are prompted from the web application to install the Formant agent.


    1. The device should have internet connectivity
    2. The device should be able to connect to 

    You can run the following script to output the device/robot details 

    bash <(wget -qO -

    Once the prerequisites are cleared, run the following steps:

    Step 1: Enter name for the device

    A device is identified by a name. The name can be changed anytime but must be alphanumeric with characters a-z, A-Z, 0-9, dash (-), underscore (_), and dot (.). Be sure to specify a name that is meaningful to your team as it will be displayed in the UI.

    Step 2: Install the Formant agent

    Copy the installation command from the web application and paste it on the robot's CLI. The installation command consists of a provisioning token that is unique to the device and expires after 1 hour. If you are unable to install the device within an hour, please refresh your token by clicking on the Token expired? Refresh button below the installation line.

    Step 3: View your data

    The agent automatically ingests health data from the device as well as about 500 ROS topics. The agent automatically picks a few data streams from the robot and displays it to you. If your device is not ROS based or you do not see the data stream you are looking for, you will need to configure the agent (see below).

    Step 4: Configure your agent

    An agent’s configuration specifies what data it should ingest from your application, how it should buffer that data, what metadata (tags) it should apply, and 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. You can see the agent’s active and desired configuration versions at any time. Visit our help page on configuring the agent for more details.

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