From f74c0fd7cd912a58810863f0c1c2ff9a78d7423e Mon Sep 17 00:00:00 2001 From: Florian Date: Tue, 13 Aug 2024 18:11:05 +0200 Subject: [PATCH] Update Docs --- docs/.vitepress/theme/custom.css | 1 + docs/firmware/nuki-bridge-firmware.md | 61 ++++++++++++++------------- docs/firmware/stock-firmware.md | 30 ++++++------- 3 files changed, 47 insertions(+), 45 deletions(-) diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 6f065f1..397f8f1 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -13,6 +13,7 @@ white-space: nowrap; transition: color .25s, border-color .25s, background-color .25s; text-decoration: none; + cursor: pointer; } .custom-layout .btn:hover { diff --git a/docs/firmware/nuki-bridge-firmware.md b/docs/firmware/nuki-bridge-firmware.md index f196a70..924b497 100644 --- a/docs/firmware/nuki-bridge-firmware.md +++ b/docs/firmware/nuki-bridge-firmware.md @@ -6,8 +6,8 @@ It doesn't support Improv via Bluetooth LE because the BLE Stack is used by the ### Update Firmware There are a few ways to update the firmware: - ESPHome OTA -- HTTP OTA -- Web Serial +- HTTP OTA +- Web Serial You can connect your Doorman via USB-C and click the button below to install the latest and greatest Doorman Nuki Bridge Firmware right here via Web Serial. @@ -30,7 +30,34 @@ You can connect your Doorman via USB-C and click the button below to install the -## Entities +## Firmware YAML +This is the minimal ESPHome configuration yaml file, make sure to change the API key. + +::: details Minimal Nuki Bridge Firmware +```yaml + +``` +::: + +## Pairing your Nuki Lock +Depending on the PCB revision, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple or turn on the `Nuki Pairing Mode` switch in Home Assistant. Press the Button on your Nuki Lock for 5 seconds until the light-ring turns on. + +After a successfully pairing the Status LED will stay constantly turned on for 3 seconds. +::: warning +If you already paired your Nuki Lock this will unpair it! +::: + +## Unpairing your Nuki Lock +You can use the `Nuki Unpair Device` Button in Home Assistant or the physical `FLASH` or `PRG` button on the Doorman PCB. + +::: info Physical Button +If your Lock is already paired with Doorman, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple. +Your Nuki Lock is now unpaired. The pairing mode will time out after 30 seconds. +::: + + + +## Entity Overview ### Locks - Nuki Lock `nuki_smart_lock` @@ -78,30 +105,4 @@ You can connect your Doorman via USB-C and click the button below to install the - Command: Hang up phone `hang_up_phone_command_input` - Command: Ring To Open Toggle `ring_to_open_toggle_command_input` - Ring To Open: Delay `doorman_ring_to_open_delay` -- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` - -## Pairing your Nuki Lock -Depending on the PCB revision, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple or turn on the `Nuki Pairing Mode` switch in Home Assistant. Press the Button on your Nuki Lock for 5 seconds until the light-ring turns on. - -After a successfully pairing the Status LED will stay constantly turned on for 3 seconds. -::: warning -If you already paired your Nuki Lock this will unpair it! -::: - -## Unpairing your Nuki Lock -You can use the `Nuki Unpair Device` Button in Home Assistant or the physical `FLASH` or `PRG` button on the Doorman PCB. - -::: info Physical Button -If your Lock is already paired with Doorman, press the `FLASH` or `PRG` button on the Doorman PCB for 5 seconds until the Status LED starts flashing purple. -Your Nuki Lock is now unpaired. The pairing mode will time out after 30 seconds. -::: - - -## Firmware -::: details Minimal Nuki Bridge Firmware -```yaml - -``` -::: - - \ No newline at end of file +- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` \ No newline at end of file diff --git a/docs/firmware/stock-firmware.md b/docs/firmware/stock-firmware.md index 51db115..6e75562 100644 --- a/docs/firmware/stock-firmware.md +++ b/docs/firmware/stock-firmware.md @@ -6,8 +6,8 @@ It supports Improv via Bluetooth LE. ### Update Firmware There are a few ways to update the firmware: - ESPHome OTA -- HTTP OTA -- Web Serial +- HTTP OTA +- Web Serial You can connect your Doorman via USB-C and click the button below to install the latest and greatest Doorman Stock Firmware right here via Web Serial. @@ -30,7 +30,18 @@ You can connect your Doorman via USB-C and click the button below to install the -## Entities +## Firmware YAML +This is the minimal ESPHome configuration yaml file, make sure to change the API key. + +::: details Minimal Stock Firmware +```yaml + +``` +::: + + + +## Entity Overview ### Sensors - Last Bus Command `last_bus_command` @@ -67,15 +78,4 @@ You can connect your Doorman via USB-C and click the button below to install the - Command: Hang up phone `hang_up_phone_command_input` - Command: Ring To Open Toggle `ring_to_open_toggle_command_input` - Ring To Open: Delay `doorman_ring_to_open_delay` -- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` - - - -## Firmware -::: details Minimal Stock Firmware -```yaml - -``` -::: - - \ No newline at end of file +- Ring To Open: Timeout `doorman_ring_to_open_timeout_mode` \ No newline at end of file