/RaspiNukiBridge

Simple Nuki Bridge implementation using asyncio

Primary LanguagePythonMIT LicenseMIT

UNMAINTAINED

This project is no longer maintained. Please use the highly reliable https://github.com/technyon/nuki_hub project

Home Assistant Virtual Nuki Bridge

Use this instead of the Nuki Bridge device.

Important - if you are experiencing delays using RPI, it is advised to use a bluetooth dongle instead of the builtin bluetooth hardware. TP-LINK UB400 is verified to be working.

Background

Installation

There are 2 methods:

  1. As a Home Assistant Addon
    1. Use this if your Home Assistant is nearby the Nuki Smart Lock
  2. Outside of Home Assistant
    1. Use this if your Home Assistant too far from the Nuki Smart Lock

Installation outside of Home Assistant OS

Get the files

Raspberry Pi 3B+ and 4 only

DOWNGRADE Bluez. See comment.

wget http://ftp.hk.debian.org/debian/pool/main/b/bluez/bluez_5.50-1.2~deb10u2_armhf.deb
sudo apt install ./bluez_5.50-1.2~deb10u2_armhf.deb

Reboot the Raspberry Pi

  1. Clone the repository.

    git clone https://github.com/dauden1184/RaspiNukiBridge.git

  2. Go to the addon directoy.

    cd nuki_bridge

  3. Install the requirements.

    pip install -r requirements.txt

  4. Go to pairing

Start automatically at boot

Create a new systemd service:

sudo nano /etc/systemd/system/nukibridge.service

Put this content in the file (change 'user' and 'WorkingDirectory' to your needs):

[Unit]
Description=Nuki bridge
After=network-online.target
[Service]
Type=simple
Restart=always
RestartSec=1
User=pi
WorkingDirectory=/home/pi/RaspiNukiBridge/nuki_bridge
ExecStart=python .
[Install]
WantedBy=multi-user.target

Enable the service and start it:

sudo systemctl daemon-reload
sudo systemctl enable nukibridge.service
sudo systemctl start nukibridge.service

Installation as Home Assistant Addon

Add custom repository

Add repository on my Home Assistant

If you want to do add the repository manually, please follow the procedure highlighted in the Home Assistant website. Use the following URL to add this repository: https://github.com/regevbr/RaspiNukiBridge

Install addon

  1. Go to Home Assistant -> Configuration -> Add-ons, backups & Supervisor -> add-on store (in the bottom right corner)

    Open your Home Assistant instance and show the Supervisor add-on store.

  2. On the top right overflow menu ⋮ click the "Check for updates" button

  3. Install the addon. It takes a few minutes.

  4. Don't start it yet!

Pairing

  1. Press the button of the Nuki Smart Lock for 6 seconds. It should light up.

  2. Run

    1. If installed as addon, click start

    2. If installed outside HA, run

      python .

  3. Look in logs for:

    ********************************************************************
*                                                                  *
*                         Pairing completed!                       *
*                            Access Token                          *
* abcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabca *
*                                                                  *
********************************************************************

  4. Copy the Access Token for a following step.

    In case you missed it, restart the service and check again.

  5. Before moving on, you might need to restart the addon. First run is less stable.

Nuki Addon

  1. Install either
    1. Official Home Assistant Nuki integration
    2. hass_nuki_ng
  2. Configure the Nuki Addon:
    1. Paste your token from the log above
    2. Address is 127.0.0.1

Enjoy!