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

8
docs/Reference.md
View File

@ -25,14 +25,19 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
* `void setControlPin(uint8_t pin)` * `void setControlPin(uint8_t pin)`
* Sets the ESP32 pin to use for the HomeSpan Control Button (default=21). * Sets the ESP32 pin to use for the HomeSpan Control Button (default=21).
* `void setStatusPin(uint8_t pin)` * `void setStatusPin(uint8_t pin)`
* Sets the ESP32 pin to use for the HomeSpan Status LED (default=LED_BUILTIN). * Sets the ESP32 pin to use for the HomeSpan Status LED (default=LED_BUILTIN).
* `void setApSSID(char *ssid)` * `void setApSSID(char *ssid)`
* Sets the SSID (network name) of the HomeSpan Setup Access Point (default="HomeSpan-Setup"). * Sets the SSID (network name) of the HomeSpan Setup Access Point (default="HomeSpan-Setup").
* `void setApPassword(char *pwd)
* `void setApPassword(char *pwd)`
* Sets the password of the HomeSpan Setup Access Point (default="homespan"). * Sets the password of the HomeSpan Setup Access Point (default="homespan").
* `void setApTimeout(uint16_t nSec)` * `void setApTimeout(uint16_t nSec)`
* Sets the duration (in seconds) that the HomeSpan Setup Access Point, once activated, stays alive before timing out (default=300 seconds). * Sets the duration (in seconds) that the HomeSpan Setup Access Point, once activated, stays alive before timing out (default=300 seconds).
* `void setCommandTimeout(uint16_t nSec)` * `void setCommandTimeout(uint16_t nSec)`
* Sets the duration (in seconds) that the HomeSpan End-User Command Mode, once activated, stays alive before timing out (default=120 seconds). * Sets the duration (in seconds) that the HomeSpan End-User Command Mode, once activated, stays alive before timing out (default=120 seconds).
@ -42,5 +47,6 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
* 1 = all status messages, and * 1 = all status messages, and
* 2 = all status messages plus all HAP communication packets to and from the HomeSpan device. * 2 = all status messages plus all HAP communication packets to and from the HomeSpan device.
* This parameter can also be changed at runtime via the [HomeSpan CLI](CLI.md). * This parameter can also be changed at runtime via the [HomeSpan CLI](CLI.md).
* `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).