digiusb 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52f78cacd459c373f90fbd41e043d12c8e0b5ff5
+  data.tar.gz: 70924c701448f285f2686e2f7b0890d2c9cc0f66
+SHA512:
+  metadata.gz: 5c6473feea90654cd90bf178e04335a549e7c454e85c0647c75d26fee16ba34c7165bbf362a78822095d427ffb9948308a5af8c714c7e30e49081af5f1deac1a
+  data.tar.gz: 3e23962bbf56bfb09f8483532e812d452ed48561cde1990cf7bed6f3e2f1f2bea107f35452396404bf894628a71bd7920f4b933811a10fd5d29551609526ea1c

data/lib/digiusb.rb

@@ -1,16 +1,25 @@
-# The DigiUSB class helps find, connect to, and talk with Digisparks using the DigiUSB arduino library bundled with the Digispark Arduino software.
-# This class aims to work like an IO object, letting you read and write characters, bytes, and strings as if it were a file, socket, or serial port.
-# To get started, grab a list of Digisparks with the DigiUSB.sparks method. Each spark has an inspect method with a unique identifier including the
-# USB device name (usually DigiUSB), and some numbers representing which ports and hubs each spark connects to. To begin with, DigiUSB.sparks.last
-# works well if you only intend to have one digispark connected to your computer. Eventually the device name (aka "product name") will hopefully
-# provide a simple way to differentiate different digisparks.
+# The DigiUSB class helps find, connect to, and talk with Digisparks using the
+# DigiUSB arduino library bundled with the Digispark Arduino software. This
+# class aims to work like an IO object, letting you read and write characters,
+# bytes, and strings as if it were a file, socket, or serial port. To get
+# started, grab a list of Digisparks with the DigiUSB.sparks method. Each spark
+# has an inspect method with a unique identifier including the USB device name
+# (usually DigiUSB), and some numbers representing which ports and hubs each
+# spark connects to. To begin with, DigiUSB.sparks.last works well if you only
+# intend to have one digispark connected to your computer. Eventually the device
+# name (aka "product name") will hopefully provide a simple way to differentiate
+# different digisparks.
 #
-# Once you have a reference to a Digispark, you can start using it as if it were an IO object immediately with methods like getc and putc.
-# As soon as you start interacting with the Digispark using these reading and writing methods the Digispark will be claimed to your ruby program
-# and will be unavailable to other programs until you do one of: close the ruby program, or unplug and plug back in the Digispark.
+# Once you have a reference to a Digispark, you can start using it as if it were
+# an IO object immediately with methods like getc and putc. As soon as you start
+# interacting with the Digispark using these reading and writing methods the
+# Digispark will be claimed to your ruby program and will be unavailable to
+# other programs until you do one of: close the ruby program, or unplug and plug
+# back in the Digispark.
 #
-# Note also that calling DigiUSB.sparks can sometimes disrupt program uploads, so if you're polling waiting for a digispark to appear you may see
-# some programming errors in the Digispark Arduino software.
+# Note also that calling DigiUSB.sparks can sometimes disrupt program uploads,
+# so if you're polling waiting for a digispark to appear you may see some
+# programming errors in the Digispark Arduino software.
 
 require 'libusb'
 
@@ -18,7 +27,7 @@ require 'libusb'
 class DigiUSB
   ProductID = 0x05df # product id number from Digistump
   VendorID = 0x16c0 # vendor id number for Digistump
-  Timeout = 1_000 # one second till device crashes due to lack of calling DigiUSB.refresh()
+  Timeout = 1_000 # spark needs to DigiUSB.refresh or DigiUSB.sleep every second
   DefaultPollingFrequency = 15 # 15hz when waiting for data to be printed
   
   # :nodoc: initialize a new DigiUSB object using a libusb device object
@@ -28,13 +37,15 @@ class DigiUSB
     @polling_frequency = DefaultPollingFrequency
   end
   
-  # polling frequency describes how aggressively ruby will ask for new bytes when waiting for the device to print something
-  # a lower value is faster (it is in hertz)
+  # polling frequency describes how aggressively ruby will ask for new bytes
+  # when waiting for the device to print something a lower value is faster (it
+  # is in hertz)
   attr_accessor :polling_frequency
   
