163 lines
3.6 KiB
Markdown
163 lines
3.6 KiB
Markdown
# SIP Voice Notifier Add-on
|
|
|
|
## Installation Complete!
|
|
|
|
The add-on is running and listening on port 8099.
|
|
|
|
## Setup Service in Home Assistant
|
|
|
|
To use the add-on, add this to your `/config/configuration.yaml`:
|
|
|
|
```yaml
|
|
# SIP Voice Notifier Service
|
|
script:
|
|
sip_send_notification:
|
|
alias: "SIP Voice Notification"
|
|
description: "Send voice notification via SIP call"
|
|
icon: mdi:phone-voip
|
|
mode: queued
|
|
fields:
|
|
destination:
|
|
name: Destination
|
|
description: "Phone number (e.g., +15551234567)"
|
|
required: true
|
|
example: "+15551234567"
|
|
selector:
|
|
text:
|
|
audio_url:
|
|
name: Audio URL
|
|
description: "HTTP(S) URL to audio file (MP3/WAV)"
|
|
required: false
|
|
example: "https://example.com/alert.mp3"
|
|
selector:
|
|
text:
|
|
message:
|
|
name: Message
|
|
description: "Text message for TTS"
|
|
required: false
|
|
example: "Emergency alert message"
|
|
selector:
|
|
text:
|
|
duration:
|
|
name: Duration
|
|
description: "Call duration in seconds"
|
|
required: false
|
|
default: 30
|
|
example: 30
|
|
selector:
|
|
number:
|
|
min: 5
|
|
max: 300
|
|
sequence:
|
|
- service: rest_command.sip_notification_call
|
|
data:
|
|
destination: "{{ destination }}"
|
|
audio_url: "{{ audio_url | default('') }}"
|
|
message: "{{ message | default('') }}"
|
|
duration: "{{ duration | default(30) }}"
|
|
|
|
rest_command:
|
|
sip_notification_call:
|
|
url: "http://088d3b92-sip-notifier:8099/send_notification"
|
|
method: POST
|
|
content_type: "application/json"
|
|
payload: >
|
|
{
|
|
"destination": "{{ destination }}",
|
|
{% if audio_url and audio_url != '' %}"audio_url": "{{ audio_url }}",{% endif %}
|
|
{% if message and message != '' %}"message": "{{ message }}",{% endif %}
|
|
"duration": {{ duration | default(30) }}
|
|
}
|
|
```
|
|
|
|
## Restart Home Assistant
|
|
|
|
After adding to configuration.yaml:
|
|
- Settings → System → Restart
|
|
|
|
## Usage
|
|
|
|
### Play Audio from URL
|
|
|
|
```yaml
|
|
service: script.sip_send_notification
|
|
data:
|
|
destination: "+15551234567"
|
|
audio_url: "https://example.com/alert.mp3"
|
|
duration: 30
|
|
```
|
|
|
|
### Text-to-Speech
|
|
|
|
```yaml
|
|
service: script.sip_send_notification
|
|
data:
|
|
destination: "+15551234567"
|
|
message: "Emergency! Water leak detected!"
|
|
duration: 40
|
|
```
|
|
|
|
## Example Automation
|
|
|
|
```yaml
|
|
automation:
|
|
- alias: "Water Leak Emergency Call"
|
|
trigger:
|
|
platform: state
|
|
entity_id: binary_sensor.water_leak
|
|
to: "on"
|
|
action:
|
|
- service: script.sip_send_notification
|
|
data:
|
|
destination: "+15551234567"
|
|
message: "EMERGENCY! Water leak detected in basement!"
|
|
duration: 45
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### Service not found
|
|
|
|
1. Check you added the script to configuration.yaml
|
|
2. Restart Home Assistant
|
|
3. Check for syntax errors in configuration.yaml
|
|
|
|
### Call fails
|
|
|
|
Check add-on logs:
|
|
Settings → Add-ons → SIP Voice Notifier → Log
|
|
|
|
Common issues:
|
|
- Incorrect SIP credentials
|
|
- Phone number format (use international: +1...)
|
|
- Network connectivity to SIP server
|
|
|
|
## Configuration
|
|
|
|
Add-on configuration options:
|
|
|
|
- **sip_server**: Your SIP provider's server address
|
|
- **sip_user**: Your SIP username
|
|
- **sip_password**: Your SIP password
|
|
- **default_duration**: Default call duration in seconds (5-300)
|
|
|
|
## SIP Providers
|
|
|
|
### Twilio
|
|
```yaml
|
|
sip_server: "ACXXXXX.pstn.twilio.com"
|
|
sip_user: "ACXXXXX"
|
|
sip_password: "your_auth_token"
|
|
```
|
|
|
|
### VoIP.ms
|
|
```yaml
|
|
sip_server: "server.voip.ms"
|
|
sip_user: "123456_subaccount"
|
|
sip_password: "password"
|
|
```
|
|
|
|
## Support
|
|
|
|
Issues: https://git.aymerick.fr/Aymerick/ha-sip-notifier/issues
|