sysfs_one_wire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 767be903b9b0f5499c7b176faf0105e154e4facf
+  data.tar.gz: 157afd2037881682e55fedad30c3248d5765b836
+SHA512:
+  metadata.gz: 722a00b944df3a8af7baf2d4e11d4f7b80cdcc785aa6226312ad99e68158aa59176dadd5cf00a5348875fff2c57e0c4e081e7c022720fafb92da0df4a4ca051c
+  data.tar.gz: e37922e67092d604818fe1ea5c4f980edfccadec55f4c1903651c65fb620d2763e34418cefb613d90db0fa8a7f07ca8b71505f3bea2db73a206bb7e023c9df1f

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2014 ASAPP SARL <opensource@asapp.fr>
+
+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,75 @@
+# One Wire
+This is a ruby gem offering binding to w1-gpio kernel module.
+
+GPIO w1 bus master driver by Ville Syrjala <syrjala@sci.fi>
+
+## Installation
+`w1-gpio` module should be loaded, 
+```
+modprobe w1-gpio
+```
+
+depending on the device you want to control load one of these.
+```
+modprobe -a w1_bq27000 w1_ds2413 w1_ds2431 w1_ds2760 w1_ds2781 w1_therm w1_ds2408 w1_ds2423 w1_ds2433 w1_ds2780 w1_ds28e04 w1_smem 
+```
+and of course
+```ruby
+gem 'sysfs_one_wire'
+#or 
+gem install sysfs_one_wire
+```
+
+for loading after reboot and depending on your OS you could try following commands
+
+### Debian/Raspian/Ubuntu
+```
+/etc/modules.conf
+/etc/modprobe.d/modeprobe.conf
+/etc/modprobe.d/
+```
+
+### Raspian
+You will also need to activate the device tree : 
+```
+cat 'dtoverlay=w1-gpio' > /boot/config.txt
+```
+
+## Usage
+```ruby
+	OneWire.slaves # return the paths of the slaves
+	OneWire.find(/2GAE/) # return the paths of corresponding slave.
+
+	OneWire.load(path) # return the devices objects for a given path
+	OneWire.devices # return all the devices objects
+```
+
+### Extend
+```ruby
+class Mermory < OneWire::Base
+
+  PREFIX = %w{06 08 0A 0C}
+  attr_reader :last_value
+
+  def value
+    @last_value = @value
+    @value = w1_slave[/some regexp to isolate the content/, 1]
+  end
+
+  def value= arg
+   @last_value = @value
+   File.write(File.join(@path.to_s, 'w1_slave'), arg)
+  end
+end
+```
+
+## Limitation/Alternative
+This is a work in progress. It only support thermometer for now, but will be extented (and this is quite easy to do it)
+
+If you need more, Maxim's Integrated offers a whole filesystem with OWFS
+
+[https://github.com/mholling/one_wire]
+[https://github.com/pedrocr/ownet]
+
+
+**Need this? come and give a hand !**

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require 'one_wire'
+
+require 'irb'
+require 'irb/completion'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/one_wire.rb

@@ -0,0 +1,61 @@
+require 'one_wire/base'
+require 'one_wire/thermometer'
+
+module OneWire
+  class << self
+    def slaves &block
+      Dir.glob(File.join(File::SEPARATOR, 'sys', 'bus', 'w1', 'devices', '*-*'), &block)
+    end
+
+    def find query
+      query = Regexp.new query if query.is_a? String
+      slaves.keep_if { |v| v =~ query }
+    end
+
+    # def find query, &block
+    #   devices = slaves.keep_if { |v| v =~ query }
+    #   devices = devices.collect { |path| load(path) }
+    #   devices.each &block if block_given?
+    #   devices      
+    # end
+
+    def all &block
+      devices = slaves.collect { |path| load(path) rescue nil }.compact
+      devices.each &block if block_given?
+      devices
+    end
+
+    # def find_by_type
+    # end
+
+    # def find_by_id
+    # end
+
+    # def find_by_name
+    # end
+
+    def load path
+      case File.basename(path)[/([\da-f]{2})-[\da-f]{12}/, 1]
+        when *Thermometer::PREFIX then return Thermometer.new(path)
+      #   when *%w{06 08 0A 0C} then Memory.new(path)
+        when %{00} then return nil
+        else Base.new(path)
+      end
+    end
+
+    def devices
+      slaves.collect { |path| load(path) }
+    end
+  end
+end
+
+# Maxim's Integrated devices types :
+# Identification only
+# Identification plus control
+# Identification plus temperature
+# Identification plus time
+# Identification plus NV SRAM
+# Identification plus (one time programmable) OTP EPROM
+# Identification plus EEPROM
+# Identification plus SHA-1 secure EEPROM
+# Identification plus logging

data/lib/one_wire/base.rb

@@ -0,0 +1,41 @@
+module OneWire
+  class Base
+    attr_reader :path
+
+    def initialize path = nil
+      @path = path
+    end
+
+    def name
+      read_attr 'name'
+    end
+
+    def id
+      read_attr 'id'
+    end
+
+    def w1_slave
+      read_attr 'w1_slave'
+    end
+
+    alias_method :to_s, :w1_slave
+
+    def value *args
+      raise NotImplementedError
+    end
+
+    def last_value *args
+      raise NotImplementedError
+    end
+
+    def dump
+      [self.class, @path]
+    end
+    
+    private
+
+    def read_attr value
+      File.read(File.join(@path.to_s, value)).chomp('')
+    end
+  end
+end

data/lib/one_wire/thermometer.rb

@@ -0,0 +1,13 @@
+module OneWire
+  class Thermometer < Base
+    
+    PREFIX = %w{10 22 28 3B}
+
+    attr_reader :last_value
+
+    def value
+      @last_value = @value
+      @value = w1_slave[/t=(\d*)/, 1].to_f / 1000
+    end
+  end
+end

data/one_wire.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name = "sysfs_one_wire"
+  spec.version = '0.1.0'
+
+  spec.authors = ["as:app worker"]
+  spec.summary = %q{asapp_gem}
+  spec.description = %q{Maxim's 1-wire binding backed on w1-gpio driver}
+  spec.email = %q{opensource@asapp.fr}
+  spec.license = "MIT"
+  spec.homepage = %q{https://github.com/asapp/one_wire}
+
+  spec.files = `git ls-files`.split($\)
+  spec.require_paths = ["lib"]
+
+  spec.extra_rdoc_files = Dir['*.md']
+  spec.rdoc_options = ["--charset=UTF-8"]
+  
+  spec.add_development_dependency  'rake'
+  spec.add_development_dependency  'rspec'
+  spec.add_development_dependency  'rdoc'
+end

data/spec/base_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe OneWire do
+  before do 
+    allow(File).to receive(:join).and_call_original
+    allow(File).to receive(:join).with(File::SEPARATOR, 'sys', 'bus', 'w1', 'devices', '*-*').and_return(File.expand_path "#{__dir__}/fixtures/sys_bus_w1_devices/*-*")
+  end
+
+  it { expect(subject.slaves).to all( match /fixtures\/sys_bus_w1_devices\/.{2}-.{12}/ ) }
+
+  it { expect(subject.find "00-").to all( match "00-" ) }
+  it { expect(subject.find "00-").to all( match /00-/ ) }
+  it { expect(subject.find /00-/).to all( match "00-" ) }
+  it { expect(subject.find /00-/).to all( match /00-/ ) }
+  it { expect(subject.find(/00-/).first).to match /fixtures\/sys_bus_w1_devices\/0{2}-0{12}/ }
+
+  it { expect(subject.load(subject.find(/00-/).first)).to be_nil}
+  it { expect(subject.load(subject.find(/28-/).first)).to be_kind_of OneWire::Thermometer}
+
+  it { expect(subject.all).to all(be_kind_of(OneWire::Base))}
+
+  describe OneWire::Base do
+    it { is_expected.to be_kind_of OneWire::Base }
+    it { expect{ subject.name }.to raise_error Errno::ENOENT }
+    
+    let(:empty_device) {OneWire::Base.new(OneWire.find(/00-/).first)}
+    it { expect(empty_device.name).to eq "00-000000000000" }
+    xit { expect(empty_device.id).to eq "" } # don't know how to read `id` file
+    it { expect(empty_device.w1_slave).to eq "empty device" }
+
+    it { expect { empty_device.value }.to raise_error(NotImplementedError) }
+    it { expect { empty_device.last_value }.to raise_error(NotImplementedError) }
+  end
+
+  describe OneWire::Thermometer do    
+    subject {OneWire::Thermometer.new(OneWire.find(/-000000000003/).first)}
+
+    it { is_expected.to be_kind_of OneWire::Thermometer }
+    it { expect(subject.name).to eq "28-000000000003" }
+    xit { expect(subject.id).to eq "" } # don't know how to read `id` file
+    it { expect(subject.w1_slave).to eq "9f 01 4b 46 7f ff 01 10 40 : crc=40 YES\n9f 01 4b 46 7f ff 01 10 40 t=25937" }
+    
+    it { expect(subject.value).to eq 25.937 }
+
+    it "should update the last value" do 
+      expect(subject.last_value).to be_nil
+      subject.value
+      expect(subject.last_value).to be_nil
+      subject.value
+      expect(subject.last_value).to eq 25.937
+    end
+  end
+end

data/spec/fixtures/sys_bus_w1_devices/00-000000000000/name

@@ -0,0 +1 @@
+00-000000000000

data/spec/fixtures/sys_bus_w1_devices/00-000000000000/w1_slave

@@ -0,0 +1,2 @@
+empty device
+

data/spec/fixtures/sys_bus_w1_devices/08-000000000004/name

@@ -0,0 +1 @@
+08-000000000004

data/spec/fixtures/sys_bus_w1_devices/08-000000000004/w1_slave

@@ -0,0 +1,2 @@
+don't know device
+

data/spec/fixtures/sys_bus_w1_devices/28-000000000001/name

@@ -0,0 +1 @@
+28-000000000001

data/spec/fixtures/sys_bus_w1_devices/28-000000000001/w1_slave

@@ -0,0 +1,2 @@
+3b 01 4b 46 7f ff 05 10 54 : crc=54 YES
+3b 01 4b 46 7f ff 05 10 54 t=19687

data/spec/fixtures/sys_bus_w1_devices/28-000000000002/name

@@ -0,0 +1 @@
+28-000000000002

data/spec/fixtures/sys_bus_w1_devices/28-000000000002/w1_slave

@@ -0,0 +1,2 @@
+3c 01 4b 46 7f ff 04 10 40 : crc=40 YES
+3c 01 4b 46 7f ff 04 10 40 t=19750

data/spec/fixtures/sys_bus_w1_devices/28-000000000003/name

@@ -0,0 +1 @@
+28-000000000003

data/spec/fixtures/sys_bus_w1_devices/28-000000000003/w1_slave

@@ -0,0 +1,3 @@
+9f 01 4b 46 7f ff 01 10 40 : crc=40 YES
+9f 01 4b 46 7f ff 01 10 40 t=25937
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'one_wire'
+
+fixtures_path = "#{File.dirname(__FILE__)}/../fixtures/sys_bus_w1_devices/"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: sysfs_one_wire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- as:app worker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Maxim's 1-wire binding backed on w1-gpio driver
+email: opensource@asapp.fr
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/one_wire.rb
+- lib/one_wire/base.rb
+- lib/one_wire/thermometer.rb
+- one_wire.gemspec
+- spec/base_spec.rb
+- spec/fixtures/sys_bus_w1_devices/00-000000000000/name
+- spec/fixtures/sys_bus_w1_devices/00-000000000000/w1_slave
+- spec/fixtures/sys_bus_w1_devices/08-000000000004/name
+- spec/fixtures/sys_bus_w1_devices/08-000000000004/w1_slave
+- spec/fixtures/sys_bus_w1_devices/28-000000000001/name
+- spec/fixtures/sys_bus_w1_devices/28-000000000001/w1_slave
+- spec/fixtures/sys_bus_w1_devices/28-000000000002/name
+- spec/fixtures/sys_bus_w1_devices/28-000000000002/w1_slave
+- spec/fixtures/sys_bus_w1_devices/28-000000000003/name
+- spec/fixtures/sys_bus_w1_devices/28-000000000003/w1_slave
+- spec/spec_helper.rb
+homepage: https://github.com/asapp/one_wire
+licenses:
+- MIT
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: asapp_gem
+test_files: []