rubyeddystoneurl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 286da3a462d1cd40888d6ddff5d93b264223be60
+  data.tar.gz: 50afcba5208938ec2ff1849eeffcadc14250ce6a
+SHA512:
+  metadata.gz: 19c2f242e3171fe80ede5e68b974594d716a25560d09b455c174af7a3e7f48cdcdbbc7c8efa1087998e707d907794a4381a510c514d837e49b965d3bc9ff18da
+  data.tar.gz: 1db4459ee61eb9510c1ae127386b41b88c7ca028e8596ff6b95b7a7d0abb5d650c41de8b03c3b2dd49d4fef6598e29e37b1e083085701dce167ecd0ababe75a8

data/ext/rubyeddystoneurl/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+
+#have_library 'stdc++'
+extension_name = 'rubyeddystoneurl/rubyeddystoneurl'
+dir_config extension_name
+
+$CPPFLAGS << " -I/usr/include/bluetooth"
+$LOCAL_LIBS << " -lbluetooth"
+
+create_makefile extension_name

data/ext/rubyeddystoneurl/rubyeddystoneurl.c

@@ -0,0 +1,171 @@
+#include "ruby.h"
+#include <errno.h>
+#include <signal.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/ioctl.h>
+#include <sys/prctl.h>
+#include <unistd.h>
+
+#include <bluetooth/bluetooth.h>
+#include <bluetooth/hci.h>
+#include <bluetooth/hci_lib.h>
+
+VALUE RubyEddystoneURL = Qnil;
+void Init_rubyeddystoneurl();
+VALUE method_scan(VALUE, VALUE);
+
+void Init_rubyeddystoneurl(){
+    VALUE RubyEddystoneURL = rb_define_module("RubyEddystoneURL");
+    rb_define_method(RubyEddystoneURL, "scan", method_scan,1);
+}
+
+VALUE method_scan(VALUE self, VALUE timeout) {
+    VALUE retArray = rb_ary_new();
+
+    int hciDeviceId = 0;
+    int hciSocket;
+    struct hci_dev_info hciDevInfo;
+
+    struct hci_filter oldHciFilter;
+    struct hci_filter newHciFilter;
+    socklen_t oldHciFilterLen;
+
+    int currentAdapterState;
+    int timeoutCounter = 0;
+
+    unsigned char hciEventBuf[HCI_MAX_EVENT_SIZE];
+    int hciEventLen;
+    evt_le_meta_event *leMetaEvent;
+    le_advertising_info *leAdvertisingInfo;
+    char btAddress[18];
+    int i;
+    int8_t rssi;
+    fd_set rfds;
+    struct timeval tv;
+    int selectRetval;
+    char btInfo[500];
+
+    if(TYPE(timeout) != T_FIXNUM) {
+        rb_raise(rb_eTypeError, "Invalid parameter");
+        return Qnil;
+    }
+
+    memset(&hciDevInfo, 0x00, sizeof(hciDevInfo));
+
+    //use first available device
+    hciDeviceId = hci_get_route(NULL);
+
+    if (hciDeviceId < 0) {
+        hciDeviceId = 0; // use device 0, if device id is invalid
+    }
+
+    // setup HCI socket
+    hciSocket = hci_open_dev(hciDeviceId);
+
+    if (hciSocket == -1) {
+        rb_raise(rb_eStandardError, "Unsupported");
+        return Qnil;
+    }
+    hciDevInfo.dev_id = hciDeviceId;
+
+    // get old HCI filter
+    oldHciFilterLen = sizeof(oldHciFilter);
+    getsockopt(hciSocket, SOL_HCI, HCI_FILTER, &oldHciFilter, &oldHciFilterLen);
+
+    // setup new HCI filter
+    hci_filter_clear(&newHciFilter);
+    hci_filter_set_ptype(HCI_EVENT_PKT, &newHciFilter);
+    hci_filter_set_event(EVT_LE_META_EVENT, &newHciFilter);
+    setsockopt(hciSocket, SOL_HCI, HCI_FILTER, &newHciFilter, sizeof(newHciFilter));
+
+    // disable scanning, it may have been left on, if so hci_le_set_scan_parameters will fail without this
+    hci_le_set_scan_enable(hciSocket, 0x00, 0, 1000);
+
+    // get HCI dev info for adapter state
+    ioctl(hciSocket, HCIGETDEVINFO, (void *)&hciDevInfo);
+    currentAdapterState = hci_test_bit(HCI_UP, &hciDevInfo.flags);
+
+    if (!currentAdapterState) {
+        //powered off
+        currentAdapterState = 0;
+    } else if (hci_le_set_scan_parameters(hciSocket, 0x01, htobs(0x0010), htobs(0x0010), 0x00, 0, 1000) < 0) {
+        if (EPERM == errno) {
+            //unauthorized
+            currentAdapterState = 1;
+        } else if (EIO == errno) {
+            //unsupported
+            currentAdapterState = 2;
+        } else {
+            //unknown
+            currentAdapterState = 3;
+        }
+    } else {
+        //powered on
+        currentAdapterState = 4;
+    }
+
+    if(currentAdapterState == 4) {
+        //scan devices
+        hci_le_set_scan_enable(hciSocket, 0x00, 1, 1000);
+        hci_le_set_scan_enable(hciSocket, 0x01, 1, 1000);
+
+        while(1) {
+            FD_ZERO(&rfds);
+            FD_SET(hciSocket, &rfds);
+
+            tv.tv_sec = 1;
+            tv.tv_usec = 0;
+
+            selectRetval = select(hciSocket + 1, &rfds, NULL, NULL, &tv);
+
+            if(selectRetval) {
+                //get scan devices
+                hciEventLen = read(hciSocket, hciEventBuf, sizeof(hciEventBuf));
+                leMetaEvent = (evt_le_meta_event *)(hciEventBuf + (1 + HCI_EVENT_HDR_SIZE));
+                hciEventLen -= (1 + HCI_EVENT_HDR_SIZE);
+
+                if (leMetaEvent->subevent == 0x02) {
+                    leAdvertisingInfo = (le_advertising_info *)(leMetaEvent->data + 1);
+                    ba2str(&leAdvertisingInfo->bdaddr, btAddress);
+
+                    VALUE hash = rb_hash_new();
+                    rb_hash_aset(hash, rb_str_new2("address"), rb_str_new2(btAddress));
+
+                    rssi = *(leAdvertisingInfo->data + leAdvertisingInfo->length);
+                    
+                    rb_hash_aset(hash, rb_str_new2("rssi"), rb_int_new((int)rssi));
+                    
+                    btInfo[0] = '\0';
+
+                    for (i = 0; i < leAdvertisingInfo->length; i++) {
+                        sprintf(btInfo + strlen(btInfo), "%02x", leAdvertisingInfo->data[i]);
+                    }
+
+                    //printf("%s\n", btInfo);
+
+                    rb_hash_aset(hash, rb_str_new2("info"), rb_str_new2(btInfo));
+                    rb_ary_push(retArray, hash);
+                }
+            }
+
+            timeoutCounter += 1;
+            sleep(1);
+            
+            if(timeoutCounter == FIX2INT(timeout)) {
+                //stop scan
+                hci_le_set_scan_enable(hciSocket, 0x00, 0, 1000);
+                break;
+            }
+
+        }
+    }
+
+    // restore original filter
+    setsockopt(hciSocket, SOL_HCI, HCI_FILTER, &oldHciFilter, sizeof(oldHciFilter));
+    // disable LE scan
+    hci_le_set_scan_enable(hciSocket, 0x00, 0, 1000);
+    close(hciSocket);
+
+    return retArray;
+}

