9 Commits
6 changed files with 179 additions and 46 deletions
+15 -2
View File
@@ -1,9 +1,22 @@
# CHANGELOG - Whatsapp Bridge Integration
## Release 0.3.0 - 2026-08-04
- **Fix:** Discover the installed WhatsApp Bridge add-on through the Supervisor API instead of relying exclusively on the old hard-coded repository hostname.
- **Fix:** Reuse Home Assistant's asynchronous HTTP session for status checks and message delivery.
- **Fix:** Surface HTTP and add-on errors when sending a message instead of reporting failed requests as successful.
## Release 0.2.4 - 2026-06-15
- **Fix:** Resolved a `TypeError` in `async_get_or_create()` caused by stricter Home Assistant Core requirements demanding a `config_entry_id` for all device registry entries.
- **Architecture Refinement:** The global "WhatsApp Bridge Hub" now utilizes a shared multi-entry architecture. It dynamically links to active configurations under a static identifier, ensuring the hub remains a single, non-duplicated entity that survives individual account deletions.
## Release 0.2.3 - 2026-06-15
- **New (Orphaned Devices Cleaner):** Added an automatic database cleanup utility. On startup, the integration now automatically identifies and removes orphaned or "ghost" devices left behind by previous configuration changes or older versions.
- **Fix:** Decoupled the central "WhatsApp Bridge Hub" device from specific config entry bindings. The Hub is now persistent and indestructible, preventing global entities (Broadcast and Live Status) from disappearing when individual user profiles are deleted or re-added.
## Release 0.2.2 - 2026-06-15
- **Architecture Change:** Introduced a dedicated "WhatsApp Bridge Hub" device. This central device acts as a single point of reference for global components, preventing UI clutter.
- **Fix:** Moved the global live status sensor and the virtual broadcast entity to the new WhatsApp Bridge Hub device. This ensures they remain fully visible and accessible across the Home Assistant UI, automations, and service calls without being duplicated across individual user accounts.
- **Improvement:** Maintained isolated, clean individual devices for each configured account profile (*Larissa, Rene, Work*).
- **Improvement:** Maintained isolated, clean individual devices for each configured account profile.
## Release 0.2.1 - 2026-06-15
- **Fix:** Resolved device assignment duplication where a single global gateway card duplicated across all account tabs.
@@ -17,4 +30,4 @@
- **Improved:** The sensor is assigned to the new main device, which significantly simplifies automations (e.g., alert on connection loss).
## Release 0.1.7
- Previous stable version
- Previous stable version
@@ -2,6 +2,7 @@ import logging
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr
from .const import DOMAIN
from .api import WhatsAppBridgeApi
_LOGGER = logging.getLogger(__name__)
@@ -9,33 +10,51 @@ async def async_setup(hass: HomeAssistant, config: dict):
return True
async def async_setup_entry(hass: HomeAssistant, entry):
"""Set up entry, create specific contact device, central hub and forward to platforms."""
"""Set up entry, create devices, and clean up old orphaned devices."""
hass.data.setdefault(DOMAIN, {})
hass.data[DOMAIN][entry.entry_id] = entry.data
hass.data[DOMAIN].setdefault("api", WhatsAppBridgeApi(hass))
device_registry = dr.async_get(hass)
# 1. Eigenes Gerät SPEZIFISCH für diesen Account/Kontakt anlegen
# 1. Automatisches Aufräumen von alten Geister-Geräten
active_entry_ids = set(hass.config_entries.async_entries(DOMAIN))
active_ids = {e.entry_id for e in active_entry_ids}
# Durchsuche die HA-Datenbank nach Geräten unserer Integration
devices_to_clean = [
dev for dev in device_registry.devices.values()
if any(identifier[0] == DOMAIN for identifier in dev.identifiers)
]
for device in devices_to_clean:
# Falls ein Gerät zu einem gelöschten Config Entry gehört -> Löschen!
# Der globale Hub ("global_bridge_hub") wird ignoriert und bleibt erhalten.
for config_id in device.config_entries:
if config_id not in active_ids and not any(idx == "global_bridge_hub" for _, idx in device.identifiers):
_LOGGER.info(f"Entferne verwaistes WhatsApp-Gerät: {device.name}")
device_registry.async_remove_device(device.id)
# 2. Eigenes Gerät SPEZIFISCH für dieses aktive Konto anlegen
device_registry.async_get_or_create(
config_entry_id=entry.entry_id,
identifiers={(DOMAIN, entry.entry_id)}, # Einzigartig pro Eintrag
identifiers={(DOMAIN, entry.entry_id)},
name=f"WhatsApp {entry.title}",
manufacturer="Bahmcloud",
model="Kontakt-Endpunkt",
sw_version="0.2.2",
sw_version="0.3.0",
)
# 2. Zentralen System-Hub NUR EINMALIG anlegen (wird an den ersten geladenen Account gekoppelt)
if not hass.data[DOMAIN].get("hub_device_created"):
device_registry.async_get_or_create(
config_entry_id=entry.entry_id,
identifiers={(DOMAIN, "global_bridge_hub")},
name="WhatsApp Bridge Hub",
manufacturer="Bahmcloud",
model="Bridge Server",
sw_version="0.2.2",
)
hass.data[DOMAIN]["hub_device_created"] = True
# 3. Zentralen System-Hub anlegen mit erzwungener config_entry_id Bindung (HA Core Anforderung)
# Nutzt Multi-Entry-Zusammenführung über den fixen "global_bridge_hub" Identifier.
device_registry.async_get_or_create(
config_entry_id=entry.entry_id,
identifiers={(DOMAIN, "global_bridge_hub")},
name="WhatsApp Bridge Hub",
manufacturer="Bahmcloud",
model="Bridge Server",
sw_version="0.3.0",
)
# Forward the setup to the sensor platform to create entities
await hass.config_entries.async_forward_entry_setups(entry, ["sensor"])
@@ -52,4 +71,7 @@ async def async_unload_entry(hass: HomeAssistant, entry):
unload_ok = await hass.config_entries.async_unload_platforms(entry, ["sensor"])
if unload_ok:
hass.data[DOMAIN].pop(entry.entry_id)
return unload_ok
if hass.data[DOMAIN].get("global_entities_entry_id") == entry.entry_id:
hass.data[DOMAIN].pop("global_entities_entry_id", None)
hass.data[DOMAIN].pop("global_entities_registered", None)
return unload_ok
@@ -0,0 +1,93 @@
"""Client for the WhatsApp Bridge add-on API."""
from __future__ import annotations
import logging
import os
from typing import Any
import aiohttp
from homeassistant.helpers.aiohttp_client import async_get_clientsession
_LOGGER = logging.getLogger(__name__)
ADDON_NAME = "WhatsApp Bridge"
ADDON_SLUG = "whatsapp_bridge"
ADDON_PORT = 3000
LEGACY_BASE_URL = "http://866fd2eb-whatsapp-bridge:3000"
SUPERVISOR_ADDONS_URL = "http://supervisor/addons"
def _addon_base_url(addons: list[dict[str, Any]]) -> str | None:
"""Return the internal URL for the installed WhatsApp Bridge add-on."""
for addon in addons:
slug = str(addon.get("slug", ""))
name = str(addon.get("name", ""))
if name.casefold() == ADDON_NAME.casefold() or slug == ADDON_SLUG or slug.endswith(
f"_{ADDON_SLUG}"
):
return f"http://{slug.replace('_', '-')}:{ADDON_PORT}"
return None
class WhatsAppBridgeApi:
"""Resolve and communicate with the installed add-on."""
def __init__(self, hass) -> None:
self._session = async_get_clientsession(hass)
self._base_url: str | None = None
async def _async_resolve_base_url(self) -> str:
if self._base_url is not None:
return self._base_url
token = os.environ.get("SUPERVISOR_TOKEN")
if token:
try:
async with self._session.get(
SUPERVISOR_ADDONS_URL,
headers={"Authorization": f"Bearer {token}"},
timeout=aiohttp.ClientTimeout(total=5),
) as response:
response.raise_for_status()
payload = await response.json()
data = payload.get("data", payload)
resolved = _addon_base_url(data.get("addons", []))
if resolved:
self._base_url = resolved
_LOGGER.debug("WhatsApp Bridge add-on found at %s", resolved)
return resolved
_LOGGER.warning("WhatsApp Bridge add-on was not found by Supervisor")
except (aiohttp.ClientError, TimeoutError, ValueError, TypeError) as err:
_LOGGER.warning("Could not discover WhatsApp Bridge add-on: %s", err)
return LEGACY_BASE_URL
async def async_get_status(self) -> dict[str, Any]:
"""Fetch the current bridge status."""
base_url = await self._async_resolve_base_url()
async with self._session.get(
f"{base_url}/api/status",
timeout=aiohttp.ClientTimeout(total=8),
) as response:
response.raise_for_status()
data = await response.json()
if not isinstance(data, dict):
raise ValueError("Status response is not an object")
return data
async def async_send_message(self, number: str, message: str) -> None:
"""Send one WhatsApp message and surface add-on errors to Home Assistant."""
base_url = await self._async_resolve_base_url()
async with self._session.post(
f"{base_url}/send",
json={"number": number, "message": message},
timeout=aiohttp.ClientTimeout(total=15),
) as response:
if response.status >= 400:
try:
detail = (await response.json()).get("error")
except (aiohttp.ContentTypeError, ValueError, AttributeError):
detail = await response.text()
raise RuntimeError(detail or f"HTTP {response.status}")
@@ -4,7 +4,7 @@
"documentation": "https://git.bahmcloud.de/bahmcloud/Whatsapp-Bridge-Integration",
"dependencies": [],
"codeowners": ["@bahmcloud"],
"version": "0.2.2",
"version": "0.3.0",
"iot_class": "local_polling",
"config_flow": true
}
}
@@ -1,5 +1,4 @@
import logging
import async_timeout
import aiohttp
from datetime import timedelta
@@ -15,18 +14,14 @@ SCAN_INTERVAL = timedelta(seconds=15)
async def async_setup_entry(hass, entry, async_add_entities):
"""Add sensors for WhatsApp accounts, live status, and a global broadcast sensor."""
api = hass.data[DOMAIN]["api"]
# Coordinator für den echten Live-Status vom Add-on einrichten
async def _async_update_data():
url = "http://866fd2eb-whatsapp-bridge:3000/api/status"
async with aiohttp.ClientSession() as session:
try:
async with async_timeout.timeout(5):
async with session.get(url) as response:
if response.status != 200:
raise UpdateFailed(f"API meldet Fehler {response.status}")
return await response.json()
except Exception as err:
raise UpdateFailed(f"Add-on nicht erreichbar: {err}")
try:
return await api.async_get_status()
except (aiohttp.ClientError, TimeoutError, ValueError) as err:
raise UpdateFailed(f"Add-on nicht erreichbar: {err}") from err
coordinator = DataUpdateCoordinator(
hass,
@@ -36,9 +31,8 @@ async def async_setup_entry(hass, entry, async_add_entities):
update_interval=SCAN_INTERVAL,
)
try:
await coordinator.async_config_entry_first_refresh()
except UpdateFailed:
await coordinator.async_refresh()
if not coordinator.last_update_success:
_LOGGER.warning("Erster Status-Abruf fehlgeschlagen. Add-on läuft eventuell noch an.")
# Jeder Account bekommt immer seine eigene Entität
@@ -49,6 +43,7 @@ async def async_setup_entry(hass, entry, async_add_entities):
entities.append(WhatsAppStatusSensor(coordinator))
entities.append(WhatsAppBroadcastEntity())
hass.data[DOMAIN]["global_entities_registered"] = True
hass.data[DOMAIN]["global_entities_entry_id"] = entry.entry_id
async_add_entities(entities, True)
@@ -93,7 +88,7 @@ class WhatsAppBroadcastEntity(SensorEntity):
@property
def device_info(self) -> DeviceInfo:
"""Ordnet diese Entität dem zentralen Hub-Gerät zu."""
"""Ordnet diese Entität dem permanenten, zentralen Hub-Gerät zu."""
return DeviceInfo(
identifiers={(DOMAIN, "global_bridge_hub")},
)
@@ -129,6 +124,8 @@ class WhatsAppStatusSensor(SensorEntity):
return "WAITING_FOR_SCAN"
elif data.get("isInitializing"):
return "INITIALIZING"
elif data.get("reconnectAttempts", 0) > 0:
return "RECONNECTING"
return "UNKNOWN"
@@ -139,13 +136,16 @@ class WhatsAppStatusSensor(SensorEntity):
if data:
return {
"client_state": data.get("clientState", "UNKNOWN"),
"has_qr_code": data.get("hasQr", False)
"has_qr_code": data.get("hasQr", False),
"is_initializing": data.get("isInitializing", False),
"reconnect_attempts": data.get("reconnectAttempts", 0),
"last_error": data.get("lastError"),
}
return {}
@property
def device_info(self) -> DeviceInfo:
"""Ordnet diese Entität dem zentralen Hub-Gerät zu."""
"""Ordnet diese Entität dem permanenten, zentralen Hub-Gerät zu."""
return DeviceInfo(
identifiers={(DOMAIN, "global_bridge_hub")},
)
@@ -154,4 +154,4 @@ class WhatsAppStatusSensor(SensorEntity):
"""Registrieren beim Live-Coordinator."""
self.async_on_remove(
self.coordinator.async_add_listener(self.async_write_ha_state)
)
)
@@ -1,6 +1,7 @@
import requests
import logging
import aiohttp
from homeassistant.core import HomeAssistant, ServiceCall
from homeassistant.exceptions import HomeAssistantError
from .const import DOMAIN, CONF_PHONE_NUMBER
_LOGGER = logging.getLogger(__name__)
@@ -9,6 +10,8 @@ async def async_setup_services(hass: HomeAssistant):
async def handle_send_message(call: ServiceCall):
message = call.data.get("message")
recipient = call.data.get("recipient")
if not recipient or message is None:
raise HomeAssistantError("Empfänger und Nachricht sind erforderlich")
targets = []
entries = hass.config_entries.async_entries(DOMAIN)
@@ -29,16 +32,18 @@ async def async_setup_services(hass: HomeAssistant):
else:
targets.append(recipient)
api = hass.data[DOMAIN]["api"]
# Senden
for num in targets:
if not num: continue
url = "http://866fd2eb-whatsapp-bridge:3000/send"
try:
await hass.async_add_executor_job(
lambda: requests.post(url, json={"number": num, "message": message}, timeout=10)
)
await api.async_send_message(num, message)
_LOGGER.info("WhatsApp sent to %s", num)
except Exception as e:
_LOGGER.error("Error sending to %s: %s", num, str(e))
except (aiohttp.ClientError, TimeoutError, RuntimeError) as err:
_LOGGER.error("Error sending to %s: %s", num, err)
raise HomeAssistantError(
f"WhatsApp-Nachricht an {num} fehlgeschlagen: {err}"
) from err
hass.services.async_register(DOMAIN, "send_message", handle_send_message)
hass.services.async_register(DOMAIN, "send_message", handle_send_message)