Merge pull request #21 from AzonInc/dev

Add Easy Setup Process

docs/de/guide/firmware/nuki-bridge-firmware.md

@@ -17,13 +17,13 @@ Du kannst deinen Doorman über USB-C anschließen und auf den untenstehenden But
     </button>
     <div slot="unsupported">
         <div class="danger custom-block">
-            <p class="custom-block-title">OH SNAP!</p>
+            <p class="custom-block-title">OH NEIN!</p>
             <p>Dein Browser unterstützt leider kein Web Serial :(</p>
         </div>
     </div>
     <div slot="not-allowed">
         <div class="danger custom-block">
-            <p class="custom-block-title">OH SNAP!</p>
+            <p class="custom-block-title">OH NEIN!</p>
             <p>Das funktioniert mit HTTP nicht :(</p>
         </div>
     </div>

docs/de/guide/firmware/stock-firmware.md

@@ -17,13 +17,13 @@ Du kannst deinen Doorman über USB-C anschließen und auf den untenstehenden But
     </button>
     <div slot="unsupported">
         <div class="danger custom-block">
-            <p class="custom-block-title">OH SNAP!</p>
+            <p class="custom-block-title">OH NEIN!</p>
             <p>Dein Browser unterstützt leider kein Web Serial :(</p>
         </div>
     </div>
     <div slot="not-allowed">
         <div class="danger custom-block">
-            <p class="custom-block-title">OH SNAP!</p>
+            <p class="custom-block-title">OH NEIN!</p>
             <p>Das funktioniert mit HTTP nicht :(</p>
         </div>
     </div>

docs/de/guide/getting-started.md

@@ -24,21 +24,28 @@ Dank mDNS-Unterstützung wird Home Assistant deinen Doorman automatisch entdecke
 ### Schritt 2: Mit Home Assistant verbinden
 Nachdem du den Doorman mit deinem Netzwerk verbunden hast, wird er langsam (blau) blinken und sollte automatisch von Home Assistant entdeckt werden. Klicke einfach auf `Konfigurieren`, um das neu entdeckte ESPHome-Gerät hinzuzufügen.
 
-### Schritt 3: Bus Befehle setzen
-::: warning Wichtig
-Du musst den Doorman zuerst mit deiner Gegensprechanlage verbinden. Sieh dir hierfür den Bereich [Verkabelung](#verkabelung) an.
+### Schritt 3: Bus-Befehle
+::: warning Bevor du weiter machst
+Du musst deinen Doorman zuerst mit der Gegensprechanlage verbinden. Sieh dir hierfür den Bereich [Verkabelung](#verkabelung) für detaillierte Anweisungen an.
 :::
 
-Du kannst die [ESPHome-Integrationsseite](https://my.home-assistant.io/redirect/integration/?domain=esphome) besuchen und auf den neuen Eintrag deines Doorman S3 klicken. Dort findest du einen Last Bus Command-Textsensor, der den zuletzt empfangenen Busbefehl im hexadezimalen Format anzeigt.
+#### Easy Setup
+Um die Konfiguration der wichtigsten Befehle zu erleichtern, kannst du den Easy Setup-Prozess nutzen.
 
-Zusätzlich werden alle empfangenen Befehle im ESPHome-Console-Log (Debug-Log) protokolliert und als Home Assistant-Ereignis veröffentlicht.
+Greif entweder auf den internen Webserver deines Doormans zu oder besuche die [ESPHome Integrationsseite](https://my.home-assistant.io/redirect/integration/?domain=esphome) und wähle das neu aufgeführte Doorman S3-Gerät aus.
 
-**Wichtige Befehle:**
-- Eingangstür-Klingel
-- Wohnungstür-Klingel
-- Eingangstür öffnen
+In `Konfiguration`-Bereich findest du den Button `Easy Setup: Start`. Klicke darauf, um den Einrichtungsprozess zu starten.
 
-Drücke die Tasten an deinem Etagen-Telefon, um die Codes aufzuzeichnen, und kopiere sie dann in die entsprechenden Konfigurations-Textfelder.
+Sobald der Prozess begonnen hat, wird der `Easy Setup: Status` Text Sensor dich durch die erforderlichen Schritte führen (z.B. Knopf X drücken, warten oder das Telefon abheben).\
+Während der Einrichtung pulsiert die RGB-Status-LED rot, solange du die Aufgabe noch nicht abgeschlossen hast, und bleibt 3 Sekunden lang rot, nachdem der Befehl gespeichert wurde.
+
+Nach Abschluss der Einrichtung endet der Prozess automatisch und zeigt den entsprechenden Status an.
+
+#### Manuell: No pain, no gain!
+Du findest auch einen `Last Bus Command` Text Sensor, der den letzten Bus-Befehl im Hexadezimalformat anzeigt.
+Außerdem wird jeder empfangene Befehl in der ESPHome-Konsole (Debug-Log-Ebene) protokolliert und als Home Assistant-Ereignis veröffentlicht.
+
+Um die Codes zu erfassen, drücke die Tasten an deinem Etagen-Telefon und kopiere die Codes anschließend in die entsprechenden Konfigurationstextfelder.
 
 ## ESPHome adoption
 Wenn du die Firmware deines Doorman anpassen möchtest, kannst du diesen zu deinem [ESPHome-Dashboard](https://my.home-assistant.io/redirect/supervisor_ingress/?addon=5c53de3b_esphome) hinzufügen und deine angepasste [Stock](firmware/stock-firmware.md) oder [Nuki Bridge](firmware/nuki-bridge-firmware.md) Firmware flashen.

docs/de/reference/entities.md

@@ -12,6 +12,7 @@ Meldet die Betriebszeit in Sekunden.
 ### Nuki Battery Level  
 Meldet den Akkustand des verbundenen Nuki Smart Locks.
 
+
 ## Binäre Sensoren
 
 ### Entrance Doorbell  
@@ -50,6 +51,13 @@ Keine Beschreibung vorhanden.
 ### Nuki Door Sensor State  
 Meldet den Türsensorstatus des gekoppelten Nuki Smart Locks.
 
+
+## Text Sensors
+
+### Easy Setup: Status
+Zeigt den aktuellen Status vom [Easy Setup](../guide/getting-started#easy-setup) Prozess an.
+
+
 ## Schalter
 
 ### Ring To Open  
@@ -64,6 +72,7 @@ Steuert das eingebaute Relais.
 ### Nuki Pairing Mode  
 Steuert den Nuki Kopplungsmodus.
 
+
 ## Buttons
 
 ### Open Entrance Door  
@@ -75,6 +84,12 @@ Steuert den Nuki Kopplungsmodus.
 ### Turn on the light  
 Schaltet das Licht ein, indem der Befehl `turn_on_light_command` auf dem Bus gesendet wird.
 
+### Easy Setup: Start <Badge type="tip" text="doorman_easy_setup_start" />
+Startet den [Easy Setup](../guide/getting-started#easy-setup) Prozess um Bus Commands einzurichten.
+
+### Easy Setup: Cancel <Badge type="tip" text="doorman_easy_setup_cancel" />
+Beendet den [Easy Setup](../guide/getting-started#easy-setup) Prozess.
+
 ### Nuki Unpair Device  
 Entkoppelt dein Nuki Smart Lock.
 

docs/en/guide/getting-started.md

@@ -24,21 +24,28 @@ Additionally, with mDNS support, Home Assistant will automatically discover your
 ### Step 2: Connect to Home Assistant
 After connecting Doorman to your network, it will blink slowly (blue) and should be automatically discovered by Home Assistant. Simply click on `Configure` to add the newly discovered ESPHome node.
 
-### Step 3: Obtaining Bus commands
-::: warning Important
-You need to connect Doorman to your intercom first. Please refer to the [Wiring](#wiring) section for details.
+### Step 3: Bus Commands
+::: warning Before proceeding
+You need to connect your Doorman to the intercom. Please refer to the [Wiring](#wiring) section for detailed instructions.
 :::
 
-You can visit the [ESPHome Integration page](https://my.home-assistant.io/redirect/integration/?domain=esphome) and click on the new Doorman S3 device entry. There, you'll find a Last Bus Command text sensor that tracks the most recent bus command in hexadecimal format.
+#### Easy Setup
+To simplify the configuration of the key commands, you can use the Easy Setup Process.
 
-Additionally, every received command is logged in the ESPHome Console (Debug log level) and published as a Home Assistant event.
+To get started, either access the internal web server of your Doorman or visit the [ESPHome Integration page](https://my.home-assistant.io/redirect/integration/?domain=esphome) and select the newly listed Doorman S3 device entry.
 
-**Important Commands:**
-- Entrance Doorbell
-- Apartment Doorbell
-- Open Entrance Door
+In the `Configuration` section, you will find the `Easy Setup: Start` button. Click this button to initiate the setup process.
 
-Press the buttons on your intercom phone to capture the codes, then copy them into the corresponding configuration text inputs.
+Once started, the `Easy Setup: Status` Text Sensor will guide you through the required steps (e.g., press button X, wait, or pick up the phone).\
+During the setup, the RGB Status LED will pulse red while waiting for you to complete each task and will remain solid red for 3 seconds after saving the command.
+
+After the setup is complete, the process will automatically end and display the corresponding status.
+
+#### Manual: No pain, no gain!
+You will also find a `Last Bus Command` Text Sensor that tracks the most recent bus command in hexadecimal format.
+Additionally, each received command is logged in the ESPHome Console (at the Debug log level) and published as a Home Assistant event.
+
+To capture the codes, press the buttons on your intercom phone and then copy the codes into the corresponding configuration text inputs.
 
 ## ESPHome adoption
 

docs/en/reference/entities.md

@@ -2,62 +2,103 @@
 The Doorman firmware exposes many entities by default. This page explains the purpose of each one.
 
 ## Sensors
+
 ### Last Bus Command <Badge type="tip" text="last_bus_command" />
 Reports every published command on the bus.
+
 ### Uptime <Badge type="tip" text="doorman_uptime" />
 Reports the uptime in seconds.
+
 ### Nuki Battery Level <Badge type="tip" text="nuki_battery_level" /> <Badge type="info" text="Nuki Bridge only" />
 Reports the battery level of the paired Nuki smart lock.
 
+
 ## Binary Sensors
+
 ### Entrance Doorbell <Badge type="tip" text="entrance_doorbell" />
 Activates whenever the `entrance_doorbell_command` command is received.
+
 ### Apartment Doorbell <Badge type="tip" text="apartment_doorbell" />
 Activates whenever the `apartment_doorbell_command` command is received.
+
 ### Pick up phone <Badge type="tip" text="pick_up_phone" /> <Badge type="info" text="Disabled by default" />
 Activates whenever the `pick_up_phone_command` command is received.
+
 ### Hang up phone <Badge type="tip" text="hang_up_phone" /> <Badge type="info" text="Disabled by default" />
 Activates whenever the `hang_up_phone_command` command is received.
+
 ### Ring To Open: Toggle <Badge type="tip" text="ring_to_open_toggle" /> <Badge type="info" text="Internal" />
 Activates whenever the `ring_to_open_toggle_command` command is received.
+
 ### Turn on light: Trigger <Badge type="tip" text="turn_on_light_trigger" /> <Badge type="info" text="Internal" />
 Activates whenever the `turn_on_light_command` command is received.
+
 ### External Button <Badge type="tip" text="doorman_external_button" /> <Badge type="info" text="Disabled by default" />
 Activates when the external button is pressed.
+
 ### Nuki Connected <Badge type="tip" text="nuki_connected" /> <Badge type="info" text="Nuki Bridge only" />
 Activates when the paired Nuki smart lock is connected.
+
 ### Nuki Paired <Badge type="tip" text="nuki_paired" /> <Badge type="info" text="Nuki Bridge only" />
 Activates when a Nuki smart lock is paired.
+
 ### Nuki Battery Critical <Badge type="tip" text="nuki_battery_critical" /> <Badge type="info" text="Nuki Bridge only" />
 Activates when the paired Nuki smart lock has a critical battery level.
+
 ### Nuki Door Sensor <Badge type="tip" text="nuki_door_sensor" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
 No description yet.
+
 ### Nuki Door Sensor State <Badge type="tip" text="nuki_door_sensor_state" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
 Reports the door sensor state of the paired Nuki smart lock.
 
+
+## Text Sensors
+
+### Easy Setup: Status
+Shows the current state of [Easy Setup](../guide/getting-started#easy-setup) for Commands.
+
+
 ## Switches
+
 ### Ring To Open <Badge type="tip" text="doorman_ring_to_open" />
 Controls the [Ring To Open](../guide/automation/ring-to-open) automation.
+
 ### Ring To Open: Confirmation <Badge type="tip" text="doorman_ring_to_open_confirmation" /> <Badge type="info" text="Disabled by default" />
 Controls the turn-on confirmation for the [Ring To Open](../guide/automation/ring-to-open) automation.
+
 ### Relay <Badge type="tip" text="doorman_relay" /> <Badge type="info" text="Disabled by default" />
 Controls the built-in relay.
+
 ### Nuki Pairing Mode <Badge type="tip" text="nuki_pairing_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
 Controls the Nuki pairing mode.
 
+
 ## Buttons
+
 ### Open Entrance Door <Badge type="tip" text="open_entrance_door" />
 Opens the entrance door by sending the `open_entrance_door_command` command on the Bus.
+
 ### Open Second Door <Badge type="tip" text="open_second_door" /> <Badge type="info" text="Disabled by default" />
 Opens the second door by sending the `open_second_door_command` command on the Bus.
+
 ### Turn on the light <Badge type="tip" text="turn_on_light" /> <Badge type="info" text="Disabled by default" />
 Turns on the light by sending the `turn_on_light_command` command on the Bus.
+
+### Easy Setup: Start <Badge type="tip" text="doorman_easy_setup_start" />
+Starts the [Easy Setup](../guide/getting-started#easy-setup) Process to interactively setup bus commands.
+
+### Easy Setup: Cancel <Badge type="tip" text="doorman_easy_setup_cancel" />
+Cancels the [Easy Setup](../guide/getting-started#easy-setup) Process.
+
 ### Nuki Unpair Device <Badge type="tip" text="nuki_unpair_device" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
 Unpairs your Nuki smart lock.
+
 ### Restart <Badge type="tip" text="doorman_restart" /> <Badge type="info" text="Disabled by default" />
 Restarts the Doorman unit, useful after configuration changes that require a restart.
+
 ### Safe mode <Badge type="tip" text="doorman_safe_mode" /> <Badge type="info" text="Disabled by default" />
 Restarts the Doorman unit into safe mode, useful for OTA updates if the unit is too busy.
+
 ### Restore Factory Settings <Badge type="tip" text="doorman_factory_reset" /> <Badge type="info" text="Disabled by default" />
 Restarts the Doorman unit and loads factory defaults.
 ::: danger USE WITH GREAT CAUTION
@@ -66,33 +107,46 @@ All credentials, global variables, counters, and saved states stored in non-vola
 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.
 :::
 
+
 ## Texts
+
 ### Command: Apartment Doorbell <Badge type="tip" text="apartment_doorbell_command_input" />
 Sets the code sent when someone rings the apartment doorbell.
+
 ### Command: Entrance Doorbell <Badge type="tip" text="entrance_doorbell_command_input" />
 Sets the code sent when someone rings the entrance doorbell.
+
 ### Command: Open Entrance Door <Badge type="tip" text="open_entrance_door_command_input" />
 Sets the code sent when you press the button to open the entrance door.
+
 ### Command: Open Second Door <Badge type="tip" text="open_second_door_command_input" /> <Badge type="info" text="Disabled by default" />
 Sets the code sent when you press the button to open the second door.
+
 ### Command: Pick up phone <Badge type="tip" text="pick_up_phone_command_input" /> <Badge type="info" text="Disabled by default" />
 Sets the code sent when you pick up the phone.
+
 ### Command: Hang up phone <Badge type="tip" text="hang_up_phone_command_input" /> <Badge type="info" text="Disabled by default" />
 Sets the code sent when you hang up the phone.
+
 ### Command: Turn on light <Badge type="tip" text="turn_on_light_command_input" /> <Badge type="info" text="Disabled by default" />
 Sets the code sent when you press the button to turn on the hallway light.
+
 ### Command: Ring To Open Toggle <Badge type="tip" text="ring_to_open_toggle_command_input" /> <Badge type="info" text="Disabled by default" />
 Sets the code used to toggle the [Ring To Open](../guide/automation/ring-to-open) automation.
 The function button is often used for this purpose as it is usually not utilized.
 
+
 ## Numbers
+
 ### Ring To Open: Delay <Badge type="tip" text="doorman_ring_to_open_delay" /> <Badge type="info" text="Disabled by default" />
 Sets the delay for the [Ring To Open](../guide/automation/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. 
 :::
 
+
 ## Selects
+
 ### Ring To Open: Timeout <Badge type="tip" text="doorman_ring_to_open_timeout_mode" /> <Badge type="info" text="Disabled by default" />
 Sets the timeout mode for the [Ring To Open](../guide/automation/ring-to-open) automation.
 
@@ -101,11 +155,15 @@ Sets the timeout mode for the [Ring To Open](../guide/automation/ring-to-open) a
 - 5 to 60 minutes
 - Never
 
+
 ## Locks
+
 ### Nuki Lock <Badge type="tip" text="nuki_smart_lock" /> <Badge type="info" text="Nuki Bridge only" />
 Represents the lock entity for your paired Nuki smart lock.
 
+
 ## Events
+
 ### Doorbell Pattern <Badge type="tip" text="doorbell_pattern" />
 Triggers each time a doorbell pattern is detected. Learn more about pattern events [here](../guide/automation/pattern-events).
 
@@ -125,14 +183,18 @@ Triggers each time a phone pick up pattern is detected. Learn more about pattern
 - double
 - triple
 
+
 ## Updates
+
 ### Firmware <Badge type="info" text="Stable" /> <Badge type="tip" text="update_http_request_stable" />
 Shows if an update on the stable branch is available and offers installation via the HTTP OTA update mechanism.
 
 ### Firmware <Badge type="info" text="Development" /> <Badge type="tip" text="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 <Badge type="danger" text="Red" /> <Badge type="tip" text="doorman_status_led" />
 A small LED on the Doorman's PCB controlled by the ESPHome [Status LED](https://esphome.io/components/light/status_led.html) component.  By default, this LED remains on when everything is functioning properly but will blink if there are issues.