A Range message contains the type definition and an optional specification for a range/limit validation for numeric parameters. The data model definition for Range is abstract, which means it never will be used in practice, only the data models derived from this will be used in the API.
Data Model (extends Message)
| Key | Type | Value |
|---|---|---|
| id | String | The message ID (see Message) |
| type | String | The message type (always RANGE, see Message). |
| time | String | Timestamp in format 'YYYY-MM-DDTHH:MM.SSZ', see Message). |
| dataType | String | A token defining the data type this Range object describes. Depending on dataType, there are more parameters present in the Range definition. |
| disabled | Bool | True tells the front end that this parameter is currently not in use. No value shall be displayed for this parameter, even if a corresponding Parameter message has been received. Any decorations like frame or descriptive label shall be displayed grayed/faded in order to show this state to the operator. |
| readonly | Bool | This parameter is for display only, the operator may not change it. |
Defined Data Types
| Token | Data Type |
|---|---|
| TEXT | StringRange |
| INTEGER | IntegerRange |
| HEX | HexRange |
| FLOAT | DoubleRange |
| BOOLEAN | BooleanRange |
| ALARM | AlarmFlagRange |
| CHOICE | EnumRange |
| OBJECT | ObjectRange |
Remark: Range objects are also used in the PresetVars list of device driver variables. In this case messageId does not contain a fully qualified message ID, but the name of the variable.