sb-ble 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbab52be19f92ec7202ac18981e9b65ead354a2c
+  data.tar.gz: b695176d8a305d5ac043fa350a5e2d995d8bc699
+SHA512:
+  metadata.gz: df55d481209aaa635386dfa2deb9f2204824bc23ac44b8adcb55e8b4331c44971f35b90bb88ed5601b215795b630ca3256796c3a69fecb5c210acba58ccdd90f
+  data.tar.gz: 5bb64da90ebf9a2e0ccb14f62c8f6b580f9c01dcb7ff039f28829dc1e64f1145936ee4276035138de31fcafb916ca8a143438f407a4656083f023ddddbd3410b

data/.rspec

@@ -0,0 +1 @@
+--color

data/.semver

@@ -0,0 +1,5 @@
+---
+:major: 0
+:minor: 5
+:patch: 0
+:special: ''

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gem "ruby-dbus", "~> 0"
+gem 'semver2', '~> 3' 
+
+group :development do
+  gem "rspec", "~> 3"
+  gem "yard", "~> 0"
+  gem "rdoc", "~> 3"
+  gem "bundler", "~> 1"
+  gem "juwelier", "~> 2"
+  gem "simplecov", ">= 0"
+  gem "pry", "~> 0"
+  gem "pry-byebug", "~> 3"
+  gem "pry-doc", "~> 0"
+  gem "pry-remote", "~> 0"
+  gem "pry-rescue", "~> 1"
+  gem "pry-stack_explorer", "~> 0"
+  gem 'redcarpet'
+  gem 'github-markup'
+end

data/Gemfile.lock

