BlikstickSquare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ccbf4f5dc0d4354cdc086fd4d79c515a5f4b748
+  data.tar.gz: c9bac64237c8c22afb97232d84e39b50d4d54857
+SHA512:
+  metadata.gz: 4c51732a40b871094c24d2e33690be3de0b9b14d769e31727c2930f89b1248ce0580e4d69ad2c5e7e85707d0049811ceaa35d5a54134d5631dfa6e6693708724
+  data.tar.gz: ce84df74bbe1fd77a261beb600f0be0e9ea5d33e7143a9da50dc0bf4407182ca36eaf77ee2c2ffc9086454bccf2e548481c8cb5c36c35a9cdcfc1ecb1ccc93a3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/BlikstickSquare.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'BlikstickSquare/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "BlikstickSquare"
+  spec.version       = BlikstickSquare::VERSION
+  spec.authors       = ["Calò, Ignazio"]
+  spec.email         = ["ignazioc@gmail.com"]
+
+  spec.summary       = 'Command line client for the Blikstick Square'
+  spec.homepage      = "https://github.com/ignazioc/blinksticksquare"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "libusb"
+  spec.add_dependency "color"
+  spec.add_dependency "commander"
+
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Calo, Ignazio
+
+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,46 @@
+# BlikstickSquare
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/BlikstickSquare`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'BlikstickSquare'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install BlikstickSquare
+
+## Usage
+```bash
+$ blink red 			# set the whole cube to ff0000
+$ blink green			# set the whole cube to 00ff00
+$ blink blue            # set the whole cube to 0000ff
+$ blink color aa00bb    # set the whole cube to aa00bb
+$ blink off             # turn off the cube
+
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/BlikstickSquare.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "BlikstickSquare"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start
+
+#Example
+#cmd = ::BlikstickSquare::Commander.new()
+#cmd.red()

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/blink

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'BlikstickSquare'
+require 'commander/import'
+
+program :name, 'blink'
+program :version, '::BlikstickSquare::BlinkStick::version'
+program :description, 'Command line client for the Blikstick Square'
+
+command :info do |c|
+  c.summary = %q{Print info}
+  c.action do |args, options|
+    ::BlikstickSquare::Commander.new().print_info()
+  end
+end
+
+command :off do |c|
+  c.summary = %q{Turn off all the leds}
+  c.action do |args, options|
+    ::BlikstickSquare::Commander.new().off()
+  end
+end
+
+command :red do |c|
+  c.summary = %q{Set red on all the 8 leds}
+  c.action do |args, options|
+    ::BlikstickSquare::Commander.new().red()
+  end
+end
+
+command :green do |c|
+  c.summary = %q{Set blue on all the 8 leds}
+  c.action do |args, options|
+    ::BlikstickSquare::Commander.new().green()
+  end
+end
+
+command :blue do |c|
+  c.summary = %q{Set blue on all the 8 leds}
+  c.action do |args, options|
+    ::BlikstickSquare::Commander.new().blue()
+  end
+end
+
+command :color do |c|
+  c.summary = %q{Set one custom color on all the 8 leds}
+  c.syntax = 'blink color 00ff00'
+  c.action do |args, options|
+    color =  args.first
+    unless color
+      puts "No color provided"
+      return 
+    end
+    
+    ::BlikstickSquare::Commander.new().set_color(color)
+  end
+end

data/lib/BlikstickSquare.rb

@@ -0,0 +1,50 @@
+require "BlikstickSquare/version"
+require "BlikstickSquare/blinkstick"
+
+module BlikstickSquare
+  class Commander
+
+    def first_blinkstick
+      BlinkStick.find_all.first
+    end
+
+    def print_info
+      b = first_blinkstick()
+      puts "Found device:"
+      puts "  Manufacturer:  " + b.manufacturer
+      puts "  Description:   " + b.description
+      puts "  Serial:        " + b.serial
+      puts "  Current Color: " + b.color.html
+      puts "  Info Block 1:  " + b.info_block1()
+      puts "  Info Block 2:  " + b.info_block2()
+    end
+
+    def off
+      set_color("000000")
+    end
+
+    def red
+      set_color("ff0000")
+    end
+
+    def green
+      set_color("00ff00")
+    end
+
+    def blue
+      set_color("0000ff")
+    end
+
+    def set_color(color)
+      b = first_blinkstick()
+      channel = 0
+      (0..7).each { | index |
+        b.set_color(channel, index, Color::RGB.from_html(color))
+      }
+    end
+
+    def red
+      set_color("ff0000")
+    end
+  end
+end

data/lib/BlikstickSquare/blinkstick.rb

