klikini / doorbirdpy

Python wrapper for the DoorBird LAN API

Moved to https://gitlab.com/klikini/doorbirdpy

---

doorbirdpy

Python wrapper for the DoorBird LAN API v0.21

Features

DoorBird API Documentation

Note that no image data is handled by this wrapper; it only returns the URLs to access images and streams. It was designed this way so that the fetching of images could be handled by the client application and so that this library would not have so many dependencies.

Supported

• Live video request
• Live image request
• Open door/other relays
• Light on
• History image requests
• Schedule requests
• Favorites requests
• Check request
• Info request
• RTSP

Not yet supported

• Monitor request
• Live audio transmit
• Live audio receive
• SIP

doorbirdpy's Issues

History image broken due to new mandatory event param

Requesting a history image is broken, probably due to a DoorBird firmware upgrade.

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

TypeError: the JSON object must be str, not 'bytes'

In my homeassistant environment running python 3.4, doorbirdpy returns a TypeError when json.loads:

Traceback (most recent call last):
  File "/srv/homeassistant/homeassistant_venv/lib/python3.4/site-packages/doorbirdpy/__init__.py", line 35, in ready
    code = json.loads(content)["BHA"]["RETURNCODE"]
  File "/usr/lib/python3.4/json/__init__.py", line 312, in loads
    s.__class__.__name__))
TypeError: the JSON object must be str, not 'bytes'

This appears to be related to content requiring decoding of UTF-8.

The solution appears to be to replace every instance of:
json.loads(content) with
json.loads(content.decode('utf-8'))

Feature request: update API to use second relay

Doorbird API has been recently updated so now second relay can get triggered. Please, can you add a method for using this new API call?

http:///bha-api/open-door.cgi?r=2

More info: https://www.doorbird.com/api

Monitoring relay trigger?

Is there any way to monitor or check wether a relay was triggered through the API, I'm only able to find ways to trigger it.