Doorbird integration

basschipper · December 28, 2017, 7:58pm

Although the api manual states that the history.cgi event param is not mandatory, it however seems like it is!

Test without event param:

➜  ~ curl -u user0001:passwd -v http://192.168.1.9/bha-api/history.cgi\?index\=1
*   Trying 192.168.1.9...
* TCP_NODELAY set
* Connected to 192.168.1.9 (192.168.1.9) port 80 (#0)
* Server auth using Basic with user 'user0001'
> GET /bha-api/history.cgi?index=1 HTTP/1.1
> Host: 192.168.1.9
> Authorization: Basic #hash
> User-Agent: curl/7.50.3
> Accept: */*
>
< HTTP/1.1 204 No Content
< Content-Type: text/plain
< Date: Thu, 28 Dec 2017 19:27:31 GMT
< Server: lighttpd/1.4.45
<
* Curl_http_done: called premature == 0
* Connection #0 to host 192.168.1.9 left intact

Test with event param:

➜  ~ curl -u user0001:passwd -v http://192.168.1.9/bha-api/history.cgi\?index\=1\&event\=doorbell
*   Trying 192.168.1.9...
* TCP_NODELAY set
* Connected to 192.168.1.9 (192.168.1.9) port 80 (#0)
* Server auth using Basic with user 'user0001'
> GET /bha-api/history.cgi?index=1&event=doorbell HTTP/1.1
> Host: 192.168.1.9
> Authorization: Basic #hash
> User-Agent: curl/7.50.3
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: image/jpeg
< Content-Length: 30867
< X-Timestamp: 1514398891
< X-Count: 35
< Date: Thu, 28 Dec 2017 19:33:06 GMT
< Server: lighttpd/1.4.45
<
* Curl_http_done: called premature == 0
* Connection #0 to host 192.168.1.9 left intact

I think DoorBird broke this with a firmware upgrade…
I submitted a issue: https://github.com/Klikini/doorbirdpy/issues/3

cveenman · January 17, 2018, 5:11pm

With version 0.61 your code is now live. Any thoughts on how to use the doorbell_events? I don’t “get it” yet.

basschipper · January 17, 2018, 7:08pm

What I understand from the code is that when doorbell_events are activated, Home Assistant is opening a API endpoint for the DoorBird and will configure the DoorBird API (on startup) with notifications to call the Home Assistant API.

I will leave some feedback when it’s working, but I still need to upgrade Home Assistant.

Klikini · January 18, 2018, 12:22am

You can use it in automations, like this one that will add entries to the logbook:

- alias: Doorbell
  trigger:
  - platform: event
    event_type: doorbird_doorbell
  action:
  - service: logbook.log
    data:
      name: Doorbell
      message: rang

More helpful examples of automations are welcome in the component documentation

nbraun18 · January 22, 2018, 10:05pm

Curious if you got this working yet and what you think

reynos · January 24, 2018, 4:06am

I’ve tried this automation and get this error:

2018-01-24 14:42:40 WARNING (MainThread) [homeassistant.components.http.ban] Login attempt or request with invalid authentication from “doorbird ip”

I’ve double checked the Doorbird logon details in config.yaml and it’s right, sounds like Doorbird is not auth to HA? Any ideas?

Klikini · January 27, 2018, 7:58pm

I realize now that I’m an idiot…

My test instance of HA doesn’t have an API/HTTP password, so it worked and I didn’t think to authenticate API calls. I will work on a fix ASAP.

reynos · January 27, 2018, 10:08pm

Not an idiot at all, easily over looked! Let me know when you a chance to correct it and I’ll test.
Many thanks!

Klikini · January 28, 2018, 11:01pm

I have pushed a fix and created a pull request, so now it’s up to the HA devs to accept it.

alandtse · February 2, 2018, 8:21am

While I haven’t moved over to this API’s ring notification (still using the proxy version), I have tied this into TTS using Bluetooth speakers with my RPi. I have my Pi connect to my Echos, and they will let me know when someone is ringing the door. There are a few known issues connecting to some Echo devices using RPis, but my Echo dot seems to consistently work. Other ideas may be to flash some lights, send some push notifications, etc.

Here’s my automation converted to use the trigger (but untested). Probably doesn’t make sense to put it in the documentation as I’m using multiple unofficial components to do this.

- id: NotifyDoorbell
  alias: 'Notify of ringing doorbell'
  initial_state: 'on'
  trigger:
    platform: event
    event_type: doorbird_doorbell
  action:
    service: tts.google_say
    data:
      entity_id: media_player.tts_bluetooth_speaker
      message: 'Ding Dong! Someone is at the front door!'

reynos · February 11, 2018, 5:17am

doorbird_doorbell event now works as of 0.63 - thanks @Klikini!
here’s my working config for playing the doorbell on Sonos if anyone needs it:

an automation:

- alias: Doorbell
  trigger:
  - platform: event
    event_type: doorbird_doorbell
  action:
    - service: script.turn_on
      data:
        entity_id: script.doorbell

calls this script:

doorbell:
  alias: Ring Doorbell
  sequence:
    - service: media_player.sonos_snapshot
      data:
        entity_id: media_player.kitchen
    - service: media_player.volume_set
      data:
        entity_id: media_player.kitchen
        volume_level: 0.60
    - service: media_player.play_media
      data:
        entity_id: media_player.kitchen
        media_content_id: http://10.0.26.20/sounds/doorbell.mp3
        media_content_type: music
    - delay:
        seconds: 4
    - service: media_player.sonos_restore
      data:
        entity_id: media_player.kitchen

briis · February 11, 2018, 8:23am

Thank you @reynos, this works perfectly. The sonos_snapshot and sonos_restore services where new to me, but this is brilliant to be able to save and restore the state of the speaker.

My issue was that the event was never triggered. I found that when I went in to the Doorbird APP under Administration and HTTP Calls the address of my HomeAssistant server was set to localhost - when changing this to the internal IP of the server the Event was now triggered when pressing the Doorbird Button.

reynos · February 28, 2018, 12:56am

Hey @Klikini I just enabled SSL and the doorbell event seems to have broken, can you check please? Thanks.

Klikini · February 28, 2018, 3:50am

I think this would happen because the DoorBird is still connecting to HA using the local IP and not using HTTPS.

I’m not sure of how to get the actual hostname, I’ll look into it.

reynos · February 28, 2018, 5:35am

I can connect locally to my HA instance using https://10.x.x.x (albeit after a browser warning that the URL does not match the cert) if that’s any help…

basschipper · February 28, 2018, 7:34am

Did you installed a valid certificate on your HA instance? Maybe the DoorBird can only deal with valid certificates. If so, the DoorBird must connect by hostname, not by ip. Please review the DoorBird notification parameters first by making a request to your DoorBird api, something like:

http://<deviceip>/bha-api/info.cgi

Klikini · February 28, 2018, 3:00pm

This is what I plan to do.

The current DoorBird component code gets the LAN IP of the HA machine and uses that. Once I get time to work and test it, I’ll attempt to read the base_url option of the http component and use that instead, otherwise fall back to the IP address if it isn’t set up.

Klikini · March 3, 2018, 10:08pm

I just looked at the code and it should work fine with SSL.

Could you please share your http component configuration?

reynos · March 4, 2018, 1:34am

If you need more info that this I’ll PM you…
http:
api_password: !secret http_api_password
ssl_certificate: !secret ssl_certificate_loc
ssl_key: !secret ssl_key_loc
base_url: !secret base_url

Klikini · March 4, 2018, 1:55am

The component should be using the base_url, so double-check that it’s correct.

Otherwise, please go to http://_doorbird_lan_ip_here_/bha-api/notification.cgi, log in with the same user account you have in your component configuration. It should look something like this:

{"BHA": { "RETURNCODE": "1", "NOTIFICATIONS": [{"event": "doorbell1","subscribe": "1","url": "http://_home_assistant_url_/api/doorbird/doorbell","user": "","password": "","relaxation": "10"}]}}`.

Then try going to the exact/entire url value and see if it responds correctly (it should just say OK) and serves a valid SSL certificate.