Skip to content

Commit 61d85cf

Browse files
AzonIncAzonInc
committed
Restructure
1 parent 4172c3f commit 61d85cf

File tree

7 files changed

+191
-172
lines changed

7 files changed

+191
-172
lines changed

‎docs/de/reference/entities.md

Lines changed: 51 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3,85 +3,88 @@ Die Doorman-Firmware stellt standardmäßig viele Entitäten zur Verfügung. Auf
33

44
## Sensoren
55

6-
### Last Bus Command
6+
### Last Bus Command <Badge type="tip" text="last_bus_command" />
77
Meldet jeden veröffentlichten Befehl auf dem Bus.
88

9-
### Uptime
9+
### Uptime <Badge type="tip" text="doorman_uptime" />
1010
Meldet die Betriebszeit in Sekunden.
1111

12-
### Nuki Battery Level
12+
### Nuki Battery Level <Badge type="tip" text="nuki_battery_level" /> <Badge type="info" text="Nuki Bridge only" />
1313
Meldet den Akkustand des verbundenen Nuki Smart Locks.
1414

1515

1616
## Binäre Sensoren
1717

18-
### Entrance Doorbell
18+
### Entrance Doorbell <Badge type="tip" text="entrance_doorbell" />
1919
Wird aktiviert, wenn der Befehl `entrance_doorbell_command` empfangen wird.
2020

21-
### Apartment Doorbell
21+
### Apartment Doorbell <Badge type="tip" text="apartment_doorbell" />
2222
Wird aktiviert, wenn der Befehl `apartment_doorbell_command` empfangen wird.
2323

24-
### Pick up phone
24+
### Pick up phone <Badge type="tip" text="pick_up_phone" /> <Badge type="info" text="Disabled by default" />
2525
Wird aktiviert, wenn der Befehl `pick_up_phone_command` empfangen wird.
2626

27-
### Hang up phone
27+
### Hang up phone <Badge type="tip" text="hang_up_phone" /> <Badge type="info" text="Disabled by default" />
2828
Wird aktiviert, wenn der Befehl `hang_up_phone_command` empfangen wird.
2929

30-
### Function Key
31-
Wird aktiviert, wenn der Befehl `function_key_command` empfangen wird.
30+
### Function Button <Badge type="tip" text="function_button" />
31+
Wird aktiviert, wenn der Befehl `function_button_command` empfangen wird.
3232

33-
### Turn on light: Trigger
33+
### Light Button <Badge type="tip" text="light_button" />
3434
Wird aktiviert, wenn der Befehl `turn_on_light_command` empfangen wird.
3535

36-
### External Button
36+
### Boot Button <Badge type="tip" text="doorman_boot_button" /> <Badge type="info" text="Disabled by default" /> <Badge type="info" text="Internal" />
37+
Wird aktiviert, wenn der Boot Button gedrückt wird.
38+
39+
### External Button <Badge type="tip" text="doorman_external_button" /> <Badge type="info" text="Disabled by default" />
3740
Wird aktiviert, wenn der externe Button gedrückt wird.
3841

39-
### Nuki Connected
42+
### Nuki Connected <Badge type="tip" text="nuki_connected" /> <Badge type="info" text="Nuki Bridge only" />
4043
Wird aktiviert, wenn das gekoppelte Nuki Smart Lock verbunden ist.
4144

42-
### Nuki Paired
45+
### Nuki Paired <Badge type="tip" text="nuki_paired" /> <Badge type="info" text="Nuki Bridge only" />
4346
Wird aktiviert, wenn ein Nuki Smart Lock gekoppelt ist.
4447

45-
### Nuki Battery Critical
48+
### Nuki Battery Critical <Badge type="tip" text="nuki_battery_critical" /> <Badge type="info" text="Nuki Bridge only" />
4649
Wird aktiviert, wenn das gekoppelte Nuki Smart Lock einen kritischen Akkustand hat.
4750

