Entities

The Doorman firmware exposes many entities by default. This page explains the purpose of each one.

Sensors

Last Bus Command last_bus_command

Reports every published command on the bus.

Uptime doorman_uptime Disabled by default

Reports the uptime in seconds.

Nuki Battery Level nuki_battery_level Nuki Bridge only

Reports the battery level of the paired Nuki smart lock.

Binary Sensors

Entrance Doorbell entrance_doorbell

Activates whenever the door_call command type is received.

Second Entrance Doorbell second_entrance_doorbell Disabled by default

Activates whenever the door_call command type with the second entrance door station address is received.

Apartment Doorbell apartment_doorbell

Activates whenever the floor_call command type is received.

Pick up phone pick_up_phone Disabled by default

Activates whenever the start_talking command type is received.

Pick up phone (door call) pick_up_phone_door_call Disabled by default

Activates whenever the start_talking_door_call command type is received.

Hang up phone hang_up_phone Disabled by default

Activates whenever the stop_talking command type is received.

Hang up phone (door call) hang_up_phone_door_call Disabled by default

Activates whenever the stop_talking_door_call command type is received.

Function Button function_button Disabled by default

Activates whenever the control_function command type is received.

Light Button light_button Disabled by default

Activates whenever the light command type is received.

Door readiness door_readiness Disabled by default

Activates whenever the door readiness is active.

Flash Button doorman_boot_button Disabled by default

Activates when the FLASH or PRG button on the PCB is pressed.

External Button doorman_external_button Disabled by default

Activates when the external button is pressed.

Nuki Connected nuki_connected Nuki Bridge only

Activates when the paired Nuki smart lock is connected.

Nuki Paired nuki_paired Nuki Bridge only

Activates when a Nuki smart lock is paired.

Nuki Battery Critical nuki_battery_critical Nuki Bridge only

Activates when the paired Nuki smart lock has a critical battery level.

Nuki Door Sensor nuki_door_sensor Nuki Bridge only Disabled by default

No description yet.

Text Sensors

Nuki Door Sensor State nuki_door_sensor_state Nuki Bridge only Disabled by default

Reports the door sensor state of the paired Nuki smart lock.

Nuki Last Unlock User nuki_last_unlock_user Nuki Bridge only

Reports the last user who locked or unlocked the Nuki smart lock.

Nuki Last Lock Action nuki_last_lock_action Nuki Bridge only Disabled by default

Reports the last lock action of the Nuki smart lock.

Nuki Last Lock Action Trigger nuki_last_lock_action_trigger Nuki Bridge only Disabled by default

Reports the last log action trigger of the Nuki smart lock.

Switches

Ring To Open doorman_ring_to_open

Controls the Ring To Open automation.

Ring To Open: Confirmation doorman_ring_to_open_confirmation Disabled by default

Controls the turn-on confirmation for the Ring To Open automation.

Relay doorman_relay Disabled by default

Controls the built-in relay.

Setup Mode doorman_setup_mode

Toggles the Interactive Setup Mode to easily setup your Doorman.

Nuki Pairing Mode nuki_pairing_mode Nuki Bridge only Disabled by default

Controls the Nuki pairing mode.

Nuki Auto unlatch nuki_auto_unlatch Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Auto unlatch setting.

Nuki Button: Locking operations nuki_button_locking_operations Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Button locking operations setting.

Nuki LED: Signal nuki_led_enabled Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock LED Signal setting.

Nuki Night Mode nuki_night_mode Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Night Mode setting.

Nuki Night Mode: Auto Lock nuki_night_mode_auto_lock_enabled Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Night Mode Auto Lock setting.

Nuki Night Mode: Reject Auto Unlock nuki_night_mode_auto_unlock_disabled Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Night Mode Reject Auto Unlock setting.

Nuki Night Mode: Lock at Start Time nuki_night_mode_immediate_lock_on_start Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Night Mode Lock at Start Time setting.

Nuki Auto Lock nuki_auto_lock Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Auto Lock setting.

Nuki Auto Lock: Immediately nuki_immediate_auto_lock Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Auto Lock Immediately setting.

Nuki Auto Unlock: Disable nuki_auto_unlock_disabled Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Auto Unlock Disable setting.

Nuki Single Lock nuki_single_lock Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Single Lock setting.

Nuki Daylight Saving Time nuki_dst_mode Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock DST Mode setting.

Nuki Automatic Updates nuki_auto_update Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Automatic Updates setting.

Buttons

Open Entrance Door open_entrance_door

Opens the entrance door by sending a open_door command on the bus.

Open Second Entrance Door open_second_door Disabled by default

Opens the second entrance door by sending a open_door command with the address of the second outdoor station on the bus.

Turn on the Light turn_on_light Disabled by default

Turns on the light by sending a light command on the bus.

Read Memory read_memory Disabled by default

Reads the memory of the intercom phone with the specified serial number.

Nuki Unpair Device nuki_unpair_device Nuki Bridge only Disabled by default

Unpairs your Nuki smart lock.

Restart doorman_restart Disabled by default

Restarts the Doorman unit, useful after configuration changes that require a restart.

Safe mode doorman_safe_mode Disabled by default

Restarts the Doorman unit into safe mode, useful for OTA updates if the unit is too busy.

Restore Factory Settings doorman_factory_reset Disabled by default

Restarts the Doorman unit and loads factory defaults.

USE WITH GREAT CAUTION

