skiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a580f986752329d6966ab3f9b18225aa76cfb316
+  data.tar.gz: 74c19e1e4f327035100376b4ad52b0d83cdacaa4
+SHA512:
+  metadata.gz: 4b6627ef78e3c01e509874e27db17ea4e0fb0f7e7561fafc1c5104fe91fb7b5eb7c750ccc1f6016764a2e311432fd6633b18da87da84596c99b3cc35dbca9c68
+  data.tar.gz: 818fdc37043a9bce29542569cc0552e1fc40124cfb346f8370812f9aa09e48fdf54205380018faabf2f712b6d822dd1aaf50fba4cf0b74caa2aecb6092ff6c5b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,77 @@
+# Skiff
+
+### This is Skiff
+<br>
+
+![image](skiff.png)
+
+
+He's very worried about probes...
+
+```
+Lem: A cork?
+Skiff: It's your best defense against the aliens' favorite form of research. The probe. You put it...
+```
+
+This gem provides a simple interface to a DS18b20 temperature probe, installed on a Raspberry Pi via the One Wire interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skiff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skiff
+
+## Usage
+
+    # Under Raspbian, the temperature readings are typically
+    # written to /sys/bus/w1/devices, so that is the default location.
+    #
+    # If you need to change it, pass your location in when you create
+    # the ::Skiff::Manager like this:
+    # 	manager = ::Skiff::Manager.new your_probe_location
+    
+    manager = ::Skiff::Manager.new
+    
+    # to get a list of all the attached probes:
+    
+    probes = manager.probes
+    
+    # probes => ["28-0115649922ff", "28-021564c24bff"]
+    
+    probe = manager.create_probe(probes.first)
+    
+    # returns an instance of ::Skiff::Probe
+    
+    # to get the raw temperature of a probe:
+    
+    temperature = probe.temperature
+    
+    # or in fahrenheit
+    
+    fahrenheit = probe.fahrenheit
+    
+    # and to get all the raw data
+    
+    raw_data = probe.raw
+    
+## Development
+
+Don't like something?  Need more functionality?
+
+Fork it, write it, create a Pull Request.
+
+Rinse and repeat.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/newellista/skiff.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "skiff"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/skiff/manager.rb

@@ -0,0 +1,16 @@
+module Skiff
+  class Manager
+    def intitialize(base_path = '/sys/bus/w1/devices')
+      @base_path = base_path
+    end
+
+    def probes
+      paths = Dir.glob(File.join(@base_path, "*"))
+      probes = paths.select { |path| path.include?("-") }.map { |path| path.split('/').last.strip }
+    end
+
+    def create_probe(probe_name)
+      ::Skiff::Probe.new(@base_path, probe_name)
+    end
+  end
+end

data/lib/skiff/probe.rb

@@ -0,0 +1,21 @@
+module Skiff
+  class Probe
+    def self.initialize(base_path, name)
+      @full_path_name = File.join([base_path, name, "w1_slave"])
+    end
+
+    def fahrenheit
+      (temperature * 1.8) + 32.0
+    end
+
+    def raw
+      file_contents = File.read(@full_path_name)
+    end
+
+    def temperature
+      temperature_data = raw.split('t=').last
+      temperature =  temperature_data.to_f / 1000
+      return temperature
+    end
+  end
+end

data/lib/skiff/version.rb

@@ -0,0 +1,3 @@
+module Skiff
+  VERSION = "0.1.0"
+end

data/lib/skiff.rb

@@ -0,0 +1,6 @@
+require "skiff/probe"
+require "skiff/manager"
+require "skiff/version"
+
+module Skiff
+end

data/skiff.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skiff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skiff"
+  spec.version       = Skiff::VERSION
+  spec.authors       = ["Steve Newell"]
+  spec.email         = ["newellista@gmail.com"]
+
+  spec.summary       = %q{DS18b20 One-Wire temperature probe reader}
+  spec.description   = %q{DS18b20 One-Wire temperature probe reader.}
+  spec.homepage      = "https://github.com/newellista/skiff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: skiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Newell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: DS18b20 One-Wire temperature probe reader.
+email:
+- newellista@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/skiff.rb
+- lib/skiff/manager.rb
+- lib/skiff/probe.rb
+- lib/skiff/version.rb
+- skiff.gemspec
+- skiff.png
+homepage: https://github.com/newellista/skiff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.8
+signing_key: 
+specification_version: 4
+summary: DS18b20 One-Wire temperature probe reader
+test_files: []