scan_beacon 0.6.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2de8ba974098283895a45b85e443df9ee44d24d
-  data.tar.gz: 9dad130a30cd2734545fc1c264c5abaf932e9a47
+  metadata.gz: 3b38f927f67bef75a626e0509245b4588b7cd62a
+  data.tar.gz: 6bffd5d1c56c0a5c560d1c403d66898ac9ec1053
 SHA512:
-  metadata.gz: 54bdcd6601ca6dc33431c39049bc1792ee48774ed2d2e99b033569e5949f16bf36bd02e7a92ba86645ff7abdb2a50b80aa60941fb37b6de60d89dc0587252a3c
-  data.tar.gz: ce40ebea3c1120b8ccbc8434853b5fb4697b347f5459cdc8fb922dae8bdee1c1b5b2d761d068a38db3666d436a0e53f41ae93b25783139838212d3913f9facbd
+  metadata.gz: da91c39c519a4d065c0ad22f29bb4d876350ecb03cfda92b13907f0bf5953df5e45e788742c81e590123c612ec6d9c4b9b40fa282559d0f61ffc75475a8b8ba5
+  data.tar.gz: 3840835c733003843718246959c5d76c913a44f70f0b0f7dbe35827b2a317bfcb0b16db9c6774d6abdf511c6caa5eff1bbe77c54c48d3b04c88bff6622eb81c1

data/README.md

@@ -1,6 +1,6 @@
 # ScanBeacon gem
 
-A ruby gem that allows you to scan for beacon advertisements using CoreBluetooth (on Mac OS X) or a BlueGiga BLE112 device (on mac or linux)
+A ruby gem that allows you to scan for beacon advertisements using IOBluetooth (on Mac OS X) or a BlueGiga BLE112 device (on mac or linux)
 
 # Example Usage
 
@@ -13,12 +13,14 @@ gem install scan_beacon
 ## Create your scanner
 ``` ruby
 require 'scan_beacon'
+# to scan using the default device on mac or linux
+scanner = ScanBeacon::DefaultScanner.new
 # to scan using CoreBluetooth on a mac
 scanner = ScanBeacon::CoreBluetoothScanner.new
-# to scan using a BLE112 device
-scanner = ScanBeacon::BLE112Scanner.new
 # to scan using BlueZ on Linux (make sure you have privileges)
 scanner = ScanBeacon::BlueZScanner.new
+# to scan using a BLE112 device
+scanner = ScanBeacon::BLE112Scanner.new
 ```
 
 ## Start a scan, yield beacons in a loop
