Generate a pairing HomeKit QR code label for your HomeKit accessory
npx homekit-qrcode --category=switch --pairingCode=84131633 --setupId=3QYTUsage: homekit-qrcode [options]
Options:
-h, --help [boolean]
--version Show version number [boolean]
-c, --category category of the Homeit accessory [string] [required] [choices: "other", "bridge", "fan", "garage", "lightbulb", "doorLock", "outlet", "switch", "thermostat", "sensor", "securitySystem", "door", "window", "windowCovering", "programmableSwitch", "rangeExtender", "ipCamera", "videoDoorBell", "airPurifier", "heater", "airConditioner", "humidifier", "dehumidifier", "appleTv", "speaker", "airport", "sprinkler", "faucet", "showerHead", "television", "targetController"]
-n, --name name of the generated file [string] [default: "homekit-qrcode"]
-o, --output format of the generated file [required] [choices: "svg", "png", "jpeg"] [default: "svg"]
-p, --pairingCode 8 digits pairing code [string] [required]
-s, --setupId [string] [required]
Examples:
npx homekit-qrcode --category=switch --pairingCode=84131633 --setupId=3QYT Generate a QR code for a HomeKit switch
npx homekit-qrcode --category=switch --pairingCode=84131633 --setupId=3QYT --name=switch --output=png Generate a QR code for a HomeKit switch as switch.png
npm installnpm run start -- --category=switch --pairingCode=84131633 --setupId=3QYTTo build homekit-qrcode for production, run:
npm run buildAfterwards the executable code is available under ./lib/.
cd lib
node index.js --category=switch --pairingCode=84131633 --setupId=3QYTnpm testThis command may be useful when obscure errors or issues are encountered. It removes and recreates dependencies of your project.
npm run repairFully automated version management and package publishing via semantic-release. It bumps the version according to conventional commits, publishes the package to npm and release a new version to GitHub.
Make sure that the secrets GITHUB_TOKEN and NPM_TOKEN are available in GitHub repository.
npm run release:ciMake sure that the environment variables GITHUB_TOKEN and NPM_TOKEN are set or declared in .env and a productive build was previously created via npm run build.
npm run releaseYou can also test the release manually by running the following command:
npm run release:dry-runThe QR code is not the same as the pairing code, instead it consists of several parameters such as the category, a specific version and other parameters. This generated setup payload is the actual content of the QR code and can be generated with the HomeKit Accessory Simulator (HAS) as well.
Scan the QR code with a QR scanner of your choice. You should get a text starting with X-HM://.... . The next 9 characters are the combination of the different parameters like the pairing code and the category. The remaining characters are the setup id.
X-HM://0081YCYEP3QYT ◄── Scanned Setup Payload
X-HM:// 008YCYEP 3QYT
▲ ▲ ▲
│ │ └─── Setup ID
│ └── Combination of Parameters (first 9 characters)
└─ Starting ContentSimon Golms
- Digital Card:
npx simongolms - Github: @SimonGolms
- Website: gol.ms
Give a ⭐️ if this project helped you!
Copyright © 2021 Simon Golms.
This project is MIT licensed.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent