Initial commit: SIP Voice Notifier v2 - single add-on with integrated service
This commit is contained in:
114
README.md
Normal file
114
README.md
Normal file
@@ -0,0 +1,114 @@
|
||||
# SIP Voice Notifier for Home Assistant
|
||||
|
||||
Send voice notifications via SIP phone calls from Home Assistant.
|
||||
|
||||
## Features
|
||||
|
||||
- 📞 Place SIP calls from automations
|
||||
- 🔊 Play audio from HTTP/HTTPS URLs (MP3, WAV, etc.)
|
||||
- 🗣️ Text-to-speech support
|
||||
- ⚡ One-step installation (add-on includes integration)
|
||||
- 🔧 Configurable call duration
|
||||
|
||||
## Installation
|
||||
|
||||
### 1. Add this repository to Home Assistant
|
||||
|
||||
Settings → Add-ons → Add-on Store → ⋮ (menu) → Repositories
|
||||
|
||||
Add URL:
|
||||
```
|
||||
https://git.aymerick.fr/openclaw-bot/ha-sip-notifier
|
||||
```
|
||||
|
||||
### 2. Install the "SIP Voice Notifier" add-on
|
||||
|
||||
Find it in the add-on store and click Install.
|
||||
|
||||
### 3. Configure
|
||||
|
||||
Settings → Add-ons → SIP Voice Notifier → Configuration
|
||||
|
||||
```yaml
|
||||
sip_server: "sip.yourprovider.com"
|
||||
sip_user: "your_username"
|
||||
sip_password: "your_password"
|
||||
default_duration: 30
|
||||
```
|
||||
|
||||
**Twilio example:**
|
||||
```yaml
|
||||
sip_server: "ACXXXXX.pstn.twilio.com"
|
||||
sip_user: "ACXXXXX"
|
||||
sip_password: "your_auth_token"
|
||||
default_duration: 30
|
||||
```
|
||||
|
||||
### 4. Start the add-on
|
||||
|
||||
Click Start. The service `sip_notifier.send_notification` will be automatically available!
|
||||
|
||||
### 5. Restart Home Assistant (if needed)
|
||||
|
||||
Settings → System → Restart
|
||||
|
||||
## Usage
|
||||
|
||||
### Play Audio from URL
|
||||
|
||||
```yaml
|
||||
service: sip_notifier.send_notification
|
||||
data:
|
||||
destination: "+15551234567"
|
||||
audio_url: "https://example.com/alert.mp3"
|
||||
duration: 30
|
||||
```
|
||||
|
||||
### Text-to-Speech
|
||||
|
||||
```yaml
|
||||
service: sip_notifier.send_notification
|
||||
data:
|
||||
destination: "+15551234567"
|
||||
message: "Emergency! Water leak detected!"
|
||||
duration: 40
|
||||
```
|
||||
|
||||
## Example Automation
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "Water Leak Alert"
|
||||
trigger:
|
||||
platform: state
|
||||
entity_id: binary_sensor.water_leak
|
||||
to: "on"
|
||||
action:
|
||||
service: sip_notifier.send_notification
|
||||
data:
|
||||
destination: "+15551234567"
|
||||
message: "EMERGENCY! Water leak detected in basement!"
|
||||
duration: 45
|
||||
```
|
||||
|
||||
## SIP Providers
|
||||
|
||||
### Twilio
|
||||
- Cost: ~$0.013/min
|
||||
- Easy setup, reliable
|
||||
|
||||
### VoIP.ms
|
||||
- Cost: ~$0.009/min
|
||||
- Canadian provider, good value
|
||||
|
||||
## Documentation
|
||||
|
||||
Full documentation available in the add-on README.
|
||||
|
||||
## Support
|
||||
|
||||
Issues and questions: https://git.aymerick.fr/openclaw-bot/ha-sip-notifier/issues
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user