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

Update Reference.md

This commit is contained in:
HomeSpan 2022-03-27 14:21:02 -05:00 committed by GitHub
parent 9ab50928f3
commit 43e93da24b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Reference.md
View File

@ -88,13 +88,13 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
The following **optional** `homeSpan` methods enable additional features and provide for further customization of the HomeSpan environment. Unless otherwise noted, calls **should** be made before `begin()` to take effect: The following **optional** `homeSpan` methods enable additional features and provide for further customization of the HomeSpan environment. Unless otherwise noted, calls **should** be made before `begin()` to take effect:
* `void enableOTA(boolean auth=true, boolean safeMode=true)` * `void enableOTA(boolean auth=true, boolean safeLoad=true)`
* enables [Over-the-Air (OTA) Updating](OTA.md) of a HomeSpan device, which is otherwise disabled * enables [Over-the-Air (OTA) Updating](OTA.md) of a HomeSpan device, which is otherwise disabled
* HomeSpan OTA requires an authorizing password unless *auth* is specified and set to *false* * HomeSpan OTA requires an authorizing password unless *auth* is specified and set to *false*
* the default OTA password for new HomeSpan devices is "homespan-ota" * the default OTA password for new HomeSpan devices is "homespan-ota"
* 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 Mode will be enabled by default unless the second argument is specified and set to *false*. HomeSpan OTA Safe Mode 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 Mode](OTA.md#homespan-safe-load-mode) 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#homespan-safe-load) for details
* `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