onewire 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in onewire.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexey Noskov
+
+MIT License
+
+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.md

@@ -0,0 +1,61 @@
+# Onewire
+
+It's simple Ruby client for OWFS [owserver](http://owfs.org/index.php?page=owserver_protocol)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onewire'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onewire
+
+## Basic usage
+
+Create client like:
+
+    require 'onewire'
+    client = Onewire.client
+
+You may specify optional host/port like this:
+
+    Onewire.client 'localhost', 4304
+
+Then, you may list OWFS directories:
+
+    client.dir('/')
+    => ["/10.67C6697351FF", "/05.4AEC29CDBAAB", "/bus.0", "/uncached", "/settings", "/system", "/statistics", "/structure", "/simultaneous", "/alarm"]
+
+And read values:
+
+    client.read('/10.67C6697351FF/temperature')
+    => 24.2887
+
+Or even write them:
+
+    client.write('/10.67C6697351FF/alias','somealias')
+    => nil
+    c.read('/10.67C6697351FF/alias')
+    => "somealias"
+
+## Scopes
+
+To simplify some operations _scopes_ are available. Scopes provide client-like interface, but where all path arguments are relative to some node. For example:
+
+    scope = client.scope('/10.67C6697351FF')
+    scope.read('temperature')
+    => 24.2887
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/onewire.rb

@@ -0,0 +1,10 @@
+require 'onewire/version'
+require 'onewire/client'
+
+module Onewire
+
+  def self.client(*args)
+    Client.new(*args)
+  end
+
+end

data/lib/onewire/client.rb

@@ -0,0 +1,74 @@
+require 'onewire/connection'
+require 'onewire/scope'
+
+module Onewire
+  class Client
+
+    class Error < StandardError; end
+
+    ERROR = 0
+    NOP = 1
+    READ = 2
+    WRITE = 3
+    DIR = 4
+    SIZE = 5
+    PRESENCE = 6
+
+    def initialize(host = 'localhost', port = 4304)
+      @host, @port = host, port
+    end
+
+    def dir(path = '')
+      interact do |c|
+        c.write DIR, "#{normalize path}\0", 8192
+
+        res = []
+
+        while dir = c.read
+          res << dir
+        end
+
+        res
+      end
+    end
+
+    def read(path)
+      interact do |c|
+        c.write READ, "#{normalize path}\0", 8192 # Default value size to read
+        typecast c.read
+      end
+    end
+
+    def write(path, value)
+      interact do |c|
+        c.write WRITE, "#{normalize path}\0#{value}\0", value.size
+        c.read
+      end
+    end
+
+    def scope(path = '')
+      Onewire::Scope.new self, path
+    end
+
+    private
+
+    def normalize(path)
+      path.gsub(/\A(?!\/)|\/{2,}/,'/')
+    end
+
+    def typecast(val)
+      Float(val) rescue val
+    end
+
+    def interact
+      conn = Connection.new(@host, @port)
+
+      begin
+        yield conn
+      ensure
+        conn.close
+      end
+    end
+
+  end
+end

data/lib/onewire/connection.rb

@@ -0,0 +1,50 @@
+require 'socket'
+
+module Onewire
+  class Connection
+
+    PING = 4294967295 # -1 as unsigned int
+
+    def initialize(host = 'localhost', port = 4304)
+      @socket = TCPSocket.new host, port
+    end
+
+    def close
+      @socket.close
+    end
+
+    def write(type, payload, size = 0, offset = 0)
+      request_fields = [version, payload.size, type, flags, size, offset, payload] # Prepare request structure (see http://owfs.org/index.php?page=owserver-protocol)
+      request_data = request_fields.pack('NNNNNNA*') # Pack it - first six parts are integers, payload is string
+
+      @socket.write request_data # Send it
+    end
+
+    def read
+      _, payload_size, _, _, size, offset = read_header
+
+      if payload_size > 0
+        @socket.read(payload_size)[offset..offset+size-1] # Read response payload
+      else
+        nil
+      end
+    end
+
+    def read_header
+      loop do
+        header = @socket.read(24).unpack('NNNNNN') # Read and unpack response header (see http://owfs.org/index.php?page=owserver-protocol)
+        return header if header[1] != PING # Return when non-ping response read
+      end
+    end
+
+    def flags
+      258 # TODO
+    end
+
+    def version
+      0
+    end
+
+  end
+
+end

data/lib/onewire/scope.rb

@@ -0,0 +1,27 @@
+require 'onewire/connection'
+
+module Onewire
+  class Scope
+
+    DELEGATED_METHODS = %q{dir read write scope}
+
+    def initialize(client, path)
+      @client, @path = client, path
+    end
+
+    def method_missing(name, *args, &block)
+      if DELEGATED_METHODS.include? name.to_s
+        path = "#{@path}/#{args.shift}" # Update path
+
+        @client.send name, path, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      DELEGATED_METHODS.include? name.to_s
+    end
+
+  end
+end

data/lib/onewire/version.rb

@@ -0,0 +1,3 @@
+module Onewire
+  VERSION = "0.0.1"
+end

data/onewire.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onewire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onewire"
+  spec.version       = Onewire::VERSION
+  spec.authors       = ["Alexey Noskov"]
+  spec.email         = ["alexey.noskov@gmail.com"]
+  spec.description   = %q{Simple client for owserver}
+  spec.summary       = %q{Simple client for owserver}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: onewire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Noskov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple client for owserver
+email:
+- alexey.noskov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onewire.rb
+- lib/onewire/client.rb
+- lib/onewire/connection.rb
+- lib/onewire/scope.rb
+- lib/onewire/version.rb
+- onewire.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2165025040075908644
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2165025040075908644
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple client for owserver
+test_files: []