# dash-slacker

> Will connect your dash button to a slack channel and post a message.

Latest version **1.0.2** (published 2017-10-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install dash-slacker
pnpm add dash-slacker
yarn add dash-slacker
bun add dash-slacker
```

Provides the commands `dash-slacker`, `dash-findbutton`.

## 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.0.2 |
| Published | 2017-10-12 |
| First published | 2017-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | github.com/nkov |
| Maintainers | nkov |

## Links

- npm: https://www.npmjs.com/package/dash-slacker
- Repository: https://github.com/nkov/dash-slacker
- Homepage: https://github.com/nkov/dash-slacker#readme
- Issues: https://github.com/nkov/dash-slacker/issues
- npm.io page: https://npm.io/package/dash-slacker

## Dependencies (3)

- [yargs](https://npm.io/package/yargs.md) 9.0.1
- [node-slack](https://npm.io/package/node-slack.md) 0.0.7
- [node-dash-button](https://npm.io/package/node-dash-button.md) 0.6.1

## Recent versions

- 1.0.2 (latest) — 2017-10-12
- 1.0.1 — 2017-10-12

## README

# Dash Slacker

Will connect your dash button to a slack channel and post a message.

## Prerequisites
- [Amazon Dash Button](https://www.amazon.com/ddb/learn-more)
- Setup your Dash button using the Amazon mobile app
  - ***NOTE: do not select a product***
- libpcap-dev
  - Linux: `$ sudo apt-get install libpcap-dev`
  - OSX: `$ pip install pypcap`

## Setup

### Locally

1. Clone repo and install dependencies

        $ npm install

2. Listen for ARP Pings on your network
        
        $ sudo npm findbutton

3. Press your dash button to emit an ARP ping and record its *MAC address*.
    -  You can do it a few times to be sure you have the right one.

### Globally

1. Install Dash Slacker

        $ npm install -g dash-slacker

2. Listen for ARP Pings on your network
        
        $ sudo dash-findbutton

3. Press your dash button to emit an ARP ping and record its *MAC address*.
    -  You can do it a few times to be sure you have the right one.

## Usage

Take the `config.json.sample` and save it as `config.json` somewhere you like for use in the following command.

*Note*: sudo is needed to access network devices.

### Locally

      $ sudo bin/dash-slacker.js --configFile=/absolute/path/to/config.json
      // Note: config.json in the project directory is used by default

### Globally

      $ sudo dash-slacker --configFile=/absolute/path/to/config.json

#### Additional Parameters

      -m  --  Wireless listening mode (arp/udp/all) (default: arp)
      -t  --  Min timeout (seconds) between requests (default: 60)

## Contributing

Pull requests are welcome!

## License

MIT.

Copyright © 2017 nkov.

Made with :heart: in NYC.

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