74 KiB
74 KiB
AccessoryInformation (3E)
Required Identification Information. For each Accessory in a HomeSpan device this must be included as the first Service.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Identifythe Home App set this to RUN_ID when it wants the device to run its identification routine | 14 | bool | PW | 0 | 1 |
| |
FirmwareRevisionmust be in form x[.y[.z]] - informational only | 52 | string | PR+EV | - | - | "1.0.0" | |
Manufacturerany string - informational only | 20 | string | PR | - | - | "HomeSpan" | |
Modelany string - informational only | 21 | string | PR | - | - | "HomeSpan-ESP32" | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
SerialNumber | 30 | string | PR | - | - | "HS-12345" | |
HardwareRevisionmust be in form x[.y[.z]] - informational only | 53 | string | PR | - | - | "1.0.0" |
AirPurifier (BB)
Defines a basic Air Purifier with an optional fan. Optional Linked Services: FilterMaintenance, AirQualitySensor, Fan, and Slat
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
CurrentAirPurifierStateindicates current state of air purification | A9 | uint8 | PR+EV | 0 | 2 |
| |
TargetAirPurifierState | A8 | uint8 | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
RotationSpeed | 29 | float | PR+PW+EV | 0 | 100 | 0 | |
SwingMode | B6 | uint8 | PR+EV+PW | 0 | 1 |
| |
LockPhysicalControlsindicates if local control lock is enabled | A7 | uint8 | PW+PR+EV | 0 | 1 |
|
AirQualitySensor (8D)
Defines an Air Quality Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
AirQualitya subjective description | 95 | uint8 | PR+EV | 0 | 5 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
OzoneDensitymeasured in µg/m3 | C3 | float | PR+EV | 0 | 1000 | 0 | |
NitrogenDioxideDensitymeasured in µg/m3 | C4 | float | PR+EV | 0 | 1000 | 0 | |
SulphurDioxideDensity | C5 | float | PR+EV | 0 | 1000 | 0 | |
PM25Density2.5-micron particulate density, measured in µg/m3 | C6 | float | PR+EV | 0 | 1000 | 0 | |
PM10Density10-micron particulate density, measured in µg/m3 | C7 | float | PR+EV | 0 | 1000 | 0 | |
VOCDensity | C8 | float | PR+EV | 0 | 1000 | 0 | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
BatteryService (96)
Defines a standalone Battery Service.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
BatteryLevelmeasured as a percentage | 68 | uint8 | PR+EV | 0 | 100 | 0 | |
ChargingStateindicates state of battery charging | 8F | uint8 | PR+EV | 0 | 2 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
CarbonDioxideSensor (97)
Defines a Carbon Dioxide Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CarbonDioxideDetectedindicates if abnormal level is detected | 92 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
| |
CarbonDioxideLevelmeasured on parts per million (ppm) | 93 | float | PR+EV | 0 | 100000 | 0 | |
CarbonDioxidePeakLevelmeasured in parts per million (ppm) | 94 | float | PR+EV | 0 | 100000 | 0 |
CarbonMonoxideSensor (7F)
Defines a Carbon Monoxide Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CarbonMonoxideDetectedindicates if abnormal level is detected | 69 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
| |
CarbonMonoxideLevelmeasured in parts per million (ppm) | 90 | float | PR+EV | 0 | 100 | 0 | |
CarbonMonoxidePeakLevelmeasured in parts per million (ppm) | 91 | float | PR+EV | 0 | 100 | 0 |
ContactSensor (80)
Defines a Contact Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
ContactSensorStateindictates if contact is detected (i.e. closed) | 6A | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
Door (81)
Defines a motorized Door.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentPositioncurrent position (as a percentage) from fully closed (0) to full open (100) | 6D | uint8 | PR+EV | 0 | 100 | 0 | |
TargetPosition | 7C | uint8 | PW+PR+EV | 0 | 100 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
ObstructionDetectedindicates if obstruction is detected | 24 | bool | PR+EV | 0 | 1 |
|
Doorbell (121)
Defines a Doorbell. Can be used on a standalone basis or in conjunction with a LockMechanism Service.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
ProgrammableSwitchEvent | 73 | uint8 | PR+EV+NV | 0 | 2 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
Fan (B7)
Defines a Fan. Can be used in conjunction with a LightBulb Service to create a Lighted Ceiling Fan.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
CurrentFanStateindicates current state of a fan | AF | uint8 | PR+EV | 0 | 2 |
| |
TargetFanState | BF | uint8 | PW+PR+EV | 0 | 1 |
| |
RotationDirection | 28 | int | PR+PW+EV | 0 | 1 |
| |
RotationSpeed | 29 | float | PR+PW+EV | 0 | 100 | 0 | |
SwingMode | B6 | uint8 | PR+EV+PW | 0 | 1 |
| |
LockPhysicalControlsindicates if local control lock is enabled | A7 | uint8 | PW+PR+EV | 0 | 1 |
|
Faucet (D7)
Defines the master control for a multi-Valve appliance. Linked Services: Valve (at least one required), and HeaterCooler (optional).
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
FilterMaintenance (BA)
Defines a Filter Maintainence check.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
FilterChangeIndicationindicates state of filter | AC | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
FilterLifeLevelmeasures as a percentage of remaining life | AB | float | PR+EV | 0 | 100 | 0 | |
ResetFilterIndication | AD | uint8 | PW | 1 | 1 | 0 |
GarageDoorOpener (41)
Defines a motorized Garage Door Opener.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentDoorStateindicates current state of a door | E | uint8 | PR+EV | 0 | 4 |
| |
TargetDoorState | 32 | uint8 | PW+PR+EV | 0 | 1 |
| |
ObstructionDetectedindicates if obstruction is detected | 24 | bool | PR+EV | 0 | 1 |
| |
LockCurrentStateindictates state of a lock | 1D | uint8 | PR+EV | 0 | 3 |
| |
LockTargetStateindicates desired state of lock | 1E | uint8 | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
Version | 37 | string | PR | - | - | "1.0.0" |
HeaterCooler (BC)
Defines a standalone Heater, Cooler, or combined Heater/Cooler. Can be used with a separate Fan Service and/or Slat Service to extend functionality.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
CurrentTemperaturecurrent temperature measured in Celsius | 11 | float | PR+EV | 0 | 100 | 0 | |
CurrentHeaterCoolerStateindicates whether appliance is currently heating, cooling, idle, or off | B1 | uint8 | PR+EV | 0 | 3 |
| |
TargetHeaterCoolerState | B2 | uint8 | PW+PR+EV | 0 | 2 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
RotationSpeed | 29 | float | PR+PW+EV | 0 | 100 | 0 | |
TemperatureDisplayUnits | 36 | uint8 | PW+PR+EV | 0 | 1 |
| |
SwingMode | B6 | uint8 | PR+EV+PW | 0 | 1 |
| |
CoolingThresholdTemperaturecooling turns on when temperature (in Celsius) rises above this threshold | D | float | PR+PW+EV | 10 | 35 | 10 | |
HeatingThresholdTemperatureheating turns on when temperature (in Celsius) falls below this threshold | 12 | float | PR+PW+EV | 0 | 25 | 16 | |
LockPhysicalControlsindicates if local control lock is enabled | A7 | uint8 | PW+PR+EV | 0 | 1 |
|
HumidifierDehumidifier (BD)
Defines a Humidifer, Dehumidifier, or combined Humidifer/Dehumidifier. Can be used with a separate Fan Service and/or Slat Service to extend functionality.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
CurrentRelativeHumiditycurrent humidity measured as a percentage | 10 | float | PR+EV | 0 | 100 | 0 | |
CurrentHumidifierDehumidifierStateindicates current state of humidifier/dehumidifer | B3 | uint8 | PR+EV | 0 | 3 |
| |
TargetHumidifierDehumidifierState | B4 | uint8 | PW+PR+EV | 0 | 2 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
RelativeHumidityDehumidifierThreshold | C9 | float | PR+PW+EV | 0 | 100 | 50 | |
RelativeHumidityHumidifierThreshold | CA | float | PR+PW+EV | 0 | 100 | 50 | |
RotationSpeed | 29 | float | PR+PW+EV | 0 | 100 | 0 | |
SwingMode | B6 | uint8 | PR+EV+PW | 0 | 1 |
| |
WaterLevel | B5 | float | PR+EV | 0 | 100 | 0 | |
LockPhysicalControlsindicates if local control lock is enabled | A7 | uint8 | PW+PR+EV | 0 | 1 |
|
HumiditySensor (82)
Defines a Humidity Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentRelativeHumiditycurrent humidity measured as a percentage | 10 | float | PR+EV | 0 | 100 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
InputSource (D9)
Defines an Input Source for a TV. Use only as a Linked Service for the Television Service.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
ConfiguredName | E3 | string | PW+PR+EV | - | - | "unnamed" | |
IsConfiguredindicates if a predefined Service has been configured | D6 | uint8 | PR+EV | 0 | 1 |
| |
Identifier | E6 | uint32 | PR | 0 | 255 | 0 | |
CurrentVisibilityState | 135 | uint8 | PR+EV | 0 | 1 | 0 | |
TargetVisibilityState | 134 | uint8 | PW+PR+EV | 0 | 1 | 0 |
IrrigationSystem (CF)
Defines an Irrigation System. Linked Services: Valve Service (at least one required).
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
ProgramMode | D1 | uint8 | PR+EV | 0 | 2 |
| |
InUseif Service is set to active, this indictes whether it is currently in use | D2 | uint8 | PR+EV | 0 | 1 |
| |
RemainingDuration | D4 | uint32 | PR+EV | 0 | 3600 | 60 | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
|
LeakSensor (83)
Defines a Leak Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
LeakDetectedindictates if a leak is detected | 70 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
LightBulb (43)
Defines any type of Light.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Onindicates if the Service is active/on | 25 | bool | PR+PW+EV | 0 | 1 |
| |
Brightnessmeasured as a percentage | 8 | int | PR+PW+EV | 0 | 100 | 0 | |
Huecolor (in degrees) from red (0) to green (120) to blue (240) and back to red (360) | 13 | float | PR+PW+EV | 0 | 360 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
Saturation | 2F | float | PR+PW+EV | 0 | 100 | 0 | |
ColorTemperaturemeasured in inverse megaKelvin (= 1,000,000 / Kelvin) | CE | uint32 | PR+PW+EV | 140 | 500 | 200 |
LightSensor (84)
Defines a Light Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentAmbientLightLevelmeasured in Lux (lumens/m2 | 6B | float | PR+EV | 0.0001 | 100000 | 1 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
LockMechanism (45)
Defines an electronic Lock.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
LockCurrentStateindictates state of a lock | 1D | uint8 | PR+EV | 0 | 3 |
| |
LockTargetStateindicates desired state of lock | 1E | uint8 | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
Mutenot used | 11A | bool | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
Volume | 119 | uint8 | PW+PR+EV | 0 | 100 | 0 |
MotionSensor (85)
Defines a Motion Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
MotionDetectedindicates if motion is detected | 22 | bool | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
OccupancySensor (86)
Defines and Occupancy Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
OccupancyDetectedindicates if occupanccy is detected | 71 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
Outlet (47)
Defines an controllable Outlet used to power any light or appliance.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Onindicates if the Service is active/on | 25 | bool | PR+PW+EV | 0 | 1 |
| |
OutletInUseindicates if an appliance or light is plugged into the outlet, regardless of whether on or off | 26 | bool | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
SecuritySystem (7E)
Defines a Security System.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
SecuritySystemCurrentState | 66 | uint8 | PR+EV | 0 | 4 |
| |
SecuritySystemTargetState | 67 | uint8 | PW+PR+EV | 0 | 3 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
SecuritySystemAlarmType | 8E | uint8 | PR+EV | 0 | 1 |
| |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
ServiceLabelNamespace | CD | uint8 | PR | 0 | 1 |
|
Slat (B9)
Defines a motorized ventilation Slat(s).
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentSlatStateindicates current state of slats | AA | uint8 | PR+EV | 0 | 2 |
| |
SlatType | C0 | uint8 | PR | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
SwingMode | B6 | uint8 | PR+EV+PW | 0 | 1 |
| |
CurrentTiltAngleangle (in degrees) of slats from fully up or left (-90) to fully open (0) to fully down or right (90) | C1 | int | PR+EV | -90 | 90 | 0 | |
TargetTiltAngle | C2 | int | PW+PR+EV | -90 | 90 | 0 |
SmokeSensor (87)
Defines a Smoke Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
SmokeDetected | 76 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
| |
Mutenot used | 11A | bool | PW+PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
Volume | 119 | uint8 | PW+PR+EV | 0 | 100 | 0 |
StatelessProgrammableSwitch (89)
Defines a "Stateless" Programmable Switch that can be used to trigger actions in the Home App.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
ProgrammableSwitchEvent | 73 | uint8 | PR+EV+NV | 0 | 2 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
Switch (49)
Defines a generic Switch.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Onindicates if the Service is active/on | 25 | bool | PR+PW+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
Television (D8)
Defines a TV. Optional Linked Services: InputSource and TelevisionSpeaker.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
ConfiguredName | E3 | string | PW+PR+EV | - | - | "unnamed" | |
ActiveIdentifierthe Identifier of the current Input Source | E7 | uint32 | PW+PR+EV | 0 | 255 | 0 | |
RemoteKey | E1 | uint8 | PW | 0 | 16 | 0 | |
PowerModeSelection | DF | uint8 | PW | 0 | 1 | 0 |
TelevisionSpeaker (113)
Defines a Television Speaker that can be controlled via the Remote Control widget on an iPhone. Use only as a Linked Service for the Television Service.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
VolumeControlType | E9 | uint8 | PR+EV | 0 | 3 | 0 | |
VolumeSelector | EA | uint8 | PW | 0 | 1 | 0 |
TemperatureSensor (8A)
Defines a Temperature Sensor.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentTemperaturecurrent temperature measured in Celsius | 11 | float | PR+EV | 0 | 100 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
StatusActive | 75 | bool | PR+EV | 0 | 1 | true | |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
StatusTampered | 7A | uint8 | PR+EV | 0 | 1 |
| |
StatusLowBattery | 79 | uint8 | PR+EV | 0 | 1 |
|
Thermostat (4A)
Defines a Thermostat used to control a furnace, air conditioner, or both.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentHeatingCoolingStateindicates whether appliance is currently heating, cooling, or just idle | F | uint8 | PR+EV | 0 | 2 |
| |
TargetHeatingCoolingState | 33 | uint8 | PW+PR+EV | 0 | 3 |
| |
CurrentTemperaturecurrent temperature measured in Celsius | 11 | float | PR+EV | 0 | 100 | 0 | |
TargetTemperature | 35 | float | PW+PR+EV | 10 | 38 | 16 | |
TemperatureDisplayUnits | 36 | uint8 | PW+PR+EV | 0 | 1 |
| |
CoolingThresholdTemperaturecooling turns on when temperature (in Celsius) rises above this threshold | D | float | PR+PW+EV | 10 | 35 | 10 | |
CurrentRelativeHumiditycurrent humidity measured as a percentage | 10 | float | PR+EV | 0 | 100 | 0 | |
HeatingThresholdTemperatureheating turns on when temperature (in Celsius) falls below this threshold | 12 | float | PR+PW+EV | 0 | 25 | 16 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
TargetRelativeHumidity | 34 | float | PW+PR+EV | 0 | 100 | 0 |
Valve (D0)
Defines an electronic Valve. Can be used standalone or as a Linked Service in conjunction with the Faucet and IrrigationSystem Services.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
Activeindicates if the Service is active/on | B0 | uint8 | PW+PR+EV | 0 | 1 |
| |
InUseif Service is set to active, this indictes whether it is currently in use | D2 | uint8 | PR+EV | 0 | 1 |
| |
ValveType | D5 | uint8 | PR+EV | 0 | 3 | 0 | |
SetDuration | D3 | uint32 | PW+PR+EV | 0 | 3600 | 60 | |
RemainingDuration | D4 | uint32 | PR+EV | 0 | 3600 | 60 | |
IsConfiguredindicates if a predefined Service has been configured | D6 | uint8 | PR+EV | 0 | 1 |
| |
StatusFault | 77 | uint8 | PR+EV | 0 | 1 |
| |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" |
Window (8B)
Defines a motorized Window.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
CurrentPositioncurrent position (as a percentage) from fully closed (0) to full open (100) | 6D | uint8 | PR+EV | 0 | 100 | 0 | |
TargetPosition | 7C | uint8 | PW+PR+EV | 0 | 100 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
ObstructionDetectedindicates if obstruction is detected | 24 | bool | PR+EV | 0 | 1 |
|
WindowCovering (8C)
Defines a motorized Window Shade, Screen, Awning, etc.
| Characteristic | UUID | Format | Perms | Min | Max | Defaults | Notes |
|---|---|---|---|---|---|---|---|
TargetPosition | 7C | uint8 | PW+PR+EV | 0 | 100 | 0 | |
CurrentPositioncurrent position (as a percentage) from fully closed (0) to full open (100) | 6D | uint8 | PR+EV | 0 | 100 | 0 | |
Namedefault name of a Service used only during initial pairing | 23 | string | PR | - | - | "unnamed" | |
CurrentHorizontalTiltAnglecurrent angle (in degrees) of slats from fully up (-90) to fully open (0) to fully down (90) | 6C | int | PR+EV | -90 | 90 | 0 | |
TargetHorizontalTiltAngle | 7B | int | PW+PR+EV | -90 | 90 | 0 | |
CurrentVerticalTiltAnglecurrent angle (in degrees) of slats from fully left (-90) to fully open (0) to fully right (90) | 6E | int | PR+EV | -90 | 90 | 0 | |
TargetVerticalTiltAngle | 7D | int | PW+PR+EV | -90 | 90 | 0 | |
ObstructionDetectedindicates if obstruction is detected | 24 | bool | PR+EV | 0 | 1 |
|