From 5fd299ede7dd47081d00c245288d5d5ecd988fa5 Mon Sep 17 00:00:00 2001 From: Gregg Date: Thu, 1 Feb 2024 07:12:03 -0600 Subject: [PATCH] Added linebreak after each Service --- docs/ServiceList.md | 76 ++++++++++++++++++++++----------------------- tools/makeServices | 2 +- 2 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/ServiceList.md b/docs/ServiceList.md index 893e539..3224d39 100644 --- a/docs/ServiceList.md +++ b/docs/ServiceList.md @@ -38,7 +38,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names Model (21) stringPR--"HomeSpan-ESP32" SerialNumber (30) stringPR--"HS-12345" HardwareRevision (53) stringPR--"1.0.0" - +
## LIGHTS, POWER, AND SWITCHES ### BatteryService (96) @@ -48,7 +48,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names ChargingState (8F) :small_blue_diamond:uint8PR+EV02 StatusLowBattery (79) :small_blue_diamond:uint8PR+EV01 ConfiguredName (E3) stringPW+PR+EV--"unnamed" - +
### LightBulb (43) Defines any type of Light.
@@ -59,7 +59,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
Saturation (2F)
  • color saturation, measured as a percentage
floatPR+PW+EV01000
ColorTemperature (CE)
  • measured in inverse megaKelvin (= 1,000,000 / Kelvin)
uint32PR+PW+EV140500200
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"
+
### Outlet (47) Defines an controllable Outlet used to power any light or appliance.
@@ -67,21 +67,21 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
On (25) :small_blue_diamond:
  • indicates if the Service is active/on
boolPR+PW+EV01
  • 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
boolPR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### StatelessProgrammableSwitch (89) Defines a "Stateless" Programmable Switch that can be used to trigger actions in the Home App.
-
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) 
ServiceLabelIndex (CB)
  • numerical index used to distinguish multiple copies of the same Service within an Accessory
uint8PR12551
+
### Switch (49) 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"
+
## HEATING, VENTILATION, AND AIR CONDITIONING (HVAC) ### AirPurifier (BB) @@ -94,7 +94,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names SwingMode (B6) uint8PR+EV+PW01 LockPhysicalControls (A7) uint8PW+PR+EV01 ConfiguredName (E3) stringPW+PR+EV--"unnamed" - +
### Fan (B7) Defines a Fan. Can be used in conjunction with a LightBulb Service to create a Lighted Ceiling Fan.
@@ -107,7 +107,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
SwingMode (B6)
  • indicates whether swing-mode is enabled
uint8PR+EV+PW01
  • SWING_DISABLED (0) :heavy_check_mark:
  • SWING_ENABLED (1) 
LockPhysicalControls (A7)
  • indicates if local control lock is enabled
uint8PW+PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### FilterMaintenance (BA) Defines a Filter Maintainence check.
@@ -116,7 +116,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
FilterLifeLevel (AB)
  • measures as a percentage of remaining life
floatPR+EV01000
ResetFilterIndication (AD)
  • triggers and update when the user chooses to reset the FilterChangeIndication from the Home App
uint8PW11
  • RESET_FILTER (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"
+
### 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.
@@ -132,7 +132,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
HeatingThresholdTemperature (12)
  • heating turns on when temperature (in Celsius) falls below this threshold
floatPR+PW+EV02516
LockPhysicalControls (A7)
  • indicates if local control lock is enabled
uint8PW+PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### 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.
@@ -148,7 +148,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
WaterLevel (B5)
  • measured as a percentage
floatPR+EV01000
LockPhysicalControls (A7)
  • indicates if local control lock is enabled
uint8PW+PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### Slat (B9) Defines a motorized ventilation Slat(s).
@@ -159,7 +159,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
CurrentTiltAngle (C1)
  • current angle (in degrees) of slats from fully up or left (-90) to fully open (0) to fully down or right (90)
intPR+EV-90900
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)
intPW+PR+EV-90900
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"
+
### Thermostat (4A) Defines a Thermostat used to control a furnace, air conditioner, or both.
@@ -174,7 +174,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
HeatingThresholdTemperature (12)
  • heating turns on when temperature (in Celsius) falls below this threshold
floatPR+PW+EV02516
TargetRelativeHumidity (34)
  • indicates desired humidity measured as a percentage
floatPW+PR+EV01000
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"
+
## STANDALONE SENSORS ### AirQualitySensor (8D) @@ -192,7 +192,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusTampered (7A) uint8PR+EV01 StatusLowBattery (79) uint8PR+EV01 ConfiguredName (E3) stringPW+PR+EV--"unnamed" - +
### CarbonDioxideSensor (97) Defines a Carbon Dioxide Sensor.
@@ -205,7 +205,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### CarbonMonoxideSensor (7F) Defines a Carbon Monoxide Sensor.
@@ -218,7 +218,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### ContactSensor (80) Defines a Contact Sensor.
@@ -229,7 +229,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### HumiditySensor (82) Defines a Humidity Sensor.
@@ -240,7 +240,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### LeakSensor (83) Defines a Leak Sensor.
@@ -251,7 +251,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### LightSensor (84) Defines a Light Sensor.
@@ -262,7 +262,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### MotionSensor (85) Defines a Motion Sensor.
@@ -273,7 +273,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### OccupancySensor (86) Defines and Occupancy Sensor.
@@ -284,7 +284,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### SmokeSensor (87) Defines a Smoke Sensor.
@@ -295,7 +295,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
### TemperatureSensor (8A) Defines a Temperature Sensor.
@@ -306,7 +306,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
StatusTampered (7A)
  • indicates whether the Service has been tampered with
