ble 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7cc1b7511a25f6f47653f9b5430a1a15c4361574
-  data.tar.gz: 776bcbf870dd96a1fb0575a8f9aefe7bcdb1199e
+SHA256:
+  metadata.gz: 17aaccf4610ffbc88f45cea4e7551b54bf44618c725dac2d00d6bafe64510fda
+  data.tar.gz: fca52cb329e71cf3a3c275748fa2efdb6ec9884382f518a203a3bb7d299b720d
 SHA512:
-  metadata.gz: 35ef023571bfd637245b82c814eaed2d08f265a14d207f29b17ad3633a9e62e30b072f4041e9b1ef4a3b6025e5607a0ed958c9cc187c98ab73eecc7534ae6cef
-  data.tar.gz: 118372609995212452776777eb03682579e5d87d57b19758cfa3e476415a10dccc2921d53e0f3ee64463876ed56edf3823f6304bece3da712f6e36d0d883afb3
+  metadata.gz: f50cfc18e960210812508fc2db9520c091509a1cb9cc6c83e39de9e9978ba05a7fa788ac8e9cffebf988df40f6a96361568013d472fe1c8fbe8fae308a3338a0
+  data.tar.gz: 9bc27795aa5926ca1693a8c50d8dcc5a5e166680fccb975e65530ed4b21df0acd29c9bacad06f41ce447e578fb622dc3dc95f045bce5b758527faa595e4fe751

data/ble.gemspec

@@ -7,19 +7,18 @@ Gem::Specification.new do |s|
   s.version       = BLE::VERSION
   s.authors       = [ "Stephane D'Alu" ]
   s.email         = [ "stephane.dalu@gmail.com" ]
-  s.homepage      = "http://github.com/sdalu/ruby-ble"
+  s.homepage      = "http://gitlab.com/sdalu/ruby-ble"
   s.summary       = "Bluetooth Low Energy (BLE) API"
   s.description   = "Allow access to Bluetooth Low Energy device from ruby"
 
   s.add_dependency "ruby-dbus"
+  s.add_dependency "concurrent-ruby"
   
   s.add_development_dependency "yard"
   s.add_development_dependency "rake"
   s.add_development_dependency "redcarpet"
   s.add_development_dependency "github-markup"
 
-  s.has_rdoc      = 'yard'
-
   s.license       = 'MIT'
   
 

data/lib/ble.rb

@@ -108,5 +108,6 @@ require_relative 'ble/db_sig_service'
 require_relative 'ble/db_sig_characteristic'
 require_relative 'ble/db_eddystone'
 require_relative 'ble/db_nordic'
+require_relative 'ble/db_ollie'
 
 

data/lib/ble/characteristic.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'concurrent'
 module BLE
   # Build information about {https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicsHome.aspx Bluetooth Characteristics}
   #
@@ -39,7 +40,16 @@ module BLE
 
     def write(val, raw: false)
       val= _serialize_value(val, raw: raw)
-      @dbus_obj[I_GATT_CHARACTERISTIC].WriteValue(val)
+      @dbus_obj[I_GATT_CHARACTERISTIC].WriteValue(val, [])
+    end
+
+    def async_write(val, raw: false)
+      val= _serialize_value(val, raw: raw)
+      Concurrent::Promise.execute do
+        @dbus_obj[I_GATT_CHARACTERISTIC].WriteValue(val, []) do |result|
+          result
+        end
+      end
     end
 
     def read(raw: false)
@@ -47,6 +57,15 @@ module BLE
       val= _deserialize_value(val, raw: raw)
     end
 
+    def async_read(raw: false)
+      return Concurrent::Promise.execute do
+        @dbus_obj[I_GATT_CHARACTERISTIC].ReadValue() do |result|
+          val= result.first
+          val= _deserialize_value(val, raw: raw)
+        end
+      end
+    end
+
     # Register to this characteristic for notifications when
     # its value changes.
     def notify!

data/lib/ble/db_ollie.rb

@@ -0,0 +1,31 @@
+module BLE
+  module Service
+    add '22bb746f-2bb0-7554-2d6f-726568705327',
+        name: 'Sphero Ollie (BB-8) BLE Service',
+        nick: :ollie_ble_service
+    add '22bb746f-2ba0-7554-2d6f-726568705327',
+        name: 'Sphero Ollie (BB-8) Robot Control Service',
+        nick: :ollie_robot_control_service
+  end
+  class Characteristic
+    add '22bb746f-2bbf-7554-2d6f-726568705327',
+        name: 'Ollie Wake',
+        nick: :ollie_wake
+
+    add '22bb746f-2bb2-7554-2d6f-726568705327',
+        name: 'Ollie TX Power',
+        nick: :ollie_tx_power
+
+    add '22bb746f-2bbd-7554-2d6f-726568705327',
+        name: 'Ollie AntiDOS',
+        nick: :ollie_antidos
+
+    add '22bb746f-2ba1-7554-2d6f-726568705327',
+        name: 'Ollie Commands',
+        nick: :ollie_commands
+
+    add '22bb746f-2ba6-7554-2d6f-726568705327',
+        name: 'Ollie Response',
+        nick: :ollie_response
+  end
+end

