Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Several Basic and Advanced Settings, Event logs, Last Unlock User #59

Merged
merged 25 commits into from
Oct 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ESPHome Nuki Lock Component (ESP32) [![Build Component](https://github.com/uriyacovy/ESPHome_nuki_lock/actions/workflows/build.yaml/badge.svg)](https://github.com/uriyacovy/ESPHome_nuki_lock/actions/workflows/build.yaml)

This module builds an ESPHome lock platform for Nuki Smartlocks (nuki_lock) that creates [24 entities](#entites) in Home Assistant.
This module builds an ESPHome lock platform for Nuki Smartlocks (nuki_lock) that creates [24 entities](#entities) in Home Assistant.

The lock entity is updated whenever the look changes state (via Nuki App, HA, or manually) using the Nuki BLE advertisement mechanism.

Expand All @@ -16,7 +16,7 @@ esphome:
- Preferences
- https://github.com/h2zero/NimBLE-Arduino#1.4.0
- Crc16
- https://github.com/I-Connect/NukiBleEsp32#93e7da927171c8973b7ef857c7fa644c174ed47d
- https://github.com/uriyacovy/NukiBleEsp32

external_components:
- source: github://uriyacovy/ESPHome_nuki_lock
Expand Down Expand Up @@ -158,8 +158,9 @@ on_paired_action:
```

### Events
By default this component sends auth eventlog events to Home Assistant.
By default this component sends the event logs as events to Home Assistant.
You can use them in automations. If you want to disable events, set the `event` property in your yaml to `none`.
If you want to check the log events, go to the Homne Assistant Developer tools -> Events and listen for `esphome.nuki` events.
AzonInc marked this conversation as resolved.
Show resolved Hide resolved
```yaml
event_type: esphome.nuki
data:
Expand All @@ -185,7 +186,7 @@ context:
user_id: null
```

## Entites
## Entities

**Lock:**
- Lock
Expand Down Expand Up @@ -219,6 +220,9 @@ context:
**Select:**
- Single Button Press Action
- Double Button Press Action
- Fob Action 1
- Fob Action 2
- Fob Action 3

**Number:**
- LED Brightness
Expand Down
Loading