48-
### Nuki Door Sensor
51+
### Nuki Door Sensor <Badge type="tip" text="nuki_door_sensor" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
4952
Keine Beschreibung vorhanden.
5053

51-
### Nuki Door Sensor State
54+
### 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" />
5255
Meldet den Türsensorstatus des gekoppelten Nuki Smart Locks.
5356

5457

5558
## Text Sensors
5659

57-
### Interactive Setup: Status
60+
### Interactive Setup: Status <Badge type="tip" text="doorman_interactive_setup_status" />
5861
Zeigt den aktuellen Status vom [Interactive Setup](../guide/getting-started#interactive-setup) Prozess an.
5962

6063

6164
## Schalter
6265

63-
### Ring To Open
66+
### Ring To Open <Badge type="tip" text="doorman_ring_to_open" />
6467
Steuert die [Ring To Open](../guide/automation/ring-to-open) Automatisierung.
6568

66-
### Ring To Open: Confirmation
69+
### Ring To Open: Confirmation <Badge type="tip" text="doorman_ring_to_open_confirmation" /> <Badge type="info" text="Disabled by default" />
6770
Steuert die Einschaltbestätigung für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung.
6871

69-
### Relay
72+
### Relay <Badge type="tip" text="doorman_relay" /> <Badge type="info" text="Disabled by default" />
7073
Steuert das eingebaute Relais.
7174

72-
### Nuki Pairing Mode
75+
### Nuki Pairing Mode <Badge type="tip" text="nuki_pairing_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
7376
Steuert den Nuki Kopplungsmodus.
7477

7578

7679
## Buttons
7780

78-
### Open Entrance Door
81+
### Open Entrance Door <Badge type="tip" text="open_entrance_door" />
7982
Öffnet die Eingangstür, indem der Befehl `open_entrance_door_command` auf dem Bus gesendet wird.
8083

81-
### Open Second Door
84+
### Open Second Door <Badge type="tip" text="open_second_door" /> <Badge type="info" text="Disabled by default" />
8285
Öffnet die zweite Tür, indem der Befehl `open_second_door_command` auf dem Bus gesendet wird.
8386

84-
### Turn on the light
87+
### Turn on the light <Badge type="tip" text="turn_on_light" /> <Badge type="info" text="Disabled by default" />
8588
Schaltet das Licht ein, indem der Befehl `turn_on_light_command` auf dem Bus gesendet wird.
8689

8790
### Interactive Setup: Start <Badge type="tip" text="doorman_interactive_setup_start" />
@@ -90,16 +93,16 @@ Startet den [Interactive Setup](../guide/getting-started#interactive-setup) Proz
9093
### Interactive Setup: Cancel <Badge type="tip" text="doorman_interactive_setup_cancel" />
9194
Beendet den [Interactive Setup](../guide/getting-started#interactive-setup) Prozess.
9295

93-
### Nuki Unpair Device
96+
### Nuki Unpair Device <Badge type="tip" text="nuki_unpair_device" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
9497
Entkoppelt dein Nuki Smart Lock.
9598

96-
### Restart
99+
### Restart <Badge type="tip" text="doorman_restart" /> <Badge type="info" text="Disabled by default" />
97100
Startet Doorman neu, nützlich nach Konfigurationsänderungen, die einen Neustart erfordern.
98101

99-
### Safe mode
102+
### Safe mode <Badge type="tip" text="doorman_safe_mode" /> <Badge type="info" text="Disabled by default" />
100103
Startet Doorman im Sicherheitsmodus neu, nützlich für OTA-Updates, wenn die Einheit zu beschäftigt ist.
101104

102-
### Restore Factory Settings
105+
### Restore Factory Settings <Badge type="tip" text="doorman_factory_reset" /> <Badge type="info" text="Disabled by default" />
103106
Startet Doorman neu und lädt die Werkseinstellungen.
104107

105108
::: Gefahr MIT GROẞER VORSICHT VERWENDEN
@@ -110,33 +113,35 @@ Wenn du WiFi über das Captive Portal, Improv Serial oder Improv BLE konfigurier
110113

111114
## Eingabe für Text
112115

113-
### Command: Apartment Doorbell
116+
### Command: Apartment Doorbell <Badge type="tip" text="apartment_doorbell_command_input" />
114117
Legt den Code fest, der gesendet wird, wenn jemand an der Wohnungsklingel läutet.
115118

116-
### Command: Entrance Doorbell
119+
### Command: Entrance Doorbell <Badge type="tip" text="entrance_doorbell_command_input" />
117120
Legt den Code fest, der gesendet wird, wenn jemand an der Eingangsklingel läutet.
118121

119-
### Command: Open Entrance Door
122+
### Command: Open Entrance Door <Badge type="tip" text="open_entrance_door_command_input" />
120123
Legt den Code fest, der gesendet wird, wenn du den Knopf zum Öffnen der Eingangstür drückst.
121124

122-
### Command: Open Second Door
125+
### Command: Open Second Door <Badge type="tip" text="open_second_door_command_input" /> <Badge type="info" text="Disabled by default" />
123126
Legt den Code fest, der gesendet wird, wenn du den Knopf zum Öffnen der zweiten Tür drückst.
124127

125-
### Command: Pick up phone
128+
### Command: Pick up phone <Badge type="tip" text="pick_up_phone_command_input" /> <Badge type="info" text="Disabled by default" />
126129
Legt den Code fest, der gesendet wird, wenn du den Hörer abnimmst.
127130

128-
### Command: Hang up phone
131+
### Command: Hang up phone <Badge type="tip" text="hang_up_phone_command_input" /> <Badge type="info" text="Disabled by default" />
129132
Legt den Code fest, der gesendet wird, wenn du den Hörer auflegst.
130133

131-
### Command: Turn on light
134+
### Command: Turn on light <Badge type="tip" text="turn_on_light_command_input" /> <Badge type="info" text="Disabled by default" />
132135
Legt den Code fest, der gesendet wird, wenn du den Knopf zum Einschalten des Flurlichts drückst.
133136

134-
### Command: Function Key
135-
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.
137+
### Command: Function Button <Badge type="tip" text="function_button_command_input" /> <Badge type="info" text="Disabled by default" />
138+
Legt den Code fest, der gesendet wird, wenn du den Funktionstaster (Kreis) drückst. Der Funktionstaster wird üblicherweise nicht genutzt.
139+
140+
Aus diesem Grund wird er verwendet, um die [Ring To Open](../guide/automation/ring-to-open) Automatisierung umzuschalten.
136141

137142
## Eingabe für Zahlenwert
138143

139-
### Ring To Open: Delay
144+
### Ring To Open: Delay <Badge type="tip" text="doorman_ring_to_open_delay" /> <Badge type="info" text="Disabled by default" />
140145
Legt die Verzögerung für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung fest.
141146

142147
::: tip
@@ -145,7 +150,7 @@ Das Einstellen der Verzögerung auf das Maximum (60 Sekunden) führt dazu, dass
145150

146151
## Dropdowns
147152

148-
### Ring To Open: Timeout
153+
### Ring To Open: Timeout <Badge type="tip" text="doorman_ring_to_open_timeout_mode" /> <Badge type="info" text="Disabled by default" />
149154
Legt den Timeout-Modus für die [Ring To Open](../guide/automation/ring-to-open) Automatisierung fest.
150155

151156
##### Modi:
@@ -155,12 +160,12 @@ Legt den Timeout-Modus für die [Ring To Open](../guide/automation/ring-to-open)
155160

156161
## Schlösser
157162

158-
### Nuki Lock
163+
### Nuki Lock <Badge type="tip" text="nuki_smart_lock" /> <Badge type="info" text="Nuki Bridge only" />
159164
Repräsentiert die Schlosseinheit für dein gekoppeltes Nuki Smart Lock.
160165

161166
## Ereignisse
162167

163-
### Doorbell Pattern
168+
### Doorbell Pattern <Badge type="tip" text="doorbell_pattern" />
164169
Wird ausgelöst, wenn ein Klingelmuster erkannt wird. Erfahre mehr über Musterereignisse [hier](../guide/automation/pattern-events).
165170

166171
##### Ereignistypen
@@ -171,7 +176,7 @@ Wird ausgelöst, wenn ein Klingelmuster erkannt wird. Erfahre mehr über Mustere
171176
- entrance_double
172177
- entrance_triple
173178

174-
### Phone pick up Pattern
179+
### Phone pick up Pattern <Badge type="tip" text="phone_pick_up_pattern" />
175180
Wird ausgelöst, wenn ein Abhebe-Muster des Telefons erkannt wird. Erfahre mehr über Musterereignisse [hier](../guide/automation/pattern-events).
176181

177182
##### Ereignistypen
@@ -181,20 +186,20 @@ Wird ausgelöst, wenn ein Abhebe-Muster des Telefons erkannt wird. Erfahre mehr
181186

182187
## Updates
183188

184-
### Firmware
189+
### Firmware <Badge type="info" text="Stable" /> <Badge type="tip" text="update_http_request_stable" />
185190
Zeigt an, ob ein Update im stabilen Zweig verfügbar ist, und bietet eine Installation über das HTTP OTA-Updateverfahren an.
186191

187-
### Firmware
192+
### Firmware <Badge type="info" text="Development" /> <Badge type="tip" text="update_http_request_dev" />
188193
Zeigt an, ob ein Update im Entwicklungszweig verfügbar ist, und bietet eine Installation über das HTTP OTA-Updateverfahren an.
189194

190195
## Lichter
191196

192-
### Status LED
197+
### Status LED <Badge type="danger" text="Red" /> <Badge type="tip" text="doorman_status_led" />
193198
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.
194199

195200
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.
196201

197-
### Status LED
202+
### Status LED <Badge type="warning" text="RGB" /> <Badge type="tip" text="doorman_rgb_status_led" />
198203
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.
199204

200205
##### Ereignistypen

‎docs/en/reference/entities.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,15 @@ Activates whenever the `pick_up_phone_command` command is received.
2727
### Hang up phone <Badge type="tip" text="hang_up_phone" /> <Badge type="info" text="Disabled by default" />
2828
Activates whenever the `hang_up_phone_command` command is received.
2929

30-
### Function Key <Badge type="tip" text="function_key" /> <Badge type="info" text="Internal" />
31-
Activates whenever the `function_key_command` command is received.
30+
### Function Button <Badge type="tip" text="function_button" />
31+
Activates whenever the `function_button_command` command is received.
3232

33-
### Turn on light: Trigger <Badge type="tip" text="turn_on_light_trigger" /> <Badge type="info" text="Internal" />
33+
### Light Button <Badge type="tip" text="light_button" />
3434
Activates whenever the `turn_on_light_command` command is received.
3535

36+
### Boot Button <Badge type="tip" text="doorman_boot_button" /> <Badge type="info" text="Disabled by default" /> <Badge type="info" text="Internal" />
37+
Activates when the boot button is pressed.
38+
3639
### External Button <Badge type="tip" text="doorman_external_button" /> <Badge type="info" text="Disabled by default" />
3740
Activates when the external button is pressed.
3841

@@ -54,7 +57,7 @@ Reports the door sensor state of the paired Nuki smart lock.
5457

5558
## Text Sensors
5659

57-
### Interactive Setup: Status
60+
### Interactive Setup: Status <Badge type="tip" text="doorman_interactive_setup_status" />
5861
Shows the current state of [Interactive Setup](../guide/getting-started#interactive-setup) for Commands.
5962

6063

@@ -131,10 +134,10 @@ Sets the code sent when you hang up the phone.
131134
### Command: Turn on light <Badge type="tip" text="turn_on_light_command_input" /> <Badge type="info" text="Disabled by default" />
132135
Sets the code sent when you press the button to turn on the hallway light.
133136

134-
### Command: Function Key <Badge type="tip" text="function_key_command_input" /> <Badge type="info" text="Disabled by default" />
135-
Sets the code used to toggle the [Ring To Open](../guide/automation/ring-to-open) automation.
136-
The function button is often used for this purpose as it is usually not utilized.
137+
### Command: Function Button <Badge type="tip" text="function_button_command_input" /> <Badge type="info" text="Disabled by default" />
138+
Sets the code that is sent when you press the function button (circle). The function button is usually not used.
137139

140+
For this reason, it is used to toggle the [Ring To Open](../guide/automation/ring-to-open) automation."
138141

139142
## Numbers
140143

‎firmware/addons/interactive-setup.yaml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ globals:
1111
restore_value: no
1212
initial_value: '""'
1313

14-
binary_sensor:
15-
- id: !extend esphome_ready
16-
on_press:
14+
esphome:
15+
on_boot:
16+
then:
1717
- delay: 2s
1818
- if:
1919
condition:
@@ -24,7 +24,7 @@ binary_sensor:
2424
apartment_doorbell_command == 0 &&
2525
entrance_doorbell_command == 0 &&
2626
pick_up_phone_command == 0 &&
27-
function_key_command == 0;
27+
function_button_command == 0;
2828
then:
2929
- button.press: doorman_interactive_setup_start
3030

@@ -51,12 +51,14 @@ button:
5151
first_step: false
5252
entity_category: CONFIG
5353

54+
5455
text_sensor:
5556
- platform: template
56-
id: doorman_interactive_setup_step
57+
id: doorman_interactive_setup_status
5758
name: "Interactive Setup: Status"
5859
entity_category: CONFIG
5960

61+
6062
# Extend TCS Intercom Component
6163
tcs_intercom:
6264
bus_command:
@@ -86,11 +88,11 @@ tcs_intercom:
8688
# LED State
8789
- script.execute:
8890
id: interactive_setup_next
89-
next_step: "function_key_command"
91+
next_step: "function_button_command"
9092
text: "Press the 'Function (Circle)' Button"
9193
first_step: false
9294

93-
# Step: function_key_command
95+
# Step: function_button_command
9496
- if:
9597
condition:
9698
- lambda: |-
@@ -99,15 +101,15 @@ tcs_intercom:
99101
{
100102
str.erase(4); // Ingore system commands
101103
}
102-
return id(interactive_setup_step) == "function_key_command" && str != "0000";
104+
return id(interactive_setup_step) == "function_button_command" && str != "0000";
103105
then:
104106
# Save Command
105107
- lambda: |-
106108
unsigned long number = 0;
107109
if(std::string(x.c_str()) != "") {
108110
number = std::stoul(x.c_str(), nullptr, 16);
109111
}
110-
id(function_key_command) = number;
112+
id(function_button_command) = number;
111113
ESP_LOGI("MAIN", "Setup: Saved Step: %s", id(interactive_setup_step).c_str());
112114
# LED State
113115
- script.execute:
@@ -194,6 +196,7 @@ tcs_intercom:
194196
text: "Setup complete"
195197
first_step: false
196198

199+
197200
script:
198201
- id: interactive_setup_next
199202
parameters:
@@ -210,7 +213,7 @@ script:
210213
id: interactive_setup_step
211214
value: '""'
212215
- text_sensor.template.publish:
213-
id: doorman_interactive_setup_step
216+
id: doorman_interactive_setup_status
214217
state: "Saving command..."
215218
# LED State: Saved
216219
- light.turn_on:
@@ -222,7 +225,7 @@ script:
222225
- delay: 3s
223226

224227
- text_sensor.template.publish:
225-
id: doorman_interactive_setup_step
228+
id: doorman_interactive_setup_status
226229
state: !lambda "return text.c_str();"
227230

228231
- if:

0 commit comments

Comments
 (0)