Getting Started

Everything you need to know to get started with Formant.

    Channel navigation

    As the number of devices increases or the number of channels created increases, it can become difficult to find and navigate within and between channels.

    Jump to ...

    The easiest way to find a regular channel or device channel is to search for it using the Jump to menu

    From the burger menuselect Jump to ... 

    Favorite

    If there is a device that you tend to use more frequently than others, you can also favorite the device channels by hovering over the device icon on the channel sidebar. The device icon will then turn to a favorite icon .

    From the burger menu hover over the device channel icon. This icon will turn to theicon. By clicking on the favorite icon, this channel will be marked as favorite and moved to the top of the device list.

    By favoriting a device channel, it will appear at the top of the device channel as well as the overview page.

    Info

    You can only favorite device channels. All regular channels are displayed on the sidebar and cannot be marked as favorite.

    Filters

    Filters are fundamental to limiting the amount of data displayed on a screen. Filters can be used to restrict data displayed on a channel by choosing the relevant filters. On device channels, users can create Views to limit the number of modules displayed on an individual screen.

    There are primarily four types of filters displayed as part of a channel:

    1. Device - Allows users to choose the relevant devices for a regular channel. This filter is not relevant to device channels as device channels only display data for a single device

    2. Telemetry Streams - Allows users to choose the specific streams relevant to their particular channel or View

    3. Data Visualization Type - Allows users to choose the relevant visualization types for this channel

    4. User-defined tags - Users can define custom tags to group devices, streams or datapoints. These tags appear along with all the other filters available in the system. For more information on creating tags, please refer to TODO

    When user-defined tags are used on datapoints, there might be several special datapoints within a stream that have tags. On the other hand, some datapoints might not have any tags at all. Hence, for user-defined tags, there is an option to select "none" to isolate all datapoints and streams that do not have a specific tag.

    Info

    When channels have too much data, you will see an error message as you scroll down the channel. The best way to remove this error message is to limit data using filters at the top of the channel.

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