artoo-digispark 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a51a27bf37373fd338272feb32e8691b5491ff
-  data.tar.gz: fdf61c7207c4938354df7d66a8b2a13c287b35e9
+  metadata.gz: 1252b057ea97cbf0cb6fb71bec9a713e810c094f
+  data.tar.gz: c68ee311f92f1c6f3cbd086d0defb5a3eb6b8a6a
 SHA512:
-  metadata.gz: 3ef3906365c958cdd101fd253cfa99dd19a543baac8134cb5dc4bd59df2e4c95c91148f4c6ce8284f30b6f826187e54ae1f6857f2c06fc2ede2a409e88e2ae36
-  data.tar.gz: 85584d6fee31abf1e934f7c0bda629d7331a6b0126f38d5ac76b2c7b533cc431205d0793432aaf451ed1f3c20ba352b82f99049b53d0080dd9c928263b27bf15
+  metadata.gz: 2525f55ff1d28811cdfbcd25406a012999bbeaa45452b090ebdfdcc28f5905883401c6b0a6e68625aead58842639b01f3fc03bda19090e882c0bcb2a064ee6b7
+  data.tar.gz: d771480ba834c27822e4994f1d266d91e229127e7170eaa735f9f9b6d441450e240884d5e069ebfa87da2adf0a8fe39992e8e6abff11d4e806eac91f3fec3f3f

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
-  - rbx-19mode
+  - jruby-1.7.9
+  - rbx-2.1.1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    artoo-digispark (0.3.0)
-      artoo (>= 1.4.0)
+    artoo-digispark (0.4.0)
+      artoo (>= 1.6.0)
       artoo-gpio
       artoo-i2c
       littlewire (>= 0.9.10)
@@ -10,30 +10,31 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    artoo (1.4.1)
+    artoo (1.6.0)
       celluloid (~> 0.15.0)
       celluloid-io (~> 0.15.0)
       multi_json (~> 1.6)
       pry (~> 0.9)
       rake
       reel (~> 0.4.0)
+      robeaux (~> 0.0.3)
       thor (~> 0.18.1)
-    artoo-gpio (0.3.0)
-      artoo (>= 1.4.0)
-    artoo-i2c (0.4.0)
-      artoo (>= 1.4.0)
+    artoo-gpio (0.4.0)
+      artoo (>= 1.6.0)
+    artoo-i2c (0.5.0)
+      artoo (>= 1.6.0)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     celluloid-io (0.15.0)
       celluloid (>= 0.15.0)
       nio4r (>= 0.5.0)
-    coderay (1.0.9)
+    coderay (1.1.0)
     colorist (0.0.2)
-    ffi (1.9.0)
+    ffi (1.9.3)
     http (0.5.0)
       http_parser.rb
-    http_parser.rb (0.6.0.beta.2)
-    libusb (0.3.4)
+    http_parser.rb (0.6.0)
+    libusb (0.4.0)
       ffi (>= 1.0)
     littlewire (0.9.10)
       colorist (>= 0.0.2)
@@ -45,24 +46,24 @@ GEM
     minitest-happy (1.0.0)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    multi_json (1.8.2)
-    nio4r (0.5.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
+    multi_json (1.8.4)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.1.0)
+    rake (10.1.1)
     reel (0.4.0)
       celluloid (>= 0.15.1)
       celluloid-io (>= 0.15.0)
       http (>= 0.5.0)
       http_parser.rb (>= 0.6.0.beta.2)
       websocket_parser (>= 0.1.4)
-    slop (3.4.6)
+    robeaux (0.0.3)
+    slop (3.4.7)
     thor (0.18.1)
     timers (1.1.0)
-    websocket_parser (0.1.4)
-      http
+    websocket_parser (0.1.6)
 
 PLATFORMS
   ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 The Hybrid Group
+Copyright (c) 2013-2014 The Hybrid Group
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -49,52 +49,61 @@ The following hardware devices have driver support, via the artoo-i2c gem:
 
 ## Connecting to Digispark
 
