little_bits 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35c3e6f043c2066ce7ec079bc4040f06f46b8230
+  data.tar.gz: 7426bd46d69939d5241af2f9ae7241d2d9b55dbe
+SHA512:
+  metadata.gz: ae3814ac379ad0cb2a23bf0605f3e4c853ce7f23a56d325fff3f5bf301ab3e75ff8454850b9afe474a9bd8f103dfbb31a1987b75ec5ddd60c65740e93030e924
+  data.tar.gz: 45f68dffa692f819f48b7b92251e99ca7914b23e44469619228f14a028b25040b8a91c2a171418014692f790c30b3e21a9e208e99ce4b33d85fe6278d5396d29

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in little_bits.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Kelly
+
+MIT License
+
+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,101 @@
+[![Build Status](https://travis-ci.org/spilth/little_bits.svg?branch=master)](https://travis-ci.org/spilth/little_bits)
+
+# LittleBits Ruby Gem
+
+A Ruby Gem for communicating with [littleBits](http://littlebits.cc) modules.
+
+Currently supported are:
+
+- [cloudBit](http://littlebits.cc/bits/cloudbit)
+- [Arduino Module](http://littlebits.cc/bits/arduino)
+
+## Requirements
+
+- [Ruby](https://www.ruby-lang.org/en/)
+- [RubyGems](https://rubygems.org/pages/download)
+- [Bundler](http://bundler.io)
+- [Arduino IDE](http://arduino.cc/en/Main/Software)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'little_bits'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install little_bits
+
+## Usage
+
+### cloudBit
+
+You'll need the **Access Token** and **Device ID** from the Settings page of the [littleBits CloudBit Control Panel](http://control.littlebitscloud.cc)
+
+You can then start up `irb` or create a script with the following code:
+
+    require 'little_bits'
+    
+    cloud_bit = LittleBits::CloudBit.new('your-access-token', 'your-device-id')
+    
+    # Set output to 100% for 3 seconds (3000 milliseconds)
+    cloud_bit.output(100, 3000)
+    
+    # Set output to 50% indefinitely (-1 for duration)
+    cloud_Bit.output(50, -1)
+
+#### Method Arguments
+
+The first argument is the percentage which should be between `0` and `100`.
+
+The second argument is the duration which should be between `0` and `32000`. You can send `-1` if you want the duration to be indefinite.
+
+### Arduino Module
+
+First, follow the [littleBits Arduino Module Getting Started Guide](http://discuss.littlebits.cc/t/getting-started/109) to set up your Arduino module.
+
+You'll need to know the serial port that the Arduino is plugged into.
+
+You'll also need to load the **StandardFirmata** sketch onto your Arduino Module:
+
+- Start the Arduino IDE
+- Plug in a USB cable from your computer to the Arduino Module
+- Select the serial port your Arduino is on from **Tools** > **Serial Port**
+- Switch to the **Arduino Leonardo** board by clicking on the **Tools** menu, then **Board** > **Arduino Leonardo**
+- Select the **File** menu, then **Example** > **Firmata** > **Standard Firmata**
+- Select the **File** menu, then **Upload**
+
+You can then start up `irb` or create a Ruby script with the following code:
+
+    require 'little_bits'
+    
+    arduino_module = LittleBits::ArduinoModule.new('/your/serial_port')
+    
+    # Turn on d1
+    arduino_module.d1(true)
+    
+    # Set d5 to max output
+    arduino_module.d5(255)
+    
+    # Set d9 to min output
+    arduino_module.d9(0)
+
+#### Method Arguments
+    
+The `d1` method can be sent `true` or `false`.
+
+The `d5` and `d9` methods can be sent `true`, `false`, or a number between `0` and `255`.
+
+## Contributing
+
+1. Fork it ( https://github.com/spilth/little_bits/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec, :build]

data/lib/little_bits.rb

@@ -0,0 +1,8 @@
+require 'little_bits/version'
+require 'little_bits/cloud_bit'
+require 'little_bits/arduino_module'
+require 'little_bits/number_module'
+
+module LittleBits
+
+end

data/lib/little_bits/arduino_module.rb

@@ -0,0 +1,36 @@
+require 'arduino_firmata'
+
+module LittleBits
+  class ArduinoModule
+    def initialize(serial_port)
+      @arduino = ArduinoFirmata.connect(serial_port)
+
+      Kernel.at_exit { @arduino.close }
+    end
+
+    def d1(value)
+      arduino.digital_write(1, value)
+    end
+
+    def d5(value)
+      if value.is_a?(Numeric)
+        arduino.analog_write(5, value)
+      else
+        arduino.digital_write(5, value)
+      end
+    end
+
+    def d9(value)
+      if value.is_a?(Numeric)
+        arduino.analog_write(9, value)
+      else
+        arduino.digital_write(9, value)
+      end
+    end
+
+    private
+
+    attr_reader :arduino
+
+  end
+end

data/lib/little_bits/cloud_bit.rb

@@ -0,0 +1,27 @@
+require 'rest_client'
+
+module LittleBits
+  class CloudBit
+    API_URL = 'https://api-http.littlebitscloud.cc'
+    API_VERSION = 'v2'
+
+    def initialize(access_token, device_id)
+      @access_token = access_token
+      @device_id = device_id
+    end
+
+    def output(percent = 100, duration_ms = 3000)
+      RestClient.post "#{API_URL}/devices/#{device_id}/output",
+                      {
+                          :percent => percent,
+                          :duration_ms => duration_ms
+                      },
+                      Accept: "application/vnd.littlebits.#{API_VERSION}+json",
+                      Authorization: "Bearer #{access_token}"
+    end
+
+    private
+
+    attr_reader :access_token, :device_id
+  end
+end

data/lib/little_bits/number_module.rb

@@ -0,0 +1,15 @@
+module LittleBits
+  class NumberModule
+
+    # From https://lb-community.s3.amazonaws.com/uploads/supporting_file/asset/448/Counter.ino
+    NUMBER_VALUES = [0,3,6,8,10,13,15,18,20,23,26,28,30,33,35,38,40,43,45,48,50,53,55,58,61,
+        64,66,69,71,74,76,78,81,84,86,89,91,94,96,99,102,104,106,108,111,114,116,
+        119,121,124,127,129,132,134,136,139,141,143,146,149,151,154,156,159,160,163,
+        166,169,171,173,176,179,181,184,186,188,190,193,196,199,202,205,208,210,212,
+        214,217,218,221,224,227,230,232,235,237,239,242,245,247,252,255]
+
+    def self.number_to_pwm(number)
+      NUMBER_VALUES[number]
+    end
+  end
+end

data/lib/little_bits/version.rb

@@ -0,0 +1,3 @@
+module LittleBits
+  VERSION = "0.0.1"
+end

data/little_bits.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'little_bits/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'little_bits'
+  spec.version       = LittleBits::VERSION
+  spec.authors       = ['Brian Kelly']
+  spec.email         = ['polymonic@gmail.com']
+  spec.summary       = %q{Gem for communicating with littleBits modules}
+  spec.description   = %q{Classes to easily talk to the cloudBit and Arduino module}
+  spec.homepage      = 'https://github.com/spilth/little_bits'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest_client', '~> 1.8'
+  spec.add_runtime_dependency 'arduino_firmata', '~>0.3.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+end

data/spec/lib/arduino_module_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+module LittleBits
+  describe ArduinoModule do
+    let(:arduino_firmata) { double(:arduino_firmata) }
+
+    before(:each) do
+      allow(ArduinoFirmata).to receive(:connect) { arduino_firmata }
+      allow(Kernel).to receive(:at_exit) do |&block|
+        block.call
+      end
+      allow(arduino_firmata).to receive(:close)
+    end
+
+    describe 'deconstruction' do
+      it 'closes arduino connection on exit' do
+        LittleBits::ArduinoModule.new('serial_port')
+
+        expect(arduino_firmata).to have_received(:close)
+      end
+    end
+
+    describe 'd1' do
+      context 'passing it true' do
+        it 'turns the d1 output on' do
+          allow(arduino_firmata).to receive(:digital_write).with(1, true)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d1(true)
+        end
+      end
+
+      context 'passing it false' do
+        it 'turns the d1 output off' do
+          allow(arduino_firmata).to receive(:digital_write).with(1, false)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d1(false)
+        end
+      end
+    end
+
+    describe 'd5' do
+      context 'passing it true' do
+        it 'turns the d5 output on' do
+          allow(arduino_firmata).to receive(:digital_write).with(5, true)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d5(true)
+        end
+      end
+
+      context 'passing it false' do
+        it 'turns the d5 output off' do
+          allow(arduino_firmata).to receive(:digital_write).with(5, false)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d5(false)
+        end
+      end
+
+      context 'passing it a number' do
+        it 'sends the number to the arduino' do
+          allow(arduino_firmata).to receive(:analog_write).with(5, 128)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d5(128)
+        end
+      end
+    end
+
+    describe 'd9' do
+      context 'passing it true' do
+        it 'turns the d9 output on' do
+          allow(arduino_firmata).to receive(:digital_write).with(9, true)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d9(true)
+        end
+      end
+
+      context 'passing it false' do
+        it 'turns the d9 output off' do
+          allow(arduino_firmata).to receive(:digital_write).with(9, false)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d9(false)
+        end
+      end
+
+      context 'passing it a number' do
+        it 'sends the number to the arduino' do
+          allow(arduino_firmata).to receive(:analog_write).with(9, 128)
+
+          arduino_module = LittleBits::ArduinoModule.new('serial_port')
+
+          arduino_module.d9(128)
+        end
+      end
+    end
+  end
+end

data/spec/lib/cloud_bit_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module LittleBits
+  describe CloudBit do
+    describe '#output' do
+      it 'POSTs an output request to the littleBits Cloud API' do
+        stub_request(
+            :post,
+            'https://api-http.littlebitscloud.cc/devices/DEVICE_ID/output').
+            with(
+            :body => {
+                'duration_ms' => '3000',
+                'percent' => '100'
+            },
+            :headers => {
+                'Accept'=>'application/vnd.littlebits.v2+json',
+                'Accept-Encoding'=>'gzip, deflate',
+                'Authorization'=>'Bearer ACCESS_TOKEN',
+                'Content-Length'=>'28',
+                'Content-Type'=>'application/x-www-form-urlencoded',
+                'User-Agent'=>'Ruby'
+            }).
+            to_return(:status => 200, :body => 'OK', :headers => {})
+
+        client = LittleBits::CloudBit.new('ACCESS_TOKEN', 'DEVICE_ID')
+        result = client.output(100, 3000)
+
+        expect(result).to be_truthy
+      end
+    end
+  end
+end

data/spec/lib/number_module_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module LittleBits
+  describe NumberModule do
+    describe '.number_to_pwm' do
+      it 'converts numbers to clock values' do
+        expect(NumberModule.number_to_pwm(0)).to eq 0
+        expect(NumberModule.number_to_pwm(1)).to eq 3
+
+        expect(NumberModule.number_to_pwm(49)).to eq 124
+        expect(NumberModule.number_to_pwm(50)).to eq 127
+        expect(NumberModule.number_to_pwm(51)).to eq 129
+
+        expect(NumberModule.number_to_pwm(98)).to eq 247
+        expect(NumberModule.number_to_pwm(99)).to eq 252
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+require './lib/little_bits'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    #expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: little_bits
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: arduino_firmata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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: Classes to easily talk to the cloudBit and Arduino module
+email:
+- polymonic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/little_bits.rb
+- lib/little_bits/arduino_module.rb
+- lib/little_bits/cloud_bit.rb
+- lib/little_bits/number_module.rb
+- lib/little_bits/version.rb
+- little_bits.gemspec
+- spec/lib/arduino_module_spec.rb
+- spec/lib/cloud_bit_spec.rb
+- spec/lib/number_module_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spilth/little_bits
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for communicating with littleBits modules
+test_files:
+- spec/lib/arduino_module_spec.rb
+- spec/lib/cloud_bit_spec.rb
+- spec/lib/number_module_spec.rb
+- spec/spec_helper.rb