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

10
docs/Reference.md
View File

@ -60,11 +60,11 @@ 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();`