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

11
docs/Reference.md
View File

@ -9,10 +9,9 @@ The HomeSpan Library is invoked by including *HomeSpan.h* in your Arduino sketch
At runtime this HomeSpan will create a global object named `homeSpan` that supports the following methods: 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);` * `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. * begin() initializes homeSpan and **must** be called at the beginning of each sketch 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"