topherfangio-lcdproc-ruby 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.project
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 topherfangio
+
+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.rdoc

@@ -0,0 +1,9 @@
+=Introduction
+LCDProc-Ruby is an object-oriented API to the LCDProc server LCDd.
+
+To get started, take a look at LCDProc::Client since it is the main
+interface to LCDd. If you are interested in the status of development,
+head over to the TODO to see what outstanding bugs are listed as well
+as an overview of the features that are yet to be implemented.
+
+LCDProc-Ruby is released under the open source MIT license.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lcdproc-ruby"
+    gem.summary = %Q{A Ruby library to interface with LCDProc.}
+    gem.email = "fangiotophia@gmail.com"
+    gem.homepage = "http://github.com/topherfangio/lcdproc-ruby"
+    gem.authors = ["topherfangio"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib/tasks/test' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+  
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lcdproc-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('TODO*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('devices/**/*.rb')
+  
+  # Show all methods including private ones
+  rdoc.options << '--all'
+  # Show line numbers and source code
+  rdoc.options << '--line-numbers' << '--inline-source'
+end
+
+# Load lcdproc-ruby specific tasks
+require 'find'
+Find.find( "tasks/test" ) do |file|
+  if File.basename( file ) =~ /\.rake$/
+    load File.expand_path( file )
+  end
+end

data/TODO

@@ -0,0 +1,18 @@
+=Introduction
+
+Currently, I am still in the process of stating all of the features that I would like to implement for the 1.0
+release. Many aspects of the program are in a working condition and can be used to create a basic program that
+talks to the LCDd server. I hope to add much functionality over the next few months and to ensure that the code
+structure enables easy extension by other developers (and myself).
+
+=Bug Fixes
+
+Bug fixes are any code/design changes that need to be implemented in order for the API to function properly or
+conform to standards.
+
+* Horizontal bar graphs should be able to handle a percentage or a regular integer
+* The <tt>menu_add_item</tt> command currently returns two responses and I have inserted a hack to get it to work, a cleaner solution is desired
+
+=Future Enhancements
+
+Any feature requests will be documented here until they can be fully implemented and added into the existing API.

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/devices/crystalfontz/packet.rb

@@ -0,0 +1,108 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  module Devices
+    module Crystalfontz
+      
+      module Packet
+        VALID_KEYS = [ "Escape", "Enter", "Up", "Down", "Left", "Right" ]
+        
+        @drives_devices = [ "CrystalFontz Driver: CFA-635" ]
+        
+        LCDProc::Devices.send( :include, self )
+        
+        
+        def Packet.drives?( search )
+          @drives_devices.include? search
+        end
+        
+        
+        # Called before initialization takes place.
+        def before_initialize( options = {} )
+          # Do nothing
+        end
+        
+        
+        # Called after initialization takes place.
+        def after_initialize( options = {} )
+          @leds = { 0 => 0, 1 => 0, 2 => 0, 3 => 0 }
+        end
+        
+        
+        # Make the specified leds light up.
+        #
+        # * <tt>leds</tt> - The leds that you wish to light. They may be specified as a single number, a range (1..3), an array [0,2] or the special parameter :all.
+        # * <tt>color</tt> - The color that you wish to light the leds. Valid options are :off, :green, :orange, or :red.
+        def light_leds( leds, color )
+          
+          if leds == :all
+            leds_to_light = @leds.keys
+          elsif leds.kind_of? Range
+            leds_to_light = leds.to_a
+          else
+            leds_to_light = ( leds.kind_of?( Array ) ? leds : [ leds ] )
+          end
+          
+          if leds_to_light.max > @leds.keys.max
+            add_message( "Error: Led '#{leds_to_light.max}' does not correspond to an actual led." )
+            return false
+          end
+          
+          case color
+            when :off
+            leds_to_light.each{ |l| @leds[l] = 0 }
+            when :green
+            leds_to_light.each{ |l| @leds[l] = 2 ** l }
+            when :orange
+            leds_to_light.each{ |l| @leds[l] = 2 ** l * 16 + 2 ** l }
+            when :red
+            leds_to_light.each{ |l| @leds[l] = 2 ** l * 16 }
+          else
+            add_message( "Error: Unknown color '#{color}'" )
+            return false
+          end
+          
+          command = Command.new( "output #{ @leds.values.sum }" )
+          response = send_command( command )
+          
+          if response.successful?
+            add_message( "Leds #{leds_to_light} were correctly lit" )
+            return true
+          else
+            add_message( "Leds #{leds_to_light} were NOT correctly lit (#{response.message})" )
+            return false
+          end
+          
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/devices/devices.rb

@@ -0,0 +1,41 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+
+	module Devices
+
+		def Devices.included_in
+			ancestors - [ self ]
+		end
+
+		def Devices.find_all_that_drive( search )
+			Devices.included_in.select { |mod| mod.drives?(search.strip) }
+		end
+
+	end
+
+end

data/examples/basic.rb

@@ -0,0 +1,39 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+
+require 'lcdproc.rb'
+
+include LCDProc
+
+c = Client.new( :name => "My Client", :host => "localhost" )
+s = Screen.new( "Test" )
+
+c.attach( s )
+graph = Widget.new( :graph )
+
+s.add_widget(graph)
+
+10.times { graph.bars.each { |bar| bar.height = rand(22) + 5 }; s.update; sleep 1 }

data/examples/clock.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+# Example: clock.rb
+# Author:  Topher Fangio
+# Date:    9.17.2008
+#
+# Purpose: This program displays a simple clock on the LCD that updates every 5 seconds.
+#          This will most likely be extracted into it's own Widget at a later date, but
+#          it makes a very good beginners example for now.
+
+require "lcdproc"
+
+include LCDProc
+
+c = Client.new( :host => "localhost" )
+s = Screen.new("clock")
+
+hour1 = Widgets::Num.new("hour1", 0, 3)
+hour2 = Widgets::Num.new("hour2", 1, 7)
+colon = Widgets::Num.new("colon", 10, 10)
+minute1 = Widgets::Num.new("minute1", 0, 12)
+minute2 = Widgets::Num.new("minute2", 0, 16)
+
+s.add_widget(hour1)
+s.add_widget(hour2)
+s.add_widget(colon)
+s.add_widget(minute1)
+s.add_widget(minute2)
+
+c.attach( s )
+
+while true do
+  t = Time.new
+  
+  if (t.hour > 10)
+    hour1.number = t.hour / 10
+    hour2.number = t.hour % 10
+  else
+    hour1.number = 0
+    hour2.number = t.hour
+  end
+  
+  if (t.min > 10)
+    minute1.number = t.min / 10
+    minute2.number = t.min % 10
+  else
+    minute1.number = 0
+    minute2.number = t.min
+  end
+  
+  s.update
+  sleep 5
+end

data/examples/lights.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# 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.
+#-------------------------------------------------------------------------------
+
+# Example: lights.rb
+# Author:  Topher Fangio
+# Date:    9.17.2008
+#
+# Purpose: This program iterates through the available lights and turns them red.
+#          Note that at the moment, only one device has been defined that supports
+#          leds, the CrystalFontz display defined in devices/crystalfontz/packet.rb.
+
+require "lcdproc"
+include LCDProc
+
+# Setup our client
+c = Client.new( :host => "192.168.1.142" )
+
+@current_led = 0
+@color = :red
+
+# Define a method to modify the current led
+def move_current_led(direction)
+  @current_led += direction
+  
+  if (@current_led > 3)
+    @current_led = 0
+  end
+  
+  if (@current_led < 0)
+    @current_led = 3
+  end
+  
+  return @current_led
+end
+
+while true
+  c.light_leds(:all, :off)
+  c.light_leds(@current_led, :red)
+
+  move_current_led(1)
+
+  sleep 1
+end