Skip to content

Doorman Entities

On this page, you can view all the entities related to Doorman.

Sensors

Uptime doorman_uptime Disabled by default

Reports the uptime in seconds. If you flashed the Home Assistant Smart Home integration, it will report the timestamp.

WiFi Signal doorman_wifi_signal Disabled by default

Reports the wifi signal in percent.

Text Sensors

ESPHome Version esphome_version Disabled by default

Reports the installed base ESPHome version.

Doorman Version doorman_firmware_version Disabled by default

Reports the installed Doorman firmware version and build time.

Model doorman_model Disabled by default

Reports the Doorman model.

Revision doorman_revision Disabled by default

Reports the Doorman hardware revision.

Switches

Relay doorman_relay Disabled by default

Controls the built-in relay.

RED Status LED: Show Bus Activity doorman_red_status_led_bus_activity Disabled by default

When enabled, the red status LED will briefly blink to indicate activity on the bus — useful for debugging or just keeping an eye on communication.

Experimental Firmware dev_firmware

Enables experimental updates, allowing you to easily switch between the master and dev branches to check for the latest changes.

Buttons

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 or Improv Serial, 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

Red Status LED: Brightness doorman_red_status_led_brightness

Controls the brightness of the red status LED.

RGB Status LED: Brightness doorman_rgb_status_led_brightness

Controls the brightness of the RGB status LED.

Selects

ESPHome Log Level esphome_logger_level Disabled by default

Configure the ESPHome log level. Default log level is INFO for stable builds and DEBUG for dev builds.

Modes:

  • Disabled
  • Error
  • Warning
  • Info
  • Configuration dev builds only
  • Debug dev builds only
  • Verbose dev builds only

Relay Mode relay_mode Disabled by default

Configure how the internal relay should be switched — either standalone or triggered when a telegram to open the entrance doors is received. For entrance doors, the relay is switched off again after 5 seconds (default).

Modes:

  • Standalone
  • Entrance Door Opener
  • Second Entrance Door Opener
  • Any Door Opener

Events

Flash Button doorman_boot_button_event Disabled by default

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

Event Types
  • single_press
  • double_press
  • long_press

External Button doorman_external_button_event Disabled by default

Triggers when the external button is pressed.

Event Types
  • single_press
  • double_press
  • long_press

Updates

Doorman Firmware Update update_http_request

Shows if an doorman firmware update is available and offers installation via the HTTP OTA update mechanism.

Lights

Red Status LED doorman_red_status_led

A small LED on the Doorman's PCB indicating errors or bus communication.

RGB Status LED doorman_rgb_status_led

A small WS2812B/SK6812B 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.

Status Descriptions
ComponentDescriptionPreview
WiFiConnecting
WiFiAccess Point Mode (Setup)
APIWaiting for connection (Home Assistant / MQTT / HomeKit)
APIConnected (Home Assistant / MQTT / HomeKit)
APIConfiguration required (MQTT Broker / HomeKit Pairing)
Setup ModeOutdoor Station Discovery
Setup ModeWaiting for Doorbell Button Press
Setup ModeIndoor Station Identification
Setup ModeIndoor Station Memory Read
Setup ModeComplete
Setup ModeError
Ring To OpenEntrance Door
Ring To OpenBoth Entrance Doors
Ring To OpenApartment Door
Ring To OpenApartment Door & Entrance Door(s)
Nuki BridgePairing Mode
Nuki BridgePaired successfully

Released under the GPL 3.0 License.