@@ -0,0 +1,192 @@
+require "libusb"
+require "color"
+
+class BlinkStick
+  @@VENDOR_ID = 0X20A0
+  @@PRODUCT_ID = 0x41E5
+
+  def open(device = nil)
+    @@usb ||= LIBUSB::Context.new
+
+    if (device)
+      @device = device
+    else
+      @device = @@usb.devices(:idVendor => @@VENDOR_ID, :idProduct => @@PRODUCT_ID).first
+    end
+
+    @handle = @device.open
+  end
+
+  def self.find_all
+    @@usb ||= LIBUSB::Context.new
+
+    result = []
+
+    @@usb.devices(:idVendor => @@VENDOR_ID, :idProduct => @@PRODUCT_ID).each { | device |
+      b = BlinkStick.new
+      b.open(device)
+
+      result.push(b)
+    }
+
+    result
+  end
+
+  def self.find_by_serial(serial)
+    @@usb ||= LIBUSB::Context.new
+
+    @@usb.devices(:idVendor => @@VENDOR_ID, :idProduct => @@PRODUCT_ID).each { | device |
+      if device.serial_number == serial
+        b = BlinkStick.new
+        b.open(device)
+        return b
+      end
+    }
+
+    nil
+  end
+
+  def color=(value)
+    for i in 0..8 do
+      puts "XXX: #{1.chr + 0.to_i.chr + i.to_i.chr + value.red.to_i.chr + value.green.to_i.chr + value.blue.to_i.chr}"
+      @handle.control_transfer(:bmRequestType => 0x20,
+                               :bRequest => 0x9,
+                               :wValue => 0x1,
+                               :wIndex => 0x0000,
+                               :dataOut => 1.chr + 0.to_i.chr + i.to_i.chr + value.red.to_i.chr + value.green.to_i.chr + value.blue.to_i.chr)  
+    end
+    
+  end
+
+  def color
+    result = @handle.control_transfer(:bmRequestType => 0x80 | 0x20, :bRequest => 0x1, :wValue => 0x1, :wIndex => 0x0000, :dataIn => 4)
+    Color::RGB.new(result[1].ord, result[2].ord, result[3].ord)
+  end
+
+  def set_color(channel, index, value)
+    attempts = 0
+    while attempts < 5
+      attempts += 1
+
+      begin
+        @handle.control_transfer(:bmRequestType => 0x20,
+                                 :bRequest => 0x9,
+                                 :wValue => 0x5,
+                                 :wIndex => 0x0000,
+                                 :dataOut => 1.chr + channel.to_i.chr + index.to_i.chr + value.red.to_i.chr + value.green.to_i.chr + value.blue.to_i.chr)
+        break
+      rescue
+        if attempts == 5
+          raise
+        end
+      end
+    end
+  end
+
+  def set_colors(channel, data)
+    report_id = 9
+    max_leds = 64
+
+    if data.size <= 8 * 3
+        max_leds = 8
+        report_id = 6
+    elsif data.size <= 16 * 3
+        max_leds = 16
+        report_id = 7
+    elsif data.size <= 32 * 3
+        max_leds = 32
+        report_id = 8
+    elsif data.size <= 64 * 3
+        max_leds = 64
+        report_id = 9
+    end
+
+    report = report_id.chr + channel.to_i.chr
+
+    (0..max_leds * 3 - 1).each do | i |
+      if data.size > i
+        report += data[i].to_i.chr
+      else
+        report += 0.chr
+      end
+    end
+
+    #Debug code
+    #puts report.unpack('U'*report.length).collect {|x| x.to_s 16}.join(" ")
+
+    attempts = 0
+    while attempts < 5
+      attempts += 1
+
+      begin
+        @handle.control_transfer(:bmRequestType => 0x20,
+                                 :bRequest => 0x9,
+                                 :wValue => report_id,
+                                 :wIndex => 0,
+                                 :dataOut => report)
+        break
+      rescue
+        if attempts == 5
+          raise
+        end
+      end
+    end
+  end
+
+  def off
+    self.color = Color::RGB.new(0, 0, 50)
+  end
+
+  def get_info_block(id)
+    bytes = @handle.control_transfer(:bmRequestType => 0x80 | 0x20, :bRequest => 0x1, :wValue => id + 1, :wIndex => 0x0000, :dataIn => 33)
+
+    result = ""
+    for i in 1..(bytes.length-1)
+      if i == "\x00"
+        break
+      end
+      result += bytes[i] 
+    end
+
+    result
+  end
+
+  def set_info_block(id, data)
+    data = (id + 1).chr + data
+    data = data + 0.chr while data.length < 33
+    @handle.control_transfer(:bmRequestType => 0x20, :bRequest => 0x9, :wValue => id + 1, :wIndex => 0x0000, :dataOut => data)
+  end
+
+  def random_color
+    r = Random.new
+    self.color = Color::RGB.new(r.rand(255), r.rand(255), r.rand(255))
+  end
+
+  def serial
+    @device.serial_number
+  end
+
+  def manufacturer
+    @device.manufacturer
+  end
+
+  def description
+    @device.product
+  end
+
+  def info_block1
+    get_info_block(1)
+  end
+
+  def info_block1=(value)
+    set_info_block(1, value)
+  end
+
+  def info_block2
+    get_info_block(2)
+  end
+
+  def info_block2=(value)
+    set_info_block(2, value)
+  end
+end

data/lib/BlikstickSquare/version.rb

@@ -0,0 +1,3 @@
+module BlikstickSquare
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: BlikstickSquare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calò, Ignazio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: libusb
+  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: color
+  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: commander
+  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: 
+email:
+- ignazioc@gmail.com
+executables:
+- blink
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- BlikstickSquare.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/blink
+- lib/BlikstickSquare.rb
+- lib/BlikstickSquare/blinkstick.rb
+- lib/BlikstickSquare/version.rb
+homepage: https://github.com/ignazioc/blinksticksquare
+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.8
+signing_key: 
+specification_version: 4
+summary: Command line client for the Blikstick Square
+test_files: []