HomeSpan/tools/test.md

AccessoryInformation (3E)

Here is some important text you need to read. Spacing is not critical since this will be formated in HTML where spaces are ignored. You can use *standard* markdown elements as well.

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Identify	14	bool	PW	0	1
FirmwareRevision	52	string	PR+EV	-	-
Manufacturer	20	string	PR	-	-
Model	21	string	PR	-	-
Name	23	string	PR	-	-
SerialNumber	30	string	PR	-	-
HardwareRevision	53	string	PR	-	-
AccessoryFlags	A6	uint32	PR+EV	1	1		This is not really used anywhere 1/3

AirPurifier (BB)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
CurrentAirPurifierState	A9	uint8	PR+EV	0	2	INACTIVE (0) IDLE (1) PURIFYING (2)
TargetAirPurifierState	A8	uint8	PW+PR+EV	0	1	MANUAL (0) AUTO (1)
Name	23	string	PR	-	-
RotationSpeed	29	float	PR+PW+EV	0	100
SwingMode	B6	uint8	PR+EV+PW	0	1	SWING_DISABLED (0) SWING_ENABLED (1)
LockPhysicalControls	A7	uint8	PW+PR+EV	0	1	CONTROL_LOCK_DISABLED (0) CONTROL_LOCK_ENABLED (1)

AirQualitySensor (8D)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
AirQuality	95	uint8	PR+EV	0	5	UNKNOWN (0) EXCELLENT (1) GOOD (2) FAIR (3) INFERIOR (4) POOR (5)
Name	23	string	PR	-	-
OzoneDensity	C3	float	PR+EV	0	1000
NitrogenDioxideDensity	C4	float	PR+EV	0	1000
SulphurDioxideDensity	C5	float	PR+EV	0	1000
PM25Density	C6	float	PR+EV	0	1000
PM10Density	C7	float	PR+EV	0	1000
VOCDensity	C8	float	PR+EV	0	1000
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

BatteryService (96)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
BatteryLevel	68	uint8	PR+EV	0	100
ChargingState	8F	uint8	PR+EV	0	2	NOT_CHARGING (0) CHARGING (1) NOT_CHARGEABLE (2)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)
Name	23	string	PR	-	-

CarbonDioxideSensor (97)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CarbonDioxideDetected	92	uint8	PR+EV	0	1	NORMAL (0) ABNORMAL (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)
CarbonDioxideLevel	93	float	PR+EV	0	100000
CarbonDioxidePeakLevel	94	float	PR+EV	0	100000

CarbonMonoxideSensor (7F)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CarbonMonoxideDetected	69	uint8	PR+EV	0	1	NORMAL (0) ABNORMAL (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)
CarbonMonoxideLevel	90	float	PR+EV	0	100
CarbonMonoxidePeakLevel	91	float	PR+EV	0	100

