scan_beacon 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d78009f7808d20ac2554c8c370a00ecd36b75e2e
-  data.tar.gz: 1f1f238adbe3cfcc939f349e9e2c57636505b292
+  metadata.gz: 5ae0be9271595f436430f8494d6f0cb9710e8083
+  data.tar.gz: 7afac292c5b16a158134c0461ca483a07e506b3a
 SHA512:
-  metadata.gz: 146ee276d74af008154a018ce72b0f410df1a294a1cf1f6383466cc06bbc2a37fa90e84272ceb9db70d9085f0491af86493091c7fb80d857dc44c31ca25e3912
-  data.tar.gz: 9947d6aced47920d648f5f5390a1a693997bc24d2a3a35d04b9c1eb9d409b0b6b0797a2c1d948b21c2cac44e5f0b6975ca405e6e977e9ef6d80518c99a5f88ba
+  metadata.gz: bf44f28c567d9c4c221802aa4fa98b3fbcd00f0459faf60b4a8cb662107de7a84f1e2f9ef59ade343efed26edc1328976e046bf11ad0ba00b3a602c9b8562199
+  data.tar.gz: 791bd526ce8efaddf2b5085317e5d88024cadf2d676f4bfd61c30965bc01caa2d31d1417cb851200ddfea31cb460844bf3dcef7f74f966d37e55f50d3505eb84

data/README.md

