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-07 20:32:38 -06:00 committed by GitHub
parent 5c002708f9
commit 5e4c3f5127
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/CLI.md
View File

@ -44,6 +44,10 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p
* **S** \<code\> - change the HomeKit Pairing Setup Code to \<code\> * **S** \<code\> - change the HomeKit Pairing Setup Code to \<code\>
* Every HomeKit device requires a unique 8-digit Setup code used for pairing. When HomeSpan is run for the first time on a new device it sets the HomeKit Setup Code to a default value of **466-37-726**, and stores it in a dedicated NVS partition. This command allows you to update the stored Setup Code to any other 8-digit code. Note that in accordance with HAP specifications, HomeSpan actually stores a hashed version of the Setup Code, rather than the Setup Code itself. This means the actual value is not recoverable, so if you forget your Setup Code you'll need to run this command and create a new one. * Every HomeKit device requires a unique 8-digit Setup code used for pairing. When HomeSpan is run for the first time on a new device it sets the HomeKit Setup Code to a default value of **466-37-726**, and stores it in a dedicated NVS partition. This command allows you to update the stored Setup Code to any other 8-digit code. Note that in accordance with HAP specifications, HomeSpan actually stores a hashed version of the Setup Code, rather than the Setup Code itself. This means the actual value is not recoverable, so if you forget your Setup Code you'll need to run this command and create a new one.
* **Q** \<id\> - change HomeSpan's default Pairing Setup ID to \<id\>
* 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 [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.