diff --git a/README.md b/README.md index b0c970497dd9af00f66ea6455c7af72435e91801..3689bfe07d42294077aaaf256ebf2b681868d326 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ -Dash Button Home Assistant Controller +Flic Button Home Assistant Controller ===================================== -A node.js module to control [Home Assistant](https://home-assistant.io/) entities via [Amazon Dash button](https://www.amazon.com/Dash-Buttons/b?ie=UTF8&node=10667898011) buttons. +A node.js module to control [Home Assistant](https://home-assistant.io/) entities via [Flic smart buttons](https://flic.io/). ## Prerequisties -* At least one Dash button (multiple are supported and can control discrete services) +* At least one Flic button (multiple are supported and can control discrete services) * [Home Assistant](https://home-assistant.io/) +* The `flicd` daemon [from Flic's Linux SDK](https://github.com/50ButtonsEach/fliclib-linux-hci) running somewhere accessible to the device running this script ## Install npm install -### Dash Button Preparation +### `flicd` Preparation -Follow Amazon's instructions to configure your button to send messages when you push them but not actually order anything. When you get a Dash button, Amazon gives you a list of setup instructions to get going. Just follow this list of instructions, but don’t complete the final step of selecting a product to order. **Do not select a product, just exit the app**. +If `flicd` and this script are not run from the same device, ensure that `flicd` is started with the `-s` flag set either to `0.0.0.0` or the IP of the device running the controller. ## Configuration -1. Discover the Dash Buttons using `node node_modules/node-dash-button/bin/findbutton`. +1. Register Flic buttons with `flicd` and note the Bluetooth MAC addresses of the various buttons 1. Rename `config-sample.json` to `config.json`. Update its values to match your configuration, including the buttons discovered in the last step. 1. Start the listener with `npm start`. ## FAQ -**Can I stop the incessant notifications from the Amazon app?** +**Can I run `flicd` as a daemon/at startup?** -The best way to do this is by blocking the button's Internet access. The button only needs to make an appearance on the network to be effective; it doesn't need to communicate outside of the local network. - - If, on the other hand, you only use Dash buttons as IoT devices, you can disable Dash-related noticiations by going to the Dash Button settings screen in your mobile app, proceeding into _Notification Settings_, then unselecting the _Dash Button Updates_ option. - \ No newline at end of file +Yes. See https://ethtiter.com/ for a `systemd` service file. diff --git a/package.json b/package.json index 72b1cacd9b19a1090964bf165f8432153b57a27d..bc98c5c5b1c441f5f7b0aafd5145da941965da1a 100644 --- a/package.json +++ b/package.json @@ -1,25 +1,23 @@ { - "name": "dash-button-home-assistant-controller", + "name": "flic-button-home-assistant-controller", "version": "0.1.0", - "description": "Control Home Assistant entities with an Amazon Dash button", + "description": "Control Home Assistant entities with Flic buttons", "author": "Erick Hitter <contact@ethitter.com>", "license": "GPL-2.0+", "main": "index.js", "keywords": [ "home assistant", - "dash", - "amazon dash", - "dash button" + "flic", + "flic button" ], "scripts": { "start": "node index.js" }, "dependencies": { - "node-dash-button": "*", "request" : "*" }, "repository": { "type": "git", - "url": "https://git.ethitter.com/open-source/dash-button-home-assistant-controller.git" + "url": "https://git.ethitter.com/open-source/flic-button-home-assistant-controller.git" } }