ContactSensor (80)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
ContactSensorState	6A	uint8	PR+EV	0	1	DETECTED (0) NOT_DETECTED (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

Door (81)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentPosition	6D	uint8	PR+EV	0	100
TargetPosition	7C	uint8	PW+PR+EV	0	100
PositionState	72	uint8	PR+EV	0	2	GOING_TO_MINIMUM (0) GOING_TO_MAXIMUM (1) STOPPED (2)
Name	23	string	PR	-	-
HoldPosition	6F	bool	PW	0	1
ObstructionDetected	24	bool	PR+EV	0	1

Doorbell (121)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
ProgrammableSwitchEvent	73	uint8	PR+EV+NV	0	2	SINGLE_PRESS (0) DOUBLE_PRESS (1) LONG_PRESS (2)
Name	23	string	PR	-	-
Volume	119	uint8	PW+PR+EV	0	100
Brightness	8	int	PR+PW+EV	0	100

Fan (B7)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
Name	23	string	PR	-	-
CurrentFanState	AF	uint8	PR+EV	0	2	INACTIVE (0) IDLE (1) BLOWING (2)
TargetFanState	BF	uint8	PW+PR+EV	0	1	MANUAL (0) AUTO (1)
RotationDirection	28	int	PR+PW+EV	0	1	CLOCKWISE (0) COUNTERCLOCKWISE (1)
RotationSpeed	29	float	PR+PW+EV	0	100
SwingMode	B6	uint8	PR+EV+PW	0	1	SWING_DISABLED (0) SWING_ENABLED (1)
LockPhysicalControls	A7	uint8	PW+PR+EV	0	1	CONTROL_LOCK_DISABLED (0) CONTROL_LOCK_ENABLED (1)

Faucet (D7)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
Name	23	string	PR	-	-

FilterMaintenance (BA)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
FilterChangeIndication	AC	uint8	PR+EV	0	1	NO_CHANGE_NEEDED (0) CHANGE_NEEDED (1)
Name	23	string	PR	-	-
FilterLifeLevel	AB	float	PR+EV	0	100
ResetFilterIndication	AD	uint8	PW	1	1

GarageDoorOpener (41)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentDoorState	E	uint8	PR+EV	0	4	OPEN (0) CLOSED (1) OPENING (2) CLOSING (3) STOPPED (4)
TargetDoorState	32	uint8	PW+PR+EV	0	1	OPEN (0) CLOSED (1)
ObstructionDetected	24	bool	PR+EV	0	1
LockCurrentState	1D	uint8	PR+EV	0	3	UNLOCKED (0) LOCKED (1) JAMMED (2) UNKNOWN (3)
LockTargetState	1E	uint8	PW+PR+EV	0	1	UNLOCK (0) LOCK (1)
Name	23	string	PR	-	-

HAPProtocolInformation (A2)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Version	37	string	PR	-	-

HeaterCooler (BC)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
CurrentTemperature	11	float	PR+EV	0	100
CurrentHeaterCoolerState	B1	uint8	PR+EV	0	3	INACTIVE (0) IDLE (1) HEATING (2) COOLING (3)
TargetHeaterCoolerState	B2	uint8	PW+PR+EV	0	2	AUTO (0) HEAT (1) COOL (2)
Name	23	string	PR	-	-
RotationSpeed	29	float	PR+PW+EV	0	100
TemperatureDisplayUnits	36	uint8	PW+PR+EV	0	1	CELSIUS (0) FAHRENHEIT (1)
SwingMode	B6	uint8	PR+EV+PW	0	1	SWING_DISABLED (0) SWING_ENABLED (1)
CoolingThresholdTemperature	D	float	PR+PW+EV	10	35
HeatingThresholdTemperature	12	float	PR+PW+EV	0	25
LockPhysicalControls	A7	uint8	PW+PR+EV	0	1	CONTROL_LOCK_DISABLED (0) CONTROL_LOCK_ENABLED (1)

HumidifierDehumidifier (BD)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
CurrentRelativeHumidity	10	float	PR+EV	0	100
CurrentHumidifierDehumidifierState	B3	uint8	PR+EV	0	3	INACTIVE (0) IDLE (1) HUMIDIFYING (2) DEHUMIDIFYING (3)
TargetHumidifierDehumidifierState	B4	uint8	PW+PR+EV	0	2	AUTO (0) HUMIDIFY (1) DEHUMIDIFY (2)
Name	23	string	PR	-	-
RelativeHumidityDehumidifierThreshold	C9	float	PR+PW+EV	0	100
RelativeHumidityHumidifierThreshold	CA	float	PR+PW+EV	0	100
RotationSpeed	29	float	PR+PW+EV	0	100
SwingMode	B6	uint8	PR+EV+PW	0	1	SWING_DISABLED (0) SWING_ENABLED (1)
WaterLevel	B5	float	PR+EV	0	100
LockPhysicalControls	A7	uint8	PW+PR+EV	0	1	CONTROL_LOCK_DISABLED (0) CONTROL_LOCK_ENABLED (1)

HumiditySensor (82)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentRelativeHumidity	10	float	PR+EV	0	100
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

InputSource (D9)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
ConfiguredName	E3	string	PW+PR+EV	-	-
IsConfigured	D6	uint8	PR+EV	0	1	NOT_CONFIGURED (0) CONFIGURED (1)
Identifier	E6	uint32	PR	0	255
CurrentVisibilityState	135	uint8	PR+EV	0	1
TargetVisibilityState	134	uint8	PW+PR+EV	0	1

IrrigationSystem (CF)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
ProgramMode	D1	uint8	PR+EV	0	2	NONE (0) SCHEDULED (1) SCHEDULE_OVERRIDEN (2)
InUse	D2	uint8	PR+EV	0	1	NOT_IN_USE (0) IN_USE (1)
RemainingDuration	D4	uint32	PR+EV	0	3600
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)

