457 | No active call
458 |
459 | `
460 | : camera
461 | ? html`
462 | 2 | 3 |
4 | 
5 |
6 |
7 | 8 | **🚀 Make and receive SIP calls directly in your Home Assistant dashboard** 9 |
10 |
11 |
5 |
6 | 7 | 8 | **🚀 Make and receive SIP calls directly in your Home Assistant dashboard** 9 |
12 | 13 | SIP Core, part of the SIP-HASS project, is the system that powers Home Assistant cards to make and receive SIP calls using WebRTC. 14 | It includes official cards and popups, but also supports third-party cards. 15 | 16 |
17 | 18 |
19 |
20 | [](https://discordapp.com/invite/qxnDtHbwuD)
21 | [](https://tech7fox.github.io/sip-hass-docs/)
22 | [](https://my.home-assistant.io/redirect/hacs_repository/?owner=TECH7Fox&repository=sipcore-hass-integration&category=integration)
23 |
24 |
25 |
26 | ## ✨ Features
27 |
28 | * 📞 Make and receive calls
29 | * 🔔 (Custom) Ringtones
30 | * 📹 Video calls
31 | * 🔢 DTMF support
32 | * 🪟 Popups for incoming calls
33 | * 🚀 Auto call on load (using `?call=
40 | 
41 | 
42 |
54 |
55 | `custom:sip-call-card`
56 |
57 | - 📊 Audio Visualizer
58 | - 📹 Supports camera entities for video
59 | - 🎮 Custom buttons for quick actions
60 | - 🔇 Mute mic & camera buttons
61 |
62 | 63 |
64 | 65 | ## Contacts Card 66 | 67 |
68 |
69 | `custom:sip-contacts-card`
70 |
71 | - 📞 Start calls to users/numbers
72 | - 👤 Option to hide your own user
73 | - 🎨 Custom names & icons
74 | - ✏️ Open field option
75 | - 🟢 State color with status entity
76 |
77 | 78 |
79 | 80 | ## 📋 Requirements 81 | For this to work you will need the following: 82 | * ☎️ A sip/pbx server (Works best with the [Asterisk add-on](https://github.com/TECH7Fox/Asterisk-add-on)) 83 | * 🔒 HTTPS for Home Assistant 84 | * 📦 HACS for easy installation 85 | 86 | 87 | ## 📚 Wiki 88 | 89 | You can find the installation instructions and guides on the documentation site: [SIP-HASS Docs](https://tech7fox.github.io/sip-hass-docs/) 90 | 91 | ## ⭐ Star History 92 | 93 |
94 | 
95 |
96 |
--------------------------------------------------------------------------------
/custom_components/sip_core/__init__.py:
--------------------------------------------------------------------------------
1 | import logging
2 | from pathlib import Path
3 | from homeassistant.core import HomeAssistant
4 | from homeassistant.components.http import StaticPathConfig
5 | from aiohttp.web import Request, Response
6 | from homeassistant.components.hassio.const import DOMAIN as HASSIO_DOMAIN
7 | from homeassistant.components.hassio.handler import HassIO, get_supervisor_client
8 | from homeassistant.helpers.http import HomeAssistantView
9 | from homeassistant.config_entries import ConfigEntry
10 | from .const import ASTERISK_ADDON_SLUG, DOMAIN, JS_FILENAME, JS_URL_PATH
11 | from .resources import add_resources, remove_resources
12 | from .defaults import sip_config
13 |
14 | logger = logging.getLogger(__name__)
15 |
16 |
17 | async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
18 | """Set up the SIP Core component."""
19 |
20 | logger.info("Registering SIP Core HTTP views")
21 | hass.http.register_view(SipCoreConfigView())
22 | hass.http.register_view(AsteriskIngressView())
23 |
24 | logger.info("Setting up SIP Core component")
25 | hass.data.setdefault(DOMAIN, {
26 | "data": config_entry.data,
27 | "options": {"sip_config": sip_config},
28 | "entry_id": config_entry.entry_id,
29 | })
30 | logger.info(config_entry.data)
31 | logger.info(config_entry.options)
32 | logger.info(config_entry.entry_id)
33 |
34 | await hass.http.async_register_static_paths(
35 | [
36 | StaticPathConfig(
37 | url_path=JS_URL_PATH,
38 | path=Path(__file__).parent / "www" / JS_FILENAME,
39 | cache_headers=True,
40 | ),
41 | StaticPathConfig(
42 | url_path="/sip_core_files/ringback-tone.mp3",
43 | path=Path(__file__).parent / "www" / "ringback-tone.mp3",
44 | cache_headers=True,
45 | ),
46 | StaticPathConfig(
47 | url_path="/sip_core_files/ring-tone.mp3",
48 | path=Path(__file__).parent / "www" / "ring-tone.mp3",
49 | cache_headers=True,
50 | ),
51 | ]
52 | )
53 |
54 | await add_resources(hass)
55 |
56 | config_entry.add_update_listener(update_listener)
57 |
58 | return True
59 |
60 |
61 | async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
62 | """Unload a config entry."""
63 | logger.info("Unloading SIP Core component")
64 | hass.data.pop(DOMAIN, None)
65 | await remove_resources(hass)
66 | return True
67 |
68 |
69 | async def update_listener(hass: HomeAssistant, config_entry: ConfigEntry):
70 | """Handle options update."""
71 | logger.info("SIP Core configuration updated")
72 | hass.data[DOMAIN]["options"]["sip_config"] = config_entry.options.get("sip_config")
73 |
74 |
75 | class SipCoreConfigView(HomeAssistantView):
76 | """View to serve SIP Core configuration."""
77 |
78 | url = "/api/sip-core/config"
79 | name = "api:sip-core:config"
80 | requires_auth = True
81 |
82 | async def get(self, request: Request):
83 | """Handle GET request."""
84 | hass: HomeAssistant = request.app["hass"]
85 | try:
86 | sip_config = hass.data[DOMAIN]["options"]["sip_config"]
87 | return self.json(sip_config)
88 | except KeyError:
89 | return self.json({"error": "No configuration found"}, status_code=500)
90 |
91 |
92 | class AsteriskIngressView(HomeAssistantView):
93 | """View to handle Asterisk Add-on ingress."""
94 |
95 | url = "/api/sip-core/asterisk-ingress"
96 | name = "api:sip-core:asterisk-ingress"
97 | requires_auth = True
98 |
99 | async def get(self, request: Request) -> Response:
100 | hass: HomeAssistant = request.app["hass"]
101 | hassio: HassIO | None = hass.data.get(HASSIO_DOMAIN)
102 | if not hassio:
103 | return self.json({"error": "supervisor not available"}, status_code=503)
104 |
105 | supervisor_client = get_supervisor_client(hass)
106 | try:
107 | addon_info = await supervisor_client.addons.addon_info(ASTERISK_ADDON_SLUG)
108 | ingress_entry = addon_info.ingress_entry
109 | if not ingress_entry:
110 | raise ValueError("Ingress entry not found for Asterisk add-on")
111 | return self.json({"ingress_entry": ingress_entry})
112 | except Exception as err:
113 | logger.error(f"Error fetching Asterisk add-on info: {err}")
114 | return self.json({"error": "Failed to fetch add-on info"}, status_code=500)
115 |
--------------------------------------------------------------------------------
/src/sip-contacts-card.ts:
--------------------------------------------------------------------------------
1 | import { LitElement, html, css } from "lit";
2 | import { sipCore } from "./sip-core";
3 |
4 | declare global {
5 | interface Window {
6 | customCards?: Array<{ type: string; name: string; preview: boolean; description: string }>;
7 | }
8 | }
9 |
10 | interface Extension {
11 | name: string;
12 | status_entity: string | null;
13 | camera_entity: string | null;
14 | hidden: boolean | null;
15 | edit: boolean | null;
16 | override_icon: string | null;
17 | override_state: string | null;
18 | }
19 |
20 | interface SIPContactsCardConfig {
21 | extensions: { [key: string]: Extension };
22 | title: string;
23 | hide_me: boolean;
24 | state_color: boolean;
25 | }
26 |
27 | class SIPContactsCard extends LitElement {
28 | public hass: any;
29 | public config: SIPContactsCardConfig | undefined;
30 |
31 | static get styles() {
32 | return css`
33 | #audioVisualizer {
34 | min-height: 20em;
35 | height: 100%;
36 | white-space: nowrap;
37 | align-items: center;
38 | display: flex;
39 | justify-content: center;
40 | }
41 |
42 | #audioVisualizer div {
43 | display: inline-block;
44 | width: 3px;
45 | height: 100px;
46 | margin: 0 7px;
47 | background: currentColor;
48 | transform: scaleY(0.5);
49 | opacity: 0.25;
50 | }
51 |
52 | .wrapper {
53 | padding: 8px;
54 | padding-top: 0px;
55 | padding-bottom: 2px;
56 | margin-top: -16px;
57 | }
58 |
59 | .flex {
60 | flex: 1;
61 | margin-top: 6px;
62 | margin-bottom: 6px;
63 | display: flex;
64 | justify-content: space-between;
65 | align-items: center;
66 | min-width: 0;
67 | }
68 |
69 | .info,
70 | .info > * {
71 | white-space: nowrap;
72 | overflow: hidden;
73 | text-overflow: ellipsis;
74 | }
75 |
76 | .info {
77 | flex: 1 1 30%;
78 | cursor: pointer;
79 | margin-left: 16px;
80 | margin-right: 8px;
81 | }
82 |
83 | .editField {
84 | width: 100%;
85 | margin-left: 16px;
86 | margin-right: 8px;
87 | }
88 |
89 | state-badge {
90 | flex-shrink: 0;
91 | }
92 | `;
93 | }
94 |
95 | connectedCallback() {
96 | super.connectedCallback();
97 | window.addEventListener("sipcore-update", () => this.requestUpdate());
98 | }
99 |
100 | disconnectedCallback() {
101 | super.disconnectedCallback();
102 | window.removeEventListener("sipcore-update", () => this.requestUpdate());
103 | }
104 |
105 | render() {
106 | var connection_state = "";
107 | if (sipCore.RTCSession != null) {
108 | connection_state = sipCore.RTCSession?.status.toString();
109 | }
110 |
111 | return html`
112 |
114 | ${Object.entries(this.config?.extensions || {}).map(([number, extension]) => {
115 | const isMe = number === sipCore.user.extension;
116 | const stateObj = this.hass.states[extension.status_entity || ""] || null;
117 | if (extension.hidden) return;
118 | if (isMe && this.config?.hide_me) return;
119 | const icon = stateObj ? extension.override_icon : extension.override_icon || "mdi:account";
120 | if (extension.edit) {
121 | return html`
122 |
178 |
123 | CALL
156 |
157 | `;
158 | } else {
159 | return html`
160 |
161 | CALL
173 |
174 | `;
175 | }
176 | })}
177 | ${extension.name}
167 |
258 | No active call
259 |
260 | `
261 | : camera
262 | ? html`
263 |
302 |
310 |
314 | Default Output
315 |
317 | ${this.outputDevices.map(
318 | (device) => html`
319 |
324 | ${device.label}
325 |
327 | `,
328 | )}
329 |
331 |
339 |
343 | Default Input
344 |
346 | ${this.inputDevices.map(
347 | (device) => html`
348 |
353 | ${device.label}
354 |
356 | `,
357 | )}
358 |
360 |
361 | Logged in as ${sipCore.user.ha_username} (${
362 | sipCore.user.extension
363 | })
364 | The current user used to log in to the SIP server. You can configure users in the SIP Core options
365 |
366 |
367 | Is ${
368 | sipCore.registered ? "registered" : "not registered"
369 | } (${sipCore.registered ? "true" : "false"})
370 | The current registration status of the SIP client. If not registered, check browser console and Asterisk logs for more information
371 |
372 |
373 | Call state is ${sipCore.callState}
374 | The current call state of the SIP client
375 |
376 |
377 | SIP-Core v${sipCore.version}
378 | The main SIP call system, created by Jordy Kuhne
379 |
380 |
381 |
394 | ${statusText}
395 | ${sipCore.callDuration}
396 |
397 |
444 |
559 |
445 |
450 |
453 | ${
454 | sipCore.callState === CALLSTATE.IDLE
455 | ? html`
456 |
472 |
473 |
477 |
479 |
555 |
557 |
558 |
480 | ${this.config.buttons.map((button) => {
481 | if (button.type === ButtonType.SERVICE_CALL) {
482 | return html`
483 |
491 |
493 | `;
494 | } else if (button.type === ButtonType.DTMF) {
495 | return html`
496 |
503 |
505 | `;
506 | }
507 | })}
508 |
509 |
510 |
520 |
527 |
528 |
539 |
547 |
548 |