-If your Digispark (http://www.kickstarter.com/projects/digistump/digispark-the-tiny-arduino-enabled-usb-dev-board) ATTiny-based USB development board already has the Little Wire (http://littlewire.cc/) protocol firmware installed, you can connect right away with Artoo. 
-
-Otherwise, for instructions on how to install Little Wire on a Digispark check out http://digistump.com/board/index.php/topic,160.0.html
+Connecting to the Digispark (http://www.kickstarter.com/projects/digistump/digispark-the-tiny-arduino-enabled-usb-dev-board) ATTiny-based USB development board is very easy using Artoo, first we need to install the littlewire (http://littlewire.cc/) protocol to communicate with the digispark, Artoo includes CLI commands to make the process of uploading littlewire to the digispark as simple as possible, after littlewire has been uploaded you can connect and communicate using Artoo.
 
 ### OSX
 
 The main steps are:
-- Plug in the Digispark to the USB port
+- Install the artoo-digispark gem
+- Upload the Littlewire protocol to the digispark
 - Connect to the device via Artoo
 
-First plug the Digispark into your computer via the USB port. Then... (directions go here)
+DO NOT plug in the Digispark to your computer's USB port until prompted.
+
+Install the artoo-digispark gem:
+
+```
+$ gem install artoo-digispark
+```
+
+After installing the artoo-digispark gem run the following command to upload littlewire to the digispark, plug it to a USB port when prompted:
+
+```
+$ artoo littlewire upload
+```
+
+Once plugged in, use the `artoo connect scan` command with the  `-t usb` option to verify your connection info:
+
+```
+$ artoo connect scan -t usb
+```
+
+Now use the `ID` info returned to find the `product` and `vendor` ID's required to establish a connection with the Digispark in your Artoo code.
+
+That is it, you are set to start running Artoo digispark examples.
 
 ### Ubuntu
 
 The main steps are:
-- Add a udev rule to allow access to the Digispark device
+- Install the artoo-digispark gem
+- Add a udev rule to allow access to the Digispark device (Do not worry
+  about this, the `cylon littlewire upload` command does it for you if none is detected)
 - Plug in the Digispark to the USB port
 - Connect to the device via Artoo
 
-First, you must add a udev rule, so that Artoo can communicate with the USB device. Ubuntu and other modern Linux distibutions use udev to manage device files when USB devices are added and removed. By default, udev will create a device with read-only permission which will not allow to you download code. You must place the udev rules below into a file named /etc/udev/rules.d/49-micronucleus.rules.
+DO NOT plug in the Digispark to your computer's USB port until prompted.
+
+Install the artoo-digispark gem:
 
 ```
-# UDEV Rules for Micronucleus boards including the Digispark.
-# This file must be placed at:
-#
-# /etc/udev/rules.d/49-micronucleus.rules    (preferred location)
-#   or
-# /lib/udev/rules.d/49-micronucleus.rules    (req'd on some broken systems)
-#
-# After this file is copied, physically unplug and reconnect the board.
-#
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666"
-KERNEL=="ttyACM*", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"
-
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="0666"
-KERNEL=="ttyACM*", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"
-#
-# If you share your linux system with other users, or just don't like the
-# idea of write permission for everybody, you can replace MODE:="0666" with
-# OWNER:="yourusername" to create the device owned by you, or with
-# GROUP:="somegroupname" and mange access using standard unix groups.
+$ gem install artoo-digispark
 ```
 
-Thanks to [@bluebie](https://github.com/Bluebie) for these instructions! (https://github.com/Bluebie/micronucleus-t85/wiki/Ubuntu-Linux)
+After installing the artoo-digispark gem run the following command to upload littlewire to the digispark, plug it to a USB port when prompted, you might be asked to enter your sudo password, since uploading littlewire to the digispark requires some new udev rules, you can check and review them in /etc/udev/rules.d/49-micronucleus.rules after running the `artoo littlewire upload` command):
 
-Now plug the Digispark into your computer via the USB port.
+```
+$ artoo littlewire upload
+```
 
 Once plugged in, use the `artoo connect scan` command with the  `-t usb` option to verify your connection info:
 
@@ -102,16 +111,37 @@ Once plugged in, use the `artoo connect scan` command with the  `-t usb` option
 $ artoo connect scan -t usb
 ```
 
-Now use the `ID` info returned to find the `product` and `vendor` ID's for the connection info Digispark in your Artoo code.
+Now use the `ID` info returned to find the `product` and `vendor` ID's required to establish a connection with the Digispark in your Artoo code.
+
+That is it, you are set to start running Artoo digispark examples.
+
+Thanks to [@bluebie](https://github.com/Bluebie) for the help with udev rules used when uploading littlewire to the digispark! (https://github.com/Bluebie/micronucleus-t85/wiki/Ubuntu-Linux)
 
 ### Windows
 
 We are currently working with the Celluloid team to add Windows support. Please check back soon!
 
+## Documentation
+
+Check out our [documentation](http://artoo.io/documentation/) for lots of information about how to use Artoo.
+
+## IRC
+
+Need more help? Just want to say "Hello"? Come visit us on IRC freenode #artoo
+
 ## Contributing
 
-1. Fork it
-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 new Pull Request
+* All patches must be provided under the Apache 2.0 License
+* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
+* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
+* We will look at the patch, test it out, and give you feedback.
+* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
+* Take care to maintain the existing coding style.
+* Add unit tests for any new or changed functionality.
+* All pull requests should be "fast forward"
+  * If there are commits after yours use “git rebase -i <new_head_branch>”
+  * If you have local changes you may need to use “git stash”
+  * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+
+
+(c) 2012-2014 The Hybrid Group

data/artoo-digispark.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "artoo-digispark"
   s.version     = Artoo::Digispark::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ron Evans"]
+  s.authors     = ["Ron Evans", "Edgar Silva"]
   s.email       = ["artoo@hybridgroup.com"]
   s.homepage    = "https://github.com/hybridgroup/artoo-digispark"
   s.summary     = %q{Artoo adaptor for Digispark}
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.extensions    = ["ext/Rakefile"]
 
-  s.add_runtime_dependency 'artoo', '>= 1.4.0'
+  s.add_runtime_dependency 'artoo', '>= 1.6.0'
   s.add_runtime_dependency 'artoo-gpio'
   s.add_runtime_dependency 'artoo-i2c'
   s.add_runtime_dependency 'littlewire', '>= 0.9.10'

data/ext/Rakefile

@@ -4,5 +4,7 @@ task :default => :install_commands
 
 task :install_commands do
   @install = Artoo::Commands::Install.new
-  @install.command(File.expand_path(File.dirname(__FILE__) + "/../lib/artoo/commands/digispark.rb"))
+  @install.command(File.expand_path(File.dirname(__FILE__) + "/../lib/artoo/commands/littlewire.rb"))
+  @install.command(File.expand_path(File.dirname(__FILE__) + "/../lib/artoo/commands/deps/49-micronucleus.rules"))
+  @install.command(File.expand_path(File.dirname(__FILE__) + "/../lib/artoo/commands/deps/littlewireLoader_v13"))
 end

data/lib/artoo-digispark/version.rb

@@ -1,5 +1,5 @@
 module Artoo
   module Digispark
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/artoo/commands/deps/49-micronucleus.rules

@@ -0,0 +1,19 @@
+# UDEV Rules for Micronucleus boards including the Digispark.
+# This file must be placed at:
+#
+# /etc/udev/rules.d/49-micronucleus.rules    (preferred location)
+#   or
+# /lib/udev/rules.d/49-micronucleus.rules    (req'd on some broken systems)
+#
+# After this file is copied, physically unplug and reconnect the board.
+#
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666"
+KERNEL=="ttyACM*", ATTRS{idVendor}=="1781", ATTRS{idProduct}=="0c9f", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"
+
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="0666"
+KERNEL=="ttyACM*", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"
+#
+# If you share your linux system with other users, or just don't like the
+# idea of write permission for everybody, you can replace MODE:="0666" with
+# OWNER:="yourusername" to create the device owned by you, or with
+# GROUP:="somegroupname" and mange access using standard unix groups.

data/lib/artoo/commands/littlewire.rb

@@ -0,0 +1,64 @@
+require 'artoo/commands/commands'
+
+module Artoo
+  module Commands
+    class Littlewire < Commands
+      package_name "littlewire"
+
+      desc "upload", "Uploads littlewire to Digispark devices"
+      def upload
+        upload_cmd = File.join(File.expand_path(File.dirname(__FILE__)), "littlewireLoader_v13")
+
+        case os
+        when :linux
+          sleep(5) if copy_udev_rules
+          run(upload_cmd)
+        when :macosx
+          run(upload_cmd)
+        else
+          say "OS not yet supported..."
+        end
+
+      end
+
+      desc "set-udev-rules", "Sets necessary udev-rules in linux systems"
+      def set_udev_rules
+        copy_udev_rules(true)
+      end
+
+      private
+      def copy_udev_rules(force = false)
+
+        udev_sys_path = '/etc/udev/rules.d/49-micronucleus.rules'
+        udev_bkp_path = File.join(File.expand_path(File.dirname(__FILE__)), "49-micronucleus.rules")
+
+        if !File.file?(udev_sys_path) || force
+          run("sudo cp #{ udev_bkp_path } #{ udev_sys_path }")
+          true
+        else
+          false
+        end
+
+      end
+    end
+  end
+end
+
+# We need to register the commands in the main artoo CLI so they
+# can be picked up when this command file is required.
+# The steps needed to register new CLI commands from outside
+# artoo are:
+# 1. Related command files need to be copied to the artoo install commands.
+# 2. We do this with a rake task that is triggered when the gem is installed
+#    (see .gemspec file and look for extensions, ext/Rakefile), in the Rakefile
+#    we defined a new default class that makes use of an artoo helper class/method
+#    Artoo::Commands::Install helper method '.command'; see ext/Rakefile for details.
+# 3. Finally in our main command file (THIS FILE) we open the artoo CLI::Root class to register
+#    the new commands.
+#
+module CLI
+  class Root
+    desc "littlewire SUBCOMMAND", "Uploads littlewire protocol to digispark"
+    subcommand "littlewire", Artoo::Commands::Littlewire
+  end
+end

metadata

@@ -1,111 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: artoo-digispark
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ron Evans
+- Edgar Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: artoo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: artoo-gpio
   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: artoo-i2c
   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: littlewire
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.10
 - !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: minitest-happy
   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: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.14.0
 description: Artoo adaptor for Digispark USB development board
@@ -116,7 +117,8 @@ extensions:
 - ext/Rakefile
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -133,7 +135,9 @@ files:
 - lib/artoo-digispark.rb
 - lib/artoo-digispark/version.rb
 - lib/artoo/adaptors/littlewire.rb
-- lib/artoo/commands/digispark.rb
+- lib/artoo/commands/deps/49-micronucleus.rules
+- lib/artoo/commands/deps/littlewireLoader_v13
+- lib/artoo/commands/littlewire.rb
 - lib/artoo/drivers/digispark.rb
 - test/adaptors/littlewire_test.rb
 - test/drivers/digispark_driver_test.rb
@@ -148,17 +152,17 @@ 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: artoo-digispark
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Artoo adaptor for Digispark

data/lib/artoo/commands/digispark.rb

@@ -1,21 +0,0 @@
-require 'artoo/commands/install'
-
-module Artoo
-  module Commands
-    class Install < Commands
-      desc "digispark", "Installs firmware on Digispark devices"
-      option :version, :aliases => "-v", :default => "1.2", :desc => "Version of firmware to install"
-      def digispark
-        case os
-        when :linux
-          # TODO: install the udev rules file
-          run("littlewire.rb install #{options[:version]}")
-        when :macosx
-          run("littlewire.rb install #{options[:version]}")
-        else
-          say "OS not yet supported..."
-        end
-      end
-    end
-  end
-end