QR Code missing for HomeKit integration

Add-ons Other
, ,
6

Well it seems your up to date and the steps i proposed before did not resolve the issue, My next steps require some more diagnostics but should point towards the root of the problem.

Lets figure out if the server has problems or If the computer your attempting to view the QR Code is:

For a test:

  • Does this issue happen on multiple systems? Have you tried to load the QR Code from a different system entirely? even Safari on an iPhone should work, or another computer all together.

I recommend Backing up before trying anything below Possibly Both Hab Server and System you are trying to get the QR Code to load on depending on the path you follow below (and of course assuming their is 2 separate computers, the Server for OpenHab and the computer your viewing OpenHab UI with).

If QR Codes do not load on other systems (Unsuccessful)

OpenHab itself has an issue most likely.

Here are the steps I would take from least destructive to most destructive in an attempt to fix this.

  • To log into the OSGI Console issue this command from the terminal in MacOS
    ssh -p8101 openhab@localhost
    (Password is habopen ) by default.
  • You should, after a bit be shown a ASCII graphic and given another prompt.
  • When I say to issue the command in OSGI this is where I am referring to.
  1. Quick Test
  • This is an older trick, not sure its still useful in OH3, but a while back I did have an issue getting OH added as a Hub in Home Kit, problem is not identical but may still play a role in you’re QR code problem, issuing the command below via OSGI and rebooting OH might be worth a try as a non destructive attempt.
    smarthome:homekit allowUnauthenticated true
  1. Enable a more detailed debugging log
  • Inside OSGI issue command
    log:set TRACE org.openhab.io.homekit.internal
  • Then I would shutdown openhab, with command in OSGI system:shutdown.
  • Then back in the MacOS Terminal find the openhab.log file and issue the command
    tail -f /pathToOpenhab.log
    This will cause the terminal to update the screen when new log files are added but will keep that terminal window occupied until closed. So just leave it up and watch the log files as it roll in
T.M.I
  • I use this technique frequently to help find issues I would normally miss, I use it for non Homekit issues too
  • Makes my OpenHab more stable at the same time :slight_smile:
  • Then open another terminal window to MacOS if you’ve not already and start Openhab
    ./start.sh
    in OH application folder via MacOS terminal.
  • Then watch the logs for entries from homekit.internal you may possibly have to load the settings page where the QR Code should be before a possible clue might show up in the logs.
  • If you find an issue with the QR code score we got a lead and nothing really destructive has to happen.
  • I would set the log level back to ERROR when done to reduce log file spam.
  1. Reset Pairings
  • In OSGI issue command
    smarthome:homekit clearPairings
  • This will force OpenHab to clear its settings for HomeKit (this will cause the Homekit Add-on to need to be re-added as a Hub in Home App).
  • A reboot of openhab is recommended after this (OSGI system:shutdown)
Why perform Steps 2 and 3 together rather then sequentialy
  • Saves the time to shutdown & reboot a 2nd time
  • Performing steps 2 and 3 would be close to a full uninstall/reinstall of the Homekit Binding, Additionally removing the cache files would be part of a “Full Uninstall”, I would just avoid clearing the caches unless steps 2 and 3 failed. just to save some headaches.
  1. Uninstall the Homekit Add-on via the OH3 UI
  • I have found most of the meaty data that is used for connections and ID and stuff is located in the
    “openHAB application”/userdata/jsondb/homekit.json
    file and I suspect removing that file and any manually installed Homekit.jar files in the Addon folder after uninstalling the current homekit binding may be enough.
  • Manual removal of files should be done with OpenHab shutdown (OSGI system:shutdown).
  • Im am pretty sure that the QR Code is generated from data in that .json file. At this point I would start OpenHab and reinstall the Homekit Binding via the UI in openhab3 then test again as the next step will sometime affect parts of the OpenHab System that are not related to HomeKit.
  1. Clear Opehab cache files
  • I find there to be quite a few issues that need to resolve after I resort to this option.
  • Here is a good thread on how to Clear the cache files for OpenHab:
    Clear the Cache
  1. Last Restort
  • At this point I would refer to any additional suggestions that @yfre might have and from there, Nuke your OpenHab install and start fresh cringe as a last resort.
If QR Codes do load on other systems (Successful)
  1. The first thing I would try would be to make sure I am not using a VPN or any sort of software firewall,
  2. Then I would make sure my system is free of Malware, Malwarebytes MacOS download: Malwarebytes is a good free to (check/remove known malware) software.
More on Malwarebytes
  • I have been using it for a some years now. Been selling it to my customers. - Paid Version will actively scan for Malware not just cleanup after the fact.
  • Thus far have no reasons to believe they are not trustworthy.
  • I have seen some malware that will affect networking settings (Enable SOCKS proxies etc).

  1. Check the System Preferences for a Pane Called Profiles (is only visible if a profile is installed so it may not be seen), look in it, if you see anything you don’t recognize in the list remove it.

  2. I would also check and make sure I have no 3rd party extensions for Safari or Chrome installed.

  3. Sometimes creating a new location inside System Preference Network Pane and then clicking the apply button will fix random issues related to network (not to much of an issue if you use DHCP, if not your probably savvy enough to recreate the desired settings manually).

  4. If the issue still persists: You can try to create another user in the “Users & Groups” System Preference Pane. Logout of the current user and login with the new user. Once again attempt to load the QR code, if it works then you have an issue someone in the user settings of the previous user.

  5. If the problem still persists: Then the problem is deeper in the MacOS system, and the next step is to update to latest version of MacOS 11.5.1 (just use software updater in system preferences).

  6. If problem still persists then reinstall MacOS overtop itself (Reboot computer hold command+r key on keyboard (assuming Intel based Mac).

  7. Still persisting then the next step is to wipe the drive out (or better solution would be to start fresh on an external hard drive as described at the end of this post), I would reformat at the same time and reinstall MacOS with a clean version.

  8. If the problem still persists, we where wrong and MacOS was not the problem and we can rule it out 100%, at the expense of some time to rebuild OpenHab.

Worst Case scenario this article explains how to add OpenHab as a HomeKit Accessory without using the QR Code. How to Add HomeKit Accessory Without QR Code by using the PIN instead of the QR Code.

If you do end up getting to the solutions that are majorly destructive, I would encourage you to get an external HD that can be erased at will, and use that for your boot drive to rebuild the your hab server or system software so that you can keep the original unmodified (mostly) just incase. Hard Drives are pretty cheap these days and IMHO well worth the saved time. In order to reinstall MacOS and or OpenHab should easily fit onto any HD larger then 64Gigs (Probably less but I like to play it safe).

Note If you are able to successfully get HomeKit connected and setup, I would Highly recommend Backing up a copy of that homekit.json file. I believe there is an issue that can make your HomeKit Add-on disconnect from Apple’s HomeKit App. Usually the hub (Homekit Add-on) goes offline and all the items attached to it are unresponsive. If that happens, and I’ve seen a lot of posts that complain about it (I was suffering from it myself at one point) the solution is to shutdown Openhab and replace that homekit.json file with a copy of the one you backed up. Doing that would bring the Homekit Add-on back into sync with Apple and everything would keep working after that point without a need to remove and re-include. I think it would be wise to create a new Backup of the .json file if new Hubs for homekit arrive (IE, a new HomePod comes in, or AppleTV, or any of the devices that Apple uses as the LocalHub for Homekit), I personally have not see this as an issue, but I am also not sure I have added any new Apple Hub devices recently.