lifx_dash 0.1.0

data/lib/lifx_dash/version.rb

@@ -0,0 +1,3 @@
+module LifxDash
+  VERSION = "0.1.0"
+end

data/lifx_dash.gemspec

@@ -0,0 +1,66 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lifx_dash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lifx_dash"
+  spec.version       = LifxDash::VERSION
+  spec.authors       = ["Matthew Hutchinson"]
+  spec.email         = ["matt@hiddenloop.com"]
+
+  spec.summary       = "Toggle LIFX lights with an Amazon Dash button"
+  spec.homepage      = "http://github.com/matthutchinson/lifx_dash"
+  spec.license       = "MIT"
+
+  spec.description   = <<-EOF
+  A command line tool to listen for Amazon Dash button presses and toggle LIFX
+  lights ON and OFF (via the LIFX HTTP API). With options to configure: the Dash
+  MAC address, network interface and LIFX bulb selector. Inspired by Ted
+  Benson's hack (http://tinyurl.com/zba3da2). Root access is required for
+  network packet sniffing.
+  EOF
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
+  spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
+  spec.bindir        = "bin"
+  spec.executables   = "lifx_dash"
+  spec.require_paths = ["lib"]
+
+  # documentation
+  spec.has_rdoc         = true
+  spec.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  spec.rdoc_options << '--title' << 'lifx_dash' << '--main' << 'README.md' << '-ri'
+
+  # non-gem dependecies
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.requirements << 'an Amazon Dash button'
+  spec.requirements << 'one or more LIFX bulbs'
+  spec.requirements << 'root (sudo) access'
+
+  # external gems
+  spec.add_runtime_dependency "gli", "2.14.0"
+  spec.add_runtime_dependency "packetfu", "1.1.11"
+
+  # dev gems
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  # docs
+  spec.add_development_dependency "ronn"
+  spec.add_development_dependency "rdoc"
+  # testing
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/man/lifx_dash.1

