Skip to content

Services

crxporter edited this page Mar 5, 2019 · 5 revisions

The Service node represents the single device you want to control or query. As of version 0.5.1, every service node creates its own HAP accessory.

This is a (possibly incomplete) list of currently functional services (version 0.5.1)

Service Name Required Characteristics Example Items
Air purifier Active, current state, target state
Air quality sensor Air quality
Carbon dioxide sensor Carbon dioxide detected
Carbon monoxide sensor Carbon monoxide detected
Contact sensor Contact sensor state Door, window (open/closed)
Door Current position, target position, position state Motorized door
Fan On Non oscillating fan
Fan V2 Active Oscillating fan
Faucet Active
Garage door opener Current state, target state, obstruction detected
Heater Cooler Active, current heater cooler state, target heater cooler state, current temperature Fan with heater
Humidifier / dehumidifier Current relative humidity, current humidifier dehumidifier state, target humidifier dehumidifier state, active
Humidity sensor Current relative humidity
Leak sensor Leak detected
Light sensor Current ambient light level
Light bulb On Can be on/off, dimmable, multi color, or adjustable temperature bulb
Lock mechanism Lock current state, lock target state Door lock
Motion sensor Motion detected
Occupancy sensor Occupancy detected
Outlet On On/off only
Security system Security system current state, security system target state Used to arm/disarm external security system
Slat Current slat state, slat type Vents on a fan
Smoke sensor Smoke detected
Stateless programmable switch Programmable switch event No output, used to send actionable "button clicks" to HomeKit
Switch On On/off only
Temperature sensor Current temperature
Thermostat Current heating cooling state, target heating cooling state, current temperature, target temperature, temperature display units HVAC control, heater, or AC unit
Valve Active, in use Faucet, sprinkler, shower
Window Current position, target position, position state Motorized window
Window covering Target position, current position, position state Blinds, roller shutters, etc.
Clone this wiki locally