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:53:04 -06:00 committed by GitHub
parent ee015c6152
commit 7a96ee43a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Reference.md
View File

@ -61,16 +61,15 @@ Creating an instance of this **class** adds a new HAP Accessory to the HomeSpan
* every HomeSpan sketch requires at least one Accessory * every HomeSpan sketch requires at least one Accessory
* there are no associated methods * there are no associated methods
* the argument *aid* is optional. * the argument *aid* is optional.
* if specified and *not* zero, the Accessory ID is set to *aid*. * 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. * 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). * 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. * 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.