Device Archetypes
The BlueRange platform as a number of predefined device archetypes which allows it to display and control a number of different device types with a generic UI. The list of supported archetypes will be extended over time. If your device does not match our supported archetypes, please contact us, so that we can add more definitions.
Archetypes, such as units must be named with the UPPERCASE_UNDERSCORE naming convention.
Applicable terminology and naming used shall follow the SIG Mesh specifications available at https://www.bluetooth.com/de/specifications/mesh-specifications/.
- archetype
-
defines what kind of thing a device primarily is all about. The archetype is used for grouping visuals and controls and serves as a hint to UIs. The
archetypedoes not limit the actuator and sensor types available to the device in any way! Any device has at most one archetype.
Lighting control
archetype: LIGHT
Smart luminaires control the illumination of a room, implement some clever energy saving and brightness adjustment logic. They often come with a number of auxiliary sensors providing valuable inputs to automations.
Actuators
Turning on / off
Switch on the light by writing a button press (1) or (0) to the device.
type |
TURN_ON_OFF |
unit |
ON_OFF (min: 0, max: 1) |
Turning on
Switch on the light by writing a button press (1) to the device. This is only necessary if turning the lamp on is a seperate command than turning it off. Otherwhise use the type TURN_ON_OFF. A value of 1 should be written.
type |
TURN_ON |
unit |
ON_OFF |
Turning off
Switch off the light by writing a button press (1) to the device. This is only necessary if turning the lamp on is a seperate command than turning it off. Otherwhise use the type TURN_ON_OFF. A value of 1 should be written.
type |
TURN_OFF |
unit |
ON_OFF |
Dimming
Allows users to adjust the dimming of a luminaire. The dimming may not necessarily control the brightness directly as other factors like environmental illumination may influence a smart light control.
type |
SET_DIMMING |
unit |
PERCENT (min: 0, max: 100) |
Dimming up
Allows users to dim up a luminaire. It increases the current brightness of a luminaire by the given percentage (not supported by all luminaires, some will dim up by a fixed value).
type |
DIM_UP |
unit |
PERCENT (min: 0, max: 100) |
Dimming down
Allows users to dim down a luminaire. It decreases the current brightness of a luminaire by the given percentage (not supported by all luminaires, some will dim down by a fixed value). The lamp will only dim down to a minimum supported light level and will not turn off.
type |
DIM_DOWN |
unit |
PERCENT (min: 0, max: 100) |
Window blinds
archetype: BLIND
Window blinds may come in different flavors that may support different features like covers and shutters.
Actuators
Remove manual settings
Turning this configuration on by sending 1 disables
type |
REMOVE_MAN |
unit |
ON_OFF (min: 0, max: 1) |
Stepping and stopping
Writing a 0 or 1 closes/opens the cover stepwise. By (re-)sending an order while the blind is executing an action the execution will be stopped.
type |
ANGLE_STEP_STOP |
unit |
ON_OFF (min: 0, max: 1) |
Driving up and down
The values 0 and 1 drive in the same direction as above, down and up respectively. The cover stops once it hits the stop position or a DRIVE_STEP_STOP is actioned.
type |
DRIVE_UP_DOWN |
unit |
ON_OFF (min: 0, max: 1) |
Absolute slat positioning
Blinds and shutters may open and close.
type |
SET_SLAT_ANGLE |
unit |
PERCENT (min: 0, max: 100) |
Absolute slat positioning
Blinds and covers can go up and down.
type |
SET_SLAT_POSITION |
unit |
PERCENT (min: 0, max: 100) |
Binary presence
Flag to indicate if there is presence in a room.
type |
SET_PRESENCE |
unit |
ON_OFF (min: 0, max: 1) |
User consent up
Writing 1 signals the user consent of a request to move the blind up from the automation.
type |
SET_USER_CONSENT_UP |
unit |
ON_OFF (min: 0, max: 1) |
User consent up
Writing 1 signals the user consent of a request to move the blind down from the automation.
type |
SET_USER_CONSENT_DOWN |
unit |
ON_OFF (min: 0, max: 1) |
Sensors
Slat position
Returns the slat position onChange.
type |
SLAT_POSITION |
unit |
PERCENT (min: 0, max: 100) |
Request up
Automation request if the blind is allowed to move up - waits for user consent
type |
REQUEST_UP |
unit |
ON_OFF (min: 0, max: 1) |
Request down
Automation request if the blind is allowed to move down - waits for user consent
type |
REQUEST_DOWN |
unit |
ON_OFF (min: 0, max: 1) |
Climate control
archetype: CLIMATE
Heating and cooling devices allow adjustment of room climate settings.
Sensors
The current temperature is not a measure of e.g. the heater but already defined above near room temperature. Some devices may support reading back the set point temperature in which case the same definition as the target room temperature actuator applies.