Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
HomeSpan/tools/test.md

67 KiB
Raw Blame History

AccessoryInformation (3E)

Required Identification Information. For each Accessory in a HomeSpan device this must be included as the first Service.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
Identify14boolPW01
  • IDLE (0)
  • RUN_ID (1)
 the Home App set this to RUN_ID when it wants the device to run its identification routine
FirmwareRevision52stringPR+EV--"1.0.0" must be in form x[.y[.z]] - informational only
Manufacturer20stringPR--"HomeSpan" any string - informational only
Model21stringPR--"HomeSpan-ESP32" any string - informational only
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
SerialNumber30stringPR--"HS-12345"
HardwareRevision53stringPR--"1.0.0" must be in form x[.y[.z]] - informational only

AirPurifier (BB)

Defines a basic Air Purifier with an optional fan. Optional Linked Services: FilterMaintenance, AirQualitySensor, Fan, and Slat
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
CurrentAirPurifierStateA9uint8PR+EV02
  • INACTIVE (0)
  • IDLE (1)
  • PURIFYING (2)
 indicates current state of air purification
TargetAirPurifierStateA8uint8PW+PR+EV01
  • MANUAL (0)
  • AUTO (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
RotationSpeed29floatPR+PW+EV01000
SwingModeB6uint8PR+EV+PW01
  • SWING_DISABLED (0)
  • SWING_ENABLED (1)
LockPhysicalControlsA7uint8PW+PR+EV01
  • CONTROL_LOCK_DISABLED (0)
  • CONTROL_LOCK_ENABLED (1)
 indicates if local control lock is enabled

AirQualitySensor (8D)

Defines an Air Quality Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
AirQuality95uint8PR+EV05
  • UNKNOWN (0)
  • EXCELLENT (1)
  • GOOD (2)
  • FAIR (3)
  • INFERIOR (4)
  • POOR (5)
 a subjective description
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
OzoneDensityC3floatPR+EV010000 measured in µg/m3
NitrogenDioxideDensityC4floatPR+EV010000 measured in µg/m3
SulphurDioxideDensityC5floatPR+EV010000
PM25DensityC6floatPR+EV010000 2.5-micron particulate density, measured in µg/m3
PM10DensityC7floatPR+EV010000 10-micron particulate density, measured in µg/m3
VOCDensityC8floatPR+EV010000
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

BatteryService (96)

Defines a standalone Battery Service.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
BatteryLevel68uint8PR+EV01000 measured as a percentage
ChargingState8Fuint8PR+EV02
  • NOT_CHARGING (0)
  • CHARGING (1)
  • NOT_CHARGEABLE (2)
 indicates state of battery charging
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

CarbonDioxideSensor (97)

Defines a Carbon Dioxide Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CarbonDioxideDetected92uint8PR+EV01
  • NORMAL (0)
  • ABNORMAL (1)
 indicates if abnormal level is detected
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)
CarbonDioxideLevel93floatPR+EV01000000 measured on parts per million (ppm)
CarbonDioxidePeakLevel94floatPR+EV01000000 measured in parts per million (ppm)

CarbonMonoxideSensor (7F)

Defines a Carbon Monoxide Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CarbonMonoxideDetected69uint8PR+EV01
  • NORMAL (0)
  • ABNORMAL (1)
 indicates if abnormal level is detected
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)
CarbonMonoxideLevel90floatPR+EV01000 measured in parts per million (ppm)
CarbonMonoxidePeakLevel91floatPR+EV01000 measured in parts per million (ppm)

ContactSensor (80)

Defines a Contact Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ContactSensorState6Auint8PR+EV01
  • DETECTED (0)
  • NOT_DETECTED (1)
 indictates if contact is detected (i.e. closed)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

Door (81)

Defines a motorized Door.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentPosition6Duint8PR+EV01000 current position (as a percentage) from fully closed (0) to full open (100)
TargetPosition7Cuint8PW+PR+EV01000
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
ObstructionDetected24boolPR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if obstruction is detected

Doorbell (121)

Defines a Doorbell. Can be used on a standalone basis or in conjunction with a LockMechanism Service.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ProgrammableSwitchEvent73uint8PR+EV+NV02
  • SINGLE_PRESS (0)
  • DOUBLE_PRESS (1)
  • LONG_PRESS (2)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

Fan (B7)

Defines a Fan. Can be used in conjunction with a LightBulb Service to create a Lighted Ceiling Fan.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
CurrentFanStateAFuint8PR+EV02
  • INACTIVE (0)
  • IDLE (1)
  • BLOWING (2)
 indicates current state of a fan
