DoorBird Plugin

Getting Started

This is a HomeSeer HS3 plugin for the ‘DoorBird’ line of video intercom units (https://www.doorbird.com/), this plugin has been developed upon request and will talk to the DoorBird units via the LAN API (not the cloud service). Once the files have been installed by the HomeSeer updater into the HomeSeer directory go into the Plug-ins > Manage page, you should now see the DoorBird plugin in the list of plugins. Please now enable this plugin by clicking the switch as you would any other plugin.

Upon enabling the plugin you should see some entries in the HomeSeer log similar to this:

Jun-06 20:27:15        DoorBird        No Password Set - Please Check

Jun-06 20:27:15        DoorBird        No Username Set - Please Check

Jun-06 20:27:15        DoorBird        No IP Address Set

Jun-06 20:27:13        Info                Plugin DoorBird has connected. IP:192.168.1.163:51106

As the HomeSeer log suggests, the IP address, username and password need to be set for HomeSeer to communicate with the Doorbird device. Please go into Plugins > Doorbird > Doorbird page and you should find four tabs that look similar to the below image. Please click Settings and you should find a page similar to this:

These fields are fairly self explanatory, the instance name will report as ‘Default’ if you have no instance name passed to the plugin. The next field is for the IP address of the DoorBird unit, the username and password fields are also for the DoorBird unit (these are found in the documentation that comes with the unit).

The plugin establishes a relationship with the DoorBird unit that means that when an event takes place in the unit (such as the door opens, motion is detected or the bell is pressed) then it sends data back to the plugins web page, the plugin will then respond accordingly. If you have passwords required for local LAN login in HomeSeer then you will find two extra boxes appear on this page that need to contain the login details for a HomeSeer account that has sufficient privileges to access a plugins web page. If you also have multiple IP addresses reported by HomeSeer then the ‘HomeSeer IP Status’ box will convert into a text box. Please ensure that this is set to the correct IP address for your HomeSeer server else the notifications will be sent to the wrong IP address.

Disabled by default is the first splash screen for the plugin, this is owing to the fact that the video feed will be a local feed only, there are issues with compatibility between browsers and often it appears to occasionally crash and fail to get the video feed. If you wish to try this page then please disable the field and reload the page.

Note: I encode and encrypt both the Doorbird username/password and the HomeSeer username/password (if needed) against the encryption methods available in HomeSeer and they are encrypted against a password only known to one person (me). All of the data is retained in the Doorbird3P.ini file in the HomeSeer Config directory, it is not passed anywhere else.

Once you have entered the required details please press Update Changes, you will see little change in the UI but please now look in the HomeSeer log. If you have established a connection with your DoorBird unit then the HomeSeer log will contain entries looking like:

Jun-06 20:32:46        DoorBird        Events Registered With Device

Jun-06 20:32:46        DoorBird        Events Registered With Device

Jun-06 20:32:46        DoorBird        Events Registered With Device

Jun-06 20:32:46        DoorBird        Success At Connection To DoorBird

Jun-06 20:32:46        DoorBird        IP Address For Instance: 192.168.1.8

Please check whether or not the plugin reports that it established a connection and whether or not you have three events entries, if you have then the plugin should now be ready to communicate with.

Devices

HomeSeer will create a group of devices for the plugin to control, these devices in the main will be self explanatory. You should find that the devices look as follows:

  1. Root Device - This device has limited function but will change it’s state to ‘Communication Error’ if there are communication issues between the plugin and the DoorBird unit.
  2. Doorbell Status - This device represents whether or not the doorbell button has been pressed on the unit, it will simply report whether or not it is ringing or not ringing, it will reset after five seconds.
  3. Motion Sensor - The DoorBird unit contains a PIR motion sensor, if this sensor is activated then it will change this device to the status ‘Motion’, it will then reset back to ‘No Motion’ after five seconds.
  4. Door Open Status - The DoorBird unit contains a notification called ‘dooropen’, this appears to be in sync with the door open control and does not activate when the manual door open contact input is triggered. The exact meaning of this device is unknown and may have limited value or may be part of a future API.. The device will time out after five seconds. Note: It will only report the door event for changing status, it will not show whether or not the door is actually open or closed..
  5. Door Open Control - This device when pressed will cause the door opener contacts to activate in the unit, the contact appears to close a number of seconds after they are opened. The device will return to the reset state after five seconds, BEWARE with this device, if you are connecting it to a door opener this allows easy control to open the door without the potential safeguards of PIN access or such - I cannot be liable should this device activate accidentally and you open a door by error/fault.
  6. Light Control - When this device is controlled the infra-red LED’s in the units camera will activate, they will turn on for around three minutes and then turn off (however the HS device will reset after a shorter time). This can be used in conjunction with the other events to enable night images to be taken.

All devices contain value/graphics pairs that have been taken from the HomeSeer contemporary image set. You are free to change them to whatever images you feel suitable by editing the pairs in the plugin pages. All of the devices should change status and can be used in events to display screens, obtain images or whatever actions you feel appropriate.

Event Actions/Triggers

At the time of writing (07/06/16) there is only one event action and no triggers. The DoorBird unit will store up to 20 images based on events raised in the device, image one will always be the most recent taken and image 20 will be the most historic. You have an event action available to download the image and the plugin will download it to the HomeSeer web server path under the \html\DoorBird directory. It will overwrite any existing file that may be present, the images will be in the format of the instance name and then the number of the image. If the plugin is not running in multi instance mode then the image will be named as the number only, all triggers for events raised by the DoorBird device can be handled by the respective device changing status. The image will be saved as a JPG and an appropriate message written to the HomeSeer log should it fail to save correctly.

The event action will support both the saving to a specific file name and/or the addition of a date/time stamp to the image which can be used for later establishing when the image was taken.

Issues/Warnings

Scripting Functions

There are no functions available in the plugin in terms of scripting, this is because of the existing functions available in the events. If there is a specific function requested then this can be considered.

Debug Logs

If you need to enable logging to file then please go into your HomeSeer directory and go into the Logs directory. Create a directory in this directory and call it DoorBird. The plugin should then begin to log to a file, please do not let this log for too long and delete the directory after you have finished obtaining enough logs.

Issues

Please post any issues/comments/requests to the appropriate HomeSeer message board thread and I will try and answer them accordingly - http://forums.homeseer.com/showthread.php?t=181427