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

Update QRCodes.md

This commit is contained in:
HomeSpan 2021-01-28 18:28:03 -06:00 committed by GitHub
parent bd611918bb
commit 6c224ec9cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/QRCodes.md
View File

@ -1,14 +1,19 @@
# Pairing with QR Codes versus Setup Codes # QR Codes versus Setup Codes
Pairing a HomeKit device with your Home App using its 9-digit *Setup Code* requires you to both: Pairing a HomeKit device using its 9-digit *Setup Code* requires you to:
* Select the specific HomeKit device you wish to pair from a list of unpaired HomeKit devices the Home App finds on your local network * Select the specific HomeKit device you wish to pair from a list of unpaired HomeKit devices the Home App finds on your local network
* Input the *Setup Code* for that device. * Input the *Setup Code* for that device into the Home App.
The order of the steps above depends on whether you input the *Setup Code* by manually typing it, or scan it from a printed tag (see the User Guide for details on how to create your own scannable *Setup Code* tags) The order of the steps above depends on whether you input the *Setup Code* by manually typing it, or scan it from a printed tag (see the User Guide for details on how to create your own scannable *Setup Code* tags)
Pairing a HomeKit device with your Home App using a QR Code instead of the its 9-digit *Setup Code* requires you only scan the QR Code. The Home App automatically finds the device on your local network and pairs it for you. On the other hand, pairing a HomeKit device with a QR Code requires you only scan the QR Code. You do not need to identify the device you want to pair - the Home App automatically searches for it on your local network and, if found, pairs to it.
This is possible because the QR Code contains within it the intended device's 9-digit *Setup Code* as well as a 4-character *Setup ID* broadcast by the device. Note the *Setup ID* is distinct from the device's 6-byte Accessory ID, and is only used to faciliate pairing with a QR Code. Every HomeKit device on your network that supports pairing with a QR code requires a unique *Setup ID*. A device that does not support pairing with a QR code does not need a *Setup ID*. This is possible because the QR Code contains within it a 4-character *Setup ID* that is unique to the device associated with that QR Code. The QR Code also contains other informattion about the device, such as its type (e.g. Light, Fan, Door) as well as its 9-digit *Setup Code*.
HomeSpan supports pairing with QR codes and uses "HSPN" as its default *Setup ID*. If you have more than one device that you intend on pairing with a QR Code, you'll need to change their default *Setup IDs* from "HSPN" to something unique using the method `homeSpan.setQRID(const char *)` (see the API Reference for details). If you do not intend on pairing your devices with QR Codes, it is fine fore them to all have the same *Setup ID*, as this ID is only used to initiate the pairing process via a QR code and serves no other purpose.
### Creating QR Codes
Just as you can create your own scannable tags for a device's *Setup Code*, you can also create your own QR Codes.
HomeSpan supports pairing with QR codes and uses "HSPN" as its default *Setup ID*. If you have more than one device that intend on pairing with a QR Code, you'll need to change the *Setup IDs* to ensure they are all uniq