diff --git a/docs/ServiceList.md b/docs/ServiceList.md index e6141f1..893e539 100644 --- a/docs/ServiceList.md +++ b/docs/ServiceList.md @@ -26,7 +26,8 @@ The pre-defined constant expressions for enumerated Characteristics are in names -## Mandatory Services + +## MANDATORY SERVICES ### AccessoryInformation (3E) Required Identification Information. For each Accessory in a HomeSpan device this must be included as the first Service.
@@ -39,7 +40,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
HardwareRevision (53)
  • must be in form x[.y[.z]] - informational only
stringPR--"1.0.0"
-## Lights, Power, and Switches +## LIGHTS, POWER, AND SWITCHES ### BatteryService (96) Defines a standalone Battery Service.
@@ -82,7 +83,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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) +## HEATING, VENTILATION, AND AIR CONDITIONING (HVAC) ### AirPurifier (BB) Defines a basic Air Purifier with an optional fan. Optional Linked Services: FilterMaintenance, AirQualitySensor, Fan, and Slat
@@ -175,7 +176,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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 +## STANDALONE SENSORS ### AirQualitySensor (8D) Defines an Air Quality Sensor.
@@ -307,7 +308,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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 +## DOORS, LOCKS, AND WINDOWS ### Door (81) Defines a motorized Door.
@@ -365,7 +366,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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 +## WATER SYSTEMS ### Faucet (D7) Defines the master control for a multi-Valve appliance. Linked Services: Valve (at least one required), and HeaterCooler (optional).
@@ -399,7 +400,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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 +## SECURITY SYSTEMS ### SecuritySystem (7E) Defines a Security System. Often combined with MotionSensor and ContactSensor Services.
@@ -411,7 +412,7 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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"
-## Televisions +## TELEVISIONS ### InputSource (D9) Defines an Input Source for a TV. Use only as a Linked Service for the Television Service.
@@ -440,18 +441,11 @@ The pre-defined constant expressions for enumerated Characteristics are in names
CharacteristicFormatPermsMinMaxConstants/Defaults
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 +## 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:
Version (37) :small_blue_diamond:
  • unused
stringPR--"1.0.0"
Mute (11A) :small_blue_diamond:
  • not used
boolPW+PR+EV01
  • OFF (0) :heavy_check_mark:
  • ON (1) 
Volume (119)
  • unused
uint8PW+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"
Mute (11A) :small_blue_diamond:
  • not used
boolPW+PR+EV01
  • OFF (0) :heavy_check_mark:
  • ON (1) 
Volume (119)
  • unused
uint8PW+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"
--- diff --git a/src/Span.h b/src/Span.h index b73058c..fe0e34c 100644 --- a/src/Span.h +++ b/src/Span.h @@ -43,6 +43,7 @@ #define END_SERV }}; #define REQ(HAPCHAR) req.push_back(&hapChars.HAPCHAR) +#define REQ_DEP(HAPCHAR) req.push_back(&hapChars.HAPCHAR) #define OPT(HAPCHAR) opt.push_back(&hapChars.HAPCHAR) #define OPT_DEP(HAPCHAR) opt.push_back(&hapChars.HAPCHAR) @@ -448,20 +449,20 @@ namespace Service { // Deprecated or unsupported Services CREATE_SERV_DEP(HAPProtocolInformation,A2) - REQ(Version); + REQ_DEP(Version); END_SERV CREATE_SERV_DEP(Microphone,112) - REQ(Mute); - OPT(Volume); - OPT(ConfiguredName); + REQ_DEP(Mute); + OPT_DEP(Volume); + OPT_DEP(ConfiguredName); OPT_DEP(Name); END_SERV CREATE_SERV_DEP(Speaker,113) - REQ(Mute); - OPT(Volume); - OPT(ConfiguredName); + REQ_DEP(Mute); + OPT_DEP(Volume); + OPT_DEP(ConfiguredName); OPT_DEP(Name); END_SERV diff --git a/tools/makeServiceList b/tools/makeServiceList index 4abd69d..6d35c56 100755 --- a/tools/makeServiceList +++ b/tools/makeServiceList @@ -4,6 +4,3 @@ grep -B 1000 "AUTOGENERATED_TEXT" ../docs/ServiceList.md > ServiceList.md ./makeServices ../src/Characteristics.h ../src/Span.h >> ServiceList.md mv ServiceList.md ../docs/ServiceList.md -#grep -B 1000 "AUTOGENERATED_TEXT" ../docs/ServiceList_Expanded.md > ServiceList_Expanded.md -#./makeServices -vdetailsAtt=" open" ../src/Characteristics.h ../src/Span.h >> ServiceList_Expanded.md -#mv ServiceList_Expanded.md ../docs/ServiceList_Expanded.md diff --git a/tools/makeServices b/tools/makeServices index 404c882..ece63f4 100755 --- a/tools/makeServices +++ b/tools/makeServices @@ -69,7 +69,7 @@ END { for(i=0;i%s
\n",desc[s])