Skip to content

Update for new DoorBird API #5487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Klikini wants to merge 1 commit into from
Closed

Update for new DoorBird API #5487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions source/_components/doorbird.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ footer: true
logo: doorbird.png
ha_category: Hub
ha_release: "0.54"
ha_iot_class: "Local Polling"
ha_iot_class: "Local Push"
---

The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant.
Expand All @@ -23,21 +23,19 @@ doorbird:
host: DOORBIRD_IP_OR_HOSTNAME
username: YOUR_USERNAME
password: YOUR_PASSWORD
hass_url_override: HASS_IP
doorbell_events: true
```

Configuration variables:

- **host** (*Required*): The LAN IP address or hostname of your device. You can find this by going to the [DoorBird Online check](http://www.doorbird.com/checkonline) and entering the information from the paper that was included in the box.
- **username** (*Required*): The username of a non-administrator user account on the device.
- **password** (*Required*): The password for the user specified.
- **doorbell_events** (*Optional*): Setting this to `true` this will register a callback URL with the device so that events can be published to the event bus when the doorbell rings.
- **doorbell_events** (*Optional*): Setting this to `true` will register a callback URL with the device so that events can be published to the event bus when the doorbell rings.
- **motion_events** (*Optional*): Setting this to `true` will register a callback URL with the device so that events can be published to the event bus when the device detects motion.
- **doorbell_number** (*Optional*): If your DoorBird device is shared and/or has multiple doorbells, specify the number of the doorbell to monitor using this variable. Defaults to 1, which is the only doorbell on most units.
- **hass_url_override** (*Optional*): If your DoorBird cannot connect to the machine running Home Assistant because you are using dynamic DNS or some other HTTP configuration (such as HTTPS), specify the LAN IP of the machine here to force a LAN connection.

<p class="note warning">
Enabling `doorbell_events` will delete all other registered push notification services with the device every time Home Assistant starts. This will not affect notifications delivered by the DoorBird mobile app.
</p>

### Doorbell Sound Examples

You can create an automation that triggers on event `doorbird_doorbell` to play a doorbell sound when the Doorbird button is pressed. This should work with any media player.
Expand Down
9 changes: 1 addition & 8 deletions source/_components/switch.doorbird.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_release: "0.54"
ha_iot_class: "Local Push"
---

The `doorbird` switch platform allows you to power relays in your [DoorBird](http://www.doorbird.com/) video doorbell device.
The `doorbird` switch platform allows you to turn on the IR lights and power the relays in your [DoorBird](http://www.doorbird.com/) video doorbell device.

<p class='note'>
You must have the [DoorBird component](/components/doorbird/) configured to use this switch.
Expand All @@ -25,11 +25,4 @@ To enable this switch, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
switch:
- platform: doorbird
switches:
- light_on
- open_door
```

Configuration variables:

- **switches** (*Required*): A list of switches to include. Possible entries are `light_on` for control of the IR array and `open_door` for control of an electronic door strike or alarm.