DoorBird


The doorbird implementation allows you to integrate your DoorBird device in Home Assistant.

Setup

The user, which you are going to use with Home Assistant, needs the “API-Operator” permission enabled.

Configuration

To connect your device, add the following to your configuration.yaml file:

# Example configuration.yaml entry
doorbird:
  token: YOUR_DOORBIRD_TOKEN
  devices:
    - host: DOORBIRD_IP_OR_HOSTNAME
      username: YOUR_USERNAME
      password: YOUR_PASSWORD

Configuration Variables

token

(string)(Required)Token to be used to authenticate Doorbird calls to Home Assistant.

devices

(list)(Required)List of doorbird devices.

host

(string)(Required)The LAN IP address or hostname of your device. You can find this by going to the DoorBird Online check and entering the information from the paper that was included in the box.

username

(string)(Required)The username of a non-administrator user account on the device.

password

(string)(Required)The password for the user specified.

name

(string)(Optional)Custom name for this device.

hass_url_override

(string)(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.

monitored_conditions

(string)(Optional)Monitor motion and/or doorbell events for this device.

doorbell

Monitor doorbell events

motion

Monitor motion events (Motion monitoring must be enabled on the doorstation via DoorBird app).

The configuration above is also used by the following platforms:

  • Camera: View live and historical event based images.
  • Switch: Enable control of relays and camera night vision.

Full example

doorbird:
  token: YOUR_DOORBIRD_TOKEN
  devices:
    - host: DOORBIRD_IP_OR_HOSTNAME
      username: YOUR_USERNAME
      password: YOUR_PASSWORD
      hass_url_override: HASS_URL
      name: Front Door
    - host: DOORBIRD_IP_OR_HOSTNAME
      username: YOUR_USERNAME
      password: YOUR_PASSWORD
      name: Driveway Gate
      monitored_conditions:
        - doorbell
        - motion

Motion and Doorbell Events

Home Assistant will fire an event any time a monitored_condition happens on a doorstation. Event names are created using the format doorbird_{station}_{event} (Examples: doorbird_side_entry_button, doorbird_side_entry_motion). You can verify the assigned event names in the Home Assistant log file.

Home Assistant will register the monitored conditions with the device as schedule entries that correspond to favorites on startup. If you remove monitored conditions from your configuration, Home Assistant will attempt to remove these items from the device. However, in some cases, such as if the IP address of the machine running Home Assistant changes or if the device is renamed in your configuration, this will not work correctly and some data will be left in device storage.

This should not cause any problems, but if you would like to remove it, open a new browser window and navigate to {Home Assistant URL}/api/doorbird/clear/{DoorBird name}. Replace {Home Assistant URL} with the full path to your running instance, such as http://localhost:8123. Replace {DoorBird name} with the name specified in your configuration for the device you would like to clear, or how it appears in the Home Assistant UI if you have not specified one, such as DoorBird 1. Then use the mobile app to reschedule push notifications.

Please note that clearing device registrations will prevent the device from sending pushes to Home Assistant until you restart your instance with the component enabled. It could also affect other third-party applications you may use with your DoorBird device. It will not break the official mobile app in any way, so mobile push notifications will still work.

Event Data

Each event includes live image and live video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use html5_viewer_url on a notification to be linked directly to the live view of the device that triggered the automation.

The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration.

Automation Example

- alias: Doorbird Ring
  trigger:
    platform: event
    event_type: doorbird_side_entry_button
  action:
    service: light.turn_on
      entity_id: light.side_entry_porch