Restrict stream rate

This section describes the set of techniques that can be used to manage the stream rate, and hence reduce bandwidth consumption of your robot.

  1. Set stream rate for the whole device
  2. Set stream rate for individual streams

Stream rate (Hz)

The stream rate is a float value between 0 and 5. Setting a value of 0 means that there will be no ingestion and a stream rate value of 5 means 5 data points will be ingested per second. Stream rate can be set on the whole device for all streams or for individual streams. If stream rate is set on individual streams, that will take precedence over the whole device's overall stream rate.

πŸ“˜

Sample map from stream rates to datapoints

0.1Hz = at most 1datapoint per 10 seconds
1Hz = at most 1 datapoint per second
5Hz = 5/s = at most 5 datapoints per second

Set stream rate for the whole device

Every device comes with a setting to control the stream rate for all telemetry streams ingested through Formant. By setting stream rate for the device, you are setting the value for the entirety of one's telemetry streams. This will override any values set for individual streams.

To set this value for an individual device, do the following

From the burger menuselect Settings β‡’ Devices β‡’ General Settings β‡’ Stream rate (Hz)
Setting stream rate for the whole device does not change the stream rates on streams that have a different stream rate set. The effective stream rate is prioritized as individual stream's rate > device stream rate > default throttle (5Hz).

To set this value for a fleet, one must update the respective configuration template and apply it to the whole fleet.

From the burger menuselect Settings β‡’ Configurations β‡’ β‡’ Generate Settings β‡’ Stream rate (Hz)

Set stream rate for individual streams

Individual stream rates can also be limited to a specific value. This is useful when you have streams that might consume a lot of bandwidth, and is generally not useful outside of specific events or timeframes. You can set stream rates for those streams as follows:

From the burger menuselect Settings β‡’ Configurations β‡’ β‡’ Telemetry β‡’ β‡’ Stream rate (Hz)
You can also change stream rate for an individual stream of a specific device by going to the settings menu of the device as follows:

From the burger menu select Settings β‡’ Devices β‡’ Telemetry β‡’ β‡’ Stream rate (Hz)

Clear stream rate

If the stream rate for a stream is set, then it takes precedence over device stream rate value. In order for the device stream rate to take effect, you will have to clear the stream rate value, by going to the same settings as above and clearing the value.


Did this page help you?