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

Update CLI.md

This commit is contained in:
HomeSpan 2021-02-08 07:53:02 -06:00 committed by GitHub
parent d02cfe63b7
commit 36f302f01e
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/CLI.md
View File

@ -48,8 +48,8 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p
* This command changes HomeSpan's default Setup ID, which is used when pairing with a QR Code, from the new-device value of "HSPN" to \<id\>. See [HomeSpan QR Codes](QRCodes.md) for details on how the Setup ID is used. The Setup ID must be exactly 4 alphanumeric characters (0-9, A-Z, and a-z). * This command changes HomeSpan's default Setup ID, which is used when pairing with a QR Code, from the new-device value of "HSPN" to \<id\>. See [HomeSpan QR Codes](QRCodes.md) for details on how the Setup ID is used. The Setup ID must be exactly 4 alphanumeric characters (0-9, A-Z, and a-z).
* Note the new Setup ID is retained in HomeSpan's NVS and used as the default for all sketches, unless a specific Setup ID is set in the sketch using the method `homeSpan.setQRID(const char *id)`. See the [HomeSpan API Reference](Reference.md) for details. * Note the new Setup ID is retained in HomeSpan's NVS and used as the default for all sketches, unless a specific Setup ID is set in the sketch using the method `homeSpan.setQRID(const char *id)`. See the [HomeSpan API Reference](Reference.md) for details.
* **O** - prompts you to set the password used for Over-the-Air (OTA) Updates * **O** - prompts you to set the password used for Over-the-Air (OTA) Updating
* HomeSpan supports [OTA Updates](OTA.md) but requires a password to always be used. For security, HomeSpan saves a *hashed* version of the password you specify in NVS, not the actual password. If you forget the password you specified, you'll need to reset it using this command. * 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 reset it using this 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()`. See the [HomeSpan API Reference](Reference.md) for details.