Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AzonInc committed Nov 12, 2024
1 parent a8625d3 commit e1c2098
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/de/guide/automation/ring-to-open.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Wenn du diese Einstellung aktivierst, wird deine Wohnungs-Klingel jedes Mal klin
:::

::: info Delay
Diese Einstellung erlaubt es dir, eine Verzögerung für den `Open Entrance Door Command` zu konfigurieren. Wenn du die Verzögerung auf 60 Sekunden einstellst, wird bei jeder Ausführung der Automation zufällig eine Verzögerung zwischen 5 und 15 Sekunden ausgewählt.
Diese Einstellung erlaubt es dir, eine Verzögerung für den Türöffner zu konfigurieren. Wenn du die Verzögerung auf 60 Sekunden einstellst, wird bei jeder Ausführung der Automation zufällig eine Verzögerung zwischen 5 und 15 Sekunden ausgewählt.
:::

::: info Timeout
Expand Down
6 changes: 1 addition & 5 deletions docs/de/guide/firmware/custom-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,4 @@

GitHub-Nutzer [peteh](https://github.com/peteh) hat eine Custom Firmware für Doorman entwickelt.

Für weitere Informationen zur Firmware [klicke hier](https://github.com/peteh/doorman).

::: tip
Du musst einige Einstellungen (GPIO, Board-Typ, Flash-Größe) anpassen, um die Kompatibilität mit dem Doorman S3 sicherzustellen.
:::
Für weitere Informationen zur Firmware [klicke hier](https://github.com/peteh/doorman).
37 changes: 35 additions & 2 deletions docs/de/reference/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@ Wird aktiviert, wenn der Befehl vom Typ `door_call` mit zweiter Außenstation `a
Wird aktiviert, wenn der Befehl vom Typ `floor_call` empfangen wird.

### Pick up phone <Badge type="tip" text="pick_up_phone" /> <Badge type="info" text="Deaktiviert" />
Wird aktiviert, wenn der Befehl vom Typ `start_talking_door_station` empfangen wird.
Wird aktiviert, wenn der Befehl vom Typ `start_talking` empfangen wird.

### Pick up phone (door call) <Badge type="tip" text="pick_up_phone_door_call" /> <Badge type="info" text="Deaktiviert" />
Wird aktiviert, wenn der Befehl vom Typ `start_talking_door_call` empfangen wird.

### Hang up phone <Badge type="tip" text="hang_up_phone" /> <Badge type="info" text="Deaktiviert" />
Wird aktiviert, wenn der Befehl vom Typ `stop_talking_door_station` empfangen wird.
Wird aktiviert, wenn der Befehl vom Typ `stop_talking` empfangen wird.

### Hang up phone (door call) <Badge type="tip" text="hang_up_phone_door_call" /> <Badge type="info" text="Deaktiviert" />
Wird aktiviert, wenn der Befehl vom Typ `stop_talking_door_call` empfangen wird.

### Function Button <Badge type="tip" text="function_button" /> <Badge type="info" text="Deaktiviert" />
Wird aktiviert, wenn der Befehl vom Typ `control_function` empfangen wird.
Expand Down Expand Up @@ -66,6 +72,12 @@ Meldet den Türsensorstatus des gekoppelten Nuki Smart Locks.
### Nuki Last Unlock User <Badge type="tip" text="nuki_last_unlock_user" /> <Badge type="info" text="Nuki Bridge" />
Reports the last user who locked or unlocked the Nuki smart lock.

### Nuki Last Lock Action <Badge type="tip" text="nuki_last_lock_action" /> <Badge type="info" text="Nuki Bridge" /> <Badge type="info" text="Deaktiviert" />
Reports the last lock action of the Nuki smart lock.

### Nuki Last Lock Action Trigger <Badge type="tip" text="nuki_last_lock_action_trigger" /> <Badge type="info" text="Nuki Bridge" /> <Badge type="info" text="Deaktiviert" />
Reports the last log action trigger of the Nuki smart lock.


## Schalter

Expand Down Expand Up @@ -114,6 +126,12 @@ Controls the Nuki Smart Lock Auto Lock Immediately setting.
### Nuki Auto Unlock: Disable <Badge type="tip" text="nuki_auto_unlock_disabled" /> <Badge type="info" text="Nuki Bridge" /> <Badge type="info" text="Deaktiviert" />
Controls the Nuki Smart Lock Auto Unlock Disable setting.

### Nuki Single Lock <Badge type="tip" text="nuki_single_lock" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Single Lock setting.

### Nuki Daylight Saving Time <Badge type="tip" text="nuki_dst_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock DST Mode setting.

### Nuki Automatic Updates <Badge type="tip" text="nuki_auto_update" /> <Badge type="info" text="Nuki Bridge" /> <Badge type="info" text="Deaktiviert" />
Controls the Nuki Smart Lock Automatic Updates setting.

Expand Down Expand Up @@ -272,6 +290,21 @@ Controls the Nuki Smart Lock Fob Action 3 setting.
- Lock n Go
- Intelligent

### Nuki Timezone <Badge type="tip" text="nuki_timezone" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Timezone setting.

##### Options:
Check out the nuki developer documentation.

### Nuki Advertising Mode <Badge type="tip" text="nuki_advertising_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Advertising Mode setting.

##### Options:
- Automatic
- Normal
- Slow
- Slowest


## Schlösser

Expand Down
4 changes: 2 additions & 2 deletions docs/en/guide/automation/ring-to-open.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ You can enable or disable the Ring To Open automation using the switch in Home A

#### Configuration Options:
::: info Confirmation
If you enable this setting, your apartment doorbell will ring each time you activate the Ring To Open automation via command.
If you enable this setting, your apartment doorbell will ring each time you activate the Ring To Open automation via command (function button).
:::

::: info Delay
This setting allows you to configure a delay for the `Open Entrance Door Command`. If you set the delay to 60 seconds, it will randomly select a delay between 5 and 15 seconds whenever the automation is executed.
This setting allows you to configure a delay for the door opener. If you set the delay to 60 seconds, it will randomly select a delay between 5 and 15 seconds whenever the automation is executed.
:::

::: info Timeout
Expand Down
6 changes: 1 addition & 5 deletions docs/en/guide/firmware/custom-firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,4 @@

Github user [peteh](https://github.com/peteh) has developed custom firmware for Doorman circuits.

For more information about the custom firmware, [click here](https://github.com/peteh/doorman).

::: tip
You will need to adjust a few settings (GPIO, board type, flash size) to ensure compatibility with Doorman S3.
:::
For more information about the custom firmware, [click here](https://github.com/peteh/doorman).
40 changes: 38 additions & 2 deletions docs/en/reference/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@ Activates whenever the `door_call` command type with the second entrance door st
Activates whenever the `floor_call` command type is received.

### Pick up phone <Badge type="tip" text="pick_up_phone" /> <Badge type="info" text="Disabled by default" />
Activates whenever the `start_talking_door_station` command type is received.
Activates whenever the `start_talking` command type is received.

### Pick up phone (door call) <Badge type="tip" text="pick_up_phone_door_call" /> <Badge type="info" text="Disabled by default" />
Activates whenever the `start_talking_door_call` command type is received.

### Hang up phone <Badge type="tip" text="hang_up_phone" /> <Badge type="info" text="Disabled by default" />
Activates whenever the `stop_talking_door_station` command type is received.
Activates whenever the `stop_talking` command type is received.

### Hang up phone (door call) <Badge type="tip" text="hang_up_phone_door_call" /> <Badge type="info" text="Disabled by default" />
Activates whenever the `stop_talking_door_call` command type is received.

### Function Button <Badge type="tip" text="function_button" /> <Badge type="info" text="Disabled by default" />
Activates whenever the `control_function` command type is received.
Expand Down Expand Up @@ -66,6 +72,12 @@ Reports the door sensor state of the paired Nuki smart lock.
### Nuki Last Unlock User <Badge type="tip" text="nuki_last_unlock_user" /> <Badge type="info" text="Nuki Bridge only" />
Reports the last user who locked or unlocked the Nuki smart lock.

### Nuki Last Lock Action <Badge type="tip" text="nuki_last_lock_action" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Reports the last lock action of the Nuki smart lock.

### Nuki Last Lock Action Trigger <Badge type="tip" text="nuki_last_lock_action_trigger" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Reports the last log action trigger of the Nuki smart lock.


## Switches

Expand Down Expand Up @@ -114,6 +126,12 @@ Controls the Nuki Smart Lock Auto Lock Immediately setting.
### Nuki Auto Unlock: Disable <Badge type="tip" text="nuki_auto_unlock_disabled" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Auto Unlock Disable setting.

### Nuki Single Lock <Badge type="tip" text="nuki_single_lock" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Single Lock setting.

### Nuki Daylight Saving Time <Badge type="tip" text="nuki_dst_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock DST Mode setting.

### Nuki Automatic Updates <Badge type="tip" text="nuki_auto_update" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Automatic Updates setting.

Expand Down Expand Up @@ -172,6 +190,9 @@ Sets the intercom phone handset volume.
### Nuki LED: Brightness <Badge type="tip" text="nuki_led_brightness" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock LED Brightness setting.

### Nuki Timezone: Offset <Badge type="tip" text="nuki_timezone_offset" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Timezone offset setting (Lock v1).

### Nuki Security Pin <Badge type="tip" text="nuki_security_pin" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Sets the Nuki Bridge Security Pin to authenticate against the Nuki Smart Lock.

Expand Down Expand Up @@ -269,6 +290,21 @@ Controls the Nuki Smart Lock Fob Action 3 setting.
- Lock n Go
- Intelligent

### Nuki Timezone <Badge type="tip" text="nuki_timezone" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Timezone setting.

##### Options:
Check out the nuki developer documentation.

### Nuki Advertising Mode <Badge type="tip" text="nuki_advertising_mode" /> <Badge type="info" text="Nuki Bridge only" /> <Badge type="info" text="Disabled by default" />
Controls the Nuki Smart Lock Advertising Mode setting.

##### Options:
- Automatic
- Normal
- Slow
- Slowest


## Locks

Expand Down
26 changes: 13 additions & 13 deletions docs/en/reference/esphome-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,16 +387,16 @@ Here are the available setting types you can use to update the settings of your
## Model Setting availability
Here are the available settings for specific indoor station models:

| Model | Available settings |
|------------------|------------------------------------------------------------------------------------------------------------|
| `TCS ISH1030` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call` |
| `TCS ISH3030` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS ISH3230` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS ISH3340` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS ISW3030` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS ISW3230` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS ISW3340` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `TCS IVH3222` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call` |
| `Koch TC50` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `Koch TCH50` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| `Koch TCH50P` | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| Model | Available settings |
|----------------|------------------------------------------------------------------------------------------------------------|
| TCS ISH1030 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call` |
| TCS ISH3030 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS ISH3230 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS ISH3340 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS ISW3030 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS ISW3230 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS ISW3340 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| TCS IVH3222 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call` |
| Koch TC50 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| Koch TCH50 | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |
| Koch TCH50P | `ringtone_floor_call`, `ringtone_door_call`, `ringtone_internal_call`, `volume_ringtone`, `volume_handset` |

0 comments on commit e1c2098

Please sign in to comment.