From 2810ca5e919d7917feb3a55c3dc2f7310314cc8f Mon Sep 17 00:00:00 2001
From: TimV <tgvitz@gmail.com>
Date: Mon, 27 Feb 2017 00:38:50 -0500
Subject: [PATCH] Create sensor.modem_callerid.markdown (#2003)

* Create sensor.modem_callerid.markdown

Documentation page for Analog modem callerid support (#5840)

* Update sensor.modem_callerid.markdown

Updated configuration file information and added description to identify USB modem.

* Update sensor.modem_callerid.markdown

Added description of how senor operates and example automation for using the sensor.

* Update sensor.modem_callerid.markdown
---
 .../sensor.modem_callerid.markdown            | 76 +++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 source/_components/sensor.modem_callerid.markdown

diff --git a/source/_components/sensor.modem_callerid.markdown b/source/_components/sensor.modem_callerid.markdown
new file mode 100644
index 00000000000..a13f1fa59e9
--- /dev/null
+++ b/source/_components/sensor.modem_callerid.markdown
@@ -0,0 +1,76 @@
+---
+layout: page
+title: "Caller ID Sensor"
+description: "Instructions how to integrate the Caller ID sensor into Home Assistant."
+date: 2017-02-20 22:10
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: home-assistant.png
+ha_category: Sensor
+ha_release: 0.40
+---
+
+
+The `modem_callerid` sensor platform 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).
+
+To enable the sensor, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  - platform: modem_callerid
+
+```
+
+Configuration variables:
+
+- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `modem_callerid`.
+- **device** (*Optional*): Device port name. Defaults to `/dev/ttyACM0`.
+
+To find the path of your USB modem, run:
+
+`$ ls /dev/ttyACM*`
+
+If `hass` runs with another user (e.g. *homeassistant* on Hassbian) 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](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/).
+
+When the sensor detects a new call, it's 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.
+
+Some example automations:
+```yaml
+automation:
+  - alias: Notify CallerID
+    trigger: 
+      platform: state
+      entity_id: sensor.modem_callerid
+      state: "callerid"      
+    action:
+      service: notify.notify
+      data:
+        message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} at {{ states.sensor.modem_callerid.attributes.cid_number }} '
+  - alias: Notify CallerID webui
+    trigger: 
+      platform: state
+      entity_id: sensor.modem_callerid
+      state: "callerid"      
+    action:
+      service: persistent_notification.create
+      data:
+        title: "Call from"
+        message: '{{ states.sensor.modem_callerid.attributes.cid_time.strftime("%I:%M %p") }} {{ states.sensor.modem_callerid.attributes.cid_name }}  {{ states.sensor.modem_callerid.attributes.cid_number }} '
+  - alias: Say CallerID
+    trigger: 
+      platform: state
+      entity_id: sensor.modem_callerid
+      state: "callerid"      
+    action:
+      service: tts.google_say
+      data_template:
+        message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} '
+```
+