ambient-orb 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzNhZjNlNGY3MDc5ZTA0YTNjMTZkM2Y4Yjc1M2U3MGRhYWMzMzQyYw==
+  data.tar.gz: !binary |-
+    ODhlYTcyNTM2NGYwNjBlOTgzMmNiNDQyNjc4OTEyMTNjYjc1MWIyYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGNiN2IwNTkwNGFkNWE2MmM1MDQ3Njk0MTFjOTY1MjZlNjg0Y2EzNjg4MTJl
+    NDNlM2MxNjVmYzhjYzkzNGFkZGM1NzgxZDUzMzQ0YjBlMDY2Y2M2NmE5Zjcw
+    ZjcwN2UzMzJiOGVhZWNkM2FhY2M0Nzg2MjQ2ZTViOGUzZmFhYzE=
+  data.tar.gz: !binary |-
+    NmZjNDRlZmZmNGExMjBjNTZhODQ0MGUyMGMzNjIwNTcxNzU1MWUzY2JiNmM3
+    NWI2MDc0OGVhYzlkZDU3NGMxMDIyMGYzODVkNDk2OWU5YTA2MzIyZWM5ZDVm
+    NmJiMjI5YWNmY2EzNzI3N2YyYWQ3M2VjMWNiOGUzYTczYTdkNDA=

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+.rvmrc
+.DS_Store
+/coverage

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'rspec', '~> 3.4.0'
+  gem 'rspec-instafail', '~> 0.4'
+  gem 'simplecov', :require => false
+end

data/README.md

@@ -0,0 +1,31 @@
+AmbientOrb
+===========
+
+Ruby code to interface with ambientdevices Ambient Orb. Only supports the
+serial interface as ambientdevices' service no longer exists.
+
+```ruby
+require 'ambient-orb'
+
+# device is automatically detected on OS X
+orb = AmbientOrb.new
+
+# a device can be passed manually
+#orb = AmbientOrb.new(:device => '/dev/ttyS0')
+
+# a logger can also be passed
+#orb = AmbientOrb.new(:logger => Logger.new(STDOUT))
+#orb.logger.level = Logger::DEBUG
+
+[
+  [ AmbientOrb::COLOR_GREEN,  AmbientOrb::ANIMATION_VERY_SLOW   ],
+  [ AmbientOrb::COLOR_BLUE,   AmbientOrb::ANIMATION_SLOW        ],
+  [ AmbientOrb::COLOR_PURPLE, AmbientOrb::ANIMATION_MEDIUM_SLOW ],
+  [ AmbientOrb::COLOR_YELLOW, AmbientOrb::ANIMATION_MEDIUM      ],
+  [ AmbientOrb::COLOR_ORANGE, AmbientOrb::ANIMATION_FAST        ],
+  [ AmbientOrb::COLOR_RED,    AmbientOrb::ANIMATION_VERY_FAST   ],
+].each do |(color, animation)|
+  orb.update(color, animation)
+  sleep(10)
+end
+```

data/ambient-orb.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'ambient-orb/version'
+
+Gem::Specification.new do |s|
+  s.name         = "ambient-orb"
+  s.version      = AmbientOrb::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Jon Tai"]
+  s.email        = ["jon.tai@gmail.com"]
+  s.homepage     = "https://github.com/jtai/ambient-orb"
+  s.summary      = "Ruby code to interface with ambientdevices Ambient Orb"
+  s.description  = "Only supports the serial interface as ambientdevices' service no longer exists"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_runtime_dependency 'serialport', '>= 1.3.1'
+end

data/lib/ambient-orb.rb