uint8PR+EV01
  • NOT_TAMPERED (0) :heavy_check_mark:
  • TAMPERED (1) 
StatusLowBattery (79)
  • 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"
+
## DOORS, LOCKS, AND WINDOWS ### Door (81) @@ -316,14 +316,14 @@ The pre-defined constant expressions for enumerated Characteristics are in names TargetPosition (7C) :small_blue_diamond:uint8PW+PR+EV01000 ObstructionDetected (24) boolPR+EV01 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"
+
### GarageDoorOpener (41) Defines a motorized Garage Door Opener.
@@ -334,7 +334,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
LockCurrentState (1D)
  • indicates state of a lock
uint8PR+EV03
  • UNLOCKED (0) :heavy_check_mark:
  • LOCKED (1) 
  • JAMMED (2) 
  • UNKNOWN (3) 
LockTargetState (1E)
  • indicates desired state of lock
uint8PW+PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### LockMechanism (45) Defines an electronic Lock.
@@ -342,7 +342,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
LockCurrentState (1D) :small_blue_diamond:
  • indicates state of a lock
uint8PR+EV03
  • UNLOCKED (0) :heavy_check_mark:
  • LOCKED (1) 
  • JAMMED (2) 
  • UNKNOWN (3) 
LockTargetState (1E) :small_blue_diamond:
  • indicates desired state of lock
uint8PW+PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### Window (8B) Defines a motorized Window.
@@ -351,7 +351,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
TargetPosition (7C) :small_blue_diamond:
  • indicates target position (as a percentage) from fully closed (0) to full open (100)
uint8PW+PR+EV01000
ObstructionDetected (24)
  • indicates if obstruction is detected
boolPR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### WindowCovering (8C) Defines a motorized Window Shade, Screen, Awning, etc.
@@ -364,7 +364,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
TargetVerticalTiltAngle (7D)
  • indicates desired angle (in degrees) of slats from fully left (-90) to fully open (0) to fully right (90)
intPW+PR+EV-90900
ObstructionDetected (24)
  • indicates if obstruction is detected
boolPR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
## WATER SYSTEMS ### Faucet (D7) @@ -373,7 +373,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names Active (B0) :small_blue_diamond:uint8PW+PR+EV01 StatusFault (77) uint8PR+EV01 ConfiguredName (E3) stringPW+PR+EV--"unnamed" - +
### IrrigationSystem (CF) Defines an Irrigation System. Linked Services: Valve Service (at least one required).
@@ -384,7 +384,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
RemainingDuration (D4)
  • duration (in seconds) remaining for Service to be active/on
uint32PR+EV0360060
StatusFault (77)
  • indicates whether the Service has a fault
uint8PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
### Valve (D0) Defines an electronic Valve. Can be used standalone or as a Linked Service in conjunction with the Faucet and IrrigationSystem Services.
@@ -398,7 +398,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
ServiceLabelIndex (CB)
  • numerical index used to distinguish multiple copies of the same Service within an Accessory
uint8PR12551
StatusFault (77)
  • indicates whether the Service has a fault
uint8PR+EV01
  • 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.
stringPW+PR+EV--"unnamed"
+
## SECURITY SYSTEMS ### SecuritySystem (7E) @@ -410,7 +410,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names StatusFault (77) uint8PR+EV01 StatusTampered (7A) uint8PR+EV01 ConfiguredName (E3) stringPW+PR+EV--"unnamed" - +
## TELEVISIONS ### InputSource (D9) @@ -421,7 +421,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names IsConfigured (D6) uint8PR+EV01 CurrentVisibilityState (135) uint8PR+EV01 TargetVisibilityState (134) uint8PW+PR+EV01 - +
### Television (D8) Defines a TV. Optional Linked Services: InputSource and TelevisionSpeaker.
@@ -431,7 +431,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
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"
+
### 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.
@@ -439,14 +439,14 @@ The pre-defined constant expressions for enumerated Characteristics are in names -
VolumeControlType (E9) :small_blue_diamond:
  • indicates the type of volume control
uint8PR+EV03
  • 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
uint8PW01
  • 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.
stringPW+PR+EV--"unnamed"
+
## MISCELLANEOUS ### ServiceLabel (CC) Groups together un-named (or un-nameable) Services by Linking them to this Service. When used, those other Services must each include a ServiceLabelIndex Characteristic with a unique value. Rarely needed.
-
CharacteristicFormatPermsMinMaxConstants/Defaults
ServiceLabelNamespace (CD) :small_blue_diamond:
  • indicates how un-named Services linked together with a ServiceLabel Service should be displayed in the Home App
uint8PR01
  • DOTS (0) 
  • NUMERALS (1) :heavy_check_mark:
+
--- diff --git a/tools/makeServices b/tools/makeServices index ece63f4..279262b 100755 --- a/tools/makeServices +++ b/tools/makeServices @@ -99,7 +99,7 @@ END { printf("\n") } - printf("\n\n") + printf("
\n\n") } printf("---\n\n")