ble 0.0.3 → 0.1.0

data/lib/ble/notifications.rb

@@ -0,0 +1,44 @@
+module BLE
+  module Notifications
+
+    # Registers current device for notifications of the given _characteristic_.
+    # Synonym for 'subscribe' or 'activate'.
+    # This step is required in order to later receive notifications.
+    # @param service [String, Symbol]
+    # @param characteristic [String, Symbol]
+    #
+    def start_notify!(service, characteristic)
+      char= _find_characteristic(service, characteristic)
+      if char.flag?('notify')
+        char.notify!
+      else
+        raise OperationNotSupportedError.new("No notifications available for characteristic #{characteristic}")
+      end
+    end
+
+    #
+    # Registers the callback to be invoked when a notification from the given _characteristic_ is received.
+    #
+    # NOTE: Requires the device to be subscribed to _characteristic_ notifications.
+    # @param service [String, Symbol]
+    # @param characteristic [String, Symbol]
+    # @param raw [Boolean] When raw is true the value (set/get) is a binary string, instead of an object corresponding to the decoded characteristic (float, integer, array, ...)
+    # @param callback [Proc] This callback will have the notified value as argument.
+    #
+    def on_notification(service, characteristic, raw: false, &callback)
+      _require_connection!
+      char= _find_characteristic(service, characteristic)
+      if char.flag?('notify')
+        char.on_change(raw: raw) { |val|
+          callback.call(val)
+        }
+      elsif char.flag?('encrypt-read') ||
+          char.flag?('encrypt-authenticated-read')
+        raise NotYetImplemented
+      else
+        raise AccessUnavailable
+      end
+    end
+
+  end
+end

data/lib/ble/version.rb

@@ -1,9 +1,15 @@
 module BLE
-  # Library version
+  # = Library version =
+  # Major version zero (0.y.z) is for initial development.
+  # Anything may change at any time.
+  # The public API should not be considered stable.
+
+  # 0.1.0 MINOR
+  # - [FEATURE] BLE notifications functionality.
+  # - [REFACTOR] Breaks Characteristic API
 
-  #
   # 0.0.3 PATCH
   # - [FIX] NotSupported exeption was not declared.
   #
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ble
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Stephane D'Alu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
@@ -93,12 +93,15 @@ files:
 - lib/ble.rb
 - lib/ble/adapter.rb
 - lib/ble/agent.rb
+- lib/ble/char_desc.rb
+- lib/ble/char_registry.rb
 - lib/ble/characteristic.rb
 - lib/ble/db_eddystone.rb
 - lib/ble/db_nordic.rb
 - lib/ble/db_sig_characteristic.rb
 - lib/ble/db_sig_service.rb
 - lib/ble/device.rb
+- lib/ble/notifications.rb
 - lib/ble/service.rb
 - lib/ble/uuid.rb
 - lib/ble/version.rb