@@ -0,0 +1,170 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "LIFX_DASH" "1" "June 2016" "" ""
+.
+.SH "NAME"
+\fBlifx_dash\fR \- Toggle LIFX lights with an Amazon Dash button
+.
+.SH "SYNOPSIS"
+\fBlifx_dash\fR \fBmonitor\fR \-m DASH_MAC_ADDRESS \-t LIFX_API_TOKEN
+.
+.br
+\fBlifx_dash\fR \fBsnoop\fR
+.
+.br
+\fBlifx_dash\fR \fBconfig\fR
+.
+.SH "DESCRIPTION"
+\fBlifx_dash\fR is a simple command\-line tool to monitor your network for Amazon Dash button presses and toggle LIFX lights ON and OFF\. The tool provides two commands, \fBmonitor\fR and \fBsnoop\fR\.
+.
+.P
+Use \fBsnoop\fR to listen for Dash presses on your network, and identify the button\'s MAC address\.
+.
+.P
+Use \fBmonitor\fR (with a MAC address and LIFX HTTP API token) to respond to presses, and toggle your lights ON and OFF\. You can optionally pass a bulb selector, or choose to daemonize the \fBmonitor\fR process\.
+.
+.P
+A \fBconfig\fR command also exists, allowing you to set default options for \fBmonitor\fR and \fBsnoop\fR\.
+.
+.SH "REQUIREMENTS"
+\fBlifx_dash\fR requires at least one LIFX bulb, and any Amazon Dash button\. You will also need a wifi network and root access to sniff packets on your network adaptor\.
+.
+.P
+Follow Amazon\'s Dash button setup steps, but \fBstop\fR before choosing any particular product to purchase\. You aill also need a free LIFX API token from here: \fIhttps://cloud\.lifx\.com/settings\fR
+.
+.SH "OPTIONS"
+The snoop command has one optional flag, the network interface to listen on\.
+.
+.IP "\(bu" 4
+\fB\-i\fR, \fB\-\-iface=arg\fR: Network Interface (default: en0)
+.
+.IP "" 0
+.
+.P
+Wait for the network to quiet down, before pressing the button, since other devices may respond with ARP packets of their own when you press\. Take care to choose the MAC address from the ARP packet that occurs only once from a single MAC address\.
+.
+.P
+The \fBmonitor\fR command accepts the following flags, both a mac address and api token are required\.
+.
+.IP "\(bu" 4
+\fB\-m\fR, \fB\-\-mac\-address=arg\fR: Dash button MAC Address (required)
+.
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-token=arg\fR: LIFX HTTP API Token (required)
+.
+.IP "\(bu" 4
+\fB\-s\fR, \fB\-\-selector=arg\fR: LIFX Bulb Selector (default: all)
+.
+.IP "\(bu" 4
+\fB\-i\fR, \fB\-\-iface=arg\fR: Network Interface (default: en0)
+.
+.IP "\(bu" 4
+\fB\-d\fR, \fB\-\-[no\-]daemonize\fR: Dameonize the monitor process (default: no)
+.
+.IP "\(bu" 4
+\fB\-l\fR, \fB\-\-log\-file\fR: Log file location (when running as a daemon) (default: /tmp/lifx_dash\.log)
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Get help on command options and arguments
+.
+.IP "" 4
+.
+.nf
+
+$ lifx_dash \-h
+$ lifx_dash monitor \-h
+$ lifx_dash snoop \-\-help
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Snoop for Dash button presses on en1
+.
+.IP "" 4
+.
+.nf
+
+$ lifx_dash snoop en1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Monitor Dash button presses on en0 with DASH_MAC_ADDRESS and LIFX_API_TOKEN, when pressed, toggle all lights
+.
+.IP "" 4
+.
+.nf
+
+$ lifx_dash monitor \-t LIFX_API_TOKEN \-m DASH_MAC_ADDRESS
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Monitor Dash button presses on en1 with a DASH_MAC_ADDRESS and LIFX_API_TOKEN, when pressed toggle the light with id \'d3b2f2d97459\'
+.
+.IP "" 4
+.
+.nf
+
+$ lifx_dash monitor \-\-token=LIFX_API_TOKEN \-\-mac\-address=DASH_MAC_ADDRESS \-s \'d3b2f2d97459\' \-i en1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Show the current configuration file options
+.
+.IP "" 4
+.
+.nf
+
+$ lifx_dash config \-s
+.
+.fi
+.
+.IP "" 0
+.
+.SH "FILES"
+Use the \fBconfig\fR command to set values for the command options\. These will be saved to: ~/\.lifx_dash\.rc\.yml and used as defaults\. They can still be overridden by any arguments passed on the command line\.
+.
+.P
+If running as a daemon (\-d switch), the \fBlifx_dash monitor\fR command will log to \fB/tmp/lifx_dash\.log\fR by default\. Use the \-\-log\-file flag to override this\.
+.
+.SH "BUGS"
+No known bugs\. Please report issues here: \fIhttps://github\.com/matthutchinson/lifx_dash/issues\fR
+.
+.SH "LICENSE"
+The MIT License: \fIhttps://raw\.githubusercontent\.com/matthutchinson/lifx_dash/master/LICENSE\.txt\fR
+.
+.SH "COPYRIGHT"
+Copyright (c) 2016 Matthew Hutchinson
+.
+.SH "AUTHOR"
+Matthew Hutchinson, \fIhttps://matthewhutchinson\.net\fR
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+\fIhttps://rubygems\.org/gems/lifx_dash\fR
+.
+.IP "\(bu" 4
+\fIhttps://github\.com/matthutchinson/lifx_dash\fR
+.
+.IP "\(bu" 4
+\fIhttps://cloud\.lifx\.com/settings\fR
+.
+.IP "\(bu" 4
+\fIhttp://tinyurl\.com/zujfkjs\fR
+.
+.IP "" 0
+

data/man/lifx_dash.1.html

