Files
Whatsapp-Bridge-Addon/README.md
2026-04-14 10:57:39 +00:00

2.0 KiB

WhatsApp Bridge for Home Assistant 📱🤖

A seamless, user-friendly way to integrate WhatsApp into your Home Assistant (HAOS) environment. This project allows you to send automated messages from multiple accounts directly through Home Assistant and Node-RED.


🌟 Features

  • Native HAOS Support: Specifically designed to run as a Home Assistant Add-on.
  • Easy Setup (Ingress): Scan the WhatsApp QR code directly within the Home Assistant UI. No terminal or external browser required.
  • Multi-Account Support: Manage different phone numbers/accounts and address them individually in your automations.
  • Node-RED Ready: All accounts appear as standard Home Assistant services/actions, making them instantly accessible in Node-RED.
  • Session Persistence: Your login stays active even after restarting Home Assistant or the Add-on.

🏗️ Architecture

This project consists of two parts:

  1. The Add-on: A Node.js bridge using whatsapp-web.js and a headless Chromium browser to handle the WhatsApp Web connection.
  2. The Integration: A custom component (Python) that adds easy-to-use services to your HA instance (e.g., whatsapp.send_message).

🚀 Quick Start (Installation)

1. Add Repository

  1. Go to your Home Assistant instance -> Settings -> Add-ons -> Add-on Store.
  2. Click the three dots (top right) -> Repositories.
  3. Paste this GitHub URL and click Add.
  1. Find "WhatsApp Bridge" in the store and click Install.
  2. Start the Add-on.
  3. Click Open Web UI and scan the QR code with your WhatsApp mobile app (under Linked Devices).

3. Add Custom Integration

Once the Add-on is running, you can add the custom integration to define your accounts/numbers.


🛠️ Usage in Automations

Once configured, you can send messages using a simple service call:

YAML Example:

service: whatsapp.send_message
data:
  account: "Private"
  message: "Hello from Home Assistant! 🤖"