Types of Devices Available in the HomeKit Plugin
This list includes all types of devices available in the HomeKit plugin, along with their available characteristics (objects) for mapping and DPT. It details the naming and structure of the HomeKit plugin based on Apple's Home app specification. To simplify the creation of widgets, we have added information on the equivalent naming for the group objects currently used in the Touch widget configuration, where available.
Simple Controls
|
Device type |
Required characteristics (* Mandatory) |
Parameters |
Equivalent widget (Touch) |
Group objects (Touch) |
|---|---|---|---|---|
|
SIMPLE LIGHT |
On/Off Control * (bool) On/Off Status (bool) |
Light switch |
Switch object Status feedback object |
|
|
SIMPLE TEMPERATURE SENSOR |
Temperature Status * (float16) |
Co2/humidity/temp sensor |
Temperature value |
|
|
SIMPLE HUMIDITY SENSOR |
Humidity Status * (scale) |
Co2/humidity/temp sensor |
Humidity value |
|
|
SIMPLE LIGHT SENSOR |
Light Status * (float16) |
Weather station Motion sensor |
Brightness value |
|
|
SIMPLE LEAK SENSOR |
Leak Detected Status * (bool) |
Water leak alarm |
Alarm object, alert |
|
|
SIMPLE MOTION SENSOR |
Motion Detected Status * (bool) |
Motion sensor |
Detection |
|
|
SIMPLE OCCUPANCY SENSOR |
Occupancy Detected Status * (bool) |
Motion sensor |
Detection |
|
|
SIMPLE SMOKE SENSOR |
Smoke Detected Status * (bool) |
Fire alarm |
Alarm object, alert |
|
|
SIMPLE OUTLET |
On/Off Control * (bool) On/Off Status (bool) |
Socket switch |
Switch object Status feedback object |
|
|
SIMPLE FAN |
Active Control * (bool) Active Status (bool) |
Fan switch |
Switch object Status feedback object |
|
|
SIMPLE SWITCH |
On/Off Control * (bool) On/Off Status (bool) |
General switch |
Switch object Status feedback object |
|
|
SIMPLE AIR QUALITY SENSOR |
Air Quality Status * (uint8) |
0 = Unknown, 1 = Excellent, 2 = Good, 3 = Fair, 4 = Inferior, 5 = Poor |
N/A |
|
|
SIMPLE CARBON MONOXIDE SENSOR |
Carbon Monoxide Detected Status * (bool) |
Air quality sensor |
Carbon monoxide |
|
|
SIMPLE CONTACT SENSOR |
Contact Sensor State Status * (bool) |
Window/Door sensor, Any switch |
Switch object |
|
Other Controls
|
Device type |
Required characteristics (* Mandatory) |
Parameters |
Equivalent widget (Touch) |
Group objects (Touch) |
|---|---|---|---|---|
|
LIGHT ON/OFF BRIGHTNESS |
On/Off Control * (bool) On/Off Status (bool) Brightness Control * (scale) Brightness Status (scale) |
Dimmer rotary Dimmer horizontal Dimmer vertical |
Switch Object Status feedback object Value object Status feedback value object |
|
|
LIGHT BRIGHTNESS |
Brightness Control * (scale) Brightness Status (scale) |
DPT of the general object must be a scale. If the object's DPT is an unsigned integer, it is not recognizable. |
Dimmer rotary Dimmer horizontal Dimmer vertical |
Value object Status feedback value object |
|
LIGHT RGB |
RGB Control * (rgb) RGB Status (rgb) |
RGB |
RGB object RGB status object |
|
|
LIGHT COLOR TEMPERATURE |
On/Off Control * (bool) On/Off Status (bool) Brightness Control * (scale) Brightness Status (scale) Color Temperature Control * (uint16) Color Temperature Status (uint16) |
Dimmer rotary Dimmer horizontal Dimmer vertical |
Switch Object Status feedback object Value object Status feedback value object |
|
|
THERMOSTAT |
Current Heating / Cooling State Status * (uint8) Target Heating / Cooling State Control * (uint8) Target Heating / Cooling State Status (uint8) Temperature Status * (float16) Target Temperature Control * (float16) Target Temperature Status (float16) |
0 = Off, 1 = Heat, 2 = Cool 0 = Off, 1 = Heat, 2 = Cool, 3 = Auto 0 = Off, 1 = Heat, 2 = Cool, 3 = Auto |
Thermostat |
Current Temperature Current setpoint temperature input Current setpoint temperature output |
|
Optional |
Humidity Status (scale) Target Relative Humidity Control (scale) Target Relative Humidity Status (scale) Cooling Threshold Temperature Control (float16) Cooling Threshold Temperature Status (float16) Heating Threshold Temperature Control (float16) Heating Threshold Temperature Status (float16) Temperature Display Units Control (bool) Temperature Display Units Status (bool) |
0 = Celsius, 1 = Fahrenheit 0 = Celsius, 1 = Fahrenheit |
||
|
LOCK MECHANISM |
Lock Target State Control * (bool) Lock Target State Status (bool) Lock Current State Status * (uint8) |
0 = Unsecured, 1 = Secured 0 = Unsecured, 1 = Secured 0 = Unsecured, 1 = Secured, 2 = Jammed, 3 = Unknown |
N/A |
|
|
DOOR |
Current Position Status * (scale) Target Position Control * (scale) Target Position Status (scale) |
Shutter rotary Shutter horizontal Shutter vertical |
Status feedback for height Height position (Status feedback for height) |
|
|
Optional |
Position State Status (uint8) Invert value checkbox |
0 = going to minimum, 1 = going to maximum, 2 = stopped Option to invert the value |
||
|
WINDOW |
Current Position Status * (scale) Target Position Control * (scale) Target Position Status (scale) |
Shutter rotary Shutter horizontal Shutter vertical |
Status feedback for height Height position (Status feedback for height) |
|
|
Optional |
Position State Status (uint8) Invert value checkbox |
0 = going to minimum, 1 = going to maximum, 2 = stopped Option to invert the value |
||
|
WINDOW COVERING |
Current Position Status * (scale) Target Position Control * (scale) Target Position Status (scale) |
Shutter rotary Shutter horizontal Shutter vertical |
Status feedback for height Height position (Status feedback for height) |
|
|
Optional |
Position state status Invert value checkbox |
0 = going to minimum, 1 = going to maximum, 2 = stopped Option to invert the value |
||
|
AIR PURIFIER |
Active Control * (bool) Active Status (bool) Current Air Purifier State Status * (uint8) Target Air Purifier State Control * (bool) Target Air Purifier State Status (bool) |
0 = Inactive, 1 = Idle, 2 = Purifying Air 0 = Manual, 1 = Auto 0 = Manual, 1 = Auto |
N/A |
|
|
Optional |
Lock Physical Controls Control (bool) Lock Physical Controls Status (bool) Rotation Speed Control (scale) Rotation Speed Status (scale) Swing Mode Control (bool) Swing Mode Status (bool) |
|||
|
HEATER COOLER |
Active Control * (bool) Active Status (bool) Current Heater / Cooler State Status * (uint8) Target Heater / Cooler State Control * (uint8) Target Heater / Cooler State Status (uint8) Temperature Status * (float16) |
0 = Inactive, 1 = Idle, 2 = Heating, 3 = Cooling 0 = Auto, 1 = Heat, 2 = Cool 0 = Auto, 1 = Heat, 2 = Cool |
Thermostat |
Switch on/off thermostat Switch on/off thermostat status Current Temperature |
|
Optional |
Lock Physical Controls Control (bool) Lock Physical Controls Status (bool) Rotation Speed Control (scale) Rotation Speed Status (scale) Swing Mode Control (bool) Swing Mode Status (bool) Cooling Threshold Temperature Control (float16) Cooling Threshold Temperature Status (float16) Heating Threshold Temperature Control (float16) Heating Threshold Temperature Status (float16) Temperature Display Units Control (bool) Temperature Display Units Status (bool) |
0 = Celsius, 1 = Fahrenheit 0 = Celsius, 1 = Fahrenheit |
||
|
HUMIDIFIER/DEHUMIDIFIER |
Active Control * (bool) Active Status (bool) Current Humidifier / Dehumidifier State Status * (uint8) Target Humidifier / Dehumidifier State Control * (uint8) Target Humidifier / Dehumidifier State Status (uint8) Humidity Status * (scale) |
0 = Inactive, 1 = Idle, 2 = Heating, 3 = Humidifying, 4 = Dehumidifying 0 = Auto, 1 = Humidifier, 2 = Dehumidifier 0 = Auto, 1 = Humidifier, 2 = Dehumidifier |
N/A |
|
|
Optional |
Lock Physical Controls Control (bool) Lock Physical Controls Status (bool) Rotation Speed Control (scale) Rotation Speed Status (scale) Swing Mode Control (bool) Swing Mode Status (bool) Relative Humidity Dehumidifier Threshold Control (scale) Relative Humidity Dehumidifier Threshold Status (scale) Relative Humidity Humidifier Threshold Control (scale) Relative Humidity Humidifier Threshold Status (scale) Water Level Status (scale) |
|||
|
VALVE |
Active Control * (bool) Active Status (bool) In Use Status * (bool) |
Thermostat |
Switch on/off thermostat Switch on/off thermostat status |
|
|
Optional |
Valve Type Status (uint8) |
0 = Water faucet, 1 = Irrigation, 2 = Shower head |
||
|
AIR QUALITY SENSOR |
Air Quality Status * (uint8) |
0 = Unknown, 1 = Excellent, 2 = Good, 3 = Fair, 4 = Inferior, 5 = Poor |
Air quality Particle sensor |
|
|
Optional |
Nitrogen Dioxide Density Status (float16) Ozone Density Status (float16) PM10 Density Status (float16) PM2.5 Density Status (float16) Sulphur Dioxide Density Status (float16) VOC Density Status (float16) Status Active Status (bool) Status Fault Status (bool) Status Low Battery Status (bool) Status Tampered Status (bool) |
NO2 (Air quality) Ozone (Air quality) Part.10 (Particle sensor) Part.2.5 (Particle sensor) TVOC (Air quality) |
||
|
SECURITY SYSTEM |
Security System Current State Status * (uint8) Security System Target State Control * (uint8) Security System Target State Status (uint8) |
0 = Stay Arm, 1 = Away Arm, 2 = Night Arm, 3 = Disarmed, 4 = Alarm Triggered 0 = Stay Arm, 1 = Away Arm, 2 = Night Arm, 3 = Disarm 0 = Stay Arm, 1 = Away Arm, 2 = Night Arm, 3 = Disarm |
N/A |
|
|
Optional |
Security System Alarm Type Status (bool) Status Fault Status (bool) Status Tampered Status (bool) |
|||
|
GARAGE DOOR OPENER |
Current Door State Status * (uint8) Target Door State Control * (bool) Target Door State Status (bool) Obstruction Detected Status * (bool) |
0 = Open, 1 = Closed, 2 = Opening, 3 = Closing, 4 = Stopped 0 = Open, 1 = Closed 0 = Open, 1 = Closed |
N/A |
|
|
Optional |
Lock Current State Status (uint8) Lock Target State Control (bool) Lock Target State Status (bool) |
0 = Unsecured, 1 = Secured, 2 = Jammed, 3 = Unknown 0 = Unsecured, 1 = Secured 0 = Unsecured, 1 = Secured |
||