mholling-one_wire 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matthew Hollingworth
+
+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,7 @@
+= one_wire
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Matthew Hollingworth. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "one_wire"
+    gem.summary = %Q{Ruby library for talking to a one-wire server (see http://owfs.org)}
+    gem.email = "mdholling@gmail.com"
+    gem.homepage = "http://github.com/mholling/one_wire"
+    gem.authors = ["Matthew Hollingworth"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = false
+end
+
+
+task :default => :spec
+
+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 = "one_wire #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/one_wire.rb

@@ -0,0 +1,9 @@
+require 'one_wire/retry'
+require 'one_wire/constants'
+require 'one_wire/config'
+require 'one_wire/exceptions'
+require 'one_wire/request'
+require 'one_wire/response'
+require 'one_wire/transaction'
+require 'one_wire/directory'
+require 'one_wire/device'

data/lib/one_wire/config.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+
+module OneWire
+  Config = Struct.new(:host, :port, :units, :retries, :retry_interval, :dirall) do
+    include Singleton
+    
+    def self.method_missing(*args)
+      instance.send(*args)
+    end
+    
+    self.host  = "localhost"
+    self.port  = 4304
+    self.units = :celsius
+    self.retries = { "EINVAL" => 100, "ENOENT" => 10 }
+    self.retry_interval = 0.2
+    self.dirall = true
+  end
+end

data/lib/one_wire/constants.rb

@@ -0,0 +1,18 @@
+module OneWire
+  module Constants
+    module Functions
+      READ     = 2
+      WRITE    = 3
+      DIR      = 4
+      PRESENCE  = 6
+      DIRALL   = 7
+    end
+  
+    module Units
+      CELSIUS = 0x00000000
+      FARENHEIT = 0x00010000
+      KELVIN = 0x00020000
+      RANKINE = 0x00030000
+    end
+  end
+end

data/lib/one_wire/device.rb

@@ -0,0 +1,30 @@
+module OneWire
+  class Device
+    include Retry
+  
+    def initialize(address, options = {})
+      @options = options
+      @path = options[:uncached] ? "/uncached/#{address}" : "/#{address}"
+      @path.squeeze!("/")
+    end
+    
+    def present?
+      Transaction.presence(@path, @options)
+      true
+    rescue Errno::ENOENT
+      false
+    end
+    
+    def read(attribute)
+      with_retry { Transaction.read("#{@path}/#{attribute}").response.data || raise(BadRead) }
+    end
+    
+    def write(attribute, value)
+      with_retry { Transaction.write("#{@path}/#{attribute}", value) }
+    end
+    
+    def dir
+      Directory.new(@path)
+    end
+  end
+end

data/lib/one_wire/directory.rb

@@ -0,0 +1,50 @@
+module OneWire
+  class Directory
+    include Retry
+    # include Enumerable
+    
+    def initialize(path, options = {})
+      @path = path
+      dirall = options.has_key?(:dir_all) ? options[:dirall] : Config.dirall
+      @entries = dirall ?
+        with_retry { Transaction.dirall(path) }.response.data.split(",") :
+        with_retry { Transaction.dir(path) }.response.map { |r| r.data }
+    end
+    
+    def directories
+      @directories ||= @entries.collect do |entry|
+        begin
+          Directory.new(entry)
+        rescue Errno::ENOTDIR
+          nil
+        end
+      end.compact
+    end
+    
+    def members
+      @members ||= @entries - directories.map { |directory| directory.path }
+    end
+    
+    attr_reader :path
+    
+    def ls
+      [ "+ " + @path.split("/").last.to_s ] +
+      members.map { |member| "  . " + member.split("/").last } +
+      directories.map { |directory| "  - " + directory.path.split("/").last }
+    end
+    
+    def tree
+      [ "+ " + @path.split("/").last.to_s ] +
+      members.map { |member| "  . " + member.split("/").last } +
+      directories.map { |directory| directory.tree.map { |line| "  #{line}"} }.flatten
+    end
+    
+    def to_s
+      ls.join("\n")
+    end
+    
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/one_wire/exceptions.rb

@@ -0,0 +1,13 @@
+module OneWire
+  class ShortRead < RuntimeError
+    def message
+      "OWServer: short read"
+    end
+  end
+
+  class BadRead < RuntimeError
+    def message
+      "OWServer: bad read"
+    end
+  end
+end

data/lib/one_wire/request.rb

@@ -0,0 +1,27 @@
+module OneWire
+  class Request
+    include OneWire::Constants::Functions
+    def initialize(socket, type, path, options = {})
+      version = 0
+      payload = path + "\000"
+      case type
+      when :dir
+        request_type, data_size = DIR, 0
+      when :dirall
+        request_type, data_size = DIRALL, 0
+      when :read
+        request_type, data_size = READ, 8192
+      when :write
+        request_type, data_size = WRITE, options[:value].size
+        payload << options[:value] << "\000"
+      when :presence
+        request_type, data_size = PRESENCE, 0
+      end
+      flags = 0x05000000 | 0x00000002 | Constants::Units.const_get((options[:units] || Config.units).to_s.upcase)
+      offset = 0
+      header = [ version, payload.size, request_type, flags, data_size, offset ].pack("NNNNNN")
+
+      socket.write(header + payload)
+    end
+  end
+end

data/lib/one_wire/response.rb

@@ -0,0 +1,15 @@
+module OneWire
+  class Response
+    def initialize(socket)
+      header = socket.read(24)
+      raise ShortRead unless header && header.size == 24
+      version, payload_size, @return_value, @flags, data_size, offset = header.unpack('NNNNNN')
+      raise SystemCallError, 2**32 - @return_value, "OWServer" if @return_value > 2**31
+      raise BadRead if payload_size > 2**31 || data_size > 2**31
+      @data = socket.read(payload_size)[0...data_size] unless payload_size.zero?
+      # @data = payload_size.zero? ? "" : socket.read(payload_size)[0...data_size]
+    end
+    
+    attr_reader :data, :return_value, :flags
+  end
+end

data/lib/one_wire/retry.rb

@@ -0,0 +1,14 @@
+module OneWire
+  module Retry
+    def with_retry
+      errors_counts = Config.retries.map { |err, count| { Errno::const_get(err) => count } }.inject { |hash, h| hash.merge h }
+      begin
+        yield
+      rescue *(errors_counts.map { |error, count| error if count > 0 }.compact) => e
+        errors_counts[e.class] -= 1
+        sleep Config.retry_interval
+        retry
+      end
+    end
+  end
+end

data/lib/one_wire/transaction.rb

@@ -0,0 +1,38 @@
+require 'socket'
+
+module OneWire
+  class Transaction
+    attr_reader :response
+    
+    def initialize(type, path, options = {})
+      host = options[:host] || OneWire::Config.host
+      port = options[:port] || OneWire::Config.port
+      socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+      socket.connect(Socket.pack_sockaddr_in(port, host))
+      OneWire::Request.new(socket, type, path, options)
+      if type == :dir
+        @response = []
+        while true do
+          response = OneWire::Response.new(socket)
+          response.data ? @response << response : break
+        end
+      else
+        @response = OneWire::Response.new(socket)
+      end
+    ensure
+      socket.close if socket && !socket.closed?
+    end
+  
+    class << self
+      [ :dir, :dirall, :read, :presence ].each do |method|
+        define_method method do |path, *args|
+          new(method, path, *args)
+        end
+      end
+      
+      def write(path, value, options = {})
+        new(:write, path, options.merge(:value => value))
+      end
+    end
+  end
+end

data/spec/one_wire_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "Owclient" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'one_wire'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: mholling-one_wire
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Hollingworth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mdholling@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/one_wire.rb
+- lib/one_wire/config.rb
+- lib/one_wire/constants.rb
+- lib/one_wire/device.rb
+- lib/one_wire/directory.rb
+- lib/one_wire/exceptions.rb
+- lib/one_wire/request.rb
+- lib/one_wire/response.rb
+- lib/one_wire/retry.rb
+- lib/one_wire/transaction.rb
+- spec/one_wire_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/mholling/one_wire
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library for talking to a one-wire server (see http://owfs.org)
+test_files: 
+- spec/one_wire_spec.rb
+- spec/spec_helper.rb