TargetFanStateBFuint8PW+PR+EV01
  • MANUAL (0)
  • AUTO (1)
RotationDirection28intPR+PW+EV01
  • CLOCKWISE (0)
  • COUNTERCLOCKWISE (1)
RotationSpeed29floatPR+PW+EV01000
SwingModeB6uint8PR+EV+PW01
  • SWING_DISABLED (0)
  • SWING_ENABLED (1)
LockPhysicalControlsA7uint8PW+PR+EV01
  • CONTROL_LOCK_DISABLED (0)
  • CONTROL_LOCK_ENABLED (1)
 indicates if local control lock is enabled

Faucet (D7)

Defines the master control for a multi-Valve appliance. Linked Services: Valve (at least one required), and HeaterCooler (optional).
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

FilterMaintenance (BA)

Defines a Filter Maintainence check.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
FilterChangeIndicationACuint8PR+EV01
  • NO_CHANGE_NEEDED (0)
  • CHANGE_NEEDED (1)
 indicates state of filter
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
FilterLifeLevelABfloatPR+EV01000 measures as a percentage of remaining life
ResetFilterIndicationADuint8PW110

GarageDoorOpener (41)

Defines a motorized Garage Door Opener.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentDoorStateEuint8PR+EV04
  • OPEN (0)
  • CLOSED (1)
  • OPENING (2)
  • CLOSING (3)
  • STOPPED (4)
 indicates current state of a door
TargetDoorState32uint8PW+PR+EV01
  • OPEN (0)
  • CLOSED (1)
ObstructionDetected24boolPR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if obstruction is detected
LockCurrentState1Duint8PR+EV03
  • UNLOCKED (0)
  • LOCKED (1)
  • JAMMED (2)
  • UNKNOWN (3)
 indictates state of a lock
LockTargetState1Euint8PW+PR+EV01
  • UNLOCK (0)
  • LOCK (1)
 indicates desired state of lock
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
Version37stringPR--"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.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
CurrentTemperature11floatPR+EV01000 current temperature measured in Celsius
CurrentHeaterCoolerStateB1uint8PR+EV03
  • INACTIVE (0)
  • IDLE (1)
  • HEATING (2)
  • COOLING (3)
 indicates whether appliance is currently heating, cooling, idle, or off
TargetHeaterCoolerStateB2uint8PW+PR+EV02
  • AUTO (0)
  • HEAT (1)
  • COOL (2)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
RotationSpeed29floatPR+PW+EV01000
TemperatureDisplayUnits36uint8PW+PR+EV01
  • CELSIUS (0)
  • FAHRENHEIT (1)
SwingModeB6uint8PR+EV+PW01
  • SWING_DISABLED (0)
  • SWING_ENABLED (1)
CoolingThresholdTemperatureDfloatPR+PW+EV103510 cooling turns on when temperature (in Celsius) rises above this threshold
HeatingThresholdTemperature12floatPR+PW+EV02516 heating turns on when temperature (in Celsius) falls below this threshold
LockPhysicalControlsA7uint8PW+PR+EV01
  • CONTROL_LOCK_DISABLED (0)
  • CONTROL_LOCK_ENABLED (1)
 indicates if local control lock is enabled

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.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
CurrentRelativeHumidity10floatPR+EV01000current humidity measured as a percentage
CurrentHumidifierDehumidifierStateB3uint8PR+EV03
  • INACTIVE (0)
  • IDLE (1)
  • HUMIDIFYING (2)
  • DEHUMIDIFYING (3)
 indicates current state of humidifier/dehumidifer
TargetHumidifierDehumidifierStateB4uint8PW+PR+EV02
  • AUTO (0)
  • HUMIDIFY (1)
  • DEHUMIDIFY (2)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
RelativeHumidityDehumidifierThresholdC9floatPR+PW+EV010050
RelativeHumidityHumidifierThresholdCAfloatPR+PW+EV010050
RotationSpeed29floatPR+PW+EV01000
SwingModeB6uint8PR+EV+PW01
  • SWING_DISABLED (0)
  • SWING_ENABLED (1)
WaterLevelB5floatPR+EV01000
LockPhysicalControlsA7uint8PW+PR+EV01
  • CONTROL_LOCK_DISABLED (0)
  • CONTROL_LOCK_ENABLED (1)
 indicates if local control lock is enabled

HumiditySensor (82)

Defines a Humidity Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentRelativeHumidity10floatPR+EV01000current humidity measured as a percentage
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

InputSource (D9)