@@ -0,0 +1,130 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    debug_inspector (0.0.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github-markup (1.6.0)
+    github_api (0.17.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.5.5)
+    highline (1.7.8)
+    interception (0.5)
+    json (1.8.6)
+    juwelier (2.4.5)
+      builder
+      bundler (>= 1.13)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      kamelcase (~> 0)
+      nokogiri (>= 1.5.10)
+      psych (~> 2.2)
+      rake
+      rdoc
+      semver2
+    jwt (1.5.6)
+    kamelcase (0.0.0)
+      semver2 (~> 3)
+    method_source (0.8.2)
+    mime-types (2.99.3)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.7.2)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    pry-doc (0.10.0)
+      pry (~> 0.9)
+      yard (~> 0.9)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    pry-rescue (1.4.5)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    psych (2.2.4)
+    rack (2.0.3)
+    rake (12.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redcarpet (3.4.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-dbus (0.13.0)
+    semver2 (3.4.2)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    yard (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1)
+  github-markup
+  juwelier (~> 2)
+  pry (~> 0)
+  pry-byebug (~> 3)
+  pry-doc (~> 0)
+  pry-remote (~> 0)
+  pry-rescue (~> 1)
+  pry-stack_explorer (~> 0)
+  rdoc (~> 3)
+  redcarpet
+  rspec (~> 3)
+  ruby-dbus (~> 0)
+  semver2 (~> 3)
+  simplecov
+  yard (~> 0)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Fred Mitchell & Sensorberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.org

@@ -0,0 +1,62 @@
+* sb-ble
+  :PROPERTIES:
+  :CUSTOM_ID: ruby-ble
+  :END:
+
+  Bluetooth Low Energy for Ruby -- Sensorberg Version
+  [[https://badge.fury.io/rb/ble][[[https://badge.fury.io/rb/ble.svg]]]]
+
+** Prelimaries
+   This is a fork of a fork. More features are being added here,
+   such as support for advertising.
+
+** Requirements
+   :PROPERTIES:
+   :CUSTOM_ID: requirements
+   :END:
+
+   -  ruby >= 2.3
+   -  Dbus
+   -  bluez >= 5.36 (available on debian testing)
+   -  =bluetoothd= started with option =-E= (experimental)
+
+** Examples
+   :PROPERTIES:
+   :CUSTOM_ID: examples
+   :END:
+
+#+BEGIN_SRC ruby
+    # Selecter adapter
+    $a = BLE::Adapter.new('hci0')
+    puts "Info: #{$a.iface} #{$a.address} #{$a.name}"
+
+    # Run discovery
+    $a.start_discovery
+    sleep(2)
+    $a.stop_discovery
+
+    # Get device and connect to it
+    $d = $a['F4:AD:CB:FB:B4:85']
+    $d.connect
+
+    # Get temperature from the environmental sensing service
+    $d[:environmental_sensing, :temperature]
+
+    # Dump device information
+    srv = :device_information
+    $d.characteristics(srv).each {|uuid|
+        info  = BLE::Characteristic[uuid]
+        name  = info.nil? ? uuid : info[:name]
+        value = $d[srv, uuid] rescue '/!\\ not-readable /!\\'
+        puts "%-30s: %s" % [ name, value ]
+    }
+#+END_SRC
+
+** Contributors
+   :PROPERTIES:
+   :CUSTOM_ID: contributors
+   :END:
+
+- Fred Mitchell (Sensorberg GmbH) LE Advertisement support
+- Oliver Valls (tramuntanal): Bug fixes / BLE Notification support
+- Stephane D'Alu

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'semver'
+
+def s_version
+  SemVer.find.format "%M.%m.%p%s"
+end
+
+require 'juwelier'
+
+Juwelier::Tasks.new do |gem|
+  gem.name = "sb-ble"
+  gem.homepage = "http://github.com/flajann2/ruby-ble"
+  gem.license = "MIT"
+  gem.summary = %Q{Bluetooth Low Energy for Ruby -- Sensorberg Version}
+  gem.description = %Q{This supports LE Advertising}
+  gem.email = "frederick.mitchell@sensorberg.com"
+  gem.authors = ["Fred Mitchell & Sensorberg"]
+  gem.version = s_version
+  # dependencies defined in Gemfile
+end
+
+Juwelier::RubygemsDotOrgTasks.new
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/ble.rb

@@ -0,0 +1,112 @@
+# coding: utf-8
+require 'dbus'
+require 'logger'
+
+# https://github.com/mvidner/ruby-dbus/blob/master/doc/Tutorial.md
+# https://kernel.googlesource.com/pub/scm/bluetooth/bluez/+/refs/heads/master/doc/
+
+
+#
+module BLE
+    private
+    # Interfaces
+    I_ADAPTER              = 'org.bluez.Adapter1'
+    I_DEVICE               = 'org.bluez.Device1'
+    I_AGENT_MANAGER        = 'org.bluez.AgentManager1'
+    I_AGENT                = 'org.bluez.Agent1'
+    I_GATT_CHARACTERISTIC  = 'org.bluez.GattCharacteristic1'
+    I_GATT_SERVICE         = 'org.bluez.GattService1'
+    I_PROXIMITY_REPORTER   = 'org.bluez.ProximityReporter1'
+    I_PROPERTIES           = 'org.freedesktop.DBus.Properties'
+    I_INTROSPECTABLE       = 'org.freedesktop.DBus.Introspectable'
+
+    # Errors
+    E_IN_PROGRESS          = 'org.bluez.Error.InProgress'
+    E_FAILED               = 'org.bluez.Error.Failed'
+    E_NOT_READY            = 'org.bluez.Error.NotReady'
+    E_ALREADY_CONNECTED    = 'org.bluez.Error.AlreadyConnected'
+    E_NOT_CONNECTED        = 'org.bluez.Error.NotConnected'
+    E_DOES_NOT_EXIST       = 'org.bluez.Error.DoesNotExist'
+    E_NOT_SUPPORTED        = 'org.bluez.Error.NotSupported'
+    E_NOT_AUTHORIZED       = 'org.bluez.Error.NotAuthorized'
+    E_INVALID_ARGUMENTS    = 'org.bluez.Error.InvalidArguments'
+    E_ALREADY_EXISTS       = 'org.bluez.Error.AlreadyExists'
+    E_AUTH_CANCELED        = 'org.bluez.Error.AuthenticationCanceled'
+    E_AUTH_FAILED          = 'org.bluez.Error.AuthenticationFailed'
+    E_AUTH_REJECTED        = 'org.bluez.Error.AuthenticationRejected'
+    E_AUTH_TIMEOUT         = 'org.bluez.Error.AuthenticationTimeout'
+    E_AUTH_ATTEMPT_FAILED  = 'org.bluez.Error.ConnectionAttemptFailed'
+    E_UNKNOWN_OBJECT       = 'org.freedesktop.DBus.Error.UnknownObject'
+    E_INVALID_ARGS         = 'org.freedesktop.DBus.Error.InvalidArgs'
+    E_INVALID_SIGNATURE    = 'org.freedesktop.DBus.Error.InvalidSignature'
+
+    # Bus
+    DBUS                   = DBus.system_bus
+    BLUEZ                  = DBUS.service('org.bluez')
+
+    public
+    # Generic Error class
+    class Error                  < StandardError ; end
+    # Notify of unimplemented part
+    class NotYetImplemented      < Error         ; end
+    # Notify that the underlying API object is dead
+    class StalledObject          < Error         ; end
+    # Notify that execution wass not able to fulill as some requirement
+    # was not ready. Usually you can wait a little and restart the action.
+    class NotReady               < Error         ; end
+    # Notify that you don't have the necessary authorization to perfrom
+    # the operation
+    class NotAuthorized          < Error         ; end
+    # Notify that some service/characteristic/... is not found
+    # on this device
+    class NotFound               < Error         ; end
+    class AccessUnavailable      < Error         ; end
+    class NotSupported      < Error         ; end
+
+
+    # Base UUID for GATT services defined with 16bit or 32bit UUID
+    GATT_BASE_UUID="00000000-0000-1000-8000-00805f9b34fb"
+
+    #"DisplayOnly", "DisplayYesNo", "KeyboardOnly",
+    # "NoInputNoOutput" and "KeyboardDisplay" which
+
+
+    def self.registerAgent(agent, service, path)
+        raise NotYetImplemented
+        bus = DBus.session_bus
+        service = bus.request_service("org.ruby.service")
+
+        service.export(BLE::Agent.new(agent_path))
+
+        o_bluez = BLUEZ.object('/org/bluez')
+        o_bluez.introspect
+        o_bluez[I_AGENT_MANAGER].RegisterAgent(agent_path, "NoInputNoOutput")
+    end
+
+
+
+
+    # Check if Bluetooth underlying API is accessible
+    def self.ok?
+        BLUEZ.exists?
+    end
+
+end
+
+require_relative 'ble/version'
+require_relative 'ble/uuid'
+require_relative 'ble/adapter'
+require_relative 'ble/char_desc'
+require_relative 'ble/notifications'
+require_relative 'ble/device'
+require_relative 'ble/service'
+require_relative 'ble/char_registry'
+require_relative 'ble/characteristic'
+require_relative 'ble/agent'
+
+require_relative 'ble/db_sig_service'
+require_relative 'ble/db_sig_characteristic'
+require_relative 'ble/db_eddystone'
+require_relative 'ble/db_nordic'
+
+

data/lib/ble/adapter.rb

@@ -0,0 +1,162 @@
+module BLE
+# Adapter class
+#   Adapter.list
+#   a = Adapter.new('hci0')
+#   a.start_discover ; sleep(10) ; a.stop_discovery
+#   a.devices
+#
+class Adapter
+    # Return a list of available unix device name for the
+    # adapter installed on the system.
+    # @return [Array<String>] list of unix device name
+    def self.list
+        o_bluez = BLUEZ.object('/org/bluez')
+        o_bluez.introspect
+        o_bluez.subnodes.reject {|adapter| ['test'].include?(adapter) }
+    end
+    
+    # Create a new Adapter
+    #
+    # @param iface [String] name of the Unix device
+    def initialize(iface)
+        @iface     = iface.dup.freeze
+        @o_adapter = BLUEZ.object("/org/bluez/#{@iface}")
+        @o_adapter.introspect
+        
+        # @o_adapter[I_PROPERTIES]
+        #     .on_signal('PropertiesChanged') do |intf, props|
+        #     end
+        # end
+    end
+    
+    # The Bluetooth interface name
+    # @return [String] name of the Unix device
+    def iface
+        @iface
+    end
+    
+    # The Bluetooth device address.
+    # @return [String] MAC address of the adapter
+    def address
+        @o_adapter[I_ADAPTER]['Address']
+    end
+    
+    # The Bluetooth system name (pretty hostname).
+    # @return [String]
+    def name
+        @o_adapter[I_ADAPTER]['Name']
+    end
+    
+    # The Bluetooth friendly name.
+    # In case no alias is set, it will return the system provided name.
+    # @return [String]
+    def alias
+        @o_adapter[I_ADAPTER]['Alias']
+    end
+    
+    # Set the alias name.
+    #
+    # When resetting the alias with an empty string, the
+    # property will default back to system name
+    #
+    # @param val [String] new alias name.
+    # @return [void]
+    def alias=(val)
+        @o_adapter[I_ADAPTER]['Alias'] = val.nil? ? '' : val.to_str
+        nil
+    end
+    
+    # Return the device corresponding to the given address.
+    # @note The device object returned has a dependency on the adapter.
+    #
+    # @param address MAC address of the device
+    # @return [Device] a device 
+    def [](address)
+        Device.new(@iface, address)
+    end
+    
+    # This method sets the device discovery filter for the caller.
+    # When this method is called with +nil+ or an empty list of UUIDs,
+    # filter is removed.
+    #
+    # @todo Need to sync with the adapter-api.txt
+    #
+    # @param uuids     a list of uuid to filter on
+    # @param rssi      RSSI threshold
+    # @param pathloss  pathloss threshold
+    # @param transport [:auto, :bredr, :le]
+    #                  type of scan to run (default: :le)
+    # @return [self]
+    def filter(uuids, rssi: nil, pathloss: nil, transport: :le)
+        unless [:auto, :bredr, :le].include?(transport)
+            raise ArgumentError,
+                  "transport must be one of :auto, :bredr, :le"
+        end
+        filter = { }
+        
+        unless uuids.nil? || uuids.empty?
+            filter['UUIDs'    ] = DBus.variant('as', uuids)
+        end
+        unless rssi.nil?
+            filter['RSSI'     ] = DBus.variant('n',  rssi)
+        end
+        unless pathloss.nil?
+            filter['Pathloss' ] = DBus.variant('q',  pathloss)
+        end
+        unless transport.nil?
+            filter['Transport'] = DBus.variant('s',  transport.to_s) 
+        end
+        
+        @o_adapter[I_ADAPTER].SetDiscoveryFilter(filter)
+        
+        self
+    end
+    
+    # Starts the device discovery session.
+    # This includes an inquiry procedure and remote device name resolving.
+    # Use {#stop_discovery} to release the sessions acquired.
+    # This process will start creating device in the underlying api
+    # as new devices are discovered.
+    #
+    # @return [Boolean]
+    def start_discovery
+        @o_adapter[I_ADAPTER].StartDiscovery
+        true
+    rescue DBus::Error => e
+        case e.name
+        when E_IN_PROGRESS then true
+        when E_FAILED      then false
+        else raise ScriptError
+        end
+    end
+    
+    # This method will cancel any previous {#start_discovery}
+    # transaction.
+    # @note The discovery procedure is shared
+    # between all discovery sessions thus calling {#stop_discovery}
+    # will only release a single session.
+    #
+    # @return [Boolean]
+    def stop_discovery
+        @o_adapter[I_ADAPTER].StopDiscovery
+        true
+    rescue DBus::Error => e
+        case e.name
+        when E_FAILED         then false
+        when E_NOT_READY      then false
+        when E_NOT_AUTHORIZED then raise NotAuthorized
+        else raise ScriptError
+        end
+        
+    end
+    
+    # List of devices MAC address that have been discovered.
+    #
+    # @return [Array<String>] List of devices MAC address.
+    def devices
+        @o_adapter.introspect # Force refresh
+        @o_adapter.subnodes.map {|dev| # Format: dev_aa_bb_cc_dd_ee_ff
+            dev[4..-1].tr('_', ':') }
+    end
+end
+end