Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Reference.md

This commit is contained in:
HomeSpan 2023-02-11 08:09:19 -06:00 committed by GitHub
parent 5cb29526c3
commit bd46416b64
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Reference.md
View File

@ -116,6 +116,13 @@ The following **optional** `homeSpan` methods enable additional features and pro
* this can be changed via the [HomeSpan CLI](CLI.md) using the 'O' command * this can be changed via the [HomeSpan CLI](CLI.md) using the 'O' command
* note enabling OTA reduces the number of HAP Controller Connections by 1 * note enabling OTA reduces the number of HAP Controller Connections by 1
* OTA Safe Load will be enabled by default unless the second argument is specified and set to *false*. HomeSpan OTA Safe Load checks to ensure that sketches uploaded to an existing HomeSpan device are themselves HomeSpan sketches, and that they also have OTA enabled. See [HomeSpan OTA Safe Load](OTA.md#ota-safe-load) for details * OTA Safe Load will be enabled by default unless the second argument is specified and set to *false*. HomeSpan OTA Safe Load checks to ensure that sketches uploaded to an existing HomeSpan device are themselves HomeSpan sketches, and that they also have OTA enabled. See [HomeSpan OTA Safe Load](OTA.md#ota-safe-load) for details
* returns 0 if enabling OTA was successful, or -1 and reports an error to the Serial Monitor if not
* `int enableOTA(const char *pwd, boolean safeLoad=true)`
* an alternative form of `enableOTA()` that allows you to programmatically change the OTA password to the specified *pwd*
* *pwd* must contain between 1 and 32 characters
* this command causes HomeSpan to ignore, but does not otherwise alter, any password stored using the 'O' command
* returns 0 if enabling OTA was successful, or -1 and reports an error to the Serial Monitor if not
* `void enableAutoStartAP()` * `void enableAutoStartAP()`
* enables automatic start-up of WiFi Access Point if WiFi Credentials are **not** found at boot time * enables automatic start-up of WiFi Access Point if WiFi Credentials are **not** found at boot time