dht11 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b8274fbb226d6dae7fdce8db8fc7da92bcb97cca882e45d68b44099bccd0444
+  data.tar.gz: d17b2ecbfccd406a3d3f04b9a3aa2be9c8ae9f11965f4ef08935ec7f368b2f1b
+SHA512:
+  metadata.gz: 5dd86c4913b85e5f0e6cdfbfe08d51ad4cc8cb1d9f5452809e0a4b629cebb979eca7029ec635daed28a641ca64a7bc433c21bc21062029cef0d85975890476af
+  data.tar.gz: ccf498800bace1ed69451035f82e6350df6022b8524c4fbdffb286b67c74699fca20a0e3b5c537ab1b72d56c9112ff5890e143c4fca4dd4690aa4c99cbe4cb42

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dht11.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rpi_gpio"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,48 @@
+# DHT11
+
+Ruby conversion of [DHT11 Python library](https://github.com/szazo/DHT11_Python) which depends only on [rpi_gpio](https://github.com/ClockVapor/rpi_gpio).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dht11'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dht11
+
+## Usage
+
+```ruby
+require 'dht11'
+
+dht = DHT11::Sensor.new(26)	# BCM numbering
+result = dht.read
+puts "Temperature: #{result.temperature}, Humidity: #{result.humidity}"
+```
+
+You can also try running the binary as:
+
+    $ bundle exec bin/dht11
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tankenta/dht11.
+
+
+## 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 "dht11"
+
+# 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/dht11

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require "dht11"
+require "dht11/app"

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

@@ -0,0 +1,26 @@
+require_relative 'lib/dht11/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dht11"
+  spec.version       = DHT11::VERSION
+  spec.authors       = ["Kenta Hirayama"]
+  spec.email         = ["hkenta112@gmail.com"]
+
+  spec.summary       = %q{Ruby conversion of DHT11 Python library which depends only on rpi_gpio.}
+  spec.homepage      = "https://github.com/tankenta/dht11"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "rpi_gpio"
+end

data/lib/dht11.rb

@@ -0,0 +1,167 @@
+require "rpi_gpio"
+
+require "dht11/version"
+require "dht11/result"
+
+module DHT11
+  module Level
+    HIGH = true
+    LOW = false
+  end
+
+  module State
+    INITIAL_PULL_DOWN = :initial_pull_down
+    INITIAL_PULL_UP = :initial_pull_up
+    DATA_FIRST_PULL_DOWN = :data_first_pull_down
+    DATA_PULL_UP = :data_pull_up
+    DATA_PULL_DOWN = :data_pull_down
+  end
+
+  class Sensor
+    def initialize(pin, tries: 10, interval: 0.1)
+      @pin = pin
+      @tries = tries
+      @interval = interval
+      RPi::GPIO.set_numbering(:bcm)
+    end
+
+    def read
+      @tries.times do 
+        @last_result = read_once
+        return @last_result if @last_result.valid?
+        sleep @interval
+      end
+      @last_result
+    end
+
+    def read_once
+      send_initial_signal
+      raw_inputs = collect_raw_input
+      periods = parse_inputs_into_pull_up_periods(raw_inputs)
+      if periods.length != 40
+        return Result.new(Err::MISSING_DATA, Float::NAN, Float::NAN)
+      end
+      bits = calculate_bits(periods)
+      bytes = bits_to_bytes(bits)
+      checksum = calculate_checksum(bytes)
+      if bytes[4] != checksum
+        return Result.new(Err::CRC, Float::NAN, Float::NAN)
+      end
+
+      temperature = bytes_to_temperature(bytes).to_f
+      humidity = bytes_to_humidity(bytes).to_f
+      Result.new(Err::NO_ERROR, temperature, humidity)
+    end
+
+    private
+
+    def send_and_sleep(output, sleep_second)
+      if output == Level::HIGH
+        RPi::GPIO.set_high(@pin)
+      else
+        RPi::GPIO.set_low(@pin)
+      end
+      sleep sleep_second
+    end
+
+    def send_initial_signal
+      RPi::GPIO.setup(@pin, as: :output)
+      send_and_sleep(Level::HIGH, 0.05)
+      send_and_sleep(Level::LOW, 0.02)
+    end
+
+    def collect_raw_input
+      RPi::GPIO.setup(@pin, as: :input, pull: :up)
+      max_unchanged_count = 100
+      unchanged_count = 0
+      last_input = -1
+      raw_inputs = []
+
+      while unchanged_count < max_unchanged_count
+        current_input = RPi::GPIO.high?(@pin)
+        raw_inputs.push(current_input)
+        if last_input == current_input
+          unchanged_count += 1
+        else
+          unchanged_count = 0
+          last_input = current_input
+        end
+      end
+      raw_inputs
+    end
+
+    def parse_inputs_into_pull_up_periods(raw_inputs)
+      state = State::INITIAL_PULL_DOWN
+      periods = []
+      period = 0
+
+      raw_inputs.each do |input|
+        period += 1
+        case state
+        when State::INITIAL_PULL_DOWN
+          if input == Level::LOW
+            state = State::INITIAL_PULL_UP
+          end
+        when State::INITIAL_PULL_UP
+          if input == Level::HIGH
+            state = State::DATA_FIRST_PULL_DOWN
+          end
+        when State::DATA_FIRST_PULL_DOWN
+          if input == Level::LOW
+            state = State::DATA_PULL_UP
+          end
+        when State::DATA_PULL_UP
+          if input == Level::HIGH
+            period = 0
+            state = State::DATA_PULL_DOWN
+          end
+        when State::DATA_PULL_DOWN
+          if input == Level::LOW
+            periods.push(period)
+            state = State::DATA_PULL_UP
+          end
+        end
+      end
+      return periods
+    end
+
+    def calculate_bits(pull_up_periods)
+      shortest_period = pull_up_periods.min()
+      longest_period = pull_up_periods.max()
+      halfway = shortest_period + (longest_period - shortest_period)/2r
+      bits = []
+      pull_up_periods.each do |period|
+        bit = period > halfway
+        bits.push(bit)
+      end
+      bits
+    end
+
+    def bits_to_bytes(bits)
+      bytes = []
+      byte = 0
+
+      bits.each_with_index do |bit, i|
+        byte = byte << 1
+        byte = byte | (bit ? 1 : 0)
+        if (i + 1) % 8 == 0
+          bytes.push(byte)
+          byte = 0
+        end
+      end
+      bytes
+    end
+
+    def calculate_checksum(bytes)
+      bytes.slice(0..3).sum & 255
+    end
+
+    def bytes_to_temperature(bytes)
+      bytes[2]
+    end
+
+    def bytes_to_humidity(bytes)
+      bytes[0]
+    end
+  end
+end

data/lib/dht11/app.rb

@@ -0,0 +1,16 @@
+module DHT11
+  class App
+    DEFAULT_PIN_BCM = 26
+
+    def run!
+      dht = Sensor.new(DEFAULT_PIN_BCM)
+      loop do
+        result = dht.read
+        puts "Temperature: #{result.temperature}, Humidity: #{result.humidity}"
+        sleep 2
+      end
+    end
+  end
+end
+
+DHT11::App.new.run!

data/lib/dht11/result.rb

@@ -0,0 +1,30 @@
+module DHT11
+  module Err
+    NO_ERROR = :NO_ERROR
+    MISSING_DATA = :MISSING_DATA
+    CRC = :CRC
+  end
+
+  class Result
+    attr_reader :temperature, :humidity, :error_code
+
+    def initialize(error_code, temperature, humidity)
+      @error_code = error_code
+      @temperature = temperature
+      @humidity = humidity
+    end
+
+    def valid?
+      @error_code == Err::NO_ERROR
+    end
+
+    def temperature_f
+      return Float::NAN if @temperature.nan?
+      (@temperature * 9/5) + 32
+    end
+
+    alias_method :temp_f, :temperature_f
+    alias :temp :temperature
+    alias :hum :humidity
+  end
+end

data/lib/dht11/version.rb

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: dht11
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenta Hirayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rpi_gpio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hkenta112@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/dht11
+- bin/setup
+- dht11.gemspec
+- lib/dht11.rb
+- lib/dht11/app.rb
+- lib/dht11/result.rb
+- lib/dht11/version.rb
+homepage: https://github.com/tankenta/dht11
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tankenta/dht11
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby conversion of DHT11 Python library which depends only on rpi_gpio.
+test_files: []