Skip to main content

SIP Core & Cards

Now we have a PBX to connect to, we can install the cards.

warning

The card only works in HTTPS. This is required by modern browsers to send your mic/cam trough. You can use something like DuckDNS or Let's Encrypt.

Installation​

  1. Go to HACS
  2. Click on Frontend
  3. Click on the 3 points in the upper right corner and click on Custom repositories
  4. Paste https://github.com/TECH7Fox/sip-hass-card into Add custom repository URL and by category choose Lovelace
  5. Click on add and check if the repository is there.
  6. You should now see SIP Client. Click INSTALL

Configure SIP Core​

Now that we have SIP Core installed, we need to configure it.

  1. In /config/www/, create a file called sip-config.json.
  2. Copy the settings template from below into it.
Settings Template
Complete SIP Core Configuration
{
    "ice_config": {
        "iceGatheringTimeout": 1000,
        "iceCandidatePoolSize": 0,
        "iceTransportPolicy": "all",
        "iceServers": [
            {
                "urls": ["stun:stun.l.google.com:19302"]
            }
        ],
        "rtcpMuxPolicy": "require"
    },
    "backup_user": {
        "ha_username": "myusername",
        "extension": "100",
        "password": "mypassword"
    },
    "users": [
        {
            "ha_username": "myusername",
            "extension": "100",
            "password": "mypassword"
        }
    ],
    "sip_video": false,
    "auto_answer": false,
    "popup_config": {
        "auto_open": true,
        "large": false,
        "buttons": [],
        "extensions": {}
    }
}
  1. Change myusername, extension and mypassword with your own Home Assistant username, SIP extension, and the password that you set in the add-on settings.
info

You can find the Home Assistant usernames in Settings > People > Users.

  1. Save the file.

  2. Reload your browser (use Ctrl + Shift + R) to make sure the new configuration is loaded.

  3. (Optional) Adjust other options like auto_answer or popup_config as needed.
    See the Settings documentation for all available options and examples.

Add the Card(s)​

Now that SIP Core is configured, you can add cards to your dashboard to make and receive calls.

📇 Contacts Card​

The Contacts Card shows a list of SIP endpoints (extensions) and lets you call them with a single click.

Example: Contacts Card
type: custom:sip-contacts-card
extensions:
  "102":
    name: Jordy
    status_entity: binary_sensor.100_registered
    override_icon: mdi:account
  "103":
    name: Desk phone
    override_icon: mdi:deskphone
  "8001":
    name: Doorbell
    override_icon: mdi:doorbell-video
  "0612345678":
    name: Test
    override_icon: mdi:dialpad
    edit: true
debug: false
hide_me: false
state_color: true

See the Contacts Card documentation for all options and features.

📞 Call Card (Optional)​

The Call Card provides a full call interface directly in your dashboard, including call controls, video, and custom buttons.

Example: Call Card
type: custom:sip-call-card
extensions:
  "101":
    name: Jordy
  "102":
    name: Desk Phone
    override_icon: mdi:deskphone
  "8001":
    name: Doorbell
    camera_entity: camera.doorbell
buttons:
  - label: Open Door
    icon: mdi:door-open
    type: service_call
    data:
      domain: light
      service: toggle
      entity_id: light.bedroom_lights
  - label: DTMF 1
    icon: mdi:1
    type: dtmf
    data:
      dtmf: "1"

See the Call Card documentation for all options and features.

🛠️ Custom Cards​

You can also create your own custom cards and popups to fit your needs.
See the developer documentation for guides and examples on building your own SIP Core components.

SSL​

WSS (Secure WebSocket) requires SSL for security reasons. The add-on sets up Asterisk's part of that, but you may still need to set up your network to work with it.

Ingress is the easiest and most secure way to use SIP Core with the Asterisk add-on.
Home Assistant tunnels the WebSocket connection through its own secure connection, so you don't need to set up SSL or port forwarding in Asterisk.

  • No need to open ports or manage certificates.
  • Works out of the box with the add-on and SIP Core.
  • Just use the default settings and let Home Assistant and SIP Core handle the rest.
tip

If you use the Asterisk add-on, Ingress is enabled by default.
For technical details, see the developer docs.