Initial commit

CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.1.0
+- Initial Version.

LICENSE

@@ -0,0 +1 @@
+The original works for this card came from Ronald Dehuysser (rdehuyss).  Check his github for any license information at: [LICENSE] (https://github.com/rdehuyss/DoorDroid)

README.md

@@ -0,0 +1,120 @@
+# Vivint Video Doorbell Card for Lovelace
+
+This is a Lovelace based Doorbell Card for Home Assistant that is for use with a Vivint Video Doorbell. It allows the user to view the current video image from the doorbell, and with a button press, it can also place a SIP call to the Doorbell via Asterisk.  
+
+[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
+
+This card is a modified copy of the Ronald Dehuysser's DoorDroid Card [rdehuyss](https://github.com/rdehuyss/DoorDroid) that has been modified to place a SIP call from the card to the doorbell. The ability to call this card from a video doorbell still remains, but the buttons to Accept or Reject the incoming call doe not show up until the call comes in.
+
+The Vivint Doorbell supports SIP, but only for a 1-way call to the doorbell.  The Vivint Doorbell does send audio in the reverse direction using RTSP (muxed with the video), but Home Assistant does not support carrying the audio.  A companion project (TO BE COMPLETED) provides an Asterisk application that can be used to call the doorbell, send SIP audio to it, plus retrieve the audio from the doorbell and insert it into the calling SIP channel which, in this case is the Vivint Doorbell Card.
+
+An example of what the card would look like:
+![DoorVivint Card](https://github.com/tommyjlong/doorvivint-card/blob/master/DoorVivint-Card.jpg?raw=true)
+
+# Installation:
+The recommended way to install is to use HACS. Alternatively, this can be manually installed.
+
+## HACS
+- Go to the HACS Settings, and under ADD CUSTOM RESPOSITORY, paste ```https://github.com/tommyjlong/doorvivint-card ```, and chose ```Plugin``` for the Category.  Hit save, and a new entry titled **[plugin]
+tommyjlong/doorvivint-card** should be created under CUSTOM REPOSITORY.  
+- Click on the new entry and a page should appear which will allow you to install this.  
+- Make sure to follow the instructions at the very bottom of the page for adding the url and type to the lovelace configuration.
+
+## Manual:
+1. Download the [doorvivint-card.js](https://github.com/tommyjlong/doorvivint-card/blob/master/dist/doorvivint-card.js) and the companion [jssip](https://github.com/tommyjlong/doorvivint-card/blob/master/dist/jssip-3.5.3.min.js) modules to `HACONFIGDIR/www/custom-lovelace/doorvivint-card/` (or in some other folder under `/HACONFIGDIR/www/`).
+
+Add the following to resources in your lovelace config:
+
+```yaml
+resources:
+  - url: /local/custom-lovelace/doorvivint-card/doorvivint.js
+  - url: /local/custom-lovelace/doorvivint-card/jssip-3.5.3.min.js
+    type: module
+```
+
+# Lovelace Configuration:
+
+When adding a card, make the type `custom:doorvivint-card`:
+
+Here is an example:
+```yaml
+- title: Doorbell
+  cards:
+    - type: custom:doorvivint-card
+      camera_entity: camera.YOUR_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 SIP URI:  ```sip:sip_username@sip_server``` used to identify itself to Asterisk.  From our example: ```sip:[email protected]```
+- ```sip_username:```  (See sip_server)
+- ```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.
+- ```sip_doorbell_username:``` This is part of the destination doorbell's SIP URI. ```sip:sip_doorbell_username@sip_doorbell_domain```.  From our example: ```sip:[email protected]```.
+- ```sip_doorbell_domain:```  (See sip_doorbell_username)
+
+
+Asterisk http.conf
+```yaml
+[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.
+```
+Asterisk pjsip.conf (for our example WebRTC Client)
+```yaml
+[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 Call had an additional button that could invoke an input_boolean.  There is some code in the doorvivint to do this, but it is commented out. Feel free to uncomment it to see if it works.
+- Using Asterisk, I have gotten SIP/JSSIP/WebRTC to work with Google Chrome on Windows 10 and 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](https://github.com/rdehuyss/DoorDroid).
+- The JavaScript SIP Library (JSSIP) is used to provide the SIP Protocol for the Browser. Reference: [jssip home](https://jssip.net/), and [jssip github](https://github.com/versatica/JsSIP/).