Values
The channel and parameter data always contain the current value, which is encapsulated in a container object.
There are the following internal data types for values:
Data type | Description |
|---|---|
NUMBER_LONG | 64-bit integer with sign. |
NUMBER_DOUBLE | 64-bit floating point number with double precision and sign. |
TEXT | String with a maximum length of 2.147.483.647 characters. |
STATE | Representation of a state as a string. |
COLOR | Color information as a string. |
A more detailed description with value ranges and unit is contained in the value description (descriptionId).
All containers contain the following fields; in addition, each data type container has specific fields.
Field | Data type | Description |
|---|---|---|
type | String | The internal data type of the value. |
info | String | Optional information of the channel |
descriptionId | String | The ID of the value description. |
changeable | Boolean | Flag whether the value is changeable. |
NUMBER_LONG
SimpleIoTCoreNumberLongValueDTO
Field | Data type | Description |
|---|---|---|
value | Number | 64-bit integer with sign. |
NUMBER_DOUBLE
SimpleIoTCoreNumberDoubleValueDTO
Field | Data type | Description |
|---|---|---|
value | Number | 64-bit floating point number with double precision and sign. |
TEXT
SimpleIoTCoreTextValueDTO
Field | Data type | Description |
|---|---|---|
value | String | String with a maximum length of 2.147.483.647 characters. |
STATE
SimpleIoTCoreStateValueDTO
Field | Data type | Description |
|---|---|---|
value | String | Representation of a state as a string. |
COLOR
SimpleIoTCoreColorValueDTO
Field | Data type | Description |
|---|---|---|
value | String | Color information as hexadecimal value. |
Description containers are used to provide a detailed specification of how values are to be interpreted or which ranges are possible. There is a description container for each internal data type in order to fulfil the specific requirements.
Each container has its own ID, which can also be used by several channels at the same time. The ID is the same across all systems, but may differ between software versions.
Each container contains the following fields, and each description container also has specific fields.
Field | Data type | Description |
|---|---|---|
type | String | The internal data type for which the description applies |
descriptionId | String | The ID of the value description |
NUMBER_LONG
SimpleIoTCoreNumberLongDescriptionDTO
Field | Data type | Description |
|---|---|---|
minValue | Number | Minimum value |
maxValue | Number | Maximum value |
stepSize | Number | Optional step size when setting the value. Default: 1 |
measuringUnit | String | Optional measuring unit of the value |
NUMBER_DOUBLE
SimpleIoTCoreNumberDoubleDescriptionDTO
Field | Data type | Description |
|---|---|---|
minValue | Number | Minimum value |
maxValue | Number | Maximum value |
stepSize | Number | Optional step size when setting the value. Default: 1.0 |
decimalPartDigits | Number | Optional decimal places of the value. Default: 2.0 |
measuringUnit | String | Optional measuring unit of the value |
TEXT
SimpleIoTCoreTextDescriptionDTO
Field | DataType | Description |
|---|---|---|
minLength | Number | Minimum number of characters |
maxLength | Number | Maximum number of characters |
STATE
SimpleIoTCoreStateDescriptionDTO
Field | Data type | Description |
|---|---|---|
possibleStates | Array | An array of strings with the possible states |
COLOR
SimpleIoTCoreHexColorDescriptionDTO
Field | Data type | Description |
|---|---|---|
colorType | String | Information on how the value is to be interpreted |
The following values are possible in the colorType field:
Type | Description |
|---|---|
HTML_HEX | Hexadecimal color value (RRGGBB) without leading hash |
