Getting Started

Everything you need to know to get started with Formant.

    Data navigation

    Channels

    Channels, components of the Formant Web Application, are named views into a subset of your organization's data. 

    A channel is defined by a set of telemetry streams filtered by devices and other user-defined tags visualized in modules, which can be arranged and customized by administrator users.

    Slices of time within channels can be shared with users outside of one's organization, such as customers and third parties.

    Device Channels

    Every device in your organization has an associated Device Channel, which contains all the specific data streams associated with said device. Using the Device Channel, one can also perform device-specific actions such as ingesting data on behalf of the device with Capture, or issuing Commands.

    Device View

    Device Views are a groups of visualization modules that represent different windows into the device channel. Each Device View is defined by a group of data streams from the device channel, and the module layout for displaying those streams.

    Devices Views enable users to quickly and cleanly dive deep into a specific collection of streams from the device's data. For example, there could be a view that only displays a robot's camera feed, a view that shows both its camera and localization streams, or a view focused entirely on the robot's battery and power state.

    Data within a channel is visualized in separate modules. 


    Modules

    Modules consist of individual telemetry streams visualized based on their assigned data visualization types and tags. Administrators can configure a module to have a custom layout (length and width) as part of the channel or view creation.

    Users can also seek for datapoints within a module.

    Seek within module 

    All modules on a single channel are aligned to the time within the timeline. This means that there might be modules that do not have any data within that specific time. 

    Seek  within a module by using the seek buttons

    Retreive data on-demand from robot 

    Data that is configured to be ingested only on-demand can be retrieved using  Retreive data on-demand.

    Layout

    The order and size of each module displayed in a channel is its layout. Layouts can be changed temporarily by moving the modules around. It can also be changed for all users by editing a View.

    Graphs split-by tags

    Enables users to split a numeric graph based on tags. A numeric graph can be split by value, by all and by none.

    Value

    Each unique tag gets its own color. Tags common to all datapoints are ignored when applying color.

    None

    This is primarily applicable to regular channels. When selected, each device gets its own color with the value averaged, regardless of tags. On a device channel, all tags get the same color and value is averaged. 

    All

    Each tag set group gets its own color.

    Fullscreen 

    Modules can be viewed in full-screen mode by double-clicking on the module title. They can be returned to their previous mode by clicking the Exit Full Screen button at the top of the module. Timeline and all its navigation capabilities are still available in full-screen mode. 

    Timeline

    A channel (regular or device) is aligned to a moment in time, which is controlled via the timeline at the bottom of the screen. 

    From the timeline, users can do the following:

    • Enable Live mode, which streams live data from the device
    • Navigate to a specific date by clicking on the date on the timeline
    • Change interval from minutes, hours, days, months by clicking on
    • Change playback speed from 0.5X (slow motion) all the way to 16X
    • Seek back and forth using the seek button
    • Move the timeline scrubber to navigate to different time intervals or at custom speed
    © 2020 Formant • 1999 Bryant St · San Francisco, CA 94110