data/lib/ble/device.rb

@@ -12,6 +12,8 @@ module BLE
     # Notify that you need to have the device in a connected state
     class NotConnected           < Error         ; end
 
+    attr_accessor :requires_connection
+
     # @param adapter      [String]  adapter unix device name
     # @param dev          [String]  device MAC address
     # @param auto_refresh [Boolean] gather information about device
@@ -49,7 +51,8 @@ module BLE
     # It will remove also the pairing information.
     # @return [Boolean]
     def remove
-      @o_adapter[I_ADAPTER].RemoveDevice(@p_dev)
+      block_given? ? @o_adapter[I_ADAPTER].RemoveDevice(@p_dev, &Proc.new) :
+                     @o_adapter[I_ADAPTER].RemoveDevice(@p_dev)
       true
     rescue DBus::Error => e
       case e.name
@@ -75,18 +78,19 @@ module BLE
     #
     # @return [Boolean]
     def pair
-      @o_dev[I_DEVICE].Pair
+      block_given? ? @o_dev[I_DEVICE].Pair(&Proc.new) :
+                     @o_dev[I_DEVICE].Pair()
       true
     rescue DBus::Error => e
       case e.name
       when E_INVALID_ARGUMENTS      then false
       when E_FAILED                 then false
       when E_ALREADY_EXISTS         then true
-      when E_AUTH_CANCELED          then raise NotAutorized
-      when E_AUTH_FAILED            then raise NotAutorized
-      when E_AUTH_REJECTED          then raise NotAutorized
-      when E_AUTH_TIMEOUT           then raise NotAutorized
-      when E_AUTH_ATTEMPT_FAILED    then raise NotAutorized
+      when E_AUTH_CANCELED          then raise NotAuthorized
+      when E_AUTH_FAILED            then raise NotAuthorized
+      when E_AUTH_REJECTED          then raise NotAuthorized
+      when E_AUTH_TIMEOUT           then raise NotAuthorized
+      when E_AUTH_ATTEMPT_FAILED    then raise NotAuthorized
       else raise ScriptError
       end
     end
@@ -95,7 +99,8 @@ module BLE
     # operation initiated by the Pair method.
     # @return [Boolean]
     def cancel_pairing
-      @o_dev[I_DEVICE].CancelPairing
+      block_given? ? @o_dev[I_DEVICE].CancelPairing(&Proc.new) :
+                     @o_dev[I_DEVICE].CancelPairing()
       true
     rescue DBus::Error => e
       case e.name
@@ -116,9 +121,11 @@ module BLE
     def connect(profile=:all)
       case profile
       when UUID::REGEX
-        @o_dev[I_DEVICE].ConnectProfile(profile)
+        block_given? ? @o_dev[I_DEVICE].ConnectProfile(profile, &Proc.new) :
+                       @o_dev[I_DEVICE].ConnectProfile(profile)
       when :all
-        @o_dev[I_DEVICE].Connect()
+        block_given? ? @o_dev[I_DEVICE].Connect(&Proc.new) :
+                       @o_dev[I_DEVICE].Connect()
       else raise ArgumentError, "profile uuid or :all expected"
       end
       true
@@ -149,9 +156,11 @@ module BLE
     def disconnect(profile=:all)
       case profile
       when UUID::REGEX
-        @o_dev[I_DEVICE].DisconnectProfile(profile)
+        block_given? ? @o_dev[I_DEVICE].DisconnectProfile(profile, &Proc.new) :
+                       @o_dev[I_DEVICE].DisconnectProfile(profile)
       when :all
-        @o_dev[I_DEVICE].Disconnect()
+        block_given? ? @o_dev[I_DEVICE].Disconnect(&Proc.new) :
+                       @o_dev[I_DEVICE].Disconnect()
       else raise ArgumentError, "profile uuid or :all expected"
       end
       true
@@ -185,7 +194,7 @@ module BLE
 
     # Indicates if the remote device is currently connected.
     def is_connected?
-      @o_dev[I_DEVICE]['Connected']
+      !@requires_connection || @o_dev[I_DEVICE]['Connected']
     rescue DBus::Error => e
       case e.name
       when E_UNKNOWN_OBJECT
@@ -343,12 +352,14 @@ module BLE
     # @return [self]
     def refresh!
       _require_connection!
