Skip to content

Commit

Permalink
Automatically start Easy Setup
Browse files Browse the repository at this point in the history
  • Loading branch information
AzonInc committed Aug 28, 2024
1 parent 92bf9ad commit bf44d65
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 10 deletions.
4 changes: 3 additions & 1 deletion docs/de/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Nachdem du den Doorman mit deinem Netzwerk verbunden hast, wird er langsam (blau
Du musst deinen Doorman zuerst mit der Gegensprechanlage verbinden. Sieh dir hierfür den Bereich [Verkabelung](#verkabelung) für detaillierte Anweisungen an.
:::

Nachdem du deinen Doorman mit Home Assistant verbunden hast, startet automatisch der `Easy Setup`-Prozess, der weiter unten beschrieben ist. Du musst ihn nicht manuell starten; er wird bei jedem Neustart automatisch gestartet, solange der Prozess nicht abgeschlossen oder abgebrochen wurde.

#### Easy Setup
Um die Konfiguration der wichtigsten Befehle zu erleichtern, kannst du den Easy Setup-Prozess nutzen.

Expand All @@ -37,7 +39,7 @@ Greif entweder auf den internen Webserver deines Doormans zu oder besuche die [E
In `Konfiguration`-Bereich findest du den Button `Easy Setup: Start`. Klicke darauf, um den Einrichtungsprozess zu starten.

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.
Während der Einrichtung pulsiert die RGB-Status-LED türkis, solange du die Aufgabe noch nicht abgeschlossen hast, und bleibt 3 Sekunden lang türkis, nachdem der Befehl gespeichert wurde.

Nach Abschluss der Einrichtung endet der Prozess automatisch und zeigt den entsprechenden Status an.

Expand Down
4 changes: 3 additions & 1 deletion docs/en/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ After connecting Doorman to your network, it will blink slowly (blue) and should
You need to connect your Doorman to the intercom. Please refer to the [Wiring](#wiring) section for detailed instructions.
:::

After connecting your Doorman to Home Assistant, the `Easy Setup` Process will automatically begin as described below. There's no need to start it manually; it will initiate automatically on every restart, provided the process hasn't been completed or canceled.

#### Easy Setup
To simplify the configuration of the key commands, you can use the Easy Setup Process.

Expand All @@ -37,7 +39,7 @@ To get started, either access the internal web server of your Doorman or visit t
In the `Configuration` section, you will find the `Easy Setup: Start` button. Click this button to initiate the setup process.

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.
During the setup, the RGB Status LED will pulse turquoise while waiting for you to complete each task and will remain solid turquoise for 3 seconds after saving the command.

After the setup is complete, the process will automatically end and display the corresponding status.

Expand Down
30 changes: 23 additions & 7 deletions firmware/base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ globals:
restore_value: true
initial_value: '0x1200'

- id: initial_setup_done
type: bool
restore_value: yes
initial_value: "false"

- id: easy_setup_step
type: std::string
restore_value: no
Expand Down Expand Up @@ -109,6 +114,13 @@ esphome:
color_brightness: 60%
- delay: 3s
- script.execute: update_led
- delay: 2s
- if:
condition:
- lambda: return id(initial_setup_done) == false && apartment_doorbell_command != 0;
then:
- button.press: doorman_easy_setup_start


# Enable logging
logger:
Expand Down Expand Up @@ -421,7 +433,7 @@ button:
- platform: template
id: turn_on_light
name: "Turn on the light"
icon: mdi:light
icon: mdi:lightbulb-on
on_press:
- tcs_intercom.send:
command: !lambda "return id(turn_on_light_command);"
Expand Down Expand Up @@ -976,9 +988,9 @@ script:
# LED State: Saved
- light.turn_on:
id: doorman_rgb_status_led
red: 100%
green: 0%
blue: 0%
red: 3%
green: 71%
blue: 67%
effect: none
- delay: 3s

Expand All @@ -997,11 +1009,15 @@ script:
# LED State: Waiting
- light.turn_on:
id: doorman_rgb_status_led
red: 100%
green: 0%
blue: 0%
red: 3%
green: 71%
blue: 67%
effect: pulse
else:
# Initial setup done
- globals.set:
id: initial_setup_done
value: 'true'
# Reset step
- globals.set:
id: easy_setup_step
Expand Down
2 changes: 1 addition & 1 deletion pcb/fabrication-toolkit-options.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"AUTO TRANSLATE": true, "EXCLUDE DNP": false, "EXTRA_LAYERS": ""}
{"AUTO TRANSLATE": false, "EXCLUDE DNP": false, "EXTRA_LAYERS": ""}

0 comments on commit bf44d65

Please sign in to comment.