-  # Returns an array of all Digisparks connected to this computer. Optionally specify a device name string to return only Digisparks with
-  # that name. At the time of writing there is no easy way to customize the device name in the Digispark Arduino software, but hopefully
-  # there will be in the future.
+  # Returns an array of all Digisparks connected to this computer. Optionally
+  # specify a device name string to return only Digisparks with that name. At
+  # the time of writing there is no easy way to customize the device name in
+  # the Digispark Arduino software, but hopefully there will be in the future.
   def self.sparks product_name = false
     usb = LIBUSB::Context.new
     usb.devices.select { |device|
@@ -44,10 +55,16 @@ class DigiUSB
     }
   end
   
+  # Connect to a Digispark. Usually the most recently plugged in one.
+  def self.connect product_name = false
+    sparks(product_name).last
+  end
   
-  # Attempt to read a single character from the Digispark. Returns a string either zero or one characters long.
-  # A zero character string means there are no characters available to read - the Digispark hasn't printed anything for you to consume yet.
-  # Returns next time Digispark calls DigiUSB.refresh() regardless of how many characters are available.
+  # Attempt to read a single character from the Digispark. Returns a string
+  # either zero or one characters long. A zero character string means there are
+  # no characters available to read - the Digispark hasn't printed anything for
+  # you to consume yet. Returns next time Digispark calls DigiUSB.refresh()
+  # regardless of how many characters are available.
   def getc
     control_transfer(
       bRequest: 0x01, # hid get report
@@ -55,10 +72,12 @@ class DigiUSB
     )
   end
   
-  # Send a single character in to the Digispark's memory. Argument may be either a single byte String, or an integer between 0 and 255 inclusive.
+  # Send a single character in to the Digispark's memory. Argument may be either
+  # a single byte String, or an integer between 0 and 255 inclusive.
+  #
   # Returns next time Digispark calls DigiUSB.refresh()
   def putc character
-    character = [character % 256].pack('c') if character.is_a? Integer
+    character = [character % 256].pack('C') if character.is_a? Integer
     raise "Cannot putc more than one byte" if character.bytesize > 1
     raise "Cannot putc fewer than one byte" if character.bytesize < 1
     
@@ -68,14 +87,15 @@ class DigiUSB
     )
   end
   
-  # Read a string fromt he Digispark until a newline is received (eg, from the println function in Digispark's DigiUSB library)
-  # The returned string includes a newline character on the end.
+  # Read a string from the Digispark until a newline is received (eg, from the
+  # println function in Digispark's DigiUSB library) The returned string
+  # includes a newline character on the end.
   def gets
     chars = ""
     until chars.include? "\n"
       char = getc()
       chars += char
-      sleep 1.0 / PollingFrequency if char == ""
+      sleep 1.0 / @polling_frequency if char == ""
     end
     return chars
   end
@@ -100,22 +120,18 @@ class DigiUSB
   alias_method :print, :write
   alias_method :send, :write
   
-  # Recieve a specific number of bytes and return them as a String. Unlike #getc read will wait until
-  # the specified number of bytes are available before returning.
-  def read bytes = 1
+  # Recieve a specific number of bytes and return them as a String. Unlike #getc
+  # read will wait until the specified number of bytes are available before
+  # returning. Optionally specify a timeout
+  def read bytes = 1, timeout = nil
+    start_time = Time.now.to_f
     chars = ""
-    
-    until chars.include? "\n"
-      char = getc()
-      chars += char
-      sleep 1.0 / PollingFrequency if char == ""
-    end
-    
-    chars += getc() until chars.length == bytes
+    chars += getc() until chars.length >= bytes || (timeout && Time.now.to_f - start_time > timeout)
     return chars
   end
   
-  # A friendly textual representation of this specific Digispark. Can be called without claiming the digispark for this program
+  # A friendly textual representation of this specific Digispark. Can be called
+  # without claiming the digispark for this program
   def inspect
     "<Digispark:#{name}:@#{address}>"
   end
@@ -126,7 +142,8 @@ class DigiUSB
     @device.product
   end
   
-  # Returns the device's bus number and address on the computer's USB interface as a string
+  # Returns the device's bus number and address on the computer's USB interface
+  # as a string
   def address
     "#{@device.bus_number}.#{@device.device_address}"
   end

data/license.txt