LeakSensor (83)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
LeakDetected	70	uint8	PR+EV	0	1	NOT_DETECTED (0) DETECTED (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

LightBulb (43)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
On	25	bool	PR+PW+EV	0	1
Brightness	8	int	PR+PW+EV	0	100
Hue	13	float	PR+PW+EV	0	360
Name	23	string	PR	-	-
Saturation	2F	float	PR+PW+EV	0	100
ColorTemperature	CE	uint32	PR+PW+EV	140	500

LightSensor (84)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentAmbientLightLevel	6B	float	PR+EV	0.0001	100000
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

LockMechanism (45)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
LockCurrentState	1D	uint8	PR+EV	0	3	UNLOCKED (0) LOCKED (1) JAMMED (2) UNKNOWN (3)
LockTargetState	1E	uint8	PW+PR+EV	0	1	UNLOCK (0) LOCK (1)
Name	23	string	PR	-	-

Microphone (112)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Mute	11A	bool	PW+PR+EV	0	1	OFF (0) ON (1)
Name	23	string	PR	-	-
Volume	119	uint8	PW+PR+EV	0	100

MotionSensor (85)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
MotionDetected	22	bool	PR+EV	0	1
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

OccupancySensor (86)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
OccupancyDetected	71	uint8	PR+EV	0	1	NOT_DETECTED (0) DETECTED (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

Outlet (47)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
On	25	bool	PR+PW+EV	0	1
OutletInUse	26	bool	PR+EV	0	1
Name	23	string	PR	-	-

SecuritySystem (7E)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
SecuritySystemCurrentState	66	uint8	PR+EV	0	4	ARMED_STAY (0) ARMED_AWAY (1) ARMED_NIGHT (2) DISARMED (3) ALARM_TRIGGERED (4)
SecuritySystemTargetState	67	uint8	PW+PR+EV	0	3	ARM_STAY (0) ARM_AWAY (1) ARM_NIGHT (2) DISARM (3)
Name	23	string	PR	-	-
SecuritySystemAlarmType	8E	uint8	PR+EV	0	1	KNOWN (0) UNKNOWN (1)
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)

ServiceLabel (CC)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
ServiceLabelNamespace	CD	uint8	PR	0	1	DOTS (0) NUMERALS (1)

Slat (B9)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentSlatState	AA	uint8	PR+EV	0	2	FIXED (0) JAMMED (1) SWINGING (2)
SlatType	C0	uint8	PR	0	1	HORIZONTAL (0) VERTICAL (1)
Name	23	string	PR	-	-
SwingMode	B6	uint8	PR+EV+PW	0	1	SWING_DISABLED (0) SWING_ENABLED (1)
CurrentTiltAngle	C1	int	PR+EV	-90	90
TargetTiltAngle	C2	int	PW+PR+EV	-90	90

SmokeSensor (87)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
SmokeDetected	76	uint8	PR+EV	0	1	NOT_DETECTED (0) DETECTED (1)
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

Speaker (113)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Mute	11A	bool	PW+PR+EV	0	1	OFF (0) ON (1)
Name	23	string	PR	-	-
Volume	119	uint8	PW+PR+EV	0	100

StatelessProgrammableSwitch (89)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
ProgrammableSwitchEvent	73	uint8	PR+EV+NV	0	2	SINGLE_PRESS (0) DOUBLE_PRESS (1) LONG_PRESS (2)
Name	23	string	PR	-	-
ServiceLabelIndex	CB	uint8	PR	1	255

Switch (49)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
On	25	bool	PR+PW+EV	0	1
Name	23	string	PR	-	-

Television (D8)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
ConfiguredName	E3	string	PW+PR+EV	-	-
ActiveIdentifier	E7	uint32	PW+PR+EV	0	255
RemoteKey	E1	uint8	PW	0	16
PowerModeSelection	DF	uint8	PW	0	1

TelevisionSpeaker (113)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
VolumeControlType	E9	uint8	PR+EV	0	3
VolumeSelector	EA	uint8	PW	0	1

TemperatureSensor (8A)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentTemperature	11	float	PR+EV	0	100
Name	23	string	PR	-	-
StatusActive	75	bool	PR+EV	0	1
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
StatusTampered	7A	uint8	PR+EV	0	1	NOT_TAMPERED (0) TAMPERED (1)
StatusLowBattery	79	uint8	PR+EV	0	1	NOT_LOW_BATTERY (0) LOW_BATTERY (1)

Thermostat (4A)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentHeatingCoolingState	F	uint8	PR+EV	0	2	OFF (0) HEATING (1) COOLING (2)
TargetHeatingCoolingState	33	uint8	PW+PR+EV	0	3	OFF (0) HEAT (1) COOL (2) AUTO (3)
CurrentTemperature	11	float	PR+EV	0	100
TargetTemperature	35	float	PW+PR+EV	10	38
TemperatureDisplayUnits	36	uint8	PW+PR+EV	0	1	CELSIUS (0) FAHRENHEIT (1)
CoolingThresholdTemperature	D	float	PR+PW+EV	10	35
CurrentRelativeHumidity	10	float	PR+EV	0	100
HeatingThresholdTemperature	12	float	PR+PW+EV	0	25
Name	23	string	PR	-	-
TargetRelativeHumidity	34	float	PW+PR+EV	0	100

Valve (D0)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
Active	B0	uint8	PW+PR+EV	0	1	INACTIVE (0) ACTIVE (1)
InUse	D2	uint8	PR+EV	0	1	NOT_IN_USE (0) IN_USE (1)
ValveType	D5	uint8	PR+EV	0	3
SetDuration	D3	uint32	PW+PR+EV	0	3600
RemainingDuration	D4	uint32	PR+EV	0	3600
IsConfigured	D6	uint8	PR+EV	0	1	NOT_CONFIGURED (0) CONFIGURED (1)
ServiceLabelIndex	CB	uint8	PR	1	255
StatusFault	77	uint8	PR+EV	0	1	NO_FAULT (0) FAULT (1)
Name	23	string	PR	-	-

Window (8B)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
CurrentPosition	6D	uint8	PR+EV	0	100
TargetPosition	7C	uint8	PW+PR+EV	0	100
PositionState	72	uint8	PR+EV	0	2	GOING_TO_MINIMUM (0) GOING_TO_MAXIMUM (1) STOPPED (2)
Name	23	string	PR	-	-
HoldPosition	6F	bool	PW	0	1
ObstructionDetected	24	bool	PR+EV	0	1

WindowCovering (8C)

Characteristic	UUID	Format	Perms	Min	Max	Constants	Notes
TargetPosition	7C	uint8	PW+PR+EV	0	100
CurrentPosition	6D	uint8	PR+EV	0	100
PositionState	72	uint8	PR+EV	0	2	GOING_TO_MINIMUM (0) GOING_TO_MAXIMUM (1) STOPPED (2)
Name	23	string	PR	-	-
HoldPosition	6F	bool	PW	0	1
CurrentHorizontalTiltAngle	6C	int	PR+EV	-90	90
TargetHorizontalTiltAngle	7B	int	PW+PR+EV	-90	90
CurrentVerticalTiltAngle	6E	int	PR+EV	-90	90
TargetVerticalTiltAngle	7D	int	PW+PR+EV	-90	90
ObstructionDetected	24	bool	PR+EV	0	1