Defines an Input Source for a TV. Use only as a Linked Service for the Television Service.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ConfiguredNameE3stringPW+PR+EV--"unnamed"
IsConfiguredD6uint8PR+EV01
  • NOT_CONFIGURED (0)
  • CONFIGURED (1)
 indicates if a predefined Service has been configured
IdentifierE6uint32PR02550
CurrentVisibilityState135uint8PR+EV010
TargetVisibilityState134uint8PW+PR+EV010

IrrigationSystem (CF)

Defines an Irrigation System. Linked Services: Valve Service (at least one required).
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
ProgramModeD1uint8PR+EV02
  • NONE (0)
  • SCHEDULED (1)
  • SCHEDULE_OVERRIDEN (2)
InUseD2uint8PR+EV01
  • NOT_IN_USE (0)
  • IN_USE (1)
 if Service is set to active, this indictes whether it is currently in use
RemainingDurationD4uint32PR+EV0360060
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)

LeakSensor (83)

Defines a Leak Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
LeakDetected70uint8PR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indictates if a leak is detected
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

LightBulb (43)

Defines any type of Light.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
On25boolPR+PW+EV01
  • OFF (0)
  • ON (1)
 indicates if the Service is active/on
Brightness8intPR+PW+EV01000 measured as a percentage
Hue13floatPR+PW+EV03600 color (in degrees) from red (0) to green (120) to blue (240) and back to red (360)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
Saturation2FfloatPR+PW+EV01000
ColorTemperatureCEuint32PR+PW+EV140500200 measured in inverse megaKelvin (= 1,000,000 / Kelvin)

LightSensor (84)