@@ -1,106 +1,24 @@
-sid vicious played a four-string fender bass guitar and couldn’t sing 
-and everybody hated him except the ones who loved him 
-a ukulele has four strings, but sid did did not play ukulele 
-he did smack and probably killed his girlfriend nancy spungen 
-
-if only sid had had a ukulele, maybe he could have been happy 
-maybe he would not have suffered such a sad end 
-he maybe would have not done all that heroin instead 
-he maybe would’ve sat around just singing nice songs to his girlfriend 
-
-so play your favorite cover song, especially if the words are wrong 
-‘cos even if your grades are bad, it doesn’t mean you’re failing 
-do your homework with a fork 
-and eat your fruit loops in the dark 
-and bring your etch-a-sketch to work 
-and play your ukulele 
-
-ukulele small and forceful 
-brave and peaceful 
-you can play the ukulele too it is painfully simple 
-play your ukulele badly, play your ukulele loudly 
-ukulele banish evil 
-ukulele save the people 
-ukulele gleaming golden on the top of every steeple 
-
-lizzie borden took an axe, and gave her father forty whacks 
-then gave her mother forty-one, and left a tragic puzzle 
-if only they had given her an instrument, those puritans 
-had lost the plot completely 
-see what happens when you muzzle 
-a person’s creativity 
-and do not let them sing and scream 
-and nowadays it’s worse ‘cause kids have automatic handguns 
-it takes about an hour to learn how to play the ukulele 
-about same to teach someone to build a standard pipe bomb 
-YOU DO THE MATH 
-
-so play your favorite cover song, especially if the words are wrong 
-‘cos even if your grades are bad, it doesn’t mean you’re failing 
-do your homework with a fork 
-and eat your fruit loops in the dark 
-and bring your flask of jack to work 
-and play your ukulele 
-
-ukulele, thing of wonder 
-ukulele, wand of thunder 
-you can play the ukulele, too 
-in london and down under 
-play joan jett, and play jacques brel 
-and eminem and neutral milk hotel 
-the children crush the hatred 
-play your ukulele naked 
-and if anybody tries to steal your ukulele, let them take it 
-
-imagine there’s no music, imagine there are no songs 
-imagine that john lennon wasn’t shot in front of his apartment 
-imagine if john lennon had composed “imagine” on the ukulele 
-maybe folks would have more clearly got the message 
-
-you may think my approach is simple-minded and naïve 
-like if you want to save the world then why not quit and feed the hungry 
-but people for millennia have needed music to survive 
-and that’s why i’ve promised john that i will not feel guilty 
-
-so play your favorite beatles’ song 
-and make the subway fall in love 
-they’re only $19.95, that’s not a lot of money 
-play until the sun comes up 
-and play until your fingers suffer 
-play LCD soundsystem songs on your ukulele 
-quit the bitching on your blog 
-and stop pretending art is hard 
-just limit yourself to three chords 
-and do not practice daily 
-you’ll minimize some stranger’s sadness 
-with a piece of wood and plastic 
-holy fuck it’s so fantastic, playing ukulele 
-eat your homework with a fork 
-and do your fruit loops in the dark 
-bring your etch-a-sketch to work 
-your flask of jack 
-your vibrator 
-your fear of heights 
-your nikon lens 
-your mom and dad 
-your disco stick 
-your soundtrack from “karate kid” 
-your ginsu knives 
-your rosary 
-your new rebecca black CD 
-your favorite room 
-your bowie knife 
-your stuffed giraffe 
-your new glass eye 
-your sousaphone 
-your breakfast tea 
-your nick drake tapes 
-your giving tree 
-your ice cream truck 
-your missing wife 
-your will to live 
-your urge to cry 
-remember we’re all going to die 
-so PLAY YOUR UKULELE
-
-— Amanda Palmer
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

metadata

@@ -1,68 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: digiusb
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Bluebie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libusb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: colorist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.2'
-description: ! "A tiny library for talking to digispark (a small arduino clone) over
-  usb a bit like talking\n  to a real arduino through a serial port! This library
-  works with the DigiUSB library built in to Digistump's\n  version of the Arduino
-  software. Also includes a tiny terminal tool, kinda like telnet for digisparks"
+description: |-
+  A tiny library for talking to digispark (a small arduino clone) over usb a bit like talking
+    to a real arduino through a serial port! This library works with the DigiUSB library built in to Digistump's
+    version of the Arduino software. Also includes a tiny terminal tool, kinda like telnet for digisparks
 email: a@creativepony.com
 executables:
 - digiterm
@@ -75,10 +68,12 @@ files:
 - license.txt
 - examples/digiblink.rb
 - examples/finn.rb
-- !binary |-
-  YmluL2RpZ2l0ZXJt
+- bin/digiterm
 homepage: http://github.com/Bluebie/digiusb.rb
-licenses: []
+licenses:
+- Unlicense
+- CC0
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -86,22 +81,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a tiny library for talking to digisparks
 test_files: []
-has_rdoc: