sb-ble 0.5.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/service.rb

@@ -0,0 +1,121 @@
+module BLE
+# Build information about {https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx Bluetooth Services}
+#
+# To add a new service description:
+#   BLE::Service.add '63a83b9c-0fa0-4d04-8ef9-23be4ed36231',
+#       name: 'World domination',
+#       type: 'net.cortex-minus.service.world_domination'
+# 
+# Returned service description will be a hash:
+#   {
+#      name: "Bluetooth service name",
+#      type: "org.bluetooth.service.name",
+#      uuid: "128bit-uuid-string"
+#   }
+#    
+module Service
+    # Notify of service not found
+    class NotFound < BLE::NotFound
+    end
+
+    private
+    DB_UUID     = {}
+    DB_TYPE     = {}
+    DB_NICKNAME = {}
+
+    public
+    # Get a service description from it's id.
+    # The id could be either a uuid, a type, or a nickname
+    #
+    # @param id [Symbol,String] uuid, type or nickname
+    # @return [Hash] service description
+    def self.[](id)
+        case id
+        when Symbol      then DB_NICKNAME[id]
+        when UUID::REGEX then DB_UUID[id]
+        when String      then DB_TYPE[id]
+        when Integer     then DB_UUID[BLE::UUID(id)]
+        else raise ArgumentError, "invalid type for service id"
+        end
+    end
+
+    # Get service description from nickname.
+    #
+    # @param id [Symbol] nickname
+    # @return [Hash] service description
+    def self.by_nickname(id)
+        DB_NICKNAME[id]
+    end
+
+    # Get service description from uuid.
+    #
+    # @param id [String] uuid
+    # @return [Hash] service description
+    def self.by_uuid(id)
+        DB_UUID[id]
+    end
+
+    # Get service description from type
+    #
+    # @param id [Strig] type
+    # @return [Hash] service description
+    def self.by_type(id)
+        DB_TYPE[id]
+    end
+    
+    # Add a service description.
+    # @example Add a service description with a 16-bit uuid
+    #   module Service
+    #       add 0x1800,
+    #           name: 'Generic Access',
+    #           type: 'org.bluetooth.service.generic_access'
+    #   end
+    #
+    # @example Add a service description with a 128-bit uuid
+    #   module Service
+    #       add '63a83b9c-0fa0-4d04-8ef9-23be4ed36231',
+    #           name: 'World domination',
+    #           type: 'net.cortex-minus.service.world_domination'
+    #   end
+    #
+    # @param uuid [Integer, String] 16-bit, 32-bit or 128-bit uuid
+    # @param name [String]
+    # @option opts :type [String] type
+    # @option opts :nick [Symbol] nickname
+    # @return [Hash] service description
+    def self.add(uuid, name:, **opts)
+        uuid = BLE::UUID(uuid)
+        type = opts.delete :type
+        nick = opts.delete :nick
+        if opts.first 
+            raise ArgumentError, "unknown keyword: #{opts.first[0]}" 
+        end
+        
+        desc = DB_UUID[uuid] = {
+            uuid: uuid,
+            name: name,
+        }
+
+        # Add type if specified
+        if type
+            type = type.downcase
+            desc.merge!(type: type)
+            DB_TYPE[type] = desc
+        end
+
+        # Add nickname if specified or can be derived from type
+        if nick.nil? && type && type =~ /\.(?<key>[^.]+)$/
+            nick = $1.to_sym if type.start_with? 'org.bluetooth.service'
+        end
+        if nick
+            if DB_NICKNAME.include?(nick)
+                raise ArgumentError,
+                      "nickname '#{nick}' already registered (uuid: #{uuid})"
+            end
+            DB_NICKNAME[nick] = desc
+        end
+        
+        desc
+    end
+end
+end

data/lib/ble/uuid.rb

