Integration with DoorBird

  • Document number: PO-040-EN
  • Version: 2.0
  • Date of publication: March 11, 2022


Triggering event no. 255 (DoorBird doorbell)

The best way to start with the integration process is to first create an additional user in the Ampio SmartHome Manager software and set a very difficult password for this user. Call the user, e.g. doorbird.

The next step is to set the DoorBird device to generate an Ampio event via the API-HTTP.

In order to do that, you need to enter a link into a web browser constructed in the following manner:

http://{DOORBIRD_API_USER}:{DOORBIRD_API_PASSWORD}@{DOORBIRD_IP}
    /bha-api/notification.cgi?
    url=http://{AMPIO_SERWER_IP}:8060/api/setEvent/255&
    event=doorbell&
    subscribe=1&
    user={NAZWA_UZYTKOWNIKA_AMPIO_DOORBIRD}&
    password={HASLO_UZYTKOWNIKA_AMPIO_DOORBIRD}

In the above address, individual symbols should be replaced with the following values:

  • DOORBIRD_API_USER - is the name of the DoorBird intercom’s user, which can be found on the digital passport card sent together with the intercom by its manufacturer, or which is created especially for the user.
  • DOORBIRD_API_PASSWORD - is the password of the DoorBird intercom’s user, which can be found on the digital passport card sent together with the intercom by its manufacturer, or which is created especially for the user.
  • DOORBIRD_IP - the IP address of the intercom in a local network, which can be found, e.g. on the router configuration site, by using IP network scanners, or on DoorBird’s website after logging in: https://www.doorbird.com/checkonline
  • AMPIO_SERVER_IP - Ampio server’s address
  • USERNAME_AMPIO_DOORBIRD - the name of the intercom’s user in the Ampio system, created especially for the intercom.
  • USER_PASSWORD_AMPIO_DOORBIRD - a password set in the Ampio system for the intercom user.

An example of the address created, based on the above-mentioned rules:

http://dwerex001:56fdsxXD3se@192.168.111.45
    /bha-api/notification.cgi?
    url=http://192.168.111.22:8060/api/setEvent/255&
    event=doorbell&
    subscribe=1&
    user=domofon&
    password=SDSEW#@#@#DEWKLDLKFD

It is also possible to create the address as shown below, where the username and password are displayed in the link:

http://dwerex001:56fdsxXD3se@192.168.111.45
    /bha-api/notification.cgi?
    url=http://domofon:SDSEW#@#@#DEWKLDLKFD@192.168.111.22:8060/api/setEvent255&
    event=doorbell&
    subscribe=1

Such a link must be copied into the internet browser and confirmed by pressing “Enter”. If the intercom receives the configuration correctly, it will give us the following feedback about a successful configuration:

{
    "BHA": {
        "RETURNCODE": "1",
        "NOTIFICATIONS": [
            {
                "event": "doorbell1",
                "subscribe": "1",
                "url": "http://192.168.111.22:8060/api/setEvent/255",
                "user": "domofon",
                "password": "SDSEW#@#@#DEWKLDLKFD",
                "relaxation": "10"
            }
        ]
    }
}

Integration via the DoorBird app

Adding the link is also possible in the DoorBird app, using the “Administration” tab. Choose the intercom that you wish to configure, and select “HTTP(s) Calls” from the list of available options. Then, enter a link that is constructed similarly to the one below:

http://domofon:SDSEW#@#@#DEWKLDLKFD@192.168.111.22:8060/api/setEvent/255&event=doorbell&subscribe=1

Summary

After performing the above-mentioned steps, pressing of the intercom button will trigger the event no. 255 in the system, which can be used to, e.g. activate the buzzer or flash the lights.

Remember that this event, similarly to all other events generated by Ampio API will not be visible to the server. Therefore, you cannot create conditions to the events.