lifx_dash 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2Q0MTdjYWZlZmM1MzQ0ZGE5MWY3YTJmMjM3NmVhNzdmNzZiZmZlMg==
-  data.tar.gz: !binary |-
-    OWVhMDk4N2JhNGIwYmNmODg0YTlhYzU2NjczNWYzZmYzOWMxMzVlMg==
+SHA1:
+  metadata.gz: cfe674982a9903633e0576f45dfd2f9e598cd9cb
+  data.tar.gz: 533b6ad256a945e13505484568345faa7d60d0d2
 SHA512:
-  metadata.gz: !binary |-
-    ZDc3ZjhlYzhjNmExYmU5ZGEyNGM4OTE4MGZkMTMzYTBhMTZmMzEwMTE4ZjNj
-    MmY5MTFkNzBjN2Y3YjE4NzcyODEyMjdiMjUxY2I5ZDcxMzdmNjljNDA2Mjk4
-    MzY5ZDlkNTFkZDRjZDMxOGVhYTgyMDJkMDJlZDE3MGNhYjdlYjY=
-  data.tar.gz: !binary |-
-    ZmZlZmQ5MDAwYjgwN2Q1MGU0MWFmODY5YTdiNTIxYmE1ODFjNTlhODlmMzM1
-    Y2Y2OGFiZWQ3MDEzNmE2YzBlYjQ4ZTE2ZDFlZGJiM2E1ZWM4YWM5ZDBhMjIw
-    MDdmMDhkYzU0ZDZjNTcxNDk3MjAyNzljZTBjZWYxYzc4ZmI2ZDc=
+  metadata.gz: 9c443ecea091c19c9f41a48cd3c7ac29f5f371982a8bdd18cbca99f8be00201822f7b0c5164911b9a1998d848f3474894c08c8828339472bfcf5234b8ed9ce6b
+  data.tar.gz: 388b2c610cbc1d6f1b27f3fcb1a98506482b18933fdf79ffd9760980a64298aa1a84bd6b21453f7b676fbd6fd5ab856afbbbb5d800e4f8ba6e1e91bfa88d4302

data/.travis.yml

@@ -5,10 +5,10 @@ before_install:
 - gem update --system
 - gem --version
 rvm:
-- 2.0.0
 - 2.1.10
-- 2.2.5
-- 2.3.1
+- 2.2.7
+- 2.3.4
+- 2.4.1
 - ruby-head
 matrix:
   allow_failures:

data/README.md

@@ -49,8 +49,9 @@ The `lifx_dash` command will now be available in your PATH.
 
 ### Dash Button Setup
 
