3.1 KiB
title, description, ha_category, ha_release, ha_iot_class, ha_domain
| title | description | ha_category | ha_release | ha_iot_class | ha_domain | |
|---|---|---|---|---|---|---|
| Modem Caller ID | Instructions on how to integrate the Caller ID sensor into Home Assistant. |
|
0.40 | Local Polling | modem_callerid |
The modem_callerid integration uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number.
Setup
To find the path of your USB modem, run:
ls /dev/ttyACM*
If Home Assistant (hass) runs with another user (e.g., homeassistant) give access to the stick with:
sudo usermod -a -G dialout homeassistant
Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as /dev/modem, by following these instructions.
Configuration
To enable the sensor, add the following lines to your configuration.yaml:
# Example configuration.yaml entry
sensor:
- platform: modem_callerid
{% configuration %}
name:
description: Name of the sensor to use in the frontend.
required: false
type: string
default: "modem_callerid"
device:
description: The port to use.
required: false
type: string
default: "/dev/ttyACM0"
{% endconfiguration %}
To find the path of your USB modem, run:
$ ls /dev/ttyACM*
If Home Assistant (hass) runs with another user (e.g., homeassistant) give access to the stick with:
$ sudo usermod -a -G dialout homeassistant
Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as /dev/modem, by following these instructions.
Examples
Some example automations:
{% raw %}
automation:
- alias: Notify CallerID
trigger:
platform: state
entity_id: sensor.modem_callerid
to: "callerid"
action:
service: notify.notify
data:
message: 'Call from {{ state_attr('sensor.modem_callerid', 'cid_name') }} at {{ state_attr('sensor.modem_callerid', 'cid_number') }} '
- alias: Notify CallerID webui
trigger:
platform: state
entity_id: sensor.modem_callerid
to: "callerid"
action:
service: persistent_notification.create
data:
title: "Call from"
message: '{{ state_attr('sensor.modem_callerid', 'cid_time').strftime("%I:%M %p") }} {{ state_attr('sensor.modem_callerid', 'cid_name') }} {{ state_attr('sensor.modem_callerid', 'cid_number') }} '
- alias: Say CallerID
trigger:
platform: state
entity_id: sensor.modem_callerid
to: "callerid"
action:
service: tts.google_say
data_template:
message: 'Call from {{ state_attr('sensor.modem_callerid', 'cid_name') }}'
{% endraw %}