@@ -0,0 +1,217 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>lifx_dash(1) - Toggle LIFX lights with an Amazon Dash button</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#REQUIREMENTS">REQUIREMENTS</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#FILES">FILES</a>
+    <a href="#BUGS">BUGS</a>
+    <a href="#LICENSE">LICENSE</a>
+    <a href="#COPYRIGHT">COPYRIGHT</a>
+    <a href="#AUTHOR">AUTHOR</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>lifx_dash(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>lifx_dash(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>lifx_dash</code> - <span class="man-whatis">Toggle LIFX lights with an Amazon Dash button</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>lifx_dash</code> <code>monitor</code> -m DASH_MAC_ADDRESS -t LIFX_API_TOKEN<br />
+<code>lifx_dash</code> <code>snoop</code><br />
+<code>lifx_dash</code> <code>config</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>lifx_dash</strong> is a simple command-line tool to monitor your network for Amazon
+Dash button presses and toggle LIFX lights ON and OFF. The tool provides two
+commands, <code>monitor</code> and <code>snoop</code>.</p>
+
+<p>Use <code>snoop</code> to listen for Dash presses on your network, and identify the
+button's MAC address.</p>
+
+<p>Use <code>monitor</code> (with a MAC address and LIFX HTTP API token) to respond to
+presses, and toggle your lights ON and OFF. You can optionally pass a bulb
+selector, or choose to daemonize the <code>monitor</code> process.</p>
+
+<p>A <code>config</code> command also exists, allowing you to set default options for
+<code>monitor</code> and <code>snoop</code>.</p>
+
+<h2 id="REQUIREMENTS">REQUIREMENTS</h2>
+
+<p><code>lifx_dash</code> requires at least one LIFX bulb, and any Amazon Dash button. You
+will also need a wifi network and root access to sniff packets on your network
+adaptor.</p>
+
+<p>Follow Amazon's Dash button setup steps, but <strong>stop</strong> before choosing any
+particular product to purchase. You aill also need a free LIFX API token from
+here: <a href="https://cloud.lifx.com/settings" data-bare-link="true">https://cloud.lifx.com/settings</a></p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>The snoop command has one optional flag, the network interface to listen on.</p>
+
+<ul>
+<li><code>-i</code>, <code>--iface=arg</code>: Network Interface (default: en0)</li>
+</ul>
+
+
+<p>Wait for the network to quiet down, before pressing the button, since other
+devices may respond with ARP packets of their own when you press. Take care to
+choose the MAC address from the ARP packet that occurs only once from a single
+MAC address.</p>
+
+<p>The <code>monitor</code> command accepts the following flags, both a mac address and api
+token are required.</p>
+
+<ul>
+<li><code>-m</code>, <code>--mac-address=arg</code>: Dash button MAC Address (required)</li>
+<li><code>-t</code>, <code>--token=arg</code>: LIFX HTTP API Token (required)</li>
+<li><code>-s</code>, <code>--selector=arg</code>:  LIFX Bulb Selector (default: all)</li>
+<li><code>-i</code>, <code>--iface=arg</code>: Network Interface (default: en0)</li>
+<li><code>-d</code>, <code>--[no-]daemonize</code>: Dameonize the monitor process (default: no)</li>
+<li><code>-l</code>, <code>--log-file</code>: Log file location (when running as a daemon) (default: /tmp/lifx_dash.log)</li>
+</ul>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Get help on command options and arguments</p>
+
+<pre><code>$ lifx_dash -h
+$ lifx_dash monitor -h
+$ lifx_dash snoop --help
+</code></pre>
+
+<p>Snoop for Dash button presses on en1</p>
+
+<pre><code>$ lifx_dash snoop en1
+</code></pre>
+
+<p>Monitor Dash button presses on en0 with DASH_MAC_ADDRESS and LIFX_API_TOKEN,
+when pressed, toggle all lights</p>
+
+<pre><code>$ lifx_dash monitor -t LIFX_API_TOKEN -m DASH_MAC_ADDRESS
+</code></pre>
+
+<p>Monitor Dash button presses on en1 with a DASH_MAC_ADDRESS and LIFX_API_TOKEN,
+when pressed toggle the light with id 'd3b2f2d97459'</p>
+
+<pre><code>$ lifx_dash monitor --token=LIFX_API_TOKEN --mac-address=DASH_MAC_ADDRESS -s 'd3b2f2d97459' -i en1
+</code></pre>
+
+<p>Show the current configuration file options</p>
+
+<pre><code>$ lifx_dash config -s
+</code></pre>
+
+<h2 id="FILES">FILES</h2>
+
+<p>Use the <code>config</code> command to set values for the command options. These will be
+saved to: ~/.lifx_dash.rc.yml and used as defaults. They can still be overridden
+by any arguments passed on the command line.</p>
+
+<p>If running as a daemon (-d switch), the <code>lifx_dash monitor</code> command will log to
+<code>/tmp/lifx_dash.log</code> by default. Use the --log-file flag to override this.</p>
+
+<h2 id="BUGS">BUGS</h2>
+
+<p>No known bugs. Please report issues here:
+<a href="https://github.com/matthutchinson/lifx_dash/issues" data-bare-link="true">https://github.com/matthutchinson/lifx_dash/issues</a></p>
+
+<h2 id="LICENSE">LICENSE</h2>
+
+<p>The MIT License:
+<a href="https://raw.githubusercontent.com/matthutchinson/lifx_dash/master/LICENSE.txt" data-bare-link="true">https://raw.githubusercontent.com/matthutchinson/lifx_dash/master/LICENSE.txt</a></p>
+
+<h2 id="COPYRIGHT">COPYRIGHT</h2>
+
+<p>Copyright (c) 2016 Matthew Hutchinson</p>
+
+<h2 id="AUTHOR">AUTHOR</h2>
+
+<p>Matthew Hutchinson, <a href="https://matthewhutchinson.net" data-bare-link="true">https://matthewhutchinson.net</a></p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<ul>
+<li><a href="https://rubygems.org/gems/lifx_dash" data-bare-link="true">https://rubygems.org/gems/lifx_dash</a></li>
+<li><a href="https://github.com/matthutchinson/lifx_dash" data-bare-link="true">https://github.com/matthutchinson/lifx_dash</a></li>
+<li><a href="https://cloud.lifx.com/settings" data-bare-link="true">https://cloud.lifx.com/settings</a></li>
+<li><a href="http://tinyurl.com/zujfkjs" data-bare-link="true">http://tinyurl.com/zujfkjs</a></li>
+</ul>
+
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>June 2016</li>
+    <li class='tr'>lifx_dash(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>