DeviceX / FunctionX
DeviceX and FunctionX is the main representation for devices and functions in the platform. Common for the X-models is that they use the same data-format for both devices and functions. The data model contains an arbitrary data part called metadata.
Base model
The base model consists of very few parameters.
| Name | Description |
|---|---|
| ID | Identifier in API and database |
| Installation ID | Identifier for what installation the object belongs to |
| Type | For Devices this is the system used, for functions this is the UI type |
| Meta | Key-value store of additional parameters |
Default types and meta-keys
This list contains information about function-types and metadata that is relevant to them.
Additional topics
Some functions require several topics to work. These function set topic_read and topic_write for the main function and then uses state topics for other functions.
This table shows an example of topics for an RGB+Dimmer function.
| Key | Value |
|---|---|
| topic_read | Main topic, dimmer |
| topic_read_red | Topic for red channel |
| topic_read_green | Topic for green channel |
| topic_read_blue | Topic for blue channel |