diff --git a/docs/ServiceList.md b/docs/ServiceList.md
index 3224d39..8fde451 100644
--- a/docs/ServiceList.md
+++ b/docs/ServiceList.md
@@ -32,7 +32,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
Required Identification Information. For each Accessory in a HomeSpan device this must be included as the first Service.
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
Identify (14) :small_blue_diamond:- triggers an update when HomeKit wants HomeSpan to run its identification routine for an Accessory
| bool | PW | 1 | 1 | |
-Name (23) - default name of a Service used only during initial pairing
| string | PR | - | - | "unnamed" |
+Name (23) - name of the Accessory when displayed in the Home App
| string | PR | - | - | "unnamed" |
FirmwareRevision (52) - must be in form x[.y[.z]] - informational only
| string | PR+EV | - | - | "1.0.0" |
Manufacturer (20) - any string - informational only
| string | PR | - | - | "HomeSpan" |
Model (21) - any string - informational only
| string | PR | - | - | "HomeSpan-ESP32" |
@@ -47,7 +47,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| BatteryLevel (68) :small_blue_diamond: | uint8 | PR+EV | 0 | 100 | 100 |
ChargingState (8F) :small_blue_diamond:- indicates state of battery charging
| uint8 | PR+EV | 0 | 2 | - NOT_CHARGING (0) :heavy_check_mark:
- CHARGING (1)
- NOT_CHARGEABLE (2)
|
StatusLowBattery (79) :small_blue_diamond:- indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### LightBulb (43)
@@ -58,7 +58,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
Hue (13) - color (in degrees) from red (0) to green (120) to blue (240) and back to red (360)
| float | PR+PW+EV | 0 | 360 | 0 |
Saturation (2F) - color saturation, measured as a percentage
| float | PR+PW+EV | 0 | 100 | 0 |
ColorTemperature (CE) - measured in inverse megaKelvin (= 1,000,000 / Kelvin)
| uint32 | PR+PW+EV | 140 | 500 | 200 |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Outlet (47)
@@ -66,7 +66,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
On (25) :small_blue_diamond:- indicates if the Service is active/on
| bool | PR+PW+EV | 0 | 1 | - OFF (0) :heavy_check_mark:
- ON (1)
|
OutletInUse (26) :small_blue_diamond:- indicates if an appliance or light is plugged into the outlet, regardless of whether on or off
| bool | PR+EV | 0 | 1 | - NOT_IN_USE (0) :heavy_check_mark:
- IN_USE (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### StatelessProgrammableSwitch (89)
@@ -80,7 +80,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
Defines a generic Switch.
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
On (25) :small_blue_diamond:- indicates if the Service is active/on
| bool | PR+PW+EV | 0 | 1 | - OFF (0) :heavy_check_mark:
- ON (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## HEATING, VENTILATION, AND AIR CONDITIONING (HVAC)
@@ -93,7 +93,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| RotationSpeed (29) | float | PR+PW+EV | 0 | 100 | 0 |
SwingMode (B6) - indicates whether swing-mode is enabled
| uint8 | PR+EV+PW | 0 | 1 | - SWING_DISABLED (0) :heavy_check_mark:
- SWING_ENABLED (1)
|
LockPhysicalControls (A7) - indicates if local control lock is enabled
| uint8 | PW+PR+EV | 0 | 1 | - CONTROL_LOCK_DISABLED (0) :heavy_check_mark:
- CONTROL_LOCK_ENABLED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Fan (B7)
@@ -106,7 +106,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| RotationSpeed (29) | float | PR+PW+EV | 0 | 100 | 0 |
SwingMode (B6) - indicates whether swing-mode is enabled
| uint8 | PR+EV+PW | 0 | 1 | - SWING_DISABLED (0) :heavy_check_mark:
- SWING_ENABLED (1)
|
LockPhysicalControls (A7) - indicates if local control lock is enabled
| uint8 | PW+PR+EV | 0 | 1 | - CONTROL_LOCK_DISABLED (0) :heavy_check_mark:
- CONTROL_LOCK_ENABLED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### FilterMaintenance (BA)
@@ -115,7 +115,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
FilterChangeIndication (AC) :small_blue_diamond:- indicates state of filter
| uint8 | PR+EV | 0 | 1 | - NO_CHANGE_NEEDED (0) :heavy_check_mark:
- CHANGE_NEEDED (1)
|
FilterLifeLevel (AB) - measures as a percentage of remaining life
| float | PR+EV | 0 | 100 | 0 |
ResetFilterIndication (AD) - triggers and update when the user chooses to reset the FilterChangeIndication from the Home App
| uint8 | PW | 1 | 1 | |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### HeaterCooler (BC)
@@ -131,7 +131,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CoolingThresholdTemperature (D) - cooling turns on when temperature (in Celsius) rises above this threshold
| float | PR+PW+EV | 10 | 35 | 10 |
HeatingThresholdTemperature (12) - heating turns on when temperature (in Celsius) falls below this threshold
| float | PR+PW+EV | 0 | 25 | 16 |
LockPhysicalControls (A7) - indicates if local control lock is enabled
| uint8 | PW+PR+EV | 0 | 1 | - CONTROL_LOCK_DISABLED (0) :heavy_check_mark:
- CONTROL_LOCK_ENABLED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### HumidifierDehumidifier (BD)
@@ -147,7 +147,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
SwingMode (B6) - indicates whether swing-mode is enabled
| uint8 | PR+EV+PW | 0 | 1 | - SWING_DISABLED (0) :heavy_check_mark:
- SWING_ENABLED (1)
|
| WaterLevel (B5) | float | PR+EV | 0 | 100 | 0 |
LockPhysicalControls (A7) - indicates if local control lock is enabled
| uint8 | PW+PR+EV | 0 | 1 | - CONTROL_LOCK_DISABLED (0) :heavy_check_mark:
- CONTROL_LOCK_ENABLED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Slat (B9)
@@ -158,7 +158,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
SwingMode (B6) - indicates whether swing-mode is enabled
| uint8 | PR+EV+PW | 0 | 1 | - SWING_DISABLED (0) :heavy_check_mark:
- SWING_ENABLED (1)
|
CurrentTiltAngle (C1) - current angle (in degrees) of slats from fully up or left (-90) to fully open (0) to fully down or right (90)
| int | PR+EV | -90 | 90 | 0 |
TargetTiltAngle (C2) - indicated desired angle (in degrees) of slats from fully up or left (-90) to fully open (0) to fully down or right (90)
| int | PW+PR+EV | -90 | 90 | 0 |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Thermostat (4A)
@@ -173,7 +173,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CurrentRelativeHumidity (10) - current humidity measured as a percentage
| float | PR+EV | 0 | 100 | 0 |
HeatingThresholdTemperature (12) - heating turns on when temperature (in Celsius) falls below this threshold
| float | PR+PW+EV | 0 | 25 | 16 |
TargetRelativeHumidity (34) - indicates desired humidity measured as a percentage
| float | PW+PR+EV | 0 | 100 | 0 |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## STANDALONE SENSORS
@@ -191,7 +191,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### CarbonDioxideSensor (97)
@@ -204,7 +204,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### CarbonMonoxideSensor (7F)
@@ -217,7 +217,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### ContactSensor (80)
@@ -228,7 +228,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### HumiditySensor (82)
@@ -239,7 +239,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### LeakSensor (83)
@@ -250,7 +250,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### LightSensor (84)
@@ -261,7 +261,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### MotionSensor (85)
@@ -272,7 +272,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### OccupancySensor (86)
@@ -283,7 +283,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### SmokeSensor (87)
@@ -294,7 +294,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### TemperatureSensor (8A)
@@ -305,7 +305,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
StatusLowBattery (79) - indicates state of battery
| uint8 | PR+EV | 0 | 1 | - NOT_LOW_BATTERY (0) :heavy_check_mark:
- LOW_BATTERY (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## DOORS, LOCKS, AND WINDOWS
@@ -315,14 +315,14 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CurrentPosition (6D) :small_blue_diamond:- current position (as a percentage) from fully closed (0) to full open (100)
| uint8 | PR+EV | 0 | 100 | 0 |
TargetPosition (7C) :small_blue_diamond:- indicates target position (as a percentage) from fully closed (0) to full open (100)
| uint8 | PW+PR+EV | 0 | 100 | 0 |
ObstructionDetected (24) - indicates if obstruction is detected
| bool | PR+EV | 0 | 1 | - NOT_DETECTED (0) :heavy_check_mark:
- DETECTED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Doorbell (121)
Defines a Doorbell. Can be used on a standalone basis or in conjunction with a LockMechanism Service.
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
ProgrammableSwitchEvent (73) :small_blue_diamond:- specifies type of button press
| uint8 | PR+EV+NV | 0 | 2 | - SINGLE_PRESS (0) :heavy_check_mark:
- DOUBLE_PRESS (1)
- LONG_PRESS (2)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### GarageDoorOpener (41)
@@ -333,7 +333,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
ObstructionDetected (24) :small_blue_diamond:- indicates if obstruction is detected
| bool | PR+EV | 0 | 1 | - NOT_DETECTED (0) :heavy_check_mark:
- DETECTED (1)
|
LockCurrentState (1D) - indicates state of a lock
| uint8 | PR+EV | 0 | 3 | - UNLOCKED (0) :heavy_check_mark:
- LOCKED (1)
- JAMMED (2)
- UNKNOWN (3)
|
LockTargetState (1E) - indicates desired state of lock
| uint8 | PW+PR+EV | 0 | 1 | - UNLOCK (0) :heavy_check_mark:
- LOCK (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### LockMechanism (45)
@@ -341,7 +341,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
LockCurrentState (1D) :small_blue_diamond:- indicates state of a lock
| uint8 | PR+EV | 0 | 3 | - UNLOCKED (0) :heavy_check_mark:
- LOCKED (1)
- JAMMED (2)
- UNKNOWN (3)
|
LockTargetState (1E) :small_blue_diamond:- indicates desired state of lock
| uint8 | PW+PR+EV | 0 | 1 | - UNLOCK (0) :heavy_check_mark:
- LOCK (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Window (8B)
@@ -350,7 +350,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CurrentPosition (6D) :small_blue_diamond:- current position (as a percentage) from fully closed (0) to full open (100)
| uint8 | PR+EV | 0 | 100 | 0 |
TargetPosition (7C) :small_blue_diamond:- indicates target position (as a percentage) from fully closed (0) to full open (100)
| uint8 | PW+PR+EV | 0 | 100 | 0 |
ObstructionDetected (24) - indicates if obstruction is detected
| bool | PR+EV | 0 | 1 | - NOT_DETECTED (0) :heavy_check_mark:
- DETECTED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### WindowCovering (8C)
@@ -363,7 +363,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CurrentVerticalTiltAngle (6E) - current angle (in degrees) of slats from fully left (-90) to fully open (0) to fully right (90)
| int | PR+EV | -90 | 90 | 0 |
TargetVerticalTiltAngle (7D) - indicates desired angle (in degrees) of slats from fully left (-90) to fully open (0) to fully right (90)
| int | PW+PR+EV | -90 | 90 | 0 |
ObstructionDetected (24) - indicates if obstruction is detected
| bool | PR+EV | 0 | 1 | - NOT_DETECTED (0) :heavy_check_mark:
- DETECTED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## WATER SYSTEMS
@@ -372,7 +372,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
Active (B0) :small_blue_diamond:- indicates if the Service is active/on
| uint8 | PW+PR+EV | 0 | 1 | - INACTIVE (0) :heavy_check_mark:
- ACTIVE (1)
|
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### IrrigationSystem (CF)
@@ -383,7 +383,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
InUse (D2) :small_blue_diamond:- if Service is set to active, this indictes whether it is currently in use
| uint8 | PR+EV | 0 | 1 | - NOT_IN_USE (0) :heavy_check_mark:
- IN_USE (1)
|
RemainingDuration (D4) - duration (in seconds) remaining for Service to be active/on
| uint32 | PR+EV | 0 | 3600 | 60 |
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### Valve (D0)
@@ -397,7 +397,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
IsConfigured (D6) - indicates if a predefined Service has been configured
| uint8 | PR+EV | 0 | 1 | - NOT_CONFIGURED (0) :heavy_check_mark:
- CONFIGURED (1)
|
ServiceLabelIndex (CB) - numerical index used to distinguish multiple copies of the same Service within an Accessory
| uint8 | PR | 1 | 255 | 1 |
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## SECURITY SYSTEMS
@@ -409,7 +409,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
SecuritySystemAlarmType (8E) - indicates whether alarm was triggered for known reason
| uint8 | PR+EV | 0 | 1 | - KNOWN (0) :heavy_check_mark:
- UNKNOWN (1)
|
StatusFault (77) - indicates whether the Service has a fault
| uint8 | PR+EV | 0 | 1 | - NO_FAULT (0) :heavy_check_mark:
- FAULT (1)
|
StatusTampered (7A) - indicates whether the Service has been tampered with
| uint8 | PR+EV | 0 | 1 | - NOT_TAMPERED (0) :heavy_check_mark:
- TAMPERED (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## TELEVISIONS
@@ -417,7 +417,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
Defines an Input Source for a TV. Use only as a Linked Service for the Television Service.
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
Identifier (E6) :small_blue_diamond:- numerical Identifer of the InputSource.
| uint32 | PR | 0 | 255 | 0 |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
IsConfigured (D6) - indicates if a predefined Service has been configured
| uint8 | PR+EV | 0 | 1 | - NOT_CONFIGURED (0) :heavy_check_mark:
- CONFIGURED (1)
|
CurrentVisibilityState (135) - current visibility of the Service, as selectable on the Settings Page of the Home App
| uint8 | PR+EV | 0 | 1 | - VISIBLE (0) :heavy_check_mark:
- NOT_VISIBLE (1)
|
TargetVisibilityState (134) - indicates desired visibility of the Service, as selectable on the Settings Page of the Home App
| uint8 | PW+PR+EV | 0 | 1 | - VISIBLE (0) :heavy_check_mark:
- NOT_VISIBLE (1)
|
@@ -430,7 +430,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
ActiveIdentifier (E7) - numerical Identifier of the InputSource selected in the Home App.
| uint32 | PW+PR+EV | 0 | 255 | 0 |
RemoteKey (E1) - triggers an update when the corresponding key is pressed in the Remote Control widget on an iPhone
| uint8 | PW | 4 | 15 | - UP (4)
- DOWN (5)
- LEFT (6)
- RIGHT (7)
- CENTER (8)
- BACK (9)
- PLAY_PAUSE (11)
- INFO (15)
|
PowerModeSelection (DF) - when defined, creates a "View TV Settings" button in the Home App that triggers an update to this Characteristic when pressed
| uint8 | PW | 0 | 0 | |
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
### TelevisionSpeaker (113)
@@ -438,7 +438,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
| Characteristic | Format | Perms | Min | Max | Constants/Defaults |
|---|
VolumeControlType (E9) :small_blue_diamond:- indicates the type of volume control
| uint8 | PR+EV | 0 | 3 | - NONE (0)
- RELATIVE (1)
- RELATIVE_CURRENT (2)
- ABSOLUTE (3) :heavy_check_mark:
|
VolumeSelector (EA) :small_blue_diamond:- triggered by presses to the iPhone's volume up/down buttons when TV is selected in the Remote Control widget
| uint8 | PW | 0 | 1 | - VOLUME_UP (0)
- VOLUME_DOWN (1)
|
-ConfiguredName (E3) - a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
| string | PW+PR+EV | - | - | "unnamed" |
+ConfiguredName (E3) - name of the Service when displayed in the Home App
| string | PW+PR+EV | - | - | "unnamed" |
## MISCELLANEOUS
diff --git a/src/Span.h b/src/Span.h
index fe0e34c..71dabf0 100644
--- a/src/Span.h
+++ b/src/Span.h
@@ -496,7 +496,7 @@ namespace Characteristic {
CREATE_CHAR(double,CoolingThresholdTemperature,10,10,35); // cooling turns on when temperature (in Celsius) rises above this threshold
CREATE_CHAR(uint32_t,ColorTemperature,200,140,500); // measured in inverse megaKelvin (= 1,000,000 / Kelvin)
CREATE_CHAR(uint8_t,ContactSensorState,1,0,1,DETECTED,NOT_DETECTED); // indictates if contact is detected (i.e. closed)
- CREATE_CHAR(const char *,ConfiguredName,"unnamed",0,1); // a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
+ CREATE_CHAR(const char *,ConfiguredName,"unnamed",0,1); // name of the Service when displayed in the Home App
CREATE_CHAR(double,CurrentAmbientLightLevel,1,0.0001,100000); // measured in Lux (lumens/m2
CREATE_CHAR(int,CurrentHorizontalTiltAngle,0,-90,90); // current angle (in degrees) of slats from fully up (-90) to fully open (0) to fully down (90)
CREATE_CHAR(uint8_t,CurrentAirPurifierState,1,0,2,INACTIVE,IDLE,PURIFYING); // indicates current state of air purification
@@ -534,7 +534,7 @@ namespace Characteristic {
CREATE_CHAR(const char *,Model,"HomeSpan-ESP32",0,1); // any string - informational only
CREATE_CHAR(boolean,MotionDetected,0,0,1,NOT_DETECTED,DETECTED); // indicates if motion is detected
CREATE_CHAR(boolean,Mute,0,0,1,OFF,ON); // not used
- CREATE_CHAR(const char *,Name,"unnamed",0,1); // default name of a Service used only during initial pairing
+ CREATE_CHAR(const char *,Name,"unnamed",0,1); // name of the Accessory when displayed in the Home App
CREATE_CHAR(double,NitrogenDioxideDensity,0,0,1000); // measured in µg/m3
CREATE_CHAR(boolean,ObstructionDetected,0,0,1,NOT_DETECTED,DETECTED); // indicates if obstruction is detected
CREATE_CHAR(double,PM25Density,0,0,1000); // 2.5-micron particulate density, measured in µg/m3