-Follow Amazon's Dash button setup steps, but **stop** before choosing any
-particular product to purchase. If necessary, you can [factory
+Follow Amazon's Dash button setup steps, but **stop** before choosing a product
+to purchase. Pressing the button should pulse white while connecting to wi-fi,
+then flash orange. If necessary, you can [factory
 reset](https://www.amazon.com/gp/help/customer/display.html?nodeId=201746400)
 your button and start the setup from scratch.
 
@@ -58,21 +59,12 @@ Next use the `snoop` command to determine the button's MAC address:
 
     $ sudo lifx_dash snoop -i en0
 
-This will listen on network interface 'en0' for ARP packets from any Dash
-button. Take a note of the MAC address that's logged when you press. To list
-network interfaces on your machine use:
+This will listen on network interface 'en0' for Dash button packets. Take a note
+of the MAC address that's logged when you press. To list network interfaces on
+your machine use:
 
-    $ ifconfig
-    # or
     $ ifconfig -l
 
-#### Snooping Tips
-
-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.
-
 ### LIFX Bulb Setup
 
 Create a [personal token](https://cloud.lifx.com/settings) for the LIFX HTTP
@@ -160,12 +152,12 @@ take a moment and check it hasn't already been raised (and possibly closed).
 
 This gem uses the [PacketFu](https://rubygems.org/gems/packetfu) gem (and
 [libpcap](https://sourceforge.net/projects/libpcap/) under the hood) to monitor
-data packets on your network. This packet stream is filtered by
-[ARP](https://en.wikipedia.org/wiki/Address_Resolution_Protocol) packets (sent
-when a device attempts to identify itself). Amazon Dash buttons do this on every
-press.
+data packets on your network. This packet stream filters
+[ARP](https://en.wikipedia.org/wiki/Address_Resolution_Protocol) packets and
+DHCP packets (sent from 0.0.0.0). Older buttons use the ARP method, while newer
+buttons issue DHCP packets.
 
-When an ARP packet is detected with a known source MAC address, the LIFX HTTP
+When a valid packet is detected with a known source MAC address, the LIFX HTTP
 API [toggle-power](https://api.developer.lifx.com/docs/toggle-power) endpoint is
 requested, with a selector and authorization header.
 
@@ -186,11 +178,11 @@ CI](https://travis-ci.org/matthutchinson/lifx_dash). Read the [contributing
 guidelines](https://github.com/matthutchinson/lifx_dash/blob/master/CONTRIBUTING.md)
 for more details.
 
-This project is intended to be a safe, welcoming space for
-collaboration, and contributors are expected to adhere to the [Contributor
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
 Covenant](http://contributor-covenant.org) code of conduct. See
-[here](https://github.com/mroth/lolcommits/blob/master/CODE_OF_CONDUCT.md) for
-more details.
+[here](https://github.com/matthutchinson/lifx_dash/blob/master/CODE_OF_CONDUCT.md)
+for more details.
 
 ## Development
 

data/bin/lifx_dash

@@ -35,11 +35,8 @@ end
 
 
 desc "Listen for Dash button presses on the network and show packet information"
-long_desc "Monitor the sepcified network interface for any Dash button ARP
-packets and log the device MAC address to stdout. 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."
+long_desc "Monitor the sepcified network interface for valid Dash button packets
+and log the device MAC address to stdout."
 command :snoop do |c|
   c.desc "Network Interface"
   c.default_value CONFIG["iface"] || "en0"
@@ -52,7 +49,7 @@ end
 
 desc "Listen for a Dash button press, and the toggle selected lights"
 long_desc "Monitor the sepcified network interface, filtered by a Dash button
-MAC address. If a valid ARP packet is detected, the LIFX lights (identified by
+MAC address. If a valid packet is detected, the LIFX lights (identified by
 the selector) will be toggled using the LIFX HTTP API (v1). You can optionally
 pass a LIFX bulb selector (the bulb ID), or choose to daemonize the `monitor`
 process.

data/lib/lifx_dash/capturer.rb

@@ -3,6 +3,16 @@ require "packetfu"
 module LifxDash
   class Capturer
 
+    # Berkeley Packet filter for Amazon Dash buttons
+    #
+    #  - older dash buttons issue an ARP packet from 0.0.0.0
+    #  - newer buttons broadcast a DHCP request from 0.0.0.0
+    #  - use the following bfp in WireShark to snoop for raw packets
+    #    - (arp or (udp.srcport == 68 and udp.dstport == 67)) and ip.src == 0.0.0.0
+    #  - for more details see https://github.com/ide/dash-button/issues/36
+    #
+    PACKET_FILTER = "(arp or (udp and src port 68 and dst port 67)) and src host 0.0.0.0"
+
     attr_reader :iface
 
     def initialize(network_iface_id)
@@ -12,25 +22,22 @@ module LifxDash
     def listen(&block)
       # examine packets on the stream
       capturer.stream.each do |packet|
-        pkt = PacketFu::ARPPacket.parse(packet)
-        # parse packet header
-        mac = PacketFu::EthHeader.str2mac(pkt.eth_src)
-        # valid ARP pkt when opcode is 1
-        if pkt.arp_opcode == 1
+        pkt = PacketFu::IPPacket.parse(packet)
+        # only consider the first packet sent
+        if pkt.ip_id == 1
+          mac = PacketFu::EthHeader.str2mac(pkt.eth_src)
           block.call(pkt, mac) if block
         end
       end
     end
 
-
     private
-
     def capturer
-      # filter and capture ARP packets on network interface
+      # capture (and filter) packets on network interface
       @capturer ||= PacketFu::Capture.new(
         iface: @iface,
         start: true,
-        filter: "arp"
+        filter: PACKET_FILTER
       )
     end
   end

data/lib/lifx_dash/snoop.rb

@@ -9,8 +9,6 @@ module LifxDash
 
     def run
       puts "Snooping for dash button packets on #{iface} ... press [CTRL-c] to stop\n\n"
-      puts " * wait for the network to quiet down, before pressing the button"
-      puts " * you might get more than 1 ARP packet when pressing, use the MAC address that occurs once\n\n"
 
       LifxDash::Capturer.new(iface).listen do |pkt, mac|
         LOGGER.info "possible Dash button press from MAC address: #{mac} -- pkt summary: #{pkt.peek}"

data/lib/lifx_dash/version.rb

@@ -1,3 +1,3 @@
 module LifxDash
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/man/lifx_dash.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "LIFX_DASH" "1" "June 2016" "" ""
+.TH "LIFX_DASH" "1" "June 2017" "" ""
 .
 .SH "NAME"
 \fBlifx_dash\fR \- Toggle LIFX lights with an Amazon Dash button
@@ -31,10 +31,13 @@ A \fBconfig\fR command also exists, allowing you to set default options for \fBm
 \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
+Follow Amazon\'s Dash button setup steps, but \fBstop\fR before choosing a product to purchase\. Pressing the button should pulse white while connecting to wi\-fi, then flash orange\. If necessary, you can factory reset \fIhttps://www\.amazon\.com/gp/help/customer/display\.html?nodeId=201746400\fR your button and start the setup from scratch\.
+.
+.P
+You will 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\.
+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)
@@ -42,9 +45,6 @@ The snoop command has one optional flag, the network interface to listen on\.
 .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

data/man/lifx_dash.1.html

@@ -106,24 +106,24 @@ selector, or choose to daemonize the <code>monitor</code> process.</p>
 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>
+<p>Follow Amazon's Dash button setup steps, but <strong>stop</strong> before choosing a product
+to purchase. Pressing the button should pulse white while connecting to wi-fi,
+then flash orange. If necessary, you can <a href="https://www.amazon.com/gp/help/customer/display.html?nodeId=201746400">factory
+reset</a>
+your button and start the setup from scratch.</p>
+
+<p>You will 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>
+<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>
 
@@ -208,7 +208,7 @@ by any arguments passed on the command line.</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>June 2016</li>
+    <li class='tc'>June 2017</li>
     <li class='tr'>lifx_dash(1)</li>
   </ol>
 

data/man/lifx_dash.1.ronn

@@ -29,21 +29,21 @@ A `config` command also exists, allowing you to set default options for
 will also need a wifi network and root access to sniff packets on your network
 adaptor.
 
-Follow Amazon's Dash button setup steps, but **stop** before choosing any
-particular product to purchase. You aill also need a free LIFX API token from
-here: [https://cloud.lifx.com/settings](https://cloud.lifx.com/settings)
+Follow Amazon's Dash button setup steps, but **stop** before choosing a product
+to purchase. Pressing the button should pulse white while connecting to wi-fi,
+then flash orange. If necessary, you can [factory
+reset](https://www.amazon.com/gp/help/customer/display.html?nodeId=201746400)
+your button and start the setup from scratch.
+
+You will also need a free LIFX API token from here:
+[https://cloud.lifx.com/settings](https://cloud.lifx.com/settings)
 
 ## OPTIONS
 
-The snoop command has one optional flag, the network interface to listen on.
+The snoop command has one optional flag - the network interface to listen on.
 
 * `-i`, `--iface=arg`: Network Interface (default: en0)
 
-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.
-
 The `monitor` command accepts the following flags, both a mac address and api
 token are required.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_dash
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -42,133 +42,134 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ronn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "  A command line tool to listen for Amazon Dash button presses and
-  toggle LIFX\n  lights ON and OFF (via the LIFX HTTP API). With options to configure:
-  the Dash\n  MAC address, network interface and LIFX bulb selector. Inspired by Ted\n
-  \ Benson's hack (http://tinyurl.com/zba3da2). Root access is required for\n  network
-  packet sniffing.\n"
+description: |2
+    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.
 email:
 - matt@hiddenloop.com
 executables:
@@ -178,10 +179,10 @@ extra_rdoc_files:
 - README.md
 - LICENSE.txt
 files:
-- .coveralls.yml
-- .gitignore
-- .simplecov
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -211,21 +212,21 @@ metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options:
-- --title
+- "--title"
 - lifx_dash
-- --main
+- "--main"
 - README.md
-- -ri
+- "-ri"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
@@ -234,7 +235,7 @@ requirements:
 - one or more LIFX bulbs
 - root access
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Toggle LIFX lights with an Amazon Dash button