blinkenlights 0.0.2 → 0.0.3

data/CHANGES

@@ -1,3 +1,5 @@
-2005-10-18 * Some small bugs fixed
-           * flash method added
-           * additional example
+2006-06-08 - 0.0.3  * Added support for Windows. The relevant code parts were
+                      contributed by Dave Burt <dave@burt.id.au>. Thanks a lot!
+2005-10-18 - 0.0.2  * Some small bugs fixed
+                    * flash method added
+                    * additional example

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/examples/loadbar.rb

@@ -5,7 +5,7 @@ include BlinkenLights::Constants
 
 proc_loadavg = '/proc/loadavg'
 
-bl = BlinkenLights.new
+bl = BlinkenLights.new(ARGV.shift || '/dev/tty8')
 trap(:INT) do
   bl.close if bl
   exit
@@ -19,6 +19,8 @@ loop do
   when 0.25..0.50 then  bl.digital = LED_LEFT
   when 0.50..0.75 then  bl.digital = LED_LEFT | LED_MIDDLE
   when 0.75..1.00 then  bl.digital = LED_LEFT | LED_MIDDLE | LED_RIGHT
+  when 1.00..2.00 then  bl.off ; bl.digital = LED_RIGHT
+  when 2.00..3.00 then  bl.off ; bl.digital = LED_RIGHT | LED_MIDDLE
   else                  bl.flash
   end
 end

data/examples/netblinker.rb

@@ -6,7 +6,7 @@ include BlinkenLights::Constants
 proc_net_dev = '/proc/net/dev'
 dev = ARGV.shift || 'eth0'
 
-bl = BlinkenLights.new
+bl = BlinkenLights.new(ARGV.shift || '/dev/tty8')
 trap(:INT) do
   bl.close if bl
   exit
@@ -20,7 +20,7 @@ loop do
   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 [  true, true  ] then LED_ALL
   when [ false, true  ] then LED_RIGHT
   when [  true, false ] then LED_LEFT
   else                       0

data/lib/blinkenlights.rb

@@ -1,3 +1,8 @@
+begin
+  require 'Win32API'
+rescue LoadError
+end
+
 # = blinkenlights.rb - Controlling the keyboard LEDs from Ruby
 #
 # == Author
@@ -28,6 +33,10 @@
 # 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.
+#
+# *Beware*: If you use BlinkenLights under Windows, not only the leds are
+# switched on/off but also the related keys are pressed/unpressed! This could
+# be quite confusing. ;)
 # 
 # == Examples
 #
@@ -46,10 +55,10 @@
 #  100.times { bl.random }
 #  bl.close
 #
-# There's also two short examples examples/netblinker.rb and
+# There are also two short examples examples/netblinker.rb and
 # examples/loadbar.rb in the distribution directory of this library, that show
 # how to let the lights blink if network packets are received/transmitted on
-# your host or how high the cpu load average is.
+# your host or to indicate how high the cpu load average is.
 class BlinkenLights
 
   # Module to hold the BlinkenLights constants.
@@ -57,9 +66,9 @@ class BlinkenLights
     # 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 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)
@@ -101,19 +110,42 @@ class BlinkenLights
 
     # All of the LEDs
     LED_ALL     = 7
+
+    if defined? ::Win32API
+      # Mapping from Unix LEDs to Windows LEDs
+      WINDOWS_LEDS = { LED_SCR => 0x91, LED_NUM => 0x90, LED_CAP => 0x14 }
+
+      # Windows key released
+      WIN_KEY_UP = 0x26
+
+      GetKeyState = ::Win32API.new("user32", "GetKeyState", ["i"], "i")
+      Keybd_event = ::Win32API.new("user32", "keybd_event", %w[i i i i], "v")
+    end
   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
+  if defined? ::Win32API
+    def initialize(ignored = nil, delay = DEF_DELAY) # :nodoc:
+      @tty      = File.new('NUL', File::RDWR)
+      @delay    = delay
+      @old_leds = get
+    end
+  else
+    # Creates a BlinkenLights instance for _tty_, a full pathname like
+    # '/dev/tty8' to control the LEDs. This parameter is ignored under the
+    # Windows operating system.
+    #
+    # _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
   end
 
+
   # The standard delay of this BlinkenLights instance.
   attr_accessor :delay
 
@@ -385,18 +417,37 @@ class BlinkenLights
     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
+  if defined? ::Win32API
+    def set(number) # :nodoc:
+      WINDOWS_LEDS.each do |nix, win|
+        if (number & nix != 0) ^ (GetKeyState.call(win) != 0)
+          Keybd_event.call(win, 0, 0, 0)
+          Keybd_event.call(win, 0, WIN_KEY_UP, 0)
+        end
+      end
+      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]
+    def get # :nodoc:
+      WINDOWS_LEDS.inject(0) do |sum, (nix, win)|
+        sum | ((GetKeyState.call(win) != 0) ? nix : 0)
+      end
+    end
+  else
+    # 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
   end
 
   # Return a string representation of this BlinkenLights instance, showing

data/make_doc.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
-system "rdoc -m BlinkenLights lib/blinkenlights.rb"
-    # vim: set et sw=4 ts=4:
+require 'rbconfig'
+bindir = Config::CONFIG['bindir']
 
+system "#{bindir}/ruby #{bindir}/rdoc -m BlinkenLights lib/blinkenlights.rb"
+    # vim: set et sw=4 ts=4:

metadata

@@ -3,52 +3,57 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: blinkenlights
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2005-10-19 00:00:00 +02:00
+  version: 0.0.3
+date: 2006-04-08 00:00:00 +02:00
 summary: Control the Blinkenlights on your keyboard from Ruby
 require_paths: 
-  - lib
+- lib
 email: flori@ping.de
 homepage: http://blinkenlights.rubyforge.org
 rubyforge_project: blinkenlights
-description: ''
+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
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Florian Frank
+- Florian Frank
 files: 
-  - examples
-  - install.rb
-  - GPL
-  - Rakefile
-  - VERSION
-  - CHANGES
-  - lib
-  - make_doc.rb
-  - README.en
-  - examples/netblinker.rb
-  - examples/loadbar.rb
-  - lib/blinkenlights.rb
+- examples
+- install.rb
+- GPL
+- Rakefile
+- VERSION
+- CHANGES
+- lib
+- make_doc.rb
+- README.en
+- examples/netblinker.rb
+- examples/loadbar.rb
+- lib/blinkenlights.rb
 test_files: []
+
 rdoc_options: 
-  - "--title"
-  - BlinkenLights in Ruby
-  - "--main"
-  - BlinkenLights
+- --title
+- BlinkenLights in Ruby
+- --main
+- BlinkenLights
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+