From 67774aa7db942f595562d95e91759acab2850ecc Mon Sep 17 00:00:00 2001 From: Florian Date: Mon, 26 Aug 2024 18:22:20 +0200 Subject: [PATCH] Update Docs --- docs/de/guide/what-is-doorman.md | 2 +- docs/de/reference/entities.md | 247 ++++++++++++++++++------------- 2 files changed, 145 insertions(+), 104 deletions(-) diff --git a/docs/de/guide/what-is-doorman.md b/docs/de/guide/what-is-doorman.md index 3c9c108..76d193e 100644 --- a/docs/de/guide/what-is-doorman.md +++ b/docs/de/guide/what-is-doorman.md @@ -20,7 +20,7 @@ Du hast gerade deinen Doorman erhalten? Geh direkt zur [Quickstart](getting-star ## Features -- Angetrieben vom ESP32-S3 +- ESP32-S3 mit Dual-Core-CPU, integriertem PSRAM und Bluetooth - USB-C Anschluss zum einfachen Flashen (und weil USB-C einfach cool ist 😎) - Kompaktes Design, das fast überall passt - Einstellbare WS2812B RGB LED zur Anzeige bestimmter Ereignisse diff --git a/docs/de/reference/entities.md b/docs/de/reference/entities.md index 545624c..bda16f4 100644 --- a/docs/de/reference/entities.md +++ b/docs/de/reference/entities.md @@ -2,114 +2,153 @@ Die Doorman-Firmware stellt standardmäßig viele Entitäten zur Verfügung. Auf dieser Seite wird erklärt, wozu jede einzelne dient. ## Sensoren -### Last Bus Command -Reports every published command on the bus. -### Uptime -Reports the uptime in seconds. -### Nuki Battery Level -Reports the battery level of the paired Nuki smart lock. + +### Last Bus Command +Meldet jeden veröffentlichten Befehl auf dem Bus. + +### Uptime +Meldet die Betriebszeit in Sekunden. + +### Nuki Battery Level +Meldet den Akkustand des verbundenen Nuki Smart Locks. ## Binäre Sensoren -### Entrance Doorbell -Activates whenever the `entrance_doorbell_command` command is received. -### Apartment Doorbell -Activates whenever the `apartment_doorbell_command` command is received. -### Pick up phone -Activates whenever the `pick_up_phone_command` command is received. -### Hang up phone -Activates whenever the `hang_up_phone_command` command is received. -### Ring To Open: Toggle -Activates whenever the `ring_to_open_toggle_command` command is received. -### Turn on light: Trigger -Activates whenever the `turn_on_light_command` command is received. -### External Button -Activates when the external button is pressed. -### Nuki Connected -Activates when the paired Nuki smart lock is connected. -### Nuki Paired -Activates when a Nuki smart lock is paired. -### Nuki Battery Critical -Activates when the paired Nuki smart lock has a critical battery level. -### Nuki Door Sensor -No description yet. -### Nuki Door Sensor State -Reports the door sensor state of the paired Nuki smart lock. + +### Entrance Doorbell +Wird aktiviert, wenn der Befehl `entrance_doorbell_command` empfangen wird. + +### Apartment Doorbell +Wird aktiviert, wenn der Befehl `apartment_doorbell_command` empfangen wird. + +### Pick up phone +Wird aktiviert, wenn der Befehl `pick_up_phone_command` empfangen wird. + +### Hang up phone +Wird aktiviert, wenn der Befehl `hang_up_phone_command` empfangen wird. + +### Ring To Open: Toggle +Wird aktiviert, wenn der Befehl `ring_to_open_toggle_command` empfangen wird. + +### Turn on light: Trigger +Wird aktiviert, wenn der Befehl `turn_on_light_command` empfangen wird. + +### External Button +Wird aktiviert, wenn der externe Button gedrückt wird. + +### Nuki Connected +Wird aktiviert, wenn das gekoppelte Nuki Smart Lock verbunden ist. + +### Nuki Paired +Wird aktiviert, wenn ein Nuki Smart Lock gekoppelt ist. + +### Nuki Battery Critical +Wird aktiviert, wenn das gekoppelte Nuki Smart Lock einen kritischen Akkustand hat. + +### Nuki Door Sensor +Keine Beschreibung vorhanden. + +### Nuki Door Sensor State +Meldet den Türsensorstatus des gekoppelten Nuki Smart Locks. ## Schalter -### Ring To Open -Controls the [Ring To Open](../guide/automation/ring-to-open) automation. -### Ring To Open: Confirmation -Controls the turn-on confirmation for the [Ring To Open](../guide/automation/ring-to-open) automation. -### Relay -Controls the built-in relay. -### Nuki Pairing Mode -Controls the Nuki pairing mode. + +### Ring To Open +Steuert die [Ring To Open](../guide/automation/ring-to-open) Automatisierung. + +### Ring To Open: Confirmation +Steuert die Einschaltbestätigung für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung. + +### Relay +Steuert das eingebaute Relais. + +### Nuki Pairing Mode +Steuert den Nuki Kopplungsmodus. ## Buttons -### Open Entrance Door -Opens the entrance door by sending the `open_entrance_door_command` command on the Bus. -### Open Second Door -Opens the second door by sending the `open_second_door_command` command on the Bus. -### Turn on the light -Turns on the light by sending the `turn_on_light_command` command on the Bus. -### Nuki Unpair Device -Unpairs your Nuki smart lock. -### Restart -Restarts the Doorman unit, useful after configuration changes that require a restart. -### Safe mode -Restarts the Doorman unit into safe mode, useful for OTA updates if the unit is too busy. -### Restore Factory Settings -Restarts the Doorman unit and loads factory defaults. -::: danger MIT GROßER VORSICHT VERWENDEN + +### Open Entrance Door +Öffnet die Eingangstür, indem der Befehl `open_entrance_door_command` auf dem Bus gesendet wird. + +### Open Second Door +Öffnet die zweite Tür, indem der Befehl `open_second_door_command` auf dem Bus gesendet wird. + +### Turn on the light +Schaltet das Licht ein, indem der Befehl `turn_on_light_command` auf dem Bus gesendet wird. + +### Nuki Unpair Device +Entkoppelt dein Nuki Smart Lock. + +### Restart +Startet Doorman neu, nützlich nach Konfigurationsänderungen, die einen Neustart erfordern. + +### Safe mode +Startet Doorman im Sicherheitsmodus neu, nützlich für OTA-Updates, wenn die Einheit zu beschäftigt ist. + +### Restore Factory Settings +Startet Doorman neu und lädt die Werkseinstellungen. + +::: Gefahr MIT GROẞER VORSICHT VERWENDEN Alle Zugangsdaten, globalen Variablen, Zähler und gespeicherten Zustände, die im nichtflüchtigen Speicher gespeichert sind, gehen verloren und können nicht wiederhergestellt werden. Selbst das Auslesen des Flash-Speichers mit esptool hilft nicht, da die Daten physisch aus dem Flash-Speicher gelöscht werden. Wenn du WiFi über das Captive Portal, Improv Serial oder Improv BLE konfiguriert hast, werden auch die WiFi-Einstellungen zurückgesetzt, wodurch solche Geräte offline gehen. Du musst das Gerät dann über einen eingebauten WiFi-Access-Point und das Captive Portal neu konfigurieren. ::: ## Eingabe für Text -### Command: Apartment Doorbell -Sets the code sent when someone rings the apartment doorbell. -### Command: Entrance Doorbell -Sets the code sent when someone rings the entrance doorbell. -### Command: Open Entrance Door -Sets the code sent when you press the button to open the entrance door. -### Command: Open Second Door -Sets the code sent when you press the button to open the second door. -### Command: Pick up phone -Sets the code sent when you pick up the phone. -### Command: Hang up phone -Sets the code sent when you hang up the phone. -### Command: Turn on light -Sets the code sent when you press the button to turn on the hallway light. -### Command: Ring To Open Toggle -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. + +### Command: Apartment Doorbell +Legt den Code fest, der gesendet wird, wenn jemand an der Wohnungsklingel läutet. + +### Command: Entrance Doorbell +Legt den Code fest, der gesendet wird, wenn jemand an der Eingangsklingel läutet. + +### Command: Open Entrance Door +Legt den Code fest, der gesendet wird, wenn du den Knopf zum Öffnen der Eingangstür drückst. + +### Command: Open Second Door +Legt den Code fest, der gesendet wird, wenn du den Knopf zum Öffnen der zweiten Tür drückst. + +### Command: Pick up phone +Legt den Code fest, der gesendet wird, wenn du den Hörer abnimmst. + +### Command: Hang up phone +Legt den Code fest, der gesendet wird, wenn du den Hörer auflegst. + +### Command: Turn on light +Legt den Code fest, der gesendet wird, wenn du den Knopf zum Einschalten des Flurlichts drückst. + +### Command: Ring To Open Toggle +Legt den Code fest, der verwendet wird, um die [Ring To Open](../guide/automation/ring-to-open) Automatisierung umzuschalten. Der Funktionstaster wird oft für diesen Zweck verwendet, da er üblicherweise nicht genutzt wird. ## Eingabe für Zahlenwert -### Ring To Open: Delay -Sets the delay for the [Ring To Open](../guide/automation/ring-to-open) automation. + +### Ring To Open: Delay +Legt die Verzögerung für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung fest. + ::: 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. +Das Einstellen der Verzögerung auf das Maximum (60 Sekunden) führt dazu, dass die Automatisierung jedes Mal eine zufällige Verzögerung zwischen 5 und 15 Sekunden generiert, wenn sie ausgelöst wird. ::: ## Dropdowns -### Ring To Open: Timeout -Sets the timeout mode for the [Ring To Open](../guide/automation/ring-to-open) automation. -##### Modes: -- Ring once -- 5 to 60 minutes -- Never +### Ring To Open: Timeout +Legt den Timeout-Modus für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung fest. + +##### Modi: +- Einmal klingeln +- 5 bis 60 Minuten +- Nie ## Schlösser -### Nuki Lock -Represents the lock entity for your paired Nuki smart lock. + +### Nuki Lock +Repräsentiert die Schlosseinheit für dein gekoppeltes Nuki Smart Lock. ## Ereignisse -### Doorbell Pattern -Triggers each time a doorbell pattern is detected. Learn more about pattern events [here](../guide/automation/pattern-events). -##### Event Types +### Doorbell Pattern +Wird ausgelöst, wenn ein Klingelmuster erkannt wird. Erfahre mehr über Musterereignisse [hier](../guide/automation/pattern-events). + +##### Ereignistypen - apartment_single - apartment_double - apartment_triple @@ -117,34 +156,36 @@ Triggers each time a doorbell pattern is detected. Learn more about pattern even - entrance_double - entrance_triple -### Phone pick up Pattern -Triggers each time a phone pick up pattern is detected. Learn more about pattern events [here](../guide/automation/pattern-events). +### Phone pick up Pattern +Wird ausgelöst, wenn ein Abhebe-Muster des Telefons erkannt wird. Erfahre mehr über Musterereignisse [hier](../guide/automation/pattern-events). -##### Event Types +##### Ereignistypen - single - double - triple ## Updates -### Firmware -Shows if an update on the stable branch is available and offers installation via the HTTP OTA update mechanism. -### Firmware -Shows if an update on the development branch is available and offers installation via the HTTP OTA update mechanism. +### Firmware +Zeigt an, ob ein Update im stabilen Zweig verfügbar ist, und bietet eine Installation über das HTTP OTA-Updateverfahren an. + +### Firmware +Zeigt an, ob ein Update im Entwicklungszweig verfügbar ist, und bietet eine Installation über das HTTP OTA-Updateverfahren an. ## Lichter -### 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. -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 +Eine kleine LED auf der Doorman-Platine, die vom ESPHome [Status LED](https://esphome.io/components/light/status_led.html) gesteuert wird. Standardmäßig bleibt diese LED eingeschaltet, wenn alles ordnungsgemäß funktioniert, blinkt jedoch bei Problemen. + +Du kannst die LED ausschalten, wenn sie störend wirkt. Selbst im ausgeschalteten Zustand behält sie ihre Funktionalität und blinkt, um auf Probleme hinzuweisen. -### 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. +### Status LED +Eine kleine WS2812B RGB-LED auf der Doorman-Platine, die verwendet wird, um bestimmte Ereignisse anzuzeigen. Die LED kann verschiedene Farben und Muster anzeigen, um visuelles Feedback zu unterschiedlichen Zuständen und Aktionen zu geben. -##### Event Types -- Waiting for WiFi / AP Enabled -- Waiting for Home Assistant to Connect -- Home Assistant Connected -- Ring To Open is Active -- Nuki Pairing Mode is Active -- Nuki Paired Successfully \ No newline at end of file +##### Ereignistypen +- Warten auf WiFi / AP aktiviert +- Warten auf Home Assistant-Verbindung +- Home Assistant verbunden +- Ring To Open ist aktiv +- Nuki Kopplungsmodus ist aktiv +- Nuki erfolgreich gekoppelt \ No newline at end of file