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-11-25 15:18:31 -06:00 committed by GitHub
parent fb03c4a7f6
commit 4acddaa7ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Reference.md
View File

@ -12,7 +12,7 @@ At runtime this HomeSpan will create a global object named `homeSpan` that suppo
* Initializes HomeSpan. * Initializes HomeSpan.
* **Must** be called at the beginning of each sketch before any other HomeSpan functions and is typically placed near the top of the Arduino `setup()` method, but **after** `Serial.begin()` so that initialization diagnostics can be output to the Serial Monitor. * **Must** be called at the beginning of each sketch before any other HomeSpan functions and is typically placed near the top of the Arduino `setup()` method, but **after** `Serial.begin()` so that initialization diagnostics can be output to the Serial Monitor.
* All arguments are **optional**. * All arguments are **optional**.
* *catID* - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is Category::Lighting. See [HomeSpan Categories](Categories.md) for a complete list. * *catID* - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is Category::Lighting. See [HomeSpan Accessory Categories](Categories.md) for a complete list.
* *displayName* - the MDNS display name broadcast by HomeSpan. Default is "HomeSpan Server". * *displayName* - the MDNS display name broadcast by HomeSpan. Default is "HomeSpan Server".
* *hostNameBase* - the full MDNS host name is broadcast by HomeSpan as *hostNameBase-DeviceID*.local, where DeviceID is a unique 6-byte code generated automatically by HomeSpan. Default is "HomeSpan". * *hostNameBase* - the full MDNS host name is broadcast by HomeSpan as *hostNameBase-DeviceID*.local, where DeviceID is a unique 6-byte code generated automatically by HomeSpan. Default is "HomeSpan".
* *modelName* - the HAP model name HomeSpan broadcasts for pairing to HomeKit. Default is "HomeSpan-ESP32". * *modelName* - the HAP model name HomeSpan broadcasts for pairing to HomeKit. Default is "HomeSpan-ESP32".
@ -50,3 +50,16 @@ 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).
## Creating the HAP Accessory Attributes Database - Primary Classes
The HAP Accessory Attributes Database is constructed by instantiating (using `new`) a combinaton of the following HomeSpan Classes:
* `SpanAccessory()`
* This creates a new HAP Accessory to hold HAP Services.
* There are no arguments or methods.
* You must call `homeSpan.begin()` before instantiating any Accessories.
* Every HomeSpan sketch requires at least one Accessory.
* `SpanService()`
* This is the base class for creating new HAP Services. It should