Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Reference.md

This commit is contained in:
HomeSpan 2020-12-07 06:51:05 -06:00 committed by GitHub
parent 0ab2be1cb3
commit badcfe53b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Reference.md
View File

@ -54,15 +54,23 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
* `void setMaxConnections(uint8_t nCon)` * `void setMaxConnections(uint8_t nCon)`
* sets the maximum number of HAP Controllers that be simultaneously connected to HomeSpan (default=8) * sets the maximum number of HAP Controllers that be simultaneously connected to HomeSpan (default=8)
## *SpanAccessory()* ## *SpanAccessory(uint32_t aid)*
Creating an instance of this **class** adds a new HAP Accessory to the HomeSpan HAP Database. Creating an instance of this **class** adds a new HAP Accessory to the HomeSpan HAP Database.
* every HomeSpan sketch requires at least one Accessory * every HomeSpan sketch requires at least one Accessory
* there are no arguments or associated methods * there are no associated methods
* The argument *aid* is optional.
* If specified and *not* zero, the Accessory ID is set to *aid*.
* If unspecified, or equal to zero, the Accessory ID will be set to one more than the ID of the previously-instantiated Accessory, or to 1 if this is the first Accessory.
* The first Accessory instantiated must always have an ID=1 (which is the default if *aid* is unspecified).
* Setting the *aid* of the first Accessory to anything but 1 throws an error during initialization.
* you must call `homeSpan.begin()` before instantiating any Accessories * you must call `homeSpan.begin()` before instantiating any Accessories
* example: `new SpanAccessory();` * example: `new SpanAccessory();`
The first argument is required; the rest are optional:
* *pin* - the ESP32 pin to which a one pole of a normally-
## *SpanService()* ## *SpanService()*
This is a **base class** from which all HomeSpan Services are derived, and should **not** be directly instantiated. Rather, to create a new Service instantiate one of the HomeSpan Services defined in the [Service](ServiceList.md) namespace. No arguments are needed. This is a **base class** from which all HomeSpan Services are derived, and should **not** be directly instantiated. Rather, to create a new Service instantiate one of the HomeSpan Services defined in the [Service](ServiceList.md) namespace. No arguments are needed.