Skip to main content

SIP Core & Cards

SIP HASS Cards add real-time audio and video calling to your Home Assistant dashboards. The system is made up of several parts that work together to provide a flexible and customizable SIP experience in your smart home.

How It Works​

  • SIP Core is the main engine that handles SIP registration, call management, and device integration. It runs in the browser and connects to your PBX (like the Asterisk add-on) using a secure WebSocket connection.
  • Ingress is used by default with the Asterisk add-on, so you don't need to open extra ports or set up SSL on your PBX. If you use your own PBX, you can set a custom WebSocket URL.
  • Settings are managed in a single configuration file (sip-config.json). Here you define users, ICE settings, popups, and more. See Settings for all options.
  • Cards are UI components you add to your dashboards. The default SIP Card lets you make and receive calls, see status, and interact with other devices.
  • Popups show call controls and video during a call. You can use the default popup or create your own for a custom experience.
  • Custom Development: It's easy to create your own cards and popups. SIP Core exposes an API for developers, and you can override the default popup or add new cards. See the developer documentation for guides and examples.

Installation (via HACS)​

You can install the SIP HASS Card using HACS:

  1. Go to HACS in Home Assistant.
  2. Click on Frontend.
  3. Click on the three dots in the upper right corner and select Custom repositories.
  4. Add the repository URL: 
    https://github.com/TECH7Fox/sip-hass-card
    and set the category to Lovelace.
  5. Click Add and check if the repository appears.
  6. You should now see SIP Client. Click INSTALL.
  7. Restart Home Assistant.
  8. Configure SIP Core by editing /config/www/sip-config.json in Home Assistant.
    • See settings for details on configuration options.
  9. Add the SIP Card(s) to your dashboard from the UI.
  10. Customize popups and cards as needed, or develop your own.

For detailed setup instructions, see the tutorial.

For all configuration options, see the settings.
For more technical information and development guides, see the developer docs.