blinkenlights 0.0.1

data/GPL

@@ -0,0 +1,340 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README.en

@@ -0,0 +1,43 @@
+Requirements
+============
+
+This library requires Linux at the moment, and isn't usable on other Unixes
+(yet). Depending on your keyboard LED positions some tweaking may be necessary,
+see the RDOC documentation.
+
+Installation
+============
+
+Just type into the command line as root:
+
+# ruby install.rb
+
+Or if you already use rubygems (you should!) just type and rubygems fetches
+the gem and installs it for you:
+
+# gem install blinkenlights
+
+Documentation
+=============
+
+To create the documentation of this module, type
+
+$ ruby make_doc.rb
+
+and the API documentation is generated by your rdoc command in
+the doc/ sub-directory.
+
+In the examples direcotry is a small example that shows, how to let the lights
+blink, if network packets were received. You very likely have to run it as
+root.
+
+Author
+======
+
+Florian Frank <flori@ping.de>
+
+License
+=======
+
+GNU General Public License (GPL), Version 2
+

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rake/gempackagetask'
+require 'rbconfig'
+
+include Config
+
+PKG_NAME = 'blinkenlights'
+PKG_VERSION = File.read('VERSION').chomp
+PKG_FILES = FileList["**/*"].exclude(/CVS|^pkg|^coverage|^doc/)
+
+desc "Installing library"
+task :install  do
+  ruby 'install.rb'
+end
+
+task :doc do
+  ruby 'make_doc.rb'
+end
+
+desc "Removing generated files"
+task :clean do
+  rm_rf 'doc'
+  rm_rf 'coverage'
+end
+
+spec = Gem::Specification.new do |s|
+  #### Basic information.
+
+  s.name = 'blinkenlights'
+  s.version = PKG_VERSION
+  s.summary = "Control the Blinkenlights on your keyboard from Ruby"
+  s.description = ""
+
+  #### Dependencies and requirements.
+
+  #s.add_dependency('log4r', '> 1.0.4')
+  #s.requirements << ""
+
+  s.files = PKG_FILES
+
+  #### C code extensions.
+
+  #s.extensions << "ext/extconf.rb"
+
+  #### Load-time details: library and application (you will need one or both).
+
+  s.require_path = 'lib'                         # Use these for libraries.
+  s.autorequire = 'blinkenlights'
+
+  #s.bindir = "bin"                               # Use these for applications.
+  #s.executables = ["bla.rb"]
+  #s.default_executable = "bla.rb"
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  #s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options << '--title' <<  'BlinkenLights in Ruby' << '--main' << 'BlinkenLights'
+  #s.test_files << 'tests/runner.rb'
+
+  #### Author and project details.
+
+  s.author = "Florian Frank"
+  s.email = "flori@ping.de"
+  s.homepage = "http://blinkenlights.rubyforge.org"
+  s.rubyforge_project = "blinkenlights"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.package_files += PKG_FILES
+end
+
+task :release => [ :clean, :package ]
+  # vim: set et sw=2 ts=2:

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/netblinker.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'blinkenlights'
+include BlinkenLights::Constants
+
+proc_net_dev = '/proc/net/dev'
+dev = ARGV.shift || 'eth0'
+
+bl = BlinkenLights.new
+trap(:INT) do
+  bl.close if bl
+  exit
+end
+
+old_rx, old_tx = 0, 0
+loop do
+  bl.off
+  line = File.read(proc_net_dev).grep(/#{dev}:/)
+  line.empty? and fail "Unknown device #{dev} in #{proc_net_dev}"
+  parts = line[0].scan(/\s+\d+/)
+  rx, tx = parts[0].to_i, parts[8].to_i
+  bl.digital = case [ rx != old_rx, tx != old_tx ]
+  when [  true, true  ] then LED_LEFT | LED_RIGHT
+  when [ false, true  ] then LED_RIGHT
+  when [  true, false ] then LED_LEFT
+  else 0
+  end
+  old_rx, old_tx = rx, tx
+end

data/install.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rbconfig'
+require 'fileutils'
+include FileUtils::Verbose
+include Config
+
+dest = CONFIG["sitelibdir"]
+mkdir_p(dest)
+file = 'lib/blinkenlights.rb'
+install(file, dest)
+    # vim: set et sw=4 ts=4:

data/lib/blinkenlights.rb

@@ -0,0 +1,399 @@
+# = blinkenlights.rb - Controlling the keyboard LEDs from Ruby
+#
+# == Author
+#
+# Florian Frank mailto:flori@ping.de
+#
+# == License
+#
+# This is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License Version 2 as published by the Free
+# Software Foundation: www.gnu.org/copyleft/gpl.html
+#
+# == Download
+#
+# The latest version of <b>blinkenlights</b> can be found at
+#
+# * http://rubyforge.org/frs/?group_id=1021
+#
+# The homepage of this library is located at
+#
+# * http://blinkenlights.rubyforge.org
+#
+# == Description
+#
+# This Ruby library is named after an old joke, see
+#   http://catb.org/~esr/jargon/html/B/blinkenlights.html
+#
+# It enables you to control the LEDs on your keyboard to signal digital numbers
+# between 0 and 7, events like received/transmitted network packets, or just
+# let them blink in visually pleasing patterns.
+# 
+# == Examples
+#
+# The block form opens the TTY, that controls the LEDs, and closes/resets
+# the LEDs  it after the block has been processed:
+#  require 'blinkenlights'
+#  BlinkenLights.open do |bl|
+#    bl.off
+#    bl.circle
+#  end
+#
+# It's also possible to manually close the object:
+#  require 'blinkenlights'
+#  bl = BlinkenLights.new
+#  bl.off
+#  100.times { bl.random }
+#  bl.close
+#
+# There's also a short example examples/netblinker.rb in the distribution
+# directory of this library, that shows how to let the lights blink if network
+# packets are received/transmitted on your host.
+class BlinkenLights
+
+  # Module to hold the BlinkenLights constants.
+  module Constants
+    # The default tty. It happens to be the one, I run X on. ;)
+    DEF_TTY   = '/dev/tty8'
+
+    # DEF_DELAY is the default standard delay in seconds, that is slept everytime
+    # the LED state is changed. If it is too small your keyboard may become
+    # confused about its LEDs' status.
+    DEF_DELAY = 0.1
+
+    # Scroll Lock LED (from /usr/include/linux/kd.h)
+    LED_SCR   = 0x01
+
+    # Num Lock LED (from /usr/include/linux/kd.h)
+    LED_NUM   = 0x02
+
+    # Caps Lock LED (from /usr/include/linux/kd.h)
+    LED_CAP   = 0x04
+
+    # Return current LED state (from /usr/include/linux/kd.h)
+    KDGETLED  = 0x4B31
+
+    # Set LED state [lights, not flags] (from /usr/include/linux/kd.h)
+    KDSETLED  = 0x4B32
+
+    # In order from left to right. This setting may have to be tweaked, if your
+    # keyboard has some unusual LED positions.
+    LEDS        = [ :LED_NUM, :LED_CAP, :LED_SCR ]
+
+    # Values for LEDs from left to right
+    LEDS_VALUES = LEDS.map { |c| self.const_get(c) }
+
+    # In order from lowest to highest
+    DIGITAL     = [ :LED_SCR, :LED_NUM, :LED_CAP ]
+
+    # The left LED
+    LED_LEFT    = 4
+
+    # The middle LED
+    LED_MIDDLE  = 2
+
+    # The right LED
+    LED_RIGHT   = 1
+  end
+  include Constants
+
+  # Creates a BlinkenLights instance for _tty_, a full pathname like
+  # '/dev/tty8' to control the LEDs. _delay_ is the standard delay in seconds,
+  # that is slept everytime the LED state is changed. If _delay_ is too small
+  # your keyboard may become confused about its LEDs' status.
+  def initialize(tty = DEF_TTY, delay = DEF_DELAY)
+    @tty      = File.new(tty, File::RDWR)
+    @delay    = delay
+    @old_leds = get
+  end
+
+  # The standard delay of this BlinkenLights instance.
+  attr_accessor :delay
+
+  # Creates a BlinkenLights instance and yields to it. After the block returns
+  # the BlinkenLights#close method is called.
+  def self.open(tty = DEF_TTY, delay = DEF_DELAY)
+    obj = new(tty, delay)
+    yield obj
+  ensure
+    obj.close if obj
+  end
+
+  # Close the open console tty after resetting LEDs to the original state.
+  def close
+    reset
+    @tty.close
+    self
+  end
+
+  # Resets the LED state to the starting state (when the BlinkenLights object
+  # was created).
+  def reset
+    set @old_leds
+    self
+  end
+  
+  # Switch off all LEDs.
+  def off
+    set 0
+    self
+  end
+  
+  # Switch on all LEDs.
+  def on
+    set 7
+    self
+  end
+
+  # Set LEDs to _number_ in binary digital mode.
+  def digital=(number)
+    number  %= 8
+    setting  = 0
+    0.upto(2) do |i|
+      if number[i] == 1
+        setting |= 1 << DIGITAL.index(LEDS[2 - i])
+      end
+    end
+    set setting
+  end
+  
+  # Return the state of the LEDs expressed in binary digital mode.
+  def digital
+    setting = get
+    result  = 0
+    2.downto(0) do |i|
+      if setting[i] == 1
+        result |= 1 << (2 - LEDS_VALUES.index(1 << i))
+      end
+    end
+    result
+  end
+
+  # Blink all the LEDs from the left to the right. Sleep for _delay_ seconds in
+  # between.
+  def left_to_right(delay = 0.0)
+    for i in [ LED_LEFT, LED_MIDDLE, LED_RIGHT ]
+      self.digital = i
+      sleep delay
+    end
+    self
+  end
+
+  # Blink all the LEDs from the right to the left. Sleep for _delay_ seconds in
+  # between.
+  def right_to_left(delay = 0.0)
+    for i in [ LED_RIGHT, LED_MIDDLE, LED_LEFT ]
+      self.digital = i
+      sleep delay
+    end
+    self
+  end
+
+  # Blink all the LEDs from the left to the right, and then from the right to
+  # the left. Sleep for _delay_ seconds in between.
+  def circle(delay = 0.0)
+    left_to_right(delay)
+    right_to_left(delay)
+    self
+  end
+
+  # Blink all the LEDs from the right to the left, and then from the left to
+  # the right. Sleep for _delay_ seconds in between.
+  def reverse_circle(delay = 0.0)
+    right_to_left(delay)
+    left_to_right(delay)
+    self
+  end
+
+  # Switch some of the LEDs on by random. Then sleep for _delay_ seconds.
+  def random(delay = 0.0)
+    self.digital = rand(8)
+    sleep delay
+    self
+  end
+
+  # Converge, that is, first blink the outer LEDs, then blink the inner LED.
+  # Sleep for _delay_ seconds in between.
+  def converge(delay = 0.0)
+    for i in [ LED_LEFT|LED_RIGHT, LED_MIDDLE ]
+      self.digital = i
+      sleep delay
+    end
+    self
+  end
+
+  # Diverge, that is, first blink the inner LED, then blink the outer LEDs.
+  # Sleep for _delay_ seconds in between.
+  def diverge(delay = 0.0)
+    for i in [ LED_MIDDLE, LED_LEFT|LED_RIGHT ]
+      self.digital = i
+      sleep delay
+    end
+    self
+  end
+
+  # Return the state of the Scroll Lock LED: true for switched on, false for
+  # off.
+  def scr
+    (get & LED_SCR) != 0
+  end
+
+  # Switch the Scroll Lock LED on, if _toggle_ is true, off, otherwise.
+  def scr=(toggle)
+    old = get
+    if toggle
+      set old | LED_SCR
+    else
+      set old & ~LED_SCR
+    end
+  end
+
+  # Switch the Scroll Lock LED on, if it was off before. Switch the Scroll Lock
+  # LED off, if it was on before. 
+  def toggle_scr(delay = 0.0)
+    self.scr = !scr
+    sleep 0.0
+    self
+  end
+
+  # Return the state of the Caps Lock LED: true for switched on, false for off.
+  def cap
+    (get & LED_CAP) != 0
+  end
+
+  # Switch the Caps Lock LED on, if _toggle_ is true, off, otherwise.
+  def cap=(toggle)
+    old = get
+    if toggle
+      set old | LED_CAP
+    else
+      set old & ~LED_CAP
+    end
+  end
+
+  # Switch the Caps Lock LED on, if it was off before. Switch the Caps Lock
+  # LED off, if it was on before. 
+  def toggle_cap(delay = 0.0)
+    self.cap = !cap
+    sleep delay
+    self
+  end
+
+  # Return the state of the Num Lock LED: true for switched on, false for off.
+  def num
+    (get & LED_NUM) != 0
+  end
+
+  # Switch the Num Lock LED on, if _toggle_ is true, off, otherwise.
+  def num=(toggle)
+    old = get
+    if toggle
+      set old | LED_NUM
+    else
+      set old & ~LED_NUM
+    end
+  end
+
+  # Switch the Num Lock LED on, if it was off before. Switch the Num Lock LED
+  # off, if it was on before. 
+  def toggle_num(delay = 0.0)
+    self.num = !num
+    self
+  end
+
+  # Return the state of the left LED: true for switched on, false for
+  # off.
+  def left
+    (digital & LED_LEFT) != 0
+  end
+
+  # Switch the left LED on, if _toggle_ is true, off, otherwise.
+  def left=(toggle)
+    old = digital
+    if toggle
+      self.digital = old | LED_LEFT
+    else
+      self.digital = old & ~LED_LEFT
+    end
+  end
+
+  # Switch the left LED on, if it was off before. Switch the left
+  # LED off, if it was on before. 
+  def toggle_left(delay = 0.0)
+    self.left = !left
+    sleep 0.0
+    self
+  end
+
+  # Return the state of the middle LED: true for switched on, false for off.
+  def middle
+    (digital & LED_MIDDLE) != 0
+  end
+
+  # Switch the middle LED on, if _toggle_ is true, off, otherwise.
+  def middle=(toggle)
+    old = digital
+    if toggle
+      self.digital = old | LED_MIDDLE
+    else
+      self.digital = old & ~LED_MIDDLE
+    end
+  end
+
+  # Switch the middle LED on, if it was off before. Switch the middle LED off,
+  # if it was on before. 
+  def toggle_middle(delay = 0.0)
+    self.middle = !middle
+    sleep delay
+    self
+  end
+
+  # Return the state of the right LED: true for switched on, false for off.
+  def right
+    (digital & LED_RIGHT) != 0
+  end
+
+  # Switch the right LED on, if _toggle_ is true, off, otherwise.
+  def right=(toggle)
+    old = digital
+    if toggle
+      self.digital = old | LED_RIGHT
+    else
+      self.digital = old & ~LED_RIGHT
+    end
+  end
+
+  # Switch the right LED on, if it was off before. Switch the right off, if it
+  # was on before. 
+  def toggle_right(delay = 0.0)
+    self.right = !right
+    self
+  end
+
+  # Set the state of the LEDs to integer _number_. (Quite low level)
+  def set(number)
+    @tty.ioctl(KDSETLED, number)
+    sleep @delay
+    number
+  end
+
+  # Return the state of the LEDs as an integer _number_. (Quite low level)
+  def get
+    char = [0].pack('C')
+    @tty.ioctl(KDGETLED, char)
+    char.unpack('C')[0]
+  end
+
+  # Return a string representation of this BlinkenLights instance, showing
+  # some interesting data.
+  def to_s
+    if @tty.closed?
+      "#<#{self.class}: closed>"
+    else
+      "#<#{self.class}: delay=#{@delay}s, tty=#{@tty.path}," +
+      " LEDs=#{'%03b' % self.digital}>"
+    end
+  end
+
+  alias inspect to_s
+end

data/make_doc.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+system "rdoc -m BlinkenLights lib/blinkenlights.rb"
+    # vim: set et sw=4 ts=4:
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: blinkenlights
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2005-10-18 00:00:00 +02:00
+summary: Control the Blinkenlights on your keyboard from Ruby
+require_paths: 
+  - lib
+email: flori@ping.de
+homepage: http://blinkenlights.rubyforge.org
+rubyforge_project: blinkenlights
+description: ''
+autorequire: blinkenlights
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Florian Frank
+files: 
+  - Rakefile
+  - GPL
+  - examples
+  - README.en
+  - VERSION
+  - install.rb
+  - make_doc.rb
+  - lib
+  - examples/netblinker.rb
+  - lib/blinkenlights.rb
+test_files: []
+rdoc_options: 
+  - "--title"
+  - BlinkenLights in Ruby
+  - "--main"
+  - BlinkenLights
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []