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

Merge branch 'dev1.1.5' of https://github.com/HomeSpan/HomeSpan into dev1.1.5

This commit is contained in:
Gregg 2021-02-14 18:33:00 -06:00
parent 24cc2486e2 a0f4a46adf
commit 63ad921106
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/CLI.md
View File

@ -50,10 +50,11 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p
* Deleting a device's HomeKit ID and Controller data with the 'H' command (see below) also restores the default Setup ID to "HSPN". * Deleting a device's HomeKit ID and Controller data with the 'H' command (see below) also restores the default Setup ID to "HSPN".
* **O** - prompts you to set the password used for Over-the-Air (OTA) Updating * **O** - prompts you to set the password used for Over-the-Air (OTA) Updating
* HomeSpan supports [Over-the-Air (OTA) Updating](OTA.md) but requires the use of a (non-blank) password. Similar to a device's Setup Code, HomeSpan saves a non-recoverable *hashed* version of the OTA password you set with this command in NVS. If you forget the password you specified, you'll need to create a new one using this command. Alternatively, you can restore the default OTA password by fully erasing the NVS with the 'E' command. * HomeSpan supports [Over-the-Air (OTA) Updating](OTA.md) but, by default, requires the use of a password. Similar to a device's Setup Code, HomeSpan saves a non-recoverable *hashed* version of the OTA password you set with this command in NVS. If you forget the password you specified, you'll need to create a new one using this command. Alternatively, you can restore the default OTA password by fully erasing the NVS with the 'E' command.
* HomeSpan uses "homespan-ota" as its default OTA password for new devices. * HomeSpan uses "homespan-ota" as its default OTA password for new devices.
* Changes to the OTA password do not take effect until the device is restarted. * Changes to the OTA password do not take effect until the device is restarted.
* OTA is not active unless specifically enabled for a sketch using the method `homeSpan.enableOTA()`. See the [HomeSpan API Reference](Reference.md) for details. * OTA is not active unless specifically enabled for a sketch using the method `homeSpan.enableOTA()`.
* You can disable the use an authorizing password by invoking `homeSpan.enableOTA(false)` instead, though this creates a security risk and is therefore **not** recommended. See the [HomeSpan API Reference](Reference.md) for details.
* **A** - start the HomeSpan Setup Access Point * **A** - start the HomeSpan Setup Access Point
* This command starts HomeSpan's temporary Access Point, which provides users with an alternate methods for configuring a device's WiFi Credentials and HomeKit Setup Code. Starting the Access Point with this command is identical to starting it via the Control Button. See the [HomeSpan User Guide](UserGuide.md) for complete details. * This command starts HomeSpan's temporary Access Point, which provides users with an alternate methods for configuring a device's WiFi Credentials and HomeKit Setup Code. Starting the Access Point with this command is identical to starting it via the Control Button. See the [HomeSpan User Guide](UserGuide.md) for complete details.

4
docs/Reference.md
View File

@ -68,9 +68,9 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
* the HomeSpan default is "HSPN" unless permanently changed for the device via the [HomeSpan CLI](CLI.md) using the 'Q' command * the HomeSpan default is "HSPN" unless permanently changed for the device via the [HomeSpan CLI](CLI.md) using the 'Q' command
* *id* must be exactly 4 alphanumeric characters (0-9, A-Z, and a-z). If not, the request to change the Setup ID is silently ignored and the default is used instead * *id* must be exactly 4 alphanumeric characters (0-9, A-Z, and a-z). If not, the request to change the Setup ID is silently ignored and the default is used instead
* `void enableOTA()` * `void enableOTA(boolean auth=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 always requires the use of an authorizing OTA password * 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