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

17
docs/Reference.md
View File

@ -1,3 +1,18 @@
# HomeSpan Library Reference # HomeSpan Library Reference
*(coming soon)* The HomeSpan Library is invoked by including *HomeSpan.h* in your Arduino sketch as follows:
```C++
#include "HomeSpan.h";
```
At runtime this HomeSpan will create a global object named `homeSpan` that supports the following methods:
* `void begin(Category catID, char *displayName, char *hostNameBase, char *modelName);`
* begin() initializes homeSpan and **must** be called at the beginning of each sketch before any other HomeSpan functions.
* all arguments are **optional**
* *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"
* *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"