Appearance
Protocol Information
Protocol information is specified for each property of each individual block.
This information is split into two sections:
- Parameters - Configuration parameters
- Measurements - Telemetry outputs
Example parameters
The following is an example of a parameter:
My parameter
- Description: Some descriptive text that describes exactly what this parameter does
- Automation reference:
SomeIdentifier - Unit: Hz
- Range: [100; 100000000]
- Enablement:
OtherParameter==1234 - Type: real
Explanation
Automation reference is an identifier that is used when automating this parameter for tests or operations controlled by external software. It will always be an identifier starting with an ASCII letter and containing letters, digits, and underscores. It will always match the regex [a-zA-Z][a-zA-Z0-9_]*
Type indicates the type of the parameter. This attribute is always present. Valid types are:
| Type | Description |
|---|---|
bool | Boolean value |
integer | Integer value |
real | Real (floating point) value |
string | Text value |
enumeration | Enumerated value. More information. |
Unit (optional) indicates the unit used to measure the parameter value. Examples can be Hz, rad/s, dB, etc.
Range (optional) shows the inclusive range of possible values that a given parameter can be set to. A range of [3; 5] means any value x 3 <= x <= 5.
Enablement (optional) shows what conditions must be satisfied for this parameter to be relevant. In the Flow GUI a parameter might be hidden if this condition is not satisfied.
Enumerated value example
The following is an example of an enumeration parameter. Following the parameter attributes is a table showing the valid values the parameter can be configured to:
- Description: Gain mode in receive path
- Automation reference:
GainMode - Type: enumeration
| Identifier | Value | Description |
|---|---|---|
FastAttack | Fast Attack | |
SlowAttack | Slow Attack | |
Hybrid | Hybrid | |
Manual | Manual |
Identifier is the identifier for the given enumeration value. This is used when setting the parameter through the automation interface.
Value is the short friendly name for the enumeration value. This is what is shown in the Flow GUI as well.
Description is a textual description of the value.