Add last unlock user sensor

Author: AzonInc

README.md

@@ -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 [23 entities](#entites) in Home Assistant.
+This module builds an ESPHome lock platform for Nuki Smartlocks (nuki_lock) that creates [24 entities](#entites) 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.
 
@@ -46,6 +46,8 @@ lock:
       name: "Nuki Door Sensor"
     door_sensor_state:
       name: "Nuki Door Sensor: State"
+    last_unlock_user:
+      name: "Nuki Last Unlock User"
     unpair:
       name: "Nuki Unpair Device"
     pairing_mode:
@@ -157,6 +159,7 @@ on_paired_action:
 
 **Text Sensor:**  
 - Door Sensor State
+- Last Unlock User
 
 **Switch:**  
 - Pairing Mode

components/nuki_lock/lock.py

@@ -25,6 +25,7 @@
 CONF_BATTERY_LEVEL = "battery_level"
 
 CONF_DOOR_SENSOR_STATE = "door_sensor_state"
+CONF_LAST_UNLOCK_USER_TEXT_SENSOR = "last_unlock_user"
 
 CONF_UNPAIR_BUTTON = "unpair"
 
@@ -215,6 +216,9 @@
         entity_category=ENTITY_CATEGORY_CONFIG,
         icon="mdi:gesture-tap",
     ),
+    cv.Optional(CONF_LAST_UNLOCK_USER_TEXT_SENSOR):  text_sensor.text_sensor_schema(
+        entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+    ),
     cv.Optional(CONF_PAIRING_MODE_TIMEOUT, default="300s"): cv.positive_time_period_seconds,
     cv.Optional(CONF_ON_PAIRING_MODE_ON): automation.validate_automation(
         {
@@ -273,6 +277,10 @@ async def to_code(config):
         sens = await text_sensor.new_text_sensor(door_sensor_state)
         cg.add(var.set_door_sensor_state_text_sensor(sens))
 
+    if last_unlock_user := config.get(CONF_LAST_UNLOCK_USER_TEXT_SENSOR):
+        sens = await text_sensor.new_text_sensor(last_unlock_user)
+        cg.add(var.set_last_unlock_user_text_sensor(sens))
+
     # Button
     if unpair := config.get(CONF_UNPAIR_BUTTON):
         b = await button.new_button(unpair)

components/nuki_lock/nuki_lock.cpp

@@ -323,7 +323,6 @@ void NukiLockComponent::processLogEntries(const std::list<NukiLock::LogEntry>& l
     char str[50];
     char authName[33];
     uint32_t authIndex = 0;
-    
 
     for(const auto& log : logEntries)
     {
@@ -448,15 +447,20 @@ void NukiLockComponent::processLogEntries(const std::list<NukiLock::LogEntry>& l
                 }
                 break;
         }
-
-        /*if(log.index > _lastRollingLog)
+        
+        // Send as Home Assistant Event
+        if(log.index > this->last_rolling_log_id)
         {
-            _lastRollingLog = log.index;
-            serializeJson(entry, _buffer, _bufferSize);
-            publishString(mqtt_topic_lock_log_rolling, _buffer, true);
-            publishInt(mqtt_topic_lock_log_rolling_last, log.index, true);
-        }*/
+            this->last_rolling_log_id = log.index;
+
+            // TODO
+        }
     }
+
+    #ifdef USE_TEXT_SENSOR
+    if (this->last_unlock_user_text_sensor_ != nullptr)
+        this->last_unlock_user_text_sensor_->publish_state(this->auth_name_);
+    #endif
 }
 
 bool NukiLockComponent::executeLockAction(NukiLock::LockAction lockAction) {
@@ -845,6 +849,7 @@ void NukiLockComponent::dump_config() {
     #endif
     #ifdef USE_TEXT_SENSOR
     LOG_TEXT_SENSOR(TAG, "Door Sensor State", this->door_sensor_state_text_sensor_);
+    LOG_TEXT_SENSOR(TAG, "Last Unlock User", this->last_unlock_user_text_sensor_);
     #endif
     #ifdef USE_SENSOR
     LOG_SENSOR(TAG, "Battery Level", this->battery_level_sensor_);

components/nuki_lock/nuki_lock.h

@@ -48,6 +48,7 @@ class NukiLockComponent : public lock::Lock, public PollingComponent, public api
     #endif
     #ifdef USE_TEXT_SENSOR
     SUB_TEXT_SENSOR(door_sensor_state)
+    SUB_TEXT_SENSOR(last_unlock_user)
     #endif
     #ifdef USE_NUMBER
     SUB_NUMBER(led_brightness)
@@ -178,6 +179,8 @@ class NukiLockComponent : public lock::Lock, public PollingComponent, public api
         bool pairing_mode_ = false;
         uint32_t pairing_mode_timer_ = 0;
 
+        uint32_t last_rolling_log_id = 0;
+
     private:
         NukiLock::NukiLock nukiLock_;