@@ -57,7 +59,7 @@ scanner.add_parser( ScanBeacon::BeaconParser.new(:mybeacon, "m:2-3=0000,i:4-19,i
 ...
 ```
 
-## Advertise as a beacon on Linux using BlueZ
+## Advertise as a beacon on Linux using BlueZ or a Mac using IOBluetooth
 Example:
 ``` ruby
 # altbeacon
@@ -67,7 +69,7 @@ beacon = ScanBeacon::Beacon.new(
   mfg_id: 0x0118,
   beacon_type: :altbeacon
 )
-advertiser = ScanBeacon::BlueZAdvertiser.new(beacon: beacon)
+advertiser = ScanBeacon::DefaultAdvertiser.new(beacon: beacon)
 advertiser.start
 ...
 advertiser.stop
@@ -79,7 +81,17 @@ beacon = ScanBeacon::Beacon.new(
   service_uuid: 0xFEAA,
   beacon_type: :eddystone_uid
 )
-advertiser = ScanBeacon::BlueZAdvertiser.new(beacon: beacon)
+advertiser = ScanBeacon::DefaultAdvertiser.new(beacon: beacon)
+advertiser.start
+...
+advertiser.stop
+
+# Eddystone URL (PhysicalWeb)
+beacon = ScanBeacon::EddystoneUrlBeacon.new(
+  url: "http://radiusnetworks.com",
+  power: -20,
+)
+advertiser = ScanBeacon::DefaultAdvertiser.new(beacon: beacon)
 advertiser.start
 ...
 advertiser.stop
@@ -87,6 +99,4 @@ advertiser.stop
 
 
 # Dependencies
-To scan for beacons, you must have a Linux machine with BlueZ installed, or a Mac, or a BLE112 device plugged in to a USB port (on Mac or Linux).
-
-To advertise as a beacon, you must have a Linux machine with BlueZ installed.
+To scan for beacons or advertise, you must have a Linux machine with BlueZ installed, or a Mac, or a BLE112 device plugged in to a USB port (on Mac or Linux).

data/ext/core_bluetooth/core_bluetooth.m

@@ -3,6 +3,7 @@
 // Include the Ruby headers and goodies
 #include "ruby.h"
 #import <Foundation/Foundation.h>
+#import <IOBluetooth/IOBluetooth.h>
 #import <CoreBluetooth/CoreBluetooth.h>
 
 // Defining a space for information and references about the module to be stored internally
@@ -14,6 +15,19 @@ VALUE method_scan();
 VALUE method_new_adverts();
 VALUE new_scan_hash(NSString* device, NSData *data, NSNumber *rssi, NSData *service_uuid);
 
+VALUE method_set_advertisement_data(VALUE klass, VALUE data);
+VALUE method_start_advertising();
+VALUE method_stop_advertising();
+
+// define some hidden methods so we can call them more easily
+@interface IOBluetoothHostController ()
+- (int)BluetoothHCILESetAdvertiseEnable:(unsigned char)arg1;
+- (int)BluetoothHCILESetAdvertisingData:(unsigned char)arg1 advertsingData:(char *)arg2;
+- (int)BluetoothHCILESetAdvertisingParameters:(unsigned short)arg1 advertisingIntervalMax:(unsigned short)arg2 advertisingType:(unsigned char)arg3 ownAddressType:(unsigned char)arg4 directAddressType:(unsigned char)arg5 directAddress:(struct BluetoothDeviceAddress { unsigned char x1[6]; }*)arg6 advertisingChannelMap:(unsigned char)arg7 advertisingFilterPolicy:(unsigned char)arg8;
+- (int)BluetoothHCILESetScanParameters:(unsigned char)arg1 LEScanInterval:(unsigned short)arg2 LEScanWindow:(unsigned short)arg3 ownAddressType:(unsigned char)arg4 scanningFilterPolicy:(unsigned char)arg5;
+- (int)BluetoothHCILESetScanEnable:(unsigned char)arg1 filterDuplicates:(unsigned char)arg2;
+@end
+
 @interface BLEDelegate : NSObject <CBCentralManagerDelegate> {
   @private
   NSMutableArray *_scans;
@@ -61,6 +75,15 @@ VALUE new_scan_hash(NSString* device, NSData *data, NSNumber *rssi, NSData *serv
 - (void)centralManagerDidUpdateState:(CBCentralManager *)central
 {
   [central scanForPeripheralsWithServices:nil options:@{CBCentralManagerScanOptionAllowDuplicatesKey : @(YES)}];
+
+  // set custom scan params to achieve better scanning performance
+  IOBluetoothHostController * device = IOBluetoothHostController.defaultController;
+  [device BluetoothHCILESetScanParameters:0x01
+                           LEScanInterval:200
+                             LEScanWindow:200
+                           ownAddressType:0x00
+                     scanningFilterPolicy:0x00];
+  [device BluetoothHCILESetScanEnable:0x01 filterDuplicates:0x00];
 }
 
 - (NSArray *) scans
@@ -90,6 +113,10 @@ void Init_core_bluetooth()
   rb_define_singleton_method(cb_module, "scan", method_scan, 0);
   rb_define_singleton_method(cb_module, "new_adverts", method_new_adverts, 0);
 
+  rb_define_singleton_method(cb_module, "set_advertisement_data", method_set_advertisement_data, 1);
+  rb_define_singleton_method(cb_module, "start_advertising", method_start_advertising, 0);
+  rb_define_singleton_method(cb_module, "stop_advertising", method_stop_advertising, 0);
+
   sym_device = ID2SYM(rb_intern("device"));
   sym_data = ID2SYM(rb_intern("data"));
   sym_rssi = ID2SYM(rb_intern("rssi"));
@@ -149,4 +176,37 @@ VALUE method_scan()
   return Qnil;
 }
 
+VALUE method_set_advertisement_data(VALUE klass, VALUE data)
+{
+  IOBluetoothHostController *device = [IOBluetoothHostController defaultController];
+  char flags_and_data[40];
+  memcpy(flags_and_data, "\x02\x01\x1A", 3);
+  memcpy(flags_and_data+3, RSTRING_PTR(data), RSTRING_LEN(data));
+  // NOTE: Mac OS X has a typo in the method definition.  This may get fixed in the future.
+  [device BluetoothHCILESetAdvertisingData: RSTRING_LEN(data)+3 advertsingData: flags_and_data];
+  return Qnil;
+}
+
+VALUE method_start_advertising()
+{
+  IOBluetoothHostController *device = [IOBluetoothHostController defaultController];
+  [device BluetoothHCILESetAdvertisingParameters: 0x00A0
+                          advertisingIntervalMax: 0x00A0 // 100ms
+                                 advertisingType: 0x03
+                                  ownAddressType: 0x00
+                               directAddressType: 0x00
+                                   directAddress: (void*)"\x00\x00\x00\x00\x00\x00"
+                                   advertisingChannelMap: 0x07 // all 3 channels
+                                 advertisingFilterPolicy: 0x00];
+  [device BluetoothHCILESetAdvertiseEnable: 1];
+  return Qnil;
+}
+
+VALUE method_stop_advertising()
+{
+  IOBluetoothHostController *device = [IOBluetoothHostController defaultController];
+  [device BluetoothHCILESetAdvertiseEnable: 0];
+  return Qnil;
+}
+
 #endif // TARGET_OS_MAC

data/ext/core_bluetooth/extconf.rb

@@ -10,6 +10,7 @@ dir_config(extension_name)
 if RUBY_PLATFORM =~ /darwin/
   $DLDFLAGS << " -framework Foundation"
   $DLDFLAGS << " -framework CoreBluetooth"
+  $DLDFLAGS << " -framework IOBluetooth"
 else
   # don't compile the code on non-mac platforms because
   # CoreBluetooth wont be there, and we may not even have

data/lib/scan_beacon/beacon.rb

@@ -3,7 +3,7 @@ require 'set'
 module ScanBeacon
   class Beacon
 
-    attr_accessor :mac, :ids, :power, :beacon_types, :data, :mfg_id, :service_uuid
+    attr_accessor :mac, :ids, :power, :beacon_types, :data, :mfg_id, :service_uuid, :rssis
 
     def initialize(opts={})
       @ids = opts[:ids] || []
@@ -12,7 +12,7 @@ module ScanBeacon
       @mfg_id = opts[:mfg_id]
       @service_uuid = opts[:service_uuid]
       @beacon_types = Set.new [opts[:beacon_type]]
-      @rssis = []
+      @rssis = opts[:rssis] || []
     end
 
     def ==(obj)

data/lib/scan_beacon/beacon_parser.rb

@@ -2,7 +2,8 @@ module ScanBeacon
   class BeaconParser
     DEFAULT_LAYOUTS = {
       altbeacon: "m:2-3=beac,i:4-19,i:20-21,i:22-23,p:24-24,d:25-25",
-      eddystone_uid: "s:0-1=feaa,m:2-2=00,p:3-3:-41,i:4-13,i:14-19;d:20-21"
+      eddystone_uid: "s:0-1=feaa,m:2-2=00,p:3-3:-41,i:4-13,i:14-19;d:20-21",
+      eddystone_url: "s:0-1=feaa,m:2-2=10,p:3-3:-41,i:4-21v",
     }
     AD_TYPE_MFG = 0xff
     AD_TYPE_SERVICE = 0x03
@@ -36,6 +37,9 @@ module ScanBeacon
           end: range_end.to_i,
           length: range_end.to_i - range_start.to_i + 1,
         }
+        if range_end.end_with? 'v'
+          field_params[:var_length] = true
+        end
         field_params[:expected] = [expected].pack("H*") unless expected.nil?
         case field_type
         when 'm'
@@ -100,14 +104,19 @@ module ScanBeacon
     end
 
     def generate_ad(beacon)
-      length = [@matchers, @ids, @power, @data_fields].flatten.map {|elem| elem[:end] }.max + 1
+      length = [@matchers, @ids, @power, @data_fields].flatten.map {|elem| elem[:start] }.max + 1
       ad = ("\x00" * length).force_encoding("ASCII-8BIT")
       @matchers.each do |matcher|
         ad[matcher[:start]..matcher[:end]] = matcher[:expected]
       end
       @ids.each_with_index do |id, index|
-        id_bytes = Beacon::Field.field_with_length(beacon.ids[index], id[:length]).bytes
-        ad[id[:start]..id[:end]] = id_bytes
+        if id[:var_length]
+          id_bytes = Beacon::Field.new(hex: beacon.ids[index]).bytes
+          ad[id[:start]..id[:start]+id_bytes.size] = id_bytes
+        else
+          id_bytes = Beacon::Field.field_with_length(beacon.ids[index], id[:length]).bytes
+          ad[id[:start]..id[:end]] = id_bytes
+        end
       end
       @data_fields.each_with_index do |field, index|
         unless beacon.data[index].nil?
@@ -116,6 +125,7 @@ module ScanBeacon
         end
       end
       ad[@power[:start]..@power[:end]] = [beacon.power].pack('c')
+      length = ad.size
       if @ad_type == AD_TYPE_SERVICE
         "\x03\x03".force_encoding("ASCII-8BIT") + [beacon.service_uuid].pack("S<") + [length+1].pack('C') + BT_EIR_SERVICE_DATA + ad
       elsif @ad_type == AD_TYPE_MFG

data/lib/scan_beacon/ble112_advertiser.rb

@@ -3,7 +3,7 @@ module ScanBeacon
 
     def initialize(opts = {})
       @device = BLE112Device.new opts[:port]
-      super()
+      super(opts)
     end
 
     def start(with_rotation = false)

data/lib/scan_beacon/ble112_device.rb

@@ -137,26 +137,10 @@ module ScanBeacon
       device_count = possible_devices.count
       possible_devices.each do |device_path|
         File.open(device_path, 'r+b') do |file|
-          file.write([BG_COMMAND, 1, BG_MSG_CLASS_SYSTEM, BG_RESET, 0].pack('C*'))
-        end
-      end
-
-      # wait for them to show up again, but only wait for up to 5 secs
-      sleep 1
-      wait_count = 0
-      while possible_devices.count < device_count && wait_count < 50
-        sleep 0.1
-        wait_count += 1
-      end
-
-      # try to open them - if we get a busy, wait and try again
-      possible_devices.each do |device_path|
-        begin
-          File.open(device_path, 'r+b') {|f| f.close }
-        rescue Errno::EBUSY
-          sleep 0.1
-          retry
+          file.write([BG_COMMAND, 0, BG_MSG_CLASS_GAP, BG_DISCOVER_STOP].pack('C*'))
         end
+        # open and close the file to clear the buffer
+        File.open(device_path, 'r+b') {|file| }
       end
     end
 

data/lib/scan_beacon/bluez_advertiser.rb

@@ -50,4 +50,5 @@ module ScanBeacon
     end
 
   end
+  DefaultAdvertiser = BlueZAdvertiser
 end

data/lib/scan_beacon/bluez_scanner.rb

@@ -23,4 +23,5 @@ module ScanBeacon
     end
 
   end
+  DefaultScanner = BlueZScanner
 end

data/lib/scan_beacon/core_bluetooth_advertiser.rb

@@ -0,0 +1,27 @@
+module ScanBeacon
+  class CoreBluetoothAdvertiser < GenericIndividualAdvertiser
+
+    def initialize(opts = {})
+      super
+    end
+
+    def ad=(value)
+      @ad = value
+      CoreBluetooth.set_advertisement_data @ad
+    end
+
+    def start
+      CoreBluetooth.start_advertising
+    end
+
+    def stop
+      CoreBluetooth.stop_advertising
+    end
+
+    def inspect
+      "<CoreBluetoothAdvertiser ad=#{@ad.inspect}>"
+    end
+
+  end
+  DefaultAdvertiser = CoreBluetoothAdvertiser
+end

data/lib/scan_beacon/core_bluetooth_scanner.rb

@@ -22,4 +22,5 @@ module ScanBeacon
     end
 
   end
+  DefaultScanner = CoreBluetoothScanner
 end

data/lib/scan_beacon/eddystone_url_beacon.rb

@@ -0,0 +1,72 @@
+module ScanBeacon
+  # Convenience class for constructing & advertising Eddystone-URL frames
+  class EddystoneUrlBeacon < Beacon
+
+    SCHEMES = {"http://www."  => "\x00",
+               "https://www." => "\x01",
+               "http://"      => "\x02",
+               "https://"     => "\x03"}
+
+    EXPANSIONS = {".com/"  => "\x00",
+                  ".org/"  => "\x01",
+                  ".edu/"  => "\x02",
+                  ".net/"  => "\x03",
+                  ".info/" => "\x04",
+                  ".biz/"  => "\x05",
+                  ".gov/"  => "\x06",
+                  ".com"   => "\x07",
+                  ".org"   => "\x08",
+                  ".edu"   => "\x09",
+                  ".net"   => "\x0a",
+                  ".info"  => "\x0b",
+                  ".biz"   => "\x0c",
+                  ".gov"   => "\x0d"}
+
+    def initialize(opts = {})
+      opts[:service_uuid] ||= 0xFEAA
+      opts[:beacon_type] ||= :eddystone_url
+      super opts
+      self.url = opts[:url] if opts[:url]
+    end
+
+    def self.from_beacon(beacon)
+      new(ids: beacon.ids, power: beacon.power, rssis: beacon.rssis)
+    end
+
+    def url
+      @url ||= self.class.decompress_url( self.ids[0].to_s )
+    end
+
+    def url=(new_url)
+      @url = new_url
+      self.ids = [self.class.compress_url(@url)]
+    end
+
+    def self.compress_url(url)
+      scheme, scheme_code = SCHEMES.find {|k, v| url.start_with? k}
+      raise ArgumentError, "Invalid URL" if scheme.nil?
+      compressed_url = scheme_code + url[scheme.size..-1]
+      EXPANSIONS.each do |k,v|
+        compressed_url.gsub! k,v
+      end
+      raise ArgumentError, "URL too long" if compressed_url.size > 18
+      compressed_url.force_encoding("ASCII-8BIT").unpack("H*")[0]
+    end
+
+    def self.decompress_url(hex)
+      compressed_url_string = [hex].pack("H*")
+      scheme_code = compressed_url_string[0]
+      scheme, scheme_code = SCHEMES.find {|k,v| v == scheme_code}
+      raise ArgumentError, "Invalid URL" if scheme.nil?
+      decompressed_url = scheme + compressed_url_string[1..-1]
+      EXPANSIONS.each do |k,v|
+        decompressed_url.gsub! v,k
+      end
+      decompressed_url
+    end
+
+    def inspect
+      "<EddystoneUrlBeacon url=\"#{url}\" rssi=#{rssi}, scans=#{ad_count}, power=#{@power}>"
+    end
+  end
+end

data/lib/scan_beacon/generic_advertiser.rb

@@ -6,12 +6,13 @@ module ScanBeacon
     def initialize(opts = {})
       self.beacon = opts[:beacon]
       self.parser = opts[:parser]
+      self.ad = opts[:ad] if opts[:ad]
       if beacon
         self.parser ||= BeaconParser.default_parsers.find {|parser| parser.beacon_type == beacon.beacon_types.first}
       end
       @advertising = false
     end
-    
+
     def start(with_rotation = false)
       raise NotImplementedError
     end
@@ -24,4 +25,4 @@ module ScanBeacon
       raise NotImplementedError
     end
   end
-end
+end

data/lib/scan_beacon/version.rb

@@ -1,3 +1,3 @@
 module ScanBeacon
-  VERSION = "0.6.8"
+  VERSION = "0.7.0"
 end

data/lib/scan_beacon.rb

@@ -1,5 +1,6 @@
 require "scan_beacon/version"
 require "scan_beacon/beacon"
+require "scan_beacon/eddystone_url_beacon"
 require "scan_beacon/beacon/field"
 require "scan_beacon/beacon_parser"
 require "scan_beacon/generic_scanner"
@@ -12,6 +13,7 @@ case RUBY_PLATFORM
 when /darwin/
   require "scan_beacon/core_bluetooth"
   require "scan_beacon/core_bluetooth_scanner"
+  require "scan_beacon/core_bluetooth_advertiser"
 when /linux/
   require "scan_beacon/bluez"
   require "scan_beacon/bluez_scanner"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scan_beacon
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Radius Networks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,9 @@ files:
 - lib/scan_beacon/ble112_scanner.rb
 - lib/scan_beacon/bluez_advertiser.rb
 - lib/scan_beacon/bluez_scanner.rb
+- lib/scan_beacon/core_bluetooth_advertiser.rb
 - lib/scan_beacon/core_bluetooth_scanner.rb
+- lib/scan_beacon/eddystone_url_beacon.rb
 - lib/scan_beacon/generic_advertiser.rb
 - lib/scan_beacon/generic_individual_advertiser.rb
 - lib/scan_beacon/generic_scanner.rb