From ab049e33cce1cb3dde66a013682e662be59d2fd1 Mon Sep 17 00:00:00 2001 From: Erick Hitter <services@ethitter.com> Date: Sat, 10 Sep 2016 15:46:39 -0700 Subject: [PATCH] Update readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ab8c595..cffe1ef 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ Dash Button SHM Controller ========================== -A node.js module to control [Samsungs SmartThings' Smart Home Monitor](https://support.smartthings.com/hc/en-us/articles/205380154-Smart-Home-Monitor) using an [Amazon Dash button](https://www.amazon.com/Dash-Buttons/b?ie=UTF8&node=10667898011). +A node.js module to control [Samsungs SmartThings' Smart Home Monitor](https://support.smartthings.com/hc/en-us/articles/205380154-Smart-Home-Monitor) using an [Amazon Dash button](https://www.amazon.com/Dash-Buttons/b?ie=UTF8&node=10667898011) and [Home Assistant](https://home-assistant.io/). -**This library requires that SHM is accessible over MQTT, as discussed [here](https://ethitter.com/2016/08/smartthings-smart-home-monitor-shm-mqtt-home-assistant/).** In turn, it requires the [SmartThings MQTT Bridge](https://github.com/stjohnjohnson/smartthings-mqtt-bridge). +**This library requires that SHM is accessible to Home Assistant via MQTT, as discussed [here](https://ethitter.com/2016/08/smartthings-smart-home-monitor-shm-mqtt-home-assistant/).** ## Prerequisties - +* [Home Assistant](https://home-assistant.io/) +* [SmartThings MQTT Bridge](https://github.com/stjohnjohnson/smartthings-mqtt-bridge) +* [SmartThings SHM MQTT Bridge](https://ethitter.com/2016/08/smartthings-smart-home-monitor-shm-mqtt-home-assistant/) ## Install @@ -20,4 +22,5 @@ Follow Amazon's instructions to configure your button to send messages when you ## Configuration 1. Discover the Dash Buttons using `node node_modules/node-dash-button/bin/findbutton`. -1. Rename `config-sample.json` to `config.json`. \ No newline at end of file +1. Rename `config-sample.json` to `config.json`. Update its values to match your configuration, including the buttons discovered in the last step. +3. Start the listener with `npm start`. \ No newline at end of file -- GitLab