Skip to main content

SIP Core & Cards

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

warning

SIP Core only works over HTTPS. This is required by modern browsers to access your microphone and camera. You can use something like DuckDNS or Let's Encrypt to enable HTTPS for your Home Assistant instance.

Installation​

Quick Install

You can also click the badge to directly add SIP Core to HACS!

HACS Repository

  1. Go to HACS in Home Assistant
  2. Click on Integrations
  3. Click on the three dots in the upper right corner and select Custom repositories

  4. Add the repository URL:
    https://github.com/TECH7Fox/sipcore-hass-integration
    and set the category to Integration

  5. Click Add and verify the repository appears
  6. You should now see SIP Core. Click INSTALL
  7. Restart Home Assistant
  8. Go to Settings → Devices & Services → Integrations and click Add Integration
  9. Search for SIP Core and follow the configuration prompts

Configure SIP Core​

After installing SIP Core as an integration, you can configure it through the Home Assistant UI.

  1. Go to Settings → Devices & Services → Integrations
  2. Find and select the SIP Core integration
  3. Click on configure and enter your settings accordenly
  4. Save your configuration
info

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

For all available configuration options, see the Settings documentation.

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.