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

Update CLI.md

This commit is contained in:
HomeSpan 2020-11-22 20:01:33 -06:00 committed by GitHub
parent 22367bf98f
commit 3646e9f11b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CLI.md
View File

@ -40,6 +40,9 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p
* **X** - delete WiFi Credentials and restart
* This command deletes whatever WiFi Credentials have been stored in the device NVS, and restarts.
* **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-72**, 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 stored 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.
* **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.
@ -49,8 +52,7 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p
* Note that if you run this command when HomeKit thinks it is still paired to the device, pairing status will be out of sync in the opposite direction. HomeKit Controllers will continue to send HAP requests to the device, thinking it is paired, but HomeSpan will ignore all these requests since it no longer recognizes any of the Controllers as being paired. To resolve this issue, you must instruct HomeKit to unpair the device via the Home App, after which you can re-pair the device if needed.
* **H** - delete HomeKit Device ID as well as all Controller data and restart
* In addition to deleting all Controller data (as if the 'U' command was run), this command also deleted the device's HomeKit ID. This unique ID is broadcast to all HomeKit Controllers so the device can be uniquely recognized. When HomeSpan first runs on a new device, it creates this unique ID and stores it permanently in an NVS partition. Normally, this ID should not changed once set. However, if you are actively developing and testing a HomeSpan device, and modify the details of your HAP Database (perhaps by adding a new Service, or changing the name of a Characteristic), you may find that HomeKit is cacheing information about your device and the changes you have made are not reflected in the Home App. Sometimes simply unpairing and re-paring the device solves this HomeKit issue. If not, deleting your device's HomeKit ID with this command forces HomeSpan to generate a new one after restarting, which means HomeKit will think this is a completely different device. Note that since this command also resets the device status to unpair, all the caveats above in the 'U' command hold true for this command as well.
* Developer's Note: HomeSpan properly broadcasts a new configuration number for all HomeKit Controllers to read every time a HomeSpan sketch is changed in a way that results in a modified HAP Accessory Database (such as changing a Characteristic). However, HomeKit Controllers do not always seems to read or respect the configuration number and instead may rely on an outdated cached version of the device's HAP Database. The 'H' command was developed to solve for this issue.
* In addition to deleting all Controller data (as if the 'U' command was run), this command also deletes the device's HomeKit ID. This unique ID is broadcast to all HomeKit Controllers so the device can be uniquely recognized. When HomeSpan first runs on a new device, it creates this unique ID and stores it permanently in an NVS partition. Normally, this ID should not changed once set. However, if you are actively developing and testing a HomeSpan sketch, you may find that HomeKit is cacheing information about your device and the changes you have made to your HAP Accessory Database are not always reflected in the Home App. Sometimes simply unpairing and re-pairing the device solves this HomeKit issue. If not, deleting your device's HomeKit ID with this command forces HomeSpan to generate a new one after restarting, which means HomeKit will think this is a completely different device, thereby ignoring any prior data it had cached.