home-assistant.io/source/_components/doorbird.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class	redirect_from
page	DoorBird	Instructions on how to integrate your DoorBird video doorbell with Home Assistant.	2017-08-06 11:30	true	false	true	true	doorbird.png	Doorbell Camera Switch	0.54	Local Push	/components/camera.doorbird/ /components/switch.doorbird/

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

There is currently support for the following device types within Home Assistant:

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

{% linkable_title Setup %}

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

{% linkable_title 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 %} token: description: Token to be used to authenticate Doorbird calls to Home Assistant. This can be obtained from your "Digital Passport" document provided with your Doorbird. required: true type: string devices: description: List of Doorbird devices. required: true type: list keys: host: description: 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. required: true type: string username: description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on Doorbird. It is recommended to set up a new account on your Doorbird for use with Home Assistant. This can be added via the Doorbird App by choosing Administration -> (User) Add. When the new account is created, you will need to enable the permission "API-Operator" in the "permissions" option. required: true type: string password: description: The password for the user specified. required: true type: string name: description: Custom name for this device. required: false type: string hass_url_override: description: 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. required: false type: string monitored_conditions: description: Monitor motion and/or doorbell events for this device. required: false type: string keys: doorbell: description: Monitor doorbell events. motion: description: Monitor motion events (Motion monitoring must be enabled on the doorstation via DoorBird app). relay: description: Monitor relay events. This event is fired even if a relay is not physically connected to the door station. Can be used to lock/unlock any smart lock present in Home Assistant via the Doorbird app.

{% endconfiguration %}

{% linkable_title 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
        - relay

{% linkable_title 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 Available Events list on the Events developer view.

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.

{% linkable_title Event Data %}

Each event includes live image and 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 following keys are available on event_data:

• timestamp
• live_video_url
• live_image_url
• rtsp_live_video_url
• html5_viewer_url

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.

{% linkable_title 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

{% linkable_title Camera %}

The doorbird implementation allows you to view the live video, the last doorbell ring image, and the last motion sensor image from your DoorBird device in Home Assistant.

{% linkable_title Configuration %}

To enable the camera, add the following to your configuration.yaml file:

# Example configuration.yaml entry
camera:
  - platform: doorbird

{% linkable_title Switch %}

The doorbird switch platform allows you to power connected relays and trigger the IR array in your DoorBird video doorbell device.

To enable this switch, add the following lines to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: doorbird