From ed7bfdaea98a9ad50876b2df6b3e17ec4b27bf95 Mon Sep 17 00:00:00 2001 From: Gregg Date: Thu, 1 Feb 2024 07:19:00 -0600 Subject: [PATCH] updated some descriptions --- docs/ServiceList.md | 72 ++++++++++++++++++++++----------------------- src/Span.h | 4 +-- 2 files changed, 38 insertions(+), 38 deletions(-) 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.
- + @@ -47,7 +47,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names - +
CharacteristicFormatPermsMinMaxConstants/Defaults
Identify (14) :small_blue_diamond:
  • triggers an update when HomeKit wants HomeSpan to run its identification routine for an Accessory
boolPW11
  • RUN_ID (1) 
Name (23)
  • default name of a Service used only during initial pairing
stringPR--"unnamed"
Name (23)
  • name of the Accessory when displayed in the Home App
stringPR--"unnamed"
FirmwareRevision (52)
  • must be in form x[.y[.z]] - informational only
stringPR+EV--"1.0.0"
Manufacturer (20)
  • any string - informational only
stringPR--"HomeSpan"
Model (21)
  • any string - informational only
stringPR--"HomeSpan-ESP32"
BatteryLevel (68) :small_blue_diamond:
  • measured as a percentage
uint8PR+EV0100100
ChargingState (8F) :small_blue_diamond:
  • indicates state of battery charging
uint8PR+EV02
  • NOT_CHARGING (0) :heavy_check_mark:
  • CHARGING (1) 
  • NOT_CHARGEABLE (2) 
StatusLowBattery (79) :small_blue_diamond:
  • indicates state of battery
uint8PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
ConfiguredName (E3)
  • name of the Service when displayed in the Home App
stringPW+PR+EV--"unnamed"

### LightBulb (43) @@ -58,7 +58,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names Hue (13) floatPR+PW+EV03600 Saturation (2F) floatPR+PW+EV01000 ColorTemperature (CE) uint32PR+PW+EV140500200 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Outlet (47) @@ -66,7 +66,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CharacteristicFormatPermsMinMaxConstants/Defaults On (25) :small_blue_diamond:boolPR+PW+EV01 OutletInUse (26) :small_blue_diamond:boolPR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### StatelessProgrammableSwitch (89) @@ -80,7 +80,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names Defines a generic Switch.
- +
CharacteristicFormatPermsMinMaxConstants/Defaults
On (25) :small_blue_diamond:
  • indicates if the Service is active/on
boolPR+PW+EV01
  • 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.
stringPW+PR+EV--"unnamed"
ConfiguredName (E3)
  • name of the Service when displayed in the Home App
stringPW+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) floatPR+PW+EV01000 SwingMode (B6) uint8PR+EV+PW01 LockPhysicalControls (A7) uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Fan (B7) @@ -106,7 +106,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names RotationSpeed (29) floatPR+PW+EV01000 SwingMode (B6) uint8PR+EV+PW01 LockPhysicalControls (A7) uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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:uint8PR+EV01 FilterLifeLevel (AB) floatPR+EV01000 ResetFilterIndication (AD) uint8PW11 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### HeaterCooler (BC) @@ -131,7 +131,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CoolingThresholdTemperature (D) floatPR+PW+EV103510 HeatingThresholdTemperature (12) floatPR+PW+EV02516 LockPhysicalControls (A7) uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### HumidifierDehumidifier (BD) @@ -147,7 +147,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names SwingMode (B6) uint8PR+EV+PW01 WaterLevel (B5) floatPR+EV01000 LockPhysicalControls (A7) uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Slat (B9) @@ -158,7 +158,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names SwingMode (B6) uint8PR+EV+PW01 CurrentTiltAngle (C1) intPR+EV-90900 TargetTiltAngle (C2) intPW+PR+EV-90900 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Thermostat (4A) @@ -173,7 +173,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CurrentRelativeHumidity (10) floatPR+EV01000 HeatingThresholdTemperature (12) floatPR+PW+EV02516 TargetRelativeHumidity (34) floatPW+PR+EV01000 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
## STANDALONE SENSORS @@ -191,7 +191,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### CarbonDioxideSensor (97) @@ -204,7 +204,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### CarbonMonoxideSensor (7F) @@ -217,7 +217,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### ContactSensor (80) @@ -228,7 +228,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### HumiditySensor (82) @@ -239,7 +239,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### LeakSensor (83) @@ -250,7 +250,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### LightSensor (84) @@ -261,7 +261,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### MotionSensor (85) @@ -272,7 +272,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### OccupancySensor (86) @@ -283,7 +283,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### SmokeSensor (87) @@ -294,7 +294,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### TemperatureSensor (8A) @@ -305,7 +305,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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:uint8PR+EV01000 TargetPosition (7C) :small_blue_diamond:uint8PW+PR+EV01000 ObstructionDetected (24) boolPR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Doorbell (121) Defines a Doorbell. Can be used on a standalone basis or in conjunction with a LockMechanism Service.
- +
CharacteristicFormatPermsMinMaxConstants/Defaults
ProgrammableSwitchEvent (73) :small_blue_diamond:
  • specifies type of button press