@@ -0,0 +1,101 @@
+require 'ambient-orb/version'
+require 'logger'
+require 'serialport'
+
+class AmbientOrb
+
+  # These are fixed characteristics of the orb.
+  SERIAL_PORT_BAUD_RATE = 19200
+  SERIAL_PORT_DATA_BITS = 8
+  SERIAL_PORT_STOP_BITS = 1
+  SERIAL_PORT_PARITY    = SerialPort::NONE
+
+  # Colors are specified as an integer from 0 to 36, inclusive. Common colors
+  # are assigned constants for convenience.
+  COLOR_RED    = 0
+  COLOR_ORANGE = 3
+  COLOR_YELLOW = 6
+  COLOR_GREEN  = 12
+  COLOR_BLUE   = 24
+  COLOR_PURPLE = 27
+
+  # Animation is specified as an integer from 0 to 9, inclusive.
+  ANIMATION_NONE        = 0
+  ANIMATION_VERY_SLOW   = 1
+  ANIMATION_SLOW        = 2
+  ANIMATION_MEDIUM_SLOW = 3
+  ANIMATION_MEDIUM      = 4
+  ANIMATION_MEDIUM_FAST = 5
+  ANIMATION_FAST        = 6
+  ANIMATION_VERY_FAST   = 7
+  ANIMATION_CRESCENDO   = 8
+  ANIMATION_HEARTBEAT   = 9
+
+  def initialize(options = {})
+    @opts = options
+  end
+
+  def device
+    @device ||= begin
+      dev = @opts[:device] || autodetect_device
+
+      unless dev && File.exist?(dev) && File.stat(dev).chardev?
+        raise ArgumentError, 'invalid device'
+      end
+
+      logger.info("selected device #{dev}")
+
+      dev
+    end
+  end
+
+  def logger
+    @logger ||= begin
+      @opts[:logger] || Logger.new(nil)
+    end
+  end
+
+  def update(color, animation)
+    if (color < 0 || color > 36)
+      raise ArgumentError, 'color must be between 0 and 36'
+    end
+
+    if (animation < 0 || animation > 9)
+      raise ArgumentError, 'animation must be between 0 and 9'
+    end
+
+    logger.info("updating with color=#{color}, animation=#{animation}")
+
+    color_ord     = (color + (37 * animation)) / 94 + 32
+    animation_ord = (color + (37 * animation)) % 94 + 32
+
+    send("~A#{color_ord.chr}#{animation_ord.chr}")
+  end
+
+  private
+
+  def autodetect_device
+    devices = Dir.glob('/dev/*.usbmodem*')
+
+    devices.each do |dev|
+      logger.debug("autodetect_device found #{dev}")
+    end
+
+    devices.first
+  end
+
+  def send(command)
+    SerialPort.open(device,
+                    SERIAL_PORT_BAUD_RATE,
+                    SERIAL_PORT_DATA_BITS,
+                    SERIAL_PORT_STOP_BITS,
+                    SERIAL_PORT_PARITY) do |serial_port|
+      logger.debug('send "~GT"')
+      serial_port.puts '~GT'
+
+      logger.debug("send \"#{command}\"")
+      serial_port.puts command
+    end
+  end
+
+end

data/lib/ambient-orb/version.rb

@@ -0,0 +1,3 @@
+class AmbientOrb
+  VERSION = '0.0.1'
+end

data/spec/lib/ambient-orb_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe AmbientOrb do
+
+  let (:options) { {} }
+  let (:orb) { AmbientOrb.new(options) }
+
+  describe '#device' do
+
+    context 'with valid device option' do
+      let (:options) { { :device => '/dev/zero' } }
+
+      it 'returns device' do
+        expect(orb.device).to eq('/dev/zero')
+      end
+    end
+
+    context 'with non-existent device' do
+      let (:options) { { :device => '/dev/nosuchdevice' } }
+
+      it 'raises ArgumentError' do
+        expect {
+          orb.device
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with block device' do
+      let (:options) { { :device => `df #{__FILE__} | tail -1 | cut -d ' ' -f 1` } }
+
+      it 'raises ArgumentError' do
+        expect {
+          orb.device
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with autodetected device' do
+      it 'returns first device matching pattern' do
+        expect(Dir).to receive(:glob).and_return(['/dev/urandom', '/dev/random'])
+        expect(orb.device).to eq('/dev/urandom')
+      end
+    end
+
+  end
+
+  describe '#update' do
+
+    let (:color) { AmbientOrb::COLOR_RED }
+    let (:animation) { AmbientOrb::ANIMATION_NONE }
+
+    context 'with out of range color' do
+      let (:color) { 37 }
+
+      it 'raises ArgumentError' do
+        expect {
+          orb.update(color, animation)
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with out of range animation' do
+      let (:animation) { 10 }
+
+      it 'raises ArgumentError' do
+        expect {
+          orb.update(color, animation)
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with valid arguments' do
+      it 'sends correct update' do
+        expect(orb).to receive(:send).with('~A  ')
+        orb.update(color, animation)
+      end
+    end
+
+    context 'with purple color' do
+      let (:color) { AmbientOrb::COLOR_PURPLE }
+
+      it 'sends correct update' do
+        expect(orb).to receive(:send).with('~A ;')
+        orb.update(color, animation)
+      end
+    end
+
+    context 'with fast animation' do
+      let (:animation) { AmbientOrb::ANIMATION_FAST }
+
+      it 'sends correct update' do
+        expect(orb).to receive(:send).with('~A"B')
+        orb.update(color, animation)
+      end
+    end
+
+  end
+
+  describe '#send' do
+
+    let (:options) { { :device => '/dev/zero' } }
+    let (:io) { IO.new }
+
+    it 'sends commands' do
+      io = double('serial_port')
+      expect(io).to receive(:puts).with('~GT')
+      expect(io).to receive(:puts).with('~A  ')
+      expect(SerialPort).to receive(:open).and_yield(io)
+      orb.update(AmbientOrb::COLOR_RED, AmbientOrb::ANIMATION_NONE)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+SimpleCov.use_merging false
+
+require 'ambient-orb'
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: ambient-orb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Tai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: Only supports the serial interface as ambientdevices' service no longer
+  exists
+email:
+- jon.tai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- ambient-orb.gemspec
+- lib/ambient-orb.rb
+- lib/ambient-orb/version.rb
+- spec/lib/ambient-orb_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jtai/ambient-orb
+licenses: []
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Ruby code to interface with ambientdevices Ambient Orb
+test_files:
+- spec/lib/ambient-orb_spec.rb
+- spec/spec_helper.rb