BarGraph State Transmission
Description
This transmission carries all necessary parameter to define the state of a BarGraph Property.
Some important points before using the BarGraph:
- The maximum accepted number of bars is 9
- The BarGraph-State can be updated through a state update or a Fast-Data-Setter transmission
- Bar-description strings should be short, otherwise they may overlap each other. If this will happen depends also on the number of bars in the view and the size of the screen.
- The BarGraph-data is transmitted in a data string, the syntax for this string is described below.
- The grid of the BarGraph is re-calculated every time an update occurs. This could be disabled by setting the fixed-maximum-value flag in the flag value. If this is done, a fixed maximum value must also be transmitted, otherwise the flag has no effect.
Layout
Byte-Index | Description | Type |
---|---|---|
8 | Flag Value | Dual hex Char |
9 | Flag Value | Dual hex Char |
10 | Number of Bars | Single Char |
11 .. | BarGraph Data | String |
.. End | Delimiter <CR> | Char |
Flag Value (8:9)
The flag value defines some preferences which affect the visual state and the behavior. The format is an 8bit hexadecimal value as string (2 char).
Flag | Description |
---|---|
0x01 | Use value as bar-descriptor (the current bar value will be displayed beneath the bar) |
0x02 | Use fixed maximum value (the grid of the BarGraph has a fixed scope) |
Number of bars (10)
This parameter defines the number of bars to display in the BarGraph. The maximum amount of bars is 9. To address the a specific bar in the bar-data-string, use the index (0-8). The index 9 is reserved and addresses the fixed-maximum-value.
BarGraph-Data (11..End)
The BarGraph data string has a special syntax to provide the data for every specific specific bar:
barIndex::barName ::barValue ;;
To provide data for multiple bars, the definitions can be appended on each other.
BarIndex
The bar-index can be 0 to 9, where 9 is the fixed-maximum-value. The index must be in range, that means that the defined number of bars must be higher than the index.
BarName
The bar-name(bar descriptor) will be displayed beneath the bar. It should be a short string, otherwise the strings for the bars could overlap each other. If the descriptor is not used or the value-as-bar-descriptor flag is set, the parameter can be marked unused by setting the underscore '_'.
BarValue
The bar-value is from type float.