All credentials, global variables, counters, and saved states stored in non-volatile memory will be lost with no chance of recovery. Even raw reading of flash memory with esptool will not help, as data is physically erased from flash memory.

If you configured WiFi using the captive portal, Improv Serial, or Improv BLE, this will reset WiFi settings as well, making such devices offline. You'll need to reconfigure the device using a built-in WiFi access point and captive portal.

Numbers

Serial Number serial_number Disabled by default

Sets the indoor station serial number for the command builder/parser.

Second Door Station ID second_door_station_id Disabled by default

Sets the ID of the second outdoor station.

Ring To Open: Delay doorman_ring_to_open_delay Disabled by default

Sets the delay for the Ring To Open automation.

TIP

Setting the delay to the maximum (60 seconds) will result in the automation generating a random delay between 5 and 15 seconds each time it is triggered.

Volume: Ringtone intercom_volume_ringtone Disabled by default

Sets the intercom phone ringtone volume.

Volume: Handset intercom_volume_handset Disabled by default

Sets the intercom phone handset volume.

Nuki LED: Brightness nuki_led_brightness Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock LED Brightness setting.

Nuki Timezone: Offset nuki_timezone_offset Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Timezone offset setting (Lock v1).

Nuki Security Pin nuki_security_pin Nuki Bridge only Disabled by default

Sets the Nuki Bridge Security Pin to authenticate against the Nuki Smart Lock.

Selects

Ring To Open: Timeout doorman_ring_to_open_timeout_mode

Sets the timeout mode for the Ring To Open automation.

Modes:

• Ring once
• 5 to 60 minutes
• Never

Ring To Open: Door Station doorman_ring_to_open_door_trigger

Sets the triggering door for the Ring To Open automation.

Options:

• Entrance
• Second Entrance
• Any

Intercom Model intercom_model Disabled by default

Sets the intercom phone model. Check the Supported Models and Settings to see your options.

Ringtone: Door Call intercom_ringtone_door_call Disabled by default

Sets the intercom phone ringtone for door calls.

Options:

• Ringtone 1 ... 13

Ringtone: Floor Call intercom_ringtone_floor_call Disabled by default

Sets the intercom phone ringtone for floor calls.

Options:

• Ringtone 1 ... 13

Ringtone: Internal Call intercom_ringtone_internal_call Disabled by default

Sets the intercom phone ringtone for internal calls.

Options:

• Ringtone 1 ... 13

Nuki Button: Single Press Action nuki_single_button_press_action Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Single Button Press Action setting.

Options:

• No Action
• Intelligent
• Unlock
• Lock
• Unlatch
• Lock n Go
• Show Status

Nuki Button: Double Press Action nuki_double_button_press_action Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Double Button Press Action setting.

Options:

• No Action
• Intelligent
• Unlock
• Lock
• Unlatch
• Lock n Go
• Show Status

Nuki Fob: Action 1 nuki_fob_action_1 Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Fob Action 1 setting.

Options:

• No Action
• Unlock
• Lock
• Lock n Go
• Intelligent

Nuki Fob: Action 2 nuki_fob_action_2 Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Fob Action 2 setting.

Options:

• No Action
• Unlock
• Lock
• Lock n Go
• Intelligent

Nuki Fob: Action 3 nuki_fob_action_3 Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Fob Action 3 setting.

Options:

• No Action
• Unlock
• Lock
• Lock n Go
• Intelligent

Nuki Timezone nuki_timezone Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Timezone setting.

Options:

Check out the nuki developer documentation.

Nuki Advertising Mode nuki_advertising_mode Nuki Bridge only Disabled by default

Controls the Nuki Smart Lock Advertising Mode setting.

Options:

• Automatic
• Normal
• Slow
• Slowest

Locks

Nuki Lock nuki_smart_lock Nuki Bridge only

Represents the lock entity for your paired Nuki smart lock.

Events

Doorbell Pattern doorbell_pattern

Triggers each time a doorbell pattern is detected. Learn more about pattern events here.

Event Types

• apartment_single
• apartment_double
• apartment_triple
• entrance_single
• entrance_double
• entrance_triple
• second_entrance_single
• second_entrance_double
• second_entrance_triple

Phone pick up Pattern phone_pick_up_pattern

Triggers each time a phone pick up pattern is detected. Learn more about pattern events here.

Event Types

• single
• double
• triple

Updates

Firmware Stable update_http_request_stable

Shows if an update on the stable branch is available and offers installation via the HTTP OTA update mechanism.

Firmware Development update_http_request_dev

Shows if an update on the development branch is available and offers installation via the HTTP OTA update mechanism.

Lights

Status LED Red doorman_status_led

A small LED on the Doorman's PCB controlled by the ESPHome Status LED component. By default, this LED remains on when everything is functioning properly but will blink if there are issues.

You can turn off the LED if it becomes annoying. Even when turned off, it will still retain its functionality and blink to signal any issues.

Status LED RGB doorman_rgb_status_led

A small WS2812B RGB LED on the Doorman's PCB is used to indicate specific events. The LED can display various colors and patterns to provide visual feedback on different states and actions.

Event Types

• Waiting for WiFi / AP Enabled Fast orange pulse
• Waiting for Home Assistant to Connect Slow blue pulse
• Home Assistant Connected Solid blue light (for 3 seconds)
• Ring To Open is Active Slow yellow pulse
• Nuki Pairing Mode is Active Slow purple pulse Nuki Bridge only
• Nuki Paired Successfully Solid purple light (for 3 seconds) Nuki Bridge only