uint8PR+EV+NV02
  • 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.
stringPW+PR+EV--"unnamed"
ConfiguredName (E3)
  • name of the Service when displayed in the Home App
stringPW+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:boolPR+EV01 LockCurrentState (1D) uint8PR+EV03 LockTargetState (1E) uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### LockMechanism (45) @@ -341,7 +341,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CharacteristicFormatPermsMinMaxConstants/Defaults LockCurrentState (1D) :small_blue_diamond:uint8PR+EV03 LockTargetState (1E) :small_blue_diamond:uint8PW+PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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:uint8PR+EV01000 TargetPosition (7C) :small_blue_diamond:uint8PW+PR+EV01000 ObstructionDetected (24) boolPR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### WindowCovering (8C) @@ -363,7 +363,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CurrentVerticalTiltAngle (6E) intPR+EV-90900 TargetVerticalTiltAngle (7D) intPW+PR+EV-90900 ObstructionDetected (24) boolPR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
## WATER SYSTEMS @@ -372,7 +372,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CharacteristicFormatPermsMinMaxConstants/Defaults Active (B0) :small_blue_diamond:uint8PW+PR+EV01 StatusFault (77) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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:uint8PR+EV01 RemainingDuration (D4) uint32PR+EV0360060 StatusFault (77) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
### Valve (D0) @@ -397,7 +397,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names IsConfigured (D6) uint8PR+EV01 ServiceLabelIndex (CB) uint8PR12551 StatusFault (77) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+PR+EV--"unnamed"
## SECURITY SYSTEMS @@ -409,7 +409,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names SecuritySystemAlarmType (8E) uint8PR+EV01 StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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.
- + @@ -430,7 +430,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names - +
CharacteristicFormatPermsMinMaxConstants/Defaults
Identifier (E6) :small_blue_diamond:
  • numerical Identifer of the InputSource.
uint32PR02550
ConfiguredName (E3)
  • a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
stringPW+PR+EV--"unnamed"
ConfiguredName (E3)
  • name of the Service when displayed in the Home App
stringPW+PR+EV--"unnamed"
IsConfigured (D6)
  • indicates if a predefined Service has been configured
uint8PR+EV01
  • 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
uint8PR+EV01
  • 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
uint8PW+PR+EV01
  • VISIBLE (0) :heavy_check_mark:
  • NOT_VISIBLE (1) 
ActiveIdentifier (E7)
  • numerical Identifier of the InputSource selected in the Home App.
uint32PW+PR+EV02550
RemoteKey (E1)
  • triggers an update when the corresponding key is pressed in the Remote Control widget on an iPhone
uint8PW415
  • 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
uint8PW00
  • VIEW_SETTINGS (0) 
ConfiguredName (E3)
  • a "configurable" Service name - any updates made from within the Home App trigger an update in HomeSpan and vice versa.
stringPW+PR+EV--"unnamed"
ConfiguredName (E3)
  • name of the Service when displayed in the Home App
stringPW+PR+EV--"unnamed"

### TelevisionSpeaker (113) @@ -438,7 +438,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names CharacteristicFormatPermsMinMaxConstants/Defaults VolumeControlType (E9) :small_blue_diamond:uint8PR+EV03 VolumeSelector (EA) :small_blue_diamond:uint8PW01 -ConfiguredName (E3) stringPW+PR+EV--"unnamed" +ConfiguredName (E3) stringPW+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