# dash-hue-light-control

> Turn on/off your hue light with Amazon dash button

Latest version **1.5.1** (published 2017-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install dash-hue-light-control
pnpm add dash-hue-light-control
yarn add dash-hue-light-control
bun add dash-hue-light-control
```

Provides the command `dash-hue-light-control`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2017-12-19 |
| First published | 2017-09-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Maxime Bret |
| Maintainers | mbret |
| Keywords | amazon, hue, dash, light, control, switch, philips |

## Links

- npm: https://www.npmjs.com/package/dash-hue-light-control
- Repository: https://github.com/mbret/dash-hue-light-control
- Homepage: https://github.com/mbret/dash-hue-light-control#readme
- Issues: https://github.com/mbret/dash-hue-light-control/issues
- npm.io page: https://npm.io/package/dash-hue-light-control

## Dependencies (4)

- [winston](https://npm.io/package/winston.md) ^2.3.1
- [commander](https://npm.io/package/commander.md) ^2.12.2
- [node-hue-api](https://npm.io/package/node-hue-api.md) 2.4.2
- [node-dash-button](https://npm.io/package/node-dash-button.md) 0.6.1

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.5.1 (latest) — 2017-12-19
- 1.4.4 — 2017-09-18
- 1.4.3 — 2017-09-18
- 1.4.2 — 2017-09-18
- 1.4.1 — 2017-09-18
- 1.4.0 — 2017-09-18
- 1.1.0 — 2017-09-12
- 1.0.3 — 2017-09-11
- 1.0.2 — 2017-09-11
- 1.0.1 — 2017-09-11
- 1.0.0 — 2017-09-11

## README

# dash-hue-light-control
This program let you control your light with Amazon dash button. dash-hue-light-control
support nodejs versions 7 and superiors. With this module you will basically be able to set 
a button that switch light with command line interface (cli) or programmatically on importing the module
to your existing program.

To use this program you will need your dash button configured and ready plus have access (ip + token)
to your hue light. I'm writing a cli/module helper to get a convenient way to have this.

Please, feel free to send me any feedback or open issues on the module github page.

### Jeedom, Domoticz, etc
If you want me to create a compatible plugin for domotics software just get in touch with me. It would be a pleasure
to improve my module and make it useable for your system.

## Contents

 * [Prerequisite](https://github.com/mbret/dash-hue-light-control#prerequisite)
 * [Installation](https://github.com/mbret/dash-hue-light-control#installation)
 * [Usage](https://github.com/mbret/dash-hue-light-control#usage)
 * [Run it as a background process](https://github.com/mbret/dash-hue-light-control#run-it-as-a-background-process)
 * [Usage as a node module (programmatically)](https://github.com/mbret/usage-as-a-node-module-(programmatically))
 * [Note about dash button](https://github.com/mbret/dash-hue-light-control#note-about-dash-button)
 * [Known issues](https://github.com/mbret/dash-hue-light-control#known-issues)
 * [Next updates](https://github.com/mbret/dash-hue-light-control#next-updates)

## Prerequisite
You need [nodejs](https://nodejs.org/en/) 7 or superior and a Unix system. This program does not
works on Windows for now due to the use of libpcap. You will also need to setup your dash 
and have an access token to your hue bridge. You can follow the step 2 from this guide to configure
your dash [http://www.instructables.com/id/Amazon-Dash-Button-Hack](http://www.instructables.com/id/Amazon-Dash-Button-Hack).
In order to have authorization to your bridge you will need to access its api and generate new user.
Follow the official guide to help you in the process [https://developers.meethue.com/documentation/getting-started](https://developers.meethue.com/documentation/getting-started).

## Installation
``` sh
# library needed for read requests from dash buttons
$ sudo apt-get install libpcap-dev
# actual program sources
# You may need sudo to install the module
$ npm install -g dash-hue-light-control
```

## Usage
Just create a `settings.json` somewhere and use its location as argument:
``` sh
$ sudo dash-hue-light-control start path/to/settings.json
```

The process will keep watching for your dash press action and control the light.

### settings.json sample
This is the most basic config example
```json
{
  "jwt": "FkXIos6bRxzyy54qsspHLa2MGx5-IQkWNLfIbn4",
  "bridge": "192.168.0.10",
  "configuration": {
    "dash": "b4:7c:9c:49:b4:d4",
    "targetId": "2",
    "mode": "toggle"
  }
}
```
The available modes are:

- `toggle`
- `on`
- `off`

The toggle mode will either turn on or off your light depending on its current state.

By default you will target a light but there are other possibilities like groups.
```json
{
  "jwt": "FkXIos6bRxzyy54qsspHLa2MGx5-IQkWNLfIbn4",
  "bridge": "192.168.0.10",
  "configuration": {
    "dash": "b4:7c:9c:49:b4:d4",
    "targetId": "2",
    "mode": "toggle",
    "target": "group"
  }
}
```
Also configuration can take an array of entry to handle several dash buttons.

## Run it as a background process
In the real world you probably want to run this program as a background process and let it run forever.
An easy way to do it is to download [pm2](https://github.com/Unitech/pm2) or other process manager and
run the command `sudo node index --settings=path/to/settings.json` through this process manager. Refer to the
dedicated doc for more info.

Here is an example with pm2:
``` sh
$ npm install pm2 -g
$ sudo pm2 start dash-hue-light-control --name="hue-room" -- start ~/Documents/settings-hue-room.json
```

Note that you will probably need to run this as sudo as well because of PcapSession

## Usage as a node module (programmatically)
You can import this program like any module and use it programmatically.
For now the api is still rather light and will be improved over time.
```javascript
const dashHueLightControl = require('dash-hue-light-control')
dashHueLightControl({
  "jwt": "FkXIos6bRxzyy54qsspHLa2MGx5-IQkWNLfIbn4",
  "bridge": "192.168.0.10",
  "configuration": {
      "dash": "b4:7c:9c:49:b4:d4",
      "targetId": "2",
      "mode": "toggle"
  }
})
```

## Note about dash button
Due to how the button is designed (sleep, wake up, connect to wifi, arp, sleep, ...) there is a noticeable timeout between a press and its action. I cannot do anything about
that and remember that this is a 2€ smart button after all.
- Use DHCP Reservation on your Amazon Dash Button to lower the latency from ~5s to ~1s.
- Dash buttons cannot be used for another ~10 seconds after they've been pressed.
Thanks [ricardo1980](https://www.npmjs.com/~ricardo1980) for the tips.

## Known issues
- I once got two triggers for one button press (never had again). It happened after a long inactivity of my button. It basically
turned the light on and off directly after. Never had again but I guess the button sometimes send more request. I will
dig into the settings to see if I can avoid it.

## Next updates
- control the color/intensity/whatever
- Use local user file to allow cli session when using mac address, etc

## Contributors
[Jamie Briers](https://github.com/JamieBriers)

---
_Source: https://npm.io/package/dash-hue-light-control · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._