hue_ble 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35bbe17153882b5eef86728879b72cc48a954b2d540d42960555305804412a95
+  data.tar.gz: b964a25de0c0f4ced9af51495cc12a13a8b1131a6b7b8eee8b63e5eccc28df1d
+SHA512:
+  metadata.gz: 584f0ca1ddf9280a8039299c4a92636e8213bc229c660555558a3959f21a1b9d75407f76553e8b2ee72eefeb7e7fffd731d049a4cbacbc11453faeb08c385006
+  data.tar.gz: 99dd3ecb36ad5ad010497a957b4c814340b9ce48cdfe7d50fbe91f4c7fdf614c3825a77f4892b3473fdca4f1677c253b8c0d9ddc43ab678016a0c877c220371b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hue_ble.gemspec
+gemspec
+
+# ruby_ble-1.0.0 is not compatible with recent bluez DBus interface, so use patched version...
+gem 'ble', git: 'https://gitlab.com/NeoCat/ruby-ble.git'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 NeoCat
+
+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.md

@@ -0,0 +1,91 @@
+# HueBLE
+
+This gem enables to control Hue light bulbs which support Bluetooth LE using Ruby.
+
+## Warning
+
+This gem is very experimental and unstable.
+
+- You need to factory reset Hue bulbs using smartphone apps before pairing.
+- Once the pairing is lost by some reasons, you need to reset the bulbs again before reconnecting to them.
+- The Hue's Bluetooth LE control interface may be subject to change in the future.
+- bluez seems not to support connecting to more than 5 BLE devices at the same time. You need to disconnect and reconnect to others if you want to control more than 5 blubs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hue_ble'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hue_ble
+
+## Usage
+
+At first, reset the Hue bulbs using Hue Bluetooth app on your smartphone. 
+Then, you need to scan bulbs and pair with them:
+
+```ruby
+require 'hue_ble'
+HueBLE.scan_cli
+```
+
+When unpaired bulbs are found, this confirms if you want to pair with them.
+The BLE address is randomized on factory reset.
+Your PC's BLE adapger and bulbs need to be very close (<90cm) on pairing, and the bulbs are scanned right after powered on.
+
+This scan will also add the already paired bulbs to the HueBLE class. (So you need to scan it every time your script is launched.)
+
+Once bulbs are added, you can control them as followings:
+
+```ruby
+def all_on
+  HueBLE.hues.each_value { |hue| hue.on }
+end
+
+def all_off
+  HueBLE.hues.each_value { |hue| hue.off }
+end
+
+def all_set(brightness: nil, color_temperature: nil, color: nil)
+  HueBLE.hues.each_value do |hue|
+    hue.brightness = brightness if brightness
+    hue.color_temperature = color_temperature if color_temperature
+    hue.color = color if color
+  rescue BLE::Characteristic::NotFound
+  end
+end
+
+def party!
+  30.times do
+    HueBLE.hues.each_value do |hue|
+      hue.brightness = rand(253) + 1
+      hue.color_temperature = rand(510) + 1
+      10.times do
+        hue.color = [rand(65533) + 1, rand(65533) + 1]
+        break
+      rescue BLE::Characteristic::NotFound
+        break
+      rescue
+        next
+      end
+    end
+    sleep 1
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/NeoaCat/ruby_hue_ble.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/hue_ble.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "hue_ble"
+  spec.version       = "0.1.0"
+  spec.authors       = ["NeoCat"]
+  spec.email         = ["neocat@neocat.jp"]
+
+  spec.summary       = %q{Control Hue light bulbs with Bluetooth LE support.}
+  spec.description   = %q{Control color temperature, brightness, and color of Hue light bulbs which supports Bluetooth LE.}
+  spec.homepage      = "https://github.com/NeoCat/ruby_hue_ble"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ble'
+end

data/lib/hue_ble.rb

@@ -0,0 +1,157 @@
+require 'ble'
+
+class HueBLE
+  VERSION = "0.1.0"
+
+  extend Forwardable
+
+  HUE_BLE_SERVICE_UUID = '932c32bd-0000-47a2-835a-a8d455b859dd'
+
+  BLE::Service.add HUE_BLE_SERVICE_UUID,
+                   name: 'Hue Lamp Control',
+                   nick: :hue_lamp_control
+
+  BLE::Characteristic.add '932c32bd-0002-47a2-835a-a8d455b859dd',
+                          name: 'ON',
+                          nick: :on,
+                          vrfy: ->(x) { x == true || x == false },
+                          in: ->(s) { s[0] == "\x01" },
+                          out: ->(v) { v ? "\x01" : "\x00" }
+
+  BLE::Characteristic.add '932c32bd-0003-47a2-835a-a8d455b859dd',
+                          name: 'Brightness',
+                          nick: :brightness,
+                          vrfy: ->(x) { x >= 1 && x <= 254 },
+                          in: ->(s) { s[0].ord },
+                          out: ->(v) { v.chr }
+
+  BLE::Characteristic.add '932c32bd-0004-47a2-835a-a8d455b859dd',
+                          name: 'Color Temperature',
+                          nick: :color_temperature,
+                          vrfy: ->(x) { x >= 1 && x <= 511 },
+                          in: ->(s) { s.unpack('v')[0] },
+                          out: ->(v) { [v].pack('v') }
+
+  BLE::Characteristic.add '932c32bd-0005-47a2-835a-a8d455b859dd',
+                          name: 'Color a,b',
+                          nick: :color,
+                          vrfy: ->(x) { x.is_a?(Array) && x.size == 2 && x.all?{ |v| v >= 1 && v <= 65534 } },
+                          in: ->(s) { s.unpack('v*') },
+                          out: ->(v) { v.pack('v*') }
+
+  def self.hues
+    @hues ||= {}
+  end
+
+  def self.scan(adapter_name: BLE::Adapter.list.first, wait: 5)
+    adapter = BLE::Adapter.new(adapter_name)
+    adapter.start_discovery
+    sleep(wait)
+    adapter.stop_discovery
+
+    unpaired_devices = []
+    adapter.devices.each do |address|
+      device = adapter[address]
+      name = device.name rescue nil
+      if name == 'Hue Lamp' && !device.is_paired?
+        unpaired_devices << device
+      elsif device.services.include?(HUE_BLE_SERVICE_UUID)
+        hues[device.address] = new(device)
+      end
+    end
+
+    { hues: hues, unpaired_devices: unpaired_devices }
+  end
+
+  def self.add(address, adapter_name: BLE::Adapter.list.first)
+    adapter = BLE::Adapter.new(adapter_name)
+    device = adapter[address]
+    device.trusted = true
+    unless device.is_paired?
+      begin
+        device.pair 
+        sleep(3)
+        device = adapter[address] # reload
+      rescue BLE::NotAuthorized => e
+        puts "Failed to pair: #{e}. Please try scanning after power off/on the bulb, getting closer, or resetting it using the smart phone app."
+      end
+    end
+    fail "device does not have Hue Lamp Control service" unless device.services.include?(HUE_BLE_SERVICE_UUID)
+    hues[address] = new(device)
+  end
+
+  def self.scan_cli(reset = false)
+    puts "Scanning devices ..."
+    scan_results = scan(wait: 1)
+    puts "Found #{scan_results[:hues].count} Hue devices:"
+    scan_results[:hues].each { |address, device| puts "  #{address}  #{device.name}" }
+
+    if @reset
+      scan_results[:hues].each { |address, device| device.remove }
+      scan_results[:unpaired_devices].each { |device| device.remove }
+      return
+    end
+
+    scan_results[:unpaired_devices].each do |device|
+      print "Found a new #{device.name}  #{device.address} : Do you want to pair? (Y/n)> " 
+      STDOUT.flush
+      add(device.address) if ["Y", "y", "\n"].include? gets[0]
+    end
+  end
+
+
+  def_delegators :@device, :address, :name, :alias, :alias=, :is_connected?, :connect, :disconnect, :pair, :is_paired?
+
+  def initialize(device)
+    @device = device
+  end
+
+  def inspect
+    "#<HueBLE:#{@device.address}>"
+  end
+
+  def on?
+    connect
+    @device[:hue_lamp_control, :on]
+  end
+
+  def on
+    connect
+    @device[:hue_lamp_control, :on] = true
+  end
+
+  def off
+    connect
+    @device[:hue_lamp_control, :on] = false
+  end
+
+  def brightness
+    connect
+    @device[:hue_lamp_control, :brightness]
+  end
+
+  def brightness=(value)
+    connect
+    @device[:hue_lamp_control, :brightness] = value
+  end
+
+  def color_temperature
+    connect
+    @device[:hue_lamp_control, :color_temperature]
+  end
+
+  def color_temperature=(value)
+    connect
+    @device[:hue_lamp_control, :color_temperature] = value
+  end
+
+  def color
+    connect
+    @device[:hue_lamp_control, :color]
+  end
+
+  def color=(value)
+    connect
+    @device[:hue_lamp_control, :color] = value
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: hue_ble
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- NeoCat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ble
+  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'
+description: Control color temperature, brightness, and color of Hue light bulbs which
+  supports Bluetooth LE.
+email:
+- neocat@neocat.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- hue_ble.gemspec
+- lib/hue_ble.rb
+homepage: https://github.com/NeoCat/ruby_hue_ble
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/NeoCat/ruby_hue_ble
+  source_code_uri: https://github.com/NeoCat/ruby_hue_ble
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Control Hue light bulbs with Bluetooth LE support.
+test_files: []