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

7
docs/Reference.md
View File

@ -10,10 +10,13 @@ At runtime this HomeSpan will create a global object named `homeSpan` that suppo
* `void begin(Category catID, char *displayName, char *hostNameBase, char *modelName);` * `void begin(Category catID, char *displayName, char *hostNameBase, char *modelName);`
* Initializes HomeSpan * Initializes HomeSpan
* **Must** be called at the beginning of each sketch before any other HomeSpan functions * **Must** be called at the beginning of each sketch (typically in `setup()`) before any other HomeSpan functions
* All arguments are **optional** * All arguments are **optional**
* *catID* - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is [Category::Lighting](Categories.md) * *catID* - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is [Category::Lighting](Categories.md)
* *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"
* `void poll()`
* Checks for HAP requests, local commands, and device activity
* **Must** be called repeatedly in each sketch (typically placed at the top of `loop()`)