-      max_wait ||= 1.5  # Use ||= due to the retry
-      @services = Hash[@o_dev[I_DEVICE]['GattServices'].map {|p_srv|
+      max_wait ||= 1.5 # Use ||= due to the retry
+      @services = Hash[@o_dev.subnodes.map {|p_srv|
+          p_srv = [@o_dev.path, p_srv].join '/'
           o_srv = BLUEZ.object(p_srv)
           o_srv.introspect
-          srv   = o_srv[I_PROPERTIES].GetAll(I_GATT_SERVICE).first
-          char  = Hash[srv['Characteristics'].map {|p_char|
+          srv   = o_srv.GetAll(I_GATT_SERVICE).first
+          char  = Hash[o_srv.subnodes.map {|char|
+              p_char = [o_srv.path, char].join '/'
               o_char = BLUEZ.object(p_char)
               o_char.introspect
               uuid  = o_char[I_GATT_CHARACTERISTIC]['UUID' ].downcase
@@ -387,7 +398,7 @@ module BLE
     # @raise [Service::NotFound, Characteristic::NotFound] if service/characteristic doesn't exist on this device
     # @raise [AccessUnavailable] if not available for reading
     # @return [Object]
-    def [](service, characteristic, raw: false)
+    def [](service, characteristic, raw: false, async: false)
       _require_connection!
       uuid  = _uuid_characteristic(characteristic)
       chars = _characteristics(service)
@@ -396,7 +407,7 @@ module BLE
       raise Characteristic::NotFound, characteristic if char.nil?
 
       if char.flag?('read')
-        char.read(raw: raw)
+         async ? char.async_read(raw: raw) : char.read(raw: raw)
       elsif char.flag?('encrypt-read') ||
           char.flag?('encrypt-authenticated-read')
         raise NotYetImplemented
@@ -404,6 +415,10 @@ module BLE
         raise AccessUnavailable
       end
     end
+    alias read []
+    def async_read service, characteristic, raw: false
+      read service, characteristic, raw: raw, async: true
+    end
 
     # Set value for a service/characteristic
     #
@@ -416,24 +431,43 @@ module BLE
     # @raise [Service::NotFound, Characteristic::NotFound] if service/characteristic doesn't exist on this device
     # @raise [AccessUnavailable] if not available for writing
     # @return [void]
-    def []=(service, characteristic, val, raw: false)
+    def []=(service, characteristic, val, raw: false, async: false)
       _require_connection!
       uuid  = _uuid_characteristic(characteristic)
       chars = _characteristics(service)
-      raise ServiceNotFound,        service        if chars.nil?
+      raise Service::NotFound,        service        if chars.nil?
       char  = chars[uuid]
-      raise CharacteristicNotFound, characteristic if char.nil?
+      raise Characteristic::NotFound, characteristic if char.nil?
 
       if char.flag?('write') ||
-          char.flag?('write-without-response')
-        char.write(val, raw: raw)
+        char.flag?('write-without-response')
+        async ? char.async_write(val, raw: raw) : char.write(val, raw: raw)
       elsif char.flag?('encrypt-write') ||
           char.flag?('encrypt-authenticated-write')
         raise NotYetImplemented
       else
         raise AccessUnavailable
       end
-      nil
+    end
+    alias write []=
+    def async_write(service, characteristic, val,  raw: false)
+      write service, characteristic, val, raw: raw, async: true
+    end
+
+    def subscribe(service, characteristic, raw: false, &block)
+      _require_connection!
+      uuid  = _uuid_characteristic(characteristic)
+      chars = _characteristics(service)
+      raise Service::NotFound,        service        if chars.nil?
+      char  = chars[uuid]
+      raise Characteristic::NotFound, characteristic if char.nil?
+
+      if char.flag? 'notify'
+        char.notify!
+        char.on_change(raw: raw, &block)
+      else
+         raise OperationNotSupportedError.new("No notifications available for characteristic #{characteristic}")
+      end
     end
 
     #---------------------------------
@@ -480,7 +514,7 @@ module BLE
                  characteristic.downcase
              else
                  if char = Characteristic[characteristic]
-                     char.uuid
+                     char[:uuid]
                  end
              end
       if uuid.nil?

data/lib/ble/version.rb

@@ -4,6 +4,9 @@ module BLE
   # Anything may change at any time.
   # The public API should not be considered stable.
 
+  # 1.0.0 MAJOR
+  # - [FEATURE] Support BLUEZ 5.36 (breaking change in DBus API)
+
   # 0.1.0 MINOR
   # - [FEATURE] BLE notifications functionality.
   # - [REFACTOR] Breaks Characteristic API
@@ -11,5 +14,5 @@ module BLE
   # 0.0.3 PATCH
   # - [FIX] NotSupported exeption was not declared.
   #
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ble
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephane D'Alu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +112,7 @@ files:
 - lib/ble/characteristic.rb
 - lib/ble/db_eddystone.rb
 - lib/ble/db_nordic.rb
+- lib/ble/db_ollie.rb
 - lib/ble/db_sig_characteristic.rb
 - lib/ble/db_sig_service.rb
 - lib/ble/device.rb
@@ -105,7 +120,7 @@ files:
 - lib/ble/service.rb
 - lib/ble/uuid.rb
 - lib/ble/version.rb
-homepage: http://github.com/sdalu/ruby-ble
+homepage: http://gitlab.com/sdalu/ruby-ble
 licenses:
 - MIT
 metadata: {}
@@ -125,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Bluetooth Low Energy (BLE) API