@@ -0,0 +1,25 @@
+module BLE
+    # Cast value to a well-formatted 128bit UUID string
+    # @param [String, Integer] val uuid
+    # @return [String] well formated 128bit UUID
+    def self.UUID(val)
+        case val
+        when Integer
+            if !(0..4294967295).include?(val)  # 2**32-1
+                raise ArgumentError, "not a 16-bit or 32-bit UUID"
+            end
+            ([val].pack("L>").unpack('H*').first + GATT_BASE_UUID[8..-1])
+        when String
+            if val !~ UUID::REGEX
+                raise ArgumentError, "not a 128bit uuid string"
+            end
+            val.downcase
+        else raise ArgumentError, "invalid uuid type"
+        end
+    end
+    
+    class UUID
+        # Regular expression for matching UUID 128-bit string
+        REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+    end
+end

data/lib/ble/version.rb

@@ -0,0 +1,15 @@
+module BLE
+  # = 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.1.0'
+end

data/sb-ble.gemspec

@@ -0,0 +1,112 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: sb-ble 0.5.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "sb-ble".freeze
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Fred Mitchell & Sensorberg".freeze]
+  s.date = "2017-05-23"
+  s.description = "This supports LE Advertising".freeze
+  s.email = "frederick.mitchell@sensorberg.com".freeze
+  s.executables = ["rble".freeze]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.org"
+  ]
+  s.files = [
+    ".rspec",
+    ".semver",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.org",
+    "Rakefile",
+    "bin/rble",
+    "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",
+    "sb-ble.gemspec",
+    "spec/ruby-ble_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/flajann2/ruby-ble".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.11".freeze
+  s.summary = "Bluetooth Low Energy for Ruby -- Sensorberg Version".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-dbus>.freeze, ["~> 0"])
+      s.add_runtime_dependency(%q<semver2>.freeze, ["~> 3"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, ["~> 3"])
+      s.add_development_dependency(%q<pry-doc>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<pry-remote>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<pry-rescue>.freeze, ["~> 1"])
+      s.add_development_dependency(%q<pry-stack_explorer>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<redcarpet>.freeze, [">= 0"])
+      s.add_development_dependency(%q<github-markup>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<ruby-dbus>.freeze, ["~> 0"])
+      s.add_dependency(%q<semver2>.freeze, ["~> 3"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<pry>.freeze, ["~> 0"])
+      s.add_dependency(%q<pry-byebug>.freeze, ["~> 3"])
+      s.add_dependency(%q<pry-doc>.freeze, ["~> 0"])
+      s.add_dependency(%q<pry-remote>.freeze, ["~> 0"])
+      s.add_dependency(%q<pry-rescue>.freeze, ["~> 1"])
+      s.add_dependency(%q<pry-stack_explorer>.freeze, ["~> 0"])
+      s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
+      s.add_dependency(%q<github-markup>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby-dbus>.freeze, ["~> 0"])
+    s.add_dependency(%q<semver2>.freeze, ["~> 3"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<pry>.freeze, ["~> 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, ["~> 3"])
+    s.add_dependency(%q<pry-doc>.freeze, ["~> 0"])
+    s.add_dependency(%q<pry-remote>.freeze, ["~> 0"])
+    s.add_dependency(%q<pry-rescue>.freeze, ["~> 1"])
+    s.add_dependency(%q<pry-stack_explorer>.freeze, ["~> 0"])
+    s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
+    s.add_dependency(%q<github-markup>.freeze, [">= 0"])
+  end
+end
+

data/spec/ruby-ble_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ruby-ble" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'ruby-ble'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,296 @@
+--- !ruby/object:Gem::Specification
+name: sb-ble
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Fred Mitchell & Sensorberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  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: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This supports LE Advertising
+email: frederick.mitchell@sensorberg.com
+executables:
+- rble
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.org
+files:
+- ".rspec"
+- ".semver"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.org
+- Rakefile
+- bin/rble
+- 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
+- sb-ble.gemspec
+- spec/ruby-ble_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/flajann2/ruby-ble
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Bluetooth Low Energy for Ruby -- Sensorberg Version
+test_files: []