@@ -31,5 +31,15 @@ scanner.scan do |beacons|
 end
 ```
 
+## Add a custom beacon layout
+By default, this gem supports AltBeacon advertisements.  But you can add a beacon parser to support other major beacon formats as well.
+
+Example:
+``` ruby
+scanner = ScanBeacon::BLE112Scanner.new
+scanner.add_parser( ScanBeacon::BeaconParser.new(:mybeacon, "m:2-3=0000,i:4-19,i:20-21,i:22-23,p:24-24") )
+...
+```
+
 # Dependencies
 You must have a BLE112 device plugged in to a USB port.

data/lib/scan_beacon/ble112_device.rb

@@ -0,0 +1,117 @@
+module ScanBeacon
+  class BLE112Device
+
+    # define a bunch of constants
+    BG_COMMAND = 0
+    BG_EVENT = 0x80
+    # msg classes
+    BG_MSG_CLASS_CONNECTION = 3
+    BG_MSG_CLASS_GAP = 6
+    # messages
+    BG_DISCONNECT = 0
+    BG_SET_MODE = 1
+    BG_DISCOVER = 2
+    BG_DISCOVER_STOP = 4
+    BG_SCAN_PARAMS = 7
+    # constants/enums
+    BG_GAP_DISCOVER_ALL = 2
+    BG_GAP_NON_DISCOVERABLE = 0
+    BG_GAP_NON_CONNECTABLE = 0
+
+    def initialize(port=nil)
+      @port = port || Dir.glob("/dev/{cu.usbmodem,ttyACM}*")[0]
+    end
+
+    def open
+      File.open(@port, 'r+b') do |file|
+        @file = file
+        yield self
+      end
+      @file = nil
+    end
+
+    def start_scan
+      # disconnect any connections
+      bg_command(@file, BG_MSG_CLASS_CONNECTION, BG_DISCONNECT,0)
+      # turn off adverts
+      bg_command(@file, BG_MSG_CLASS_GAP, BG_SET_MODE, [BG_GAP_NON_DISCOVERABLE, BG_GAP_NON_CONNECTABLE])
+      # stop previous scan
+      bg_command(@file, BG_MSG_CLASS_GAP, BG_DISCOVER_STOP)
+      # write new scan params
+      bg_command(@file, BG_MSG_CLASS_GAP, BG_SCAN_PARAMS, [200,200, 0], "S<S<C")
+      # start new scan
+      bg_command(@file, BG_MSG_CLASS_GAP, BG_DISCOVER, BG_GAP_DISCOVER_ALL)
+    end
+
+    def stop_scan
+      bg_command(@file, BG_MSG_CLASS_GAP, BG_DISCOVER_STOP)
+    end
+
+    def read
+      BLE112Response.new( bg_read(@file) )
+    end
+
+    class BLE112Response
+      def initialize(data)
+        @data = data
+      end
+
+      def size
+        @data.size
+      end
+
+      def event?
+        @data[0].unpack('C')[0] == BG_EVENT
+      end
+
+      def gap_scan?
+        @data[2..3].unpack('CC') == [BG_MSG_CLASS_GAP, 0]
+      end
+
+      def manufacturer_ad?
+        size > 20 && advertisement_type == 0xFF
+      end
+
+      def advertisement?
+        event? && gap_scan? && manufacturer_ad?
+      end
+
+      def advertisement_type
+        @data[19].unpack('C')[0]
+      end
+
+      def advertisement_data
+        @advertisement_data ||= @data[20..-1]
+      end
+
+      def mac
+        @data[6..11].unpack('H2 H2 H2 H2 H2 H2').join(":")
+      end
+
+      def rssi
+        @data[4].unpack('c')[0]
+      end
+    end
+
+    private
+
+      def bg_command(port, msg_class, msg, data=nil, data_format=nil)
+        data = [data].compact unless data.is_a? Array
+        if data_format.nil?
+          data = data.pack('C*')
+        else
+          data = data.pack(data_format)
+        end
+        cmd = [0, data.size, msg_class, msg].flatten.pack('C*') + data
+        port.write(cmd)
+        bg_read(port)
+      end
+
+      def bg_read(port)
+        response = port.read(1) while response.nil? || ![0x00, 0x80].include?(response.unpack('C')[0])
+        response << port.read(3)
+        payload_length = response[1].unpack('C')[0]
+        response << port.read(payload_length)
+      end
+  end
+end

data/lib/scan_beacon/ble112_scanner.rb

@@ -2,17 +2,13 @@ require 'timeout'
 
 module ScanBeacon
   class BLE112Scanner
-    SCAN_CMD = [0,1,6,2,2].pack('CCCCC')
-    SCAN_PARAMS = [0, 5, 6, 7, 200,200, 0].pack('CCCCS<S<C')
-    RESET_CMD = [0,1,9,0,0].pack('ccccc')
-    MANUFACTURER_AD = 0xFF
 
     DEFAULT_LAYOUTS = {altbeacon: "m:2-3=beac,i:4-19,i:20-21,i:22-23,p:24-24,d:25-25"}
 
     attr_reader :beacons
 
     def initialize(opts = {})
-      @port = opts[:port] || Dir.glob("/dev/{cu.usbmodem,ttyACM}*")[0]
+      @device = BLE112Device.new opts[:port]
       @cycle_seconds = opts[:cycle_seconds] || 1
       @parsers = DEFAULT_LAYOUTS.map {|name, layout| BeaconParser.new name, layout }
       @beacons = []
@@ -23,58 +19,33 @@ module ScanBeacon
     end
 
     def scan
-      clear_the_buffer
-      open_port do |port|
-        send_scan_command(port)
+      @device.open do |device|
+        device.start_scan
         cycle_end = Time.now + @cycle_seconds
 
-        while true do
-          byte = port.each_byte.next
-          append_to_buffer(byte)
-          if Time.now > cycle_end
-            yield @beacons
-            @beacons = []
-            cycle_end = Time.now + @cycle_seconds
+        begin
+          while true do
+            check_for_beacon( device.read )
+            if Time.now > cycle_end
+              yield @beacons
+              @beacons = []
+              cycle_end = Time.now + @cycle_seconds
+            end
           end
+        ensure
+          device.stop_scan
         end
-      end
-    end
 
-    def open_port
-      File.open(@port, 'r+b') do |port|
-        yield port
       end
     end
 
-    def append_to_buffer(byte)
-      if @buffer.size == 0 && (byte == 0x00 || byte == 0x80)
-        @buffer << byte
-        @packet_type = byte
-      elsif @buffer.size == 1
-        @buffer << byte
-        @payload_length = byte
-        @expected_size = 4 + (@packet_type & 0x07) + @payload_length
-      elsif @buffer.size > 1
-        @buffer << byte
-        check_for_beacon
-      end
-    end
-
-    def check_for_beacon
-      if @expected_size && @buffer.size >= @expected_size
-        packet_class =  @buffer[2]
-        packet_command =  @buffer[3]
-        payload = @buffer[4..-1].pack('C*')
-        if (@packet_type & 0x80 != 0x00) && (packet_class == 0x06) &&
-            (packet_command == 0x00) && @buffer[19] == MANUFACTURER_AD
-          data = payload[16..-1]
-          beacon = nil
-          if @parsers.detect {|parser| beacon = parser.parse(data) }
-            beacon.mac = parse_mac(payload)
-            add_beacon(beacon, parse_rssi(payload))
-          end
+    def check_for_beacon(response)
+      if response.advertisement?
+        beacon = nil
+        if @parsers.detect {|parser| beacon = parser.parse(response.advertisement_data) }
+          beacon.mac = response.mac
+          add_beacon(beacon, response.rssi)
         end
-        clear_the_buffer
       end
     end
 
@@ -88,35 +59,5 @@ module ScanBeacon
       beacon.add_rssi(rssi)
     end
 
-    def parse_mac(payload)
-      payload[2..7].unpack('H2 H2 H2 H2 H2 H2').join(":")
-    end
-
-    def parse_rssi(payload)
-      payload[0].unpack('c')[0]
-    end
-
-    def clear_the_buffer
-      @buffer = []
-      @expected_size = nil
-    end
-
-    def send_scan_command(port)
-      # disconnect any connections
-      port.write([0,1,3,0,0].pack('CCCCC'))
-      port.read(7)
-      # turn off adverts
-      port.write([0,2,6,1,0,0].pack('CCCCCC'))
-      port.read(6)
-      # stop previous scan
-      port.write([0,0,6,4].pack('CCCC'))
-      port.read(6)
-      # write new scan params
-      port.write(SCAN_PARAMS)
-      port.read(6)
-      # start new scan
-      port.write(SCAN_CMD)
-      port.read(6)
-    end
   end
 end

data/lib/scan_beacon/version.rb

@@ -1,3 +1,3 @@
 module ScanBeacon
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/scan_beacon.rb

@@ -1,6 +1,7 @@
 require "scan_beacon/version"
 require "scan_beacon/beacon"
 require "scan_beacon/beacon_parser"
+require "scan_beacon/ble112_device"
 require "scan_beacon/ble112_scanner"
 
 module ScanBeacon

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scan_beacon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Radius Networks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/scan_beacon.rb
 - lib/scan_beacon/beacon.rb
 - lib/scan_beacon/beacon_parser.rb
+- lib/scan_beacon/ble112_device.rb
 - lib/scan_beacon/ble112_scanner.rb
 - lib/scan_beacon/version.rb
 - scan_beacon.gemspec