data/lib/rubyeddystoneurl.rb

@@ -0,0 +1,113 @@
+=begin
+ * 2018 http://ferdinandsilva.com
+ *
+ * Ruby C Extension To Scan Eddystone-URL Beacons
+ * 
+ * Author:
+ * Ferdinand Silva <ferdinandsilva@ferdinandsilva.com>
+ *
+=end
+require 'rubyeddystoneurl/rubyeddystoneurl' 
+include RubyEddystoneURL
+
+def discover(timeout)
+    ret = Hash.new
+
+    devices = scan(timeout)
+
+    devices.each do |dev|
+        if !ret.key?(dev['address'])
+            # add to return
+            ret[dev['address']] = {
+                "name" => "",
+                "url" => "",
+                "rssi" => dev['rssi']
+            }
+        end
+
+        if dev['info'].length > 28
+            # valid info
+            lineToRemove = dev['info'][0..25]
+            cleanLine = dev['info'].sub lineToRemove, ""
+
+            if cleanLine[/^(00|01|02|03)/]
+                #URL
+                justStarted = true
+                urlStr = ""
+
+                while cleanLine.length > 0
+                    lineToRemove = cleanLine[0..1]
+
+                    #decode URL
+                    if justStarted
+                        justStarted = false
+
+                        if lineToRemove == "00"
+                            urlStr = "http://www."
+                        elsif lineToRemove == "01"
+                            urlStr = "https://www."
+                        elsif lineToRemove == "02"
+                            urlStr = "http://"
+                        else
+                            # 03
+                            urlStr = "https://"
+                        end
+                        cleanLine = cleanLine.sub lineToRemove, ""
+                        next
+                    end
+
+                    if lineToRemove == "00"
+                        urlStr += ".com/"
+                    elsif lineToRemove == "01"
+                        urlStr += ".org/"
+                    elsif lineToRemove == "02"
+                        urlStr += ".edu/"
+                    elsif lineToRemove == "03"
+                        urlStr += ".net/"
+                    elsif lineToRemove == "04"
+                        urlStr += ".info/"
+                    elsif lineToRemove == "05"
+                        urlStr += ".biz/"
+                    elsif lineToRemove == "06"
+                        urlStr += ".gov/"
+                    elsif lineToRemove == "07"
+                        urlStr += ".com"
+                    elsif lineToRemove == "08"
+                        urlStr += ".org"
+                    elsif lineToRemove == "09"
+                        urlStr += ".edu"
+                    elsif lineToRemove == "0a"
+                        urlStr += ".net"
+                    elsif lineToRemove == "0b"
+                        urlStr += ".info"
+                    elsif lineToRemove == "0c"
+                        urlStr += ".biz"
+                    elsif lineToRemove == "0d"
+                        urlStr += ".gov"
+                    else
+                        urlStr += [lineToRemove].pack 'H*'
+                    end
+
+                    cleanLine = cleanLine.sub lineToRemove, ""
+                end
+
+                ret[dev['address']]['url'] = urlStr
+            else
+                #name
+                lineToRemove = cleanLine[0..3]
+                cleanLine = cleanLine.sub lineToRemove, ""
+                ret[dev['address']]['name'] = [cleanLine].pack 'H*'
+            end
+        end
+    end
+
+    # clean up devices
+    # remove devices that doesn't have a url
+    ret.each do |k,v|
+        if ret[k]["url"] == ""
+            ret.delete k
+        end
+    end
+
+    return ret
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: rubyeddystoneurl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ferdinand E. Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies: []
+description: Ruby C Extension To Scan Eddystone-URL Bluetooth Low Energy Beacons
+email: ferdinandsilva@ferdinandsilva.com
+executables: []
+extensions:
+- ext/rubyeddystoneurl/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/rubyeddystoneurl/extconf.rb
+- ext/rubyeddystoneurl/rubyeddystoneurl.c
+- lib/rubyeddystoneurl.rb
+homepage: http://ferdinandsilva.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby C Extension To Scan Eddystone-URL Bluetooth Low Energy Beacons
+test_files: []