Skip to content

Services

Christopher Aitken edited this page Jul 19, 2020 · 5 revisions

The Service node represents the accessory you want to control or query within the Home app. Some service nodes can only be set/used as a child-service, such as the BatteryService, to any other Service node (accessory).

Service Name Required Characteristics Example use
AccessControl AccessControlLevel
AccessoryInformation Identify, Manufacturer, Model,
AccessoryRuntimeInformation Ping
Air purifier Active, current state, target state
Air quality sensor Air quality
BatteryService BatteryLevel, ChargingState, StatusLowBattery
CameraEventRecordingManagement Active, SupportedCameraRecordingConfiguration, SupportedVideoRecordingConfiguration, SupportedAudioRecordingConfiguration, SelectedCameraRecordingConfiguration
CameraOperatingMode ManuallyDisabled, NightVision, ThirdPartyCameraActive, CameraOperatingModeIndicator, PeriodicSnapshotsActive
CameraRTPStreamManagement SupportedVideoStreamConfiguration, SupportedAudioStreamConfiguration, SupportedRTPConfiguration, SelectedRTPStreamConfiguration, StreamingStatus, SetupEndpoints
Carbon dioxide sensor Carbon dioxide detected
Carbon monoxide sensor Carbon monoxide detected
Contact sensor ContactSensorState Door, window (open/closed)
Diagnostics SupportedDiagnosticsSnapshot
Door Current position, target position, position state Motorized door
Doorbell ProgrammableSwitchEvent
Fan On Non oscillating fan
Fan V2 Active Oscillating fan
Faucet Active
FilterMaintenance FilterChangeIndication
Garage door opener Current state, target state, obstruction detected
Heater Cooler Active, current heater cooler state, target heater cooler state, current temperature Air conditioner system
Humidifier / dehumidifier Current relative humidity, current humidifier dehumidifier state, target humidifier dehumidifier state, active
Humidity sensor Current relative humidity
IrrigationSystem Active, ProgramMode, InUse
Leak sensor Leak detected
Light sensor Current ambient light level
Light bulb On Can be on/off, dimmable, multi color, or adjustable temperature bulb
LockManagement LockControlPoint, Version
Lock mechanism Lock current state, lock target state Door lock
Microphone Mute
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
ServiceLabel ServiceLabelNamespace
Slat Current slat state, slat type Vents on a fan
SmartSpeaker CurrentMediaState, TargetMediaState
Smoke sensor Smoke detected
Speaker Mute
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
TransferTransportManagement SupportedTransferTransportConfiguration, SetupTransferTransport
Valve Active, in use Faucet, sprinkler, shower
WiFiRouter ConfiguredName, ManagedNetworkEnable, NetworkAccessViolationControl, NetworkClientProfileControl, NetworkClientStatusControl, RouterStatus, SupportedRouterConfiguration, WANConfigurationList, WANStatusList
WiFiSatellite WiFiSatelliteStatus
WiFiTransport CurrentTransport, WiFiCapabilities
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