A SIP client inside home assistant!
With this card you can make and receive calls to other HA clients and other sip devices, so you can use it as for example an intercom.
The card supports video, DTMF signals, custom icons, custom names, status entities and camera entities.
This is still work in progress, and these are the things i want to add in the near future.
- Improve styling (hard because custom cards can't use all ha elements)
- Include default ringtones
- Translations
Asterisk add-on This card works with the Asterisk add-on, which is very easy to set up, with just some clicks!
For this to work you will need the following:
- A sip/pbx server. (I use the Asterisk add-on)
- Extension for every device. (The add-on auto-generates extensions for every person in HA)
- HACS on your HA. (Home assistant)
Go to https://tech7fox.github.io/sip-hass-docs/docs/card/guides/freepbx to see how to setup FreePBX for this card.
Download using HACS
- Go to HACS
- Click on
Frontend - Click on the 3 points in the upper right corner and click on
Custom repositories - Paste https://github.com/TECH7Fox/HA-SIP/ into
Add custom repository URLand by category choose Lovelace - Click on add and check if the repository is there.
- You should now see SIP.js Client. Click
INSTALL
Click on add card and scroll down to and choose Custom: SIP Card.
The entire card is configurable from the editor.
set your ringtones to play when calling/being called.
/local is your www folder in config. Example: /local/ringtone.mp3 = /config/www/ringtone.mp3.
You can put ?call=<number> behind the URL to auto call that number when the card loads. Useful for notifications.
You can set ICE options for external use. These settings are not (yet) configurable with the card editor, so you will
need to set them in the code editor. Don't set iceConfig if you don't want to use ICE.
Here is a example:
iceTimeout: 5
iceConfig:
iceCandidatePoolSize: 0
iceTransportPolicy: all
iceServers:
- urls:
- stun:stun.l.google.com:19302
- stun:stun1.l.google.com:19302
rtcpMuxPolicy: require
Everything (expect ICE) is configurable with the card editor. But for people that are configuring it with YAML, here is a example:
type: custom:sipjs-card
server: 192.168.0.10
port: '8089'
video: false
ringtone: /local/asterisk/ringtone.mp3
button_size: '62'
custom:
- name: Doorbell
number: '007'
icon: mdi:doorbell
camera: 'camera.doorbell'
- name: Jordy deskphone
number: '008'
icon: mdi:deskphone
camera: ''
dtmfs:
- name: Door
signal: '1'
icon: mdi:door
extensions:
- person: person.person1
name: Test person
extension: '101'
secret: 1234
icon: mdi:person
entity: binary_sensor.myphone
camera: ''
- person: person.jordy
name: Jordy PC
extension: '100'
secret: 1234
icon: mdi:monitor
- person: person.tablet
name: Tablet
extension: '102'
secret: 1234
icon: mdi:tablet
state_color: false
ringbacktone: /local/asterisk/backtone.mp3
auto_answer: false
buttons:
- name: 'Garage Door'
icon: mdi:garage
entity: switch.garagedoor
custom_title: ''
hide_me: true
iceTimeout: 3 # Default is 5 seconds
backup_name: Tablet
backup_extension: '200'
backup_secret: 1234
iceConfig: # Remove if you don't want to use ICE
iceCandidatePoolSize: 0
iceTransportPolicy: all
iceServers:
- urls:
- stun:stun.l.google.com:19302
- stun:stun1.l.google.com:19302
rtcpMuxPolicy: require
You can find more information on the SIP-HASS Docs.
Most problems is because your PBX server is not configured correct, or your certificate is not accepted.
To accept the certificate for Asterisk/FreePBX go to https://<host>:8089/ws and click continue.
To see how to configure FreePBX go to the FreePBX guide.
Android companion app 2022.2 required for speaker + audio permissions.
If you are still having problems you can make an issue or ask on the discord server.
For development on Windows, easiest way is to use the devcontainer and run npm run build in the terminal. Then copy the sipjs-card.js file to your www folder.
You can ask for help on the discord server.
PR's are always welcome!