ds18b20 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd777d91d73f1ead320d2aa633a934b517ad424f
+  data.tar.gz: 236c03f35d0c660dcb51fa17e05f3290a2e6a51d
+SHA512:
+  metadata.gz: b83e3c0000f296d1379dc089c5396edc03576bb71c40337e3d8c723ec064365977c9e32482654f616d1cf58d70273b51fb454b4d3c69495c1423a7d23f6665c5
+  data.tar.gz: 72096fa272b2d6094ca35600ac9adadee63f7b86235ba5b9238e1b14e70f5747b230d42d2d560cc7e4474af8c56cda129d4aefc6ea0e4861b4cd06d0dd2dc987

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ds18b20.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ds18b20 (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ds18b20!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Owais
+
+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,46 @@
+NOTE: In Development
+
+[![Build Status](https://travis-ci.org/owaiswiz/ds18b20.svg?branch=master)](https://travis-ci.org/owaiswiz/ds18b20)
+
+# DS18B20
+
+This gem makes interfacing with the DS18B20 temperature easier over 1-Wire.
+
+
+After setting it up correctly make sure you have the correct file path where it's output is being recorded.
+The file name on raspberry pi should be `w1_slave`. If you don't know where the file is located - please read : [DS18B20 - Temperature Sensing](https://learn.adafruit.com/adafruits-raspberry-pi-lesson-11-ds18b20-temperature-sensing?view=all).
+
+
+After making sure that you have the file path and that output looks similar to one in the tutorial above, you can easily use this gem following the instructions below (not yet released - soon).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ds18b20'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ds18b20
+
+## Usage
+
+In-development
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/owaiswiz/ds18b20.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "ds18b20"
+
+# 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(__FILE__)

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/ds18b20.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ds18b20/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ds18b20"
+  spec.version       = Ds18b20::VERSION
+  spec.authors       = ["Owais"]
+  spec.email         = ["owaiswiz@gmail.com"]
+
+  spec.summary       = %q{A Gem to easily interface with the DS18B20 Temperature Sensor Over 1-Wire}
+  spec.homepage      = "https://github.com/owaiswiz/ds18b20.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ds18b20.rb

@@ -0,0 +1,4 @@
+require "ds18b20/version"
+require "ds18b20/parser"
+module Ds18b20
+end

data/lib/ds18b20/exceptions.rb

@@ -0,0 +1,13 @@
+module Ds18b20
+  class InvalidReadingError < StandardError
+    def initialize
+      super("An error occurred while reading the temperature.\nPlease make sure that the DS18B20 sensor is properly installed and you've specified the correct file.")
+    end
+  end
+
+  class InvalidFileSpecifiedError < StandardError
+    def initialize
+      super("An error occured while trying to read the file. Either the file you specified is not correct or the data in the file is not the one that is being expected by this program.\nPlease make sure that the file you specified has the data in a similar manner as this file: https://github.com/owaiswiz/ds18b20/blob/master/spec/support/valid_sample_positive_24_187C")
+    end
+  end
+end

data/lib/ds18b20/parser.rb

@@ -0,0 +1,73 @@
+require 'ds18b20/exceptions'
+module Ds18b20
+  class Parser
+
+    ERROR_READINGS = [85000,127687]
+    MAXIMUM_RETRIES = 5
+
+    def initialize(file_location)
+      @file_location = file_location
+      @retries = 0
+    end
+
+    def get_temperature_celsius
+      get_temperature_from_file
+    end
+
+    def get_temperature_fahrenheit
+      (get_temperature_from_file * 9/5.0) + 32
+    end
+
+    def get_temperature_kelvin
+      get_temperature_from_file + 273.15
+    end
+
+    alias_method :celsius, :get_temperature_celsius
+    alias_method :fahrenheit, :get_temperature_fahrenheit
+    alias_method :kelvin, :get_temperature_kelvin
+
+    private
+    def get_temperature_from_file
+      content = read_file
+      data = content.split("\n")[1].split
+      raw_hex = (data[1][1] + data[0]).hex
+      reading_int = data.last.split("=").last.to_i
+      
+      if ERROR_READINGS.include?(reading_int) || content.include?("crc=00 NO") 
+        raise Ds18b20::InvalidReadingError 
+      end
+
+      if raw_hex < 2048
+        # The result is positive and can be returned 
+        # after dividing by 16      
+        return raw_hex/16.0
+      else
+        # The result is negative and can be returned 
+        # after taking 2's complement and dividing by 16
+        return -(twos_complement(raw_hex)/16.0)
+      end
+
+    rescue Ds18b20::InvalidReadingError
+      if @retries < MAXIMUM_RETRIES
+        @retries += 1
+        sleep 0.1
+        retry
+      else
+        raise Ds18b20::InvalidReadingError
+      end
+    end
+
+    def read_file
+      file = File.read(@file_location)
+      if file && file.include?("t=")
+        return file
+      end
+      raise Ds18b20::InvalidFileSpecifiedError
+    end
+
+    def twos_complement(number)
+      (number ^ ((1<<12) - 1)) + 1
+    end
+  end
+end
+

data/lib/ds18b20/version.rb

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ds18b20
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owais
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ds18b20.gemspec
+- lib/ds18b20.rb
+- lib/ds18b20/exceptions.rb
+- lib/ds18b20/parser.rb
+- lib/ds18b20/version.rb
+homepage: https://github.com/owaiswiz/ds18b20.git
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A Gem to easily interface with the DS18B20 Temperature Sensor Over 1-Wire
+test_files: []