Defines a Light Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentAmbientLightLevel6BfloatPR+EV0.00011000001 measured in Lux (lumens/m2
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

LockMechanism (45)

Defines an electronic Lock.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
LockCurrentState1Duint8PR+EV03
  • UNLOCKED (0)
  • LOCKED (1)
  • JAMMED (2)
  • UNKNOWN (3)
 indictates state of a lock
LockTargetState1Euint8PW+PR+EV01
  • UNLOCK (0)
  • LOCK (1)
 indicates desired state of lock
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
Mute11AboolPW+PR+EV01
  • OFF (0)
  • ON (1)
 not used
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
Volume119uint8PW+PR+EV01000

MotionSensor (85)

Defines a Motion Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
MotionDetected22boolPR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if motion is detected
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

OccupancySensor (86)

Defines and Occupancy Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
OccupancyDetected71uint8PR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if occupanccy is detected
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

Outlet (47)

Defines an controllable Outlet used to power any light or appliance.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
On25boolPR+PW+EV01
  • OFF (0)
  • ON (1)
 indicates if the Service is active/on
OutletInUse26boolPR+EV01
  • NOT_IN_USE (0)
  • IN_USE (1)
 indicates if an appliance or light is plugged into the outlet, regardless of whether on or off
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

SecuritySystem (7E)

Defines a Security System.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
SecuritySystemCurrentState66uint8PR+EV04
  • ARMED_STAY (0)
  • ARMED_AWAY (1)
  • ARMED_NIGHT (2)
  • DISARMED (3)
  • ALARM_TRIGGERED (4)
SecuritySystemTargetState67uint8PW+PR+EV03
  • ARM_STAY (0)
  • ARM_AWAY (1)
  • ARM_NIGHT (2)
  • DISARM (3)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
SecuritySystemAlarmType8Euint8PR+EV01
  • KNOWN (0)
  • UNKNOWN (1)
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
ServiceLabelNamespaceCDuint8PR01
  • DOTS (0)
  • NUMERALS (1)

Slat (B9)

Defines a motorized ventilation Slat(s).
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentSlatStateAAuint8PR+EV02
  • FIXED (0)
  • JAMMED (1)
  • SWINGING (2)
 indicates current state of slats
SlatTypeC0uint8PR01
  • HORIZONTAL (0)
  • VERTICAL (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
SwingModeB6uint8PR+EV+PW01
  • SWING_DISABLED (0)
  • SWING_ENABLED (1)
CurrentTiltAngleC1intPR+EV-90900 angle (in degrees) of slats from fully up or left (-90) to fully open (0) to fully down or right (90)
TargetTiltAngleC2intPW+PR+EV-90900

SmokeSensor (87)

Defines a Smoke Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
SmokeDetected76uint8PR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)
Mute11AboolPW+PR+EV01
  • OFF (0)
  • ON (1)
 not used
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
Volume119uint8PW+PR+EV01000

StatelessProgrammableSwitch (89)

Defines a "Stateless" Programmable Switch that can be used to trigger actions in the Home App.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ProgrammableSwitchEvent73uint8PR+EV+NV02
  • SINGLE_PRESS (0)
  • DOUBLE_PRESS (1)
  • LONG_PRESS (2)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

Switch (49)

Defines a generic Switch.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
On25boolPR+PW+EV01
  • OFF (0)
  • ON (1)
 indicates if the Service is active/on
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

Television (D8)

Defines a TV. Optional Linked Services: InputSource and TelevisionSpeaker.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
ConfiguredNameE3stringPW+PR+EV--"unnamed"
ActiveIdentifierE7uint32PW+PR+EV02550 the Identifier of the current Input Source
RemoteKeyE1uint8PW0160
PowerModeSelectionDFuint8PW010

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.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
VolumeControlTypeE9uint8PR+EV030
VolumeSelectorEAuint8PW010

TemperatureSensor (8A)

Defines a Temperature Sensor.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentTemperature11floatPR+EV01000 current temperature measured in Celsius
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
StatusActive75boolPR+EV01true
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
StatusTampered7Auint8PR+EV01
  • NOT_TAMPERED (0)
  • TAMPERED (1)
StatusLowBattery79uint8PR+EV01
  • NOT_LOW_BATTERY (0)
  • LOW_BATTERY (1)

Thermostat (4A)

Defines a Thermostat used to control a furnace, air conditioner, or both.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentHeatingCoolingStateFuint8PR+EV02
  • IDLE (0)
  • HEATING (1)
  • COOLING (2)
 indicates whether appliance is currently heating, cooling, or just idle
TargetHeatingCoolingState33uint8PW+PR+EV03
  • OFF (0)
  • HEAT (1)
  • COOL (2)
  • AUTO (3)
CurrentTemperature11floatPR+EV01000 current temperature measured in Celsius
TargetTemperature35floatPW+PR+EV103816
TemperatureDisplayUnits36uint8PW+PR+EV01
  • CELSIUS (0)
  • FAHRENHEIT (1)
CoolingThresholdTemperatureDfloatPR+PW+EV103510 cooling turns on when temperature (in Celsius) rises above this threshold
CurrentRelativeHumidity10floatPR+EV01000current humidity measured as a percentage
HeatingThresholdTemperature12floatPR+PW+EV02516 heating turns on when temperature (in Celsius) falls below this threshold
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
TargetRelativeHumidity34floatPW+PR+EV01000

Valve (D0)

Defines an electronic Valve. Can be used standalone or as a Linked Service in conjunction with the Faucet and IrrigationSystem Services.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
ActiveB0uint8PW+PR+EV01
  • INACTIVE (0)
  • ACTIVE (1)
 indicates if the Service is active/on
InUseD2uint8PR+EV01
  • NOT_IN_USE (0)
  • IN_USE (1)
 if Service is set to active, this indictes whether it is currently in use
ValveTypeD5uint8PR+EV030
SetDurationD3uint32PW+PR+EV0360060
RemainingDurationD4uint32PR+EV0360060
IsConfiguredD6uint8PR+EV01
  • NOT_CONFIGURED (0)
  • CONFIGURED (1)
 indicates if a predefined Service has been configured
StatusFault77uint8PR+EV01
  • NO_FAULT (0)
  • FAULT (1)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing

Window (8B)

Defines a motorized Window.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
CurrentPosition6Duint8PR+EV01000 current position (as a percentage) from fully closed (0) to full open (100)
TargetPosition7Cuint8PW+PR+EV01000
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
ObstructionDetected24boolPR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if obstruction is detected

WindowCovering (8C)

Defines a motorized Window Shade, Screen, Awning, etc.
CharacteristicUUIDFormatPermsMinMaxDefaultsNotes
TargetPosition7Cuint8PW+PR+EV01000
CurrentPosition6Duint8PR+EV01000 current position (as a percentage) from fully closed (0) to full open (100)
Name23stringPR--"unnamed" default name of a Service used only during initial pairing
CurrentHorizontalTiltAngle6CintPR+EV-90900 current angle (in degrees) of slats from fully up (-90) to fully open (0) to fully down (90)
TargetHorizontalTiltAngle7BintPW+PR+EV-90900
CurrentVerticalTiltAngle6EintPR+EV-90900 current angle (in degrees) of slats from fully left (-90) to fully open (0) to fully right (90)
TargetVerticalTiltAngle7DintPW+PR+EV-90900
ObstructionDetected24boolPR+EV01
  • NOT_DETECTED (0)
  • DETECTED (1)
 indicates if obstruction is detected