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 11:12:23 -06:00 committed by GitHub
parent c0c020e369
commit bd2ed48002
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CLI.md
View File

@ -8,7 +8,7 @@ At startup, HomeSpan displays a welcome message, provides some general informati
If there are no errors, HomeSpan will next provide information about the Accessory ID of your device (or create one if this is a new device), the IDs of any controllers that have been paired to your device (if any), and the long-term public keys (LTPK) associated with each device. Under normal operations, you will not need any of this information. Note that this data is stored in a special Non-Volatile Storage (NVS) partition in the ESP32's flash memory and is therefore retained even if the device is re-programmed. See the HomeSpan NVS section below for details. If there are no errors, HomeSpan will next provide information about the Accessory ID of your device (or create one if this is a new device), the IDs of any controllers that have been paired to your device (if any), and the long-term public keys (LTPK) associated with each device. Under normal operations, you will not need any of this information. Note that this data is stored in a special Non-Volatile Storage (NVS) partition in the ESP32's flash memory and is therefore retained even if the device is re-programmed. See the HomeSpan NVS section below for details.
Lastly, HomeSpan will report an Accessory configuration number. This number is also stored in NVS and is incremented every time you make a change to construction of your HAP Database in the HomeSpan sketch. For example, adding a new Service or changing the initial value of a Characteristic will result in a new configurartion number. Changing any other portion of sketch does not cause the configuratin number to be incremented. This value is broadcast by HomeSpan to all HomeKit controllers so that the controllers know when to ask for a full refresh of the the HAP Database from your device. Lastly, HomeSpan will report an Accessory configuration number. This number is also stored in NVS and is incremented every time you make a change to the construction of your HAP Database in the HomeSpan sketch. For example, adding a new Service or changing the initial value of a Characteristic will result in a new configuration number. Changing any other portion of your sketch does not cause the configuration number to be incremented. This value is broadcast by HomeSpan to all HomeKit controllers so that the controllers supposedly know when to ask for a full refresh of the the HAP Database from your device. HomeKit controllers unfortunately do not always poll for this information, which can lead to a mismatch between the tiles that appear in your Home App, and what your HomeSpan device actually contains. See the [Tutorials](Tutorials.md) page for how to resolve this problem if it arises.
#### WiFi Connectivity #### WiFi Connectivity