Vivint/Vivotek Video Doorbell Card for Lovelace

This is a Lovelace based Doorbell Card for Home Assistant that is for use with a Vivint/Vivotek Video Doorbell that has been setup for local use (in other words, is no longer part of the Vivint ecosystem). It allows the user to view the current video image from the doorbell, and with the press of a button, it can also place a SIP call to the Doorbell via Asterisk. Note: As the Vivint Doorbell uses the software from Vivotek, this card should work with any Vivotek camera that has a speaker and microphone, and in theory, this should work with any camera that supports SIP.

This card is a modified version of the Ronald Dehuysser's rdehuyss DoorDroid Card. It has been modified to place a SIP call from the card to the doorbell. The ability to call this card from some other SIP client (such as the DoorDroid) still remains, however the buttons to Accept or Reject the incoming call do not show up until the call comes in.

The Vivint/Vivotek Doorbell supports SIP, but only for a 1-way call to the doorbell. The Vivint/Vivotek Doorbell does send audio in the reverse direction using RTSP (muxed with the video), but Home Assistant does not support carrying the reverse audio. A companion project app_rtsp_sip provides an Asterisk application that can be used to call the doorbell, send SIP audio to the doorbell, plus extract the reverse audio from the doorbell's RTSP stream and insert it into the calling SIP channel which, in this case is the Vivint Doorbell Card. In effect, the companion project allows the DoorVivint Card to setup a two-way audio channel to the Vivint/Vivotek Video Doorbell.

An example of what the card would look like:

Installation:

The recommended way to install is to use HACS. Alternatively, this can be manually installed.

HACS

• Go to the HACS Settings (look for 3 vertical dots), and under ADD CUSTOM RESPOSITORY, paste https://github.com/tommyjlong/doorvivint-card , and chose Lovelace (or Plugin) for the Category. Hit Add (or Save), and a new entry titled Doorvivint Card should now be present.
• Click on this new entry and a page should appear which will allow you to install this. Now install it.
• Make sure to follow the instructions at the very bottom of the page for adding the url and type to the lovelace resource configuration. It should be something like:

  - url: /hacsfiles/doorvivint-card/jssip-3.5.3.min.js
    type: js
  - url: /hacsfiles/doorvivint-card/doorvivint-card.js
    type: module

Manual:

1. Download the doorvivint-card.js and the companion jssip modules to HACONFIGDIR/www/custom-lovelace/doorvivint-card/ (or in some other folder under /HACONFIGDIR/www/).

Add the following resources in your lovelace resource config:

resources:
  - url: /local/custom-lovelace/doorvivint-card/jssip-3.5.3.min.js
    type: js
  - url: /local/custom-lovelace/doorvivint-card/doorvivint.js
    type: module

Lovelace Configuration:

When adding a card, make the type custom:doorvivint-card:

Here is an example:

- title: Doorbell
  cards:
    - type: custom:doorvivint-card
      camera_entity: camera.YOUR_HA_DOORBELL_CAMERA_NAME
      title: null
      sip_settings:
        sip_server: my.duckdns.org 
        sip_username: '1001'
        sip_password: mypassword 
        sip_wss_url: 'wss://my.duckdns.org:8089/ws'
        sip_doorbell_username: '101'
        sip_doorbell_domain: '192.168.1.6' #Asterisk LAN IP address
      style: |
          ha-card {
            display: block;
            margin-left: auto;
            margin-right: auto;
            width: 88%;
          }

• sip_server: This is part of the Browser's WebRTC Client SIP URI: sip:sip_username@sip_server which is used by SIP to identify itself to Asterisk. From our example this will become: sip:[email protected]
• sip_username: (See sip_server). This is also the extension phone number that Asterisk will associate with the DoorVivint WebRTC Client.
• sip_password: This is used as part of the SIP Authentication with Asterisk.
• sip_wss_url: This is the websocket URL to connect to Asterisk's websocket server. From the example, the browser client will attempt to connect to Asterisk using a TLS websocket to your external world's domain/IP address (my.duckdns.org) using port 8089. If a NAT router is used, it should be setup to "Port Forward" this to your Asterisk Local Area Network name/address using the tlsbindaddr websocket port (See below).
• sip_doorbell_username: This is part of the destination doorbell's SIP URI. sip:sip_doorbell_username@sip_doorbell_domain. From our example, this will become: sip:[email protected].
• sip_doorbell_domain: This is the SIP domain, which in this case is the Local Area Network name/address of the Asterisk Server. (See also sip_doorbell_username)

Asterisk Configuration

The following is to be used as a guideline as they are based on my experiences setting up Asterisk to run SIP and RTP over a websocket. The Doorbell itself and other SIP Clients are not shown in this guideline but such are discussed in the companion project app_rtsp_sip.

The resource module that handles secure RTP is not loaded, so add the following line:

module.conf

load = res_srtp

Enable the websocket on the Asterisk webserver:

http.conf

[general]
.....
tlsenable=yes               ; enable tls - default no.
tlsbindaddr=0.0.0.0:8089    ; address and port to bind to - default is bindaddr and port 8089.
tlscertfile=PATH_TO_YOUR_CERTIFICATE.pem  ; can point to same one that HA uses.
tlsprivatekey=PATH_TO_YOUR_PRIVATE_KEY.pem  ; can point to same one that HA uses.

Configure the pjsip webrtc SIP Client:

pjsip.conf

[transport-wss]
type=transport
protocol=wss
bind=0.0.0.0

;-------------------------
;WebRTC
;-------------------------
[1001]
type=aor
max_contacts=1
remove_existing=yes

[1001]
type=auth
auth_type=userpass
password=mypassword 
username=1001

[1001]
type=endpoint
aors=1001
auth=1001

dtls_auto_generate_cert=yes
webrtc=yes
context=from-internal
disallow=all
allow=ulaw,alaw,gsm,g726,g722
callerid=Web Socket <1001>
transport=transport-wss

Known Limitations/Quirks

• The original DoorDroid Card had an additional button that once pressed, could invoke an input_boolean (which could be used by HA to open a gate for example). There is some code in the doorvivint to do this, but it is commented out. Feel free to uncomment it to see if it still works.
• Using Asterisk 17.x and its pjsip based SIP stack, I have gotten the DoorVivint WebRTC/JSSIP client to work for Google Chrome on Windows 10 and on an older Safari 11 on a MAC. Thus far using Safari on iOS, only works for sending audio, but doesn't play any received audio. Have not gotten this to work with Home Assistant iOS App.

Credits:

• The original DoorDroid Call came from Ronald Dehuysser rdehuyss.
• The JavaScript SIP Library (JSSIP) is used to provide the SIP Protocol for the Browser. Reference: jssip home, and jssip github.