dht_sensor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4195274066348fe61c4ff857135100fc15439aee
+  data.tar.gz: 0d3acc0a87ac1c235dd8f845e3091a410619869b
+SHA512:
+  metadata.gz: 484f98da5da92cb28d3aa43ea5c0d887a8d7df7f9f29fb3bbe4a9dbed006f16338c47e10f2a7e941b0a13edc55e281a105b63b7b42b42fd77011fac07ab3d63b
+  data.tar.gz: df1185ab78faa9deea047ea1356aea2408f2e776adbc632b8fd86eb1cbb84fb5ae45596133a77be74e997b6a27c1fcf2fc61e32dc497d548944633def04b5bfe

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Guest
+
+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,30 @@
+# DhtSensor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dht_sensor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dht_sensor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dht_sensor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Write tests!
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require 'rspec/core/rake_task'
+
+Rake::ExtensionTask.new 'dht_sensor' do |ext|
+  ext.lib_dir = "lib/dht_sensor"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/dht_sensor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dht_sensor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dht_sensor"
+  spec.version       = DhtSensor::VERSION
+  spec.authors       = ["Benjamin Guest"]
+  spec.email         = ["benguest@gmail.com"]
+  spec.summary       = %q{Ruby C extension to use the DHT-XX type humidity/temperature sensors}
+  spec.description   = %q{Ruby C extension to access temperature and humidity reading taken by the DHT-XX type sensors, see (http://www.adafruit.com/products/385)}
+  spec.homepage      = "http://github.com/bguest/dht_sensor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.extensions = %w[ext/dht_sensor/extconf.rb]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake-compiler", "~> 0.9.2"
+  spec.add_development_dependency "rspec",     "~> 2.14"
+  spec.add_development_dependency 'mocha',     "~> 1.0"
+  spec.add_development_dependency "simplecov", "~> 0.8.2"
+  spec.add_development_dependency "rake",      "~> 10.2"
+end

data/example.rb

@@ -0,0 +1,11 @@
+require 'dht_sensor'
+
+sensor = DhtSensor.new(22,4)
+temp, humidity = sensor.to_a
+if temp.between?(-0.0001,0.0001) && humidity.between?(-0.0001,0.0001)
+  puts "Error: DHT22 is stupid"
+  puts "Temp: #{temp}, Humidity:#{humidity}"
+else
+  puts "Temperature = #{temp*9/5+32} °F"
+  puts "Humidity    = #{humidity}%"
+end

data/ext/dht_sensor/dht_sensor.c

@@ -0,0 +1,53 @@
+// Include the Ruby headers and goodies
+#include "ruby.h"
+#include "dhtreader.h"
+
+// Defining a space for information and references about the class to be stored internally
+VALUE DhtSensor = Qnil;
+
+// Prototype for the initialization method - Ruby calls this, not you
+void Init_dht_sensor();
+
+// Prototype for our methods - methods are prefixed by 'method_' here
+VALUE method_initialize(VALUE self, VALUE type, VALUE pin);
+VALUE method_to_a(VALUE self);
+
+// The initialization method for this module
+void Init_dht_sensor() {
+  DhtSensor = rb_define_class("DhtSensor", rb_cObject);
+  rb_define_method(DhtSensor, "initialize", method_initialize, 2);
+  rb_define_method(DhtSensor, "to_a", method_to_a, 0);
+}
+
+VALUE method_initialize(VALUE self, VALUE type, VALUE pin){
+  ID id_type = rb_intern("type");
+  ID id_pin =  rb_intern("pin");
+
+  rb_ivar_set(self, id_type, type);
+  rb_ivar_set(self, id_pin, pin);
+
+  bcm2835_init();
+
+  return self;
+}
+
+VALUE method_to_a(VALUE self){
+  float temp, hum;
+  int type_i, pin_i;
+  VALUE return_array, temperature, humidity;
+
+  ID id_type = rb_intern("type");
+  ID id_pin =  rb_intern("pin");
+
+  type_i = NUM2INT(rb_ivar_get(self, id_type));
+  pin_i  = NUM2INT(rb_ivar_get(self, id_pin));
+
+  readDHT(type_i, pin_i, &temp, &hum);
+
+  return_array = rb_ary_new2(2);
+  temperature = DBL2NUM(temp);
+  humidity    = DBL2NUM(hum);
+  rb_ary_push(return_array, temperature);
+  rb_ary_push(return_array, humidity);
+  return return_array;
+}

data/ext/dht_sensor/dhtreader.c

@@ -0,0 +1,108 @@
+/*  Python module for DHT temperature/humidity sensors
+ *
+ *  Modified by Qingping Hou from DHT reader example, original header:
+ *
+ *  How to access GPIO registers from C-code on the Raspberry-Pi
+ *  Example program
+ *  15-January-2012
+ *  Dom and Gert
+ */
+#define _BSD_SOURCE // for usleep
+
+#define MAXTIMINGS 100
+
+//#define DEBUG
+
+#define DHT11 11
+#define DHT22 22
+#define AM2302 22
+
+#include "dhtreader.h"
+
+int readDHT(int type, int pin, float *temp_p, float *hum_p)
+{
+	int counter = 0;
+	int laststate = HIGH;
+	int i = 0;
+	int j = 0;
+	int checksum = 0;
+#ifdef DEBUG
+	int bitidx = 0;
+	int bits[250];
+#endif
+	int data[100];
+
+	// Set GPIO pin to output
+	bcm2835_gpio_fsel(pin, BCM2835_GPIO_FSEL_OUTP);
+
+	bcm2835_gpio_write(pin, HIGH);
+	usleep(500000);  // 500 ms
+	bcm2835_gpio_write(pin, LOW);
+	usleep(20000);
+
+	bcm2835_gpio_fsel(pin, BCM2835_GPIO_FSEL_INPT);
+
+	data[0] = data[1] = data[2] = data[3] = data[4] = 0;
+
+	// wait for pin to drop?
+	while (bcm2835_gpio_lev(pin) == 1) {
+		usleep(1);
+	}
+
+	// read data!
+	for (i = 0; i < MAXTIMINGS; i++) {
+		counter = 0;
+		while ( bcm2835_gpio_lev(pin) == laststate) {
+			counter++;
+			//nanosleep(1);		// overclocking might change this?
+			if (counter == 1000)
+				break;
+		}
+		laststate = bcm2835_gpio_lev(pin);
+		if (counter == 1000) break;
+#ifdef DEBUG
+		bits[bitidx++] = counter;
+#endif
+
+		if ((i>3) && (i%2 == 0)) {
+			// shove each bit into the storage bytes
+			data[j/8] <<= 1;
+			if (counter > 200)
+				data[j/8] |= 1;
+			j++;
+		}
+	}
+
+#ifdef DEBUG
+	for (int ii=3; ii<bitidx; ii+=2) {
+		printf("bit %d: %d\n", ii-3, bits[ii]);
+		printf("bit %d: %d (%d)\n", ii-2, bits[ii+1], bits[ii+1] > 200);
+	}
+	printf("Data (%d): 0x%x 0x%x 0x%x 0x%x 0x%x\n", j, data[0], data[1], data[2], data[3], data[4]);
+#endif
+
+	if (j >= 39) {
+		checksum = (data[0] + data[1] + data[2] + data[3]) & 0xFF;
+		if (data[4] == checksum) {
+			/* yay! checksum is valid */
+			if (type == DHT11) {
+				/*printf("Temp = %d *C, Hum = %d \%\n", data[2], data[0]);*/
+				*temp_p = (float)data[2];
+				*hum_p = (float)data[0];
+			} else if (type == DHT22) {
+				*hum_p = data[0] * 256 + data[1];
+				*hum_p /= 10;
+
+				*temp_p = (data[2] & 0x7F)* 256 + data[3];
+				*temp_p /= 10.0;
+				if (data[2] & 0x80)
+					*temp_p *= -1;
+				/*printf("Temp =  %.1f *C, Hum = %.1f \%\n", f, h);*/
+			}
+			return 0;
+		}
+		return -2;
+	}
+
+	return -1;
+}

data/ext/dht_sensor/dhtreader.h

@@ -0,0 +1,21 @@
+
+/* for usleep */
+//#define _BSD_SOURCE
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <dirent.h>
+#include <fcntl.h>
+#include <assert.h>
+#include <unistd.h>
+#include <sys/mman.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <bcm2835.h>
+#include <unistd.h>
+
+int readDHT(int type, int pin, float *temp_p, float *hum_p);
+int readDHT2(int type, int pin, float *temp_p, float *hum_p);
+

data/ext/dht_sensor/extconf.rb

@@ -0,0 +1,55 @@
+# Loads mkmf which is used to make makefiles for Ruby extensions
+require 'mkmf'
+
+# Load Libraries
+
+LIBDIR      = RbConfig::CONFIG['libdir']
+INCLUDEDIR  = RbConfig::CONFIG['includedir']
+
+HEADER_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/include',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/include',
+
+  # Check the ruby install locations
+  INCLUDEDIR,
+
+  # Finally fall back to /usr
+  '/usr/include',
+]
+
+LIB_DIRS = [
+  # First search /opt/local for macports
+  '/opt/local/lib',
+
+  # Then search /usr/local for people that installed from source
+  '/usr/local/lib',
+
+  # Check the ruby install locations
+  LIBDIR,
+
+  # Finally fall back to /usr
+  '/usr/lib',
+]
+unless find_header('bcm2835.h')
+  abort 'bcm2835 is missing'
+end
+
+unless have_library('bcm2835') && append_library($libs, 'bcm2835')
+  abort "Can't Appended Library bcm2835!"
+end
+
+dir_config('bcm2835', HEADER_DIRS, LIB_DIRS)
+
+$CFLAGS << ' -std=c99'
+
+# Give it a name
+#extension_name = 'dht_sensor'
+
+# The destination
+#dir_config(extension_name)
+
+# Do the work
+create_makefile("dht_sensor/dht_sensor")

data/lib/dht_sensor/dht_stub.rb

@@ -0,0 +1,29 @@
+class DhtStub
+  class NullLogger
+    def debug(*) end
+  end
+
+  # Note: #type and #pin are not yet available on the dth_sensor class
+  attr_reader :type, :pin
+
+  def initialize(type, pin, logger: NullLogger.new)
+    @type = type
+    logger.debug "DHT Type --> #{type}"
+
+    @pin = pin
+    logger.debug "DHT Pin  --> #{pin}"
+
+    @temperature = 42.0
+    @humidity = 69.0
+
+    self
+  end
+
+  def to_a
+    [@temperature, @humidity]
+  end
+
+  private
+
+  attr_writer :humidity, :temperature
+end

data/lib/dht_sensor/version.rb

@@ -0,0 +1,3 @@
+class DhtSensor
+  VERSION = "0.0.1"
+end

data/lib/dht_sensor.rb

@@ -0,0 +1,6 @@
+require "dht_sensor/version"
+require "dht_sensor/dht_sensor"
+
+#module DhtSensor
+  ## Your code goes here...
+#end

data/spec/dht_stub_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe DhtStub do
+
+  let(:dht_stub){DhtStub.new(22,4)}
+
+  before do
+    @logger = double()
+  end
+
+  describe '#new' do
+
+    it 'should set type and pin' do
+      dht_stub.type.should == 22
+      dht_stub.pin.should == 4
+    end
+
+    it 'should log that pin and type are set' do
+      @logger.expects(:debug).with('DHT Type --> 42')
+      @logger.expects(:debug).with('DHT Pin  --> 3')
+      DhtStub.new(42,3, logger: @logger)
+    end
+  end
+
+  describe '#to_a' do
+    it 'should respond with a temperature humidity array' do
+     dht_stub.send(:humidity=,34)
+     dht_stub.send(:temperature=,40)
+
+     arry = dht_stub.to_a
+     arry[0].should be_within(0.001).of(40)
+     arry[1].should be_within(0.001).of(34)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start
+require 'dht_sensor/dht_stub'
+require 'rspec'
+require 'mocha/api'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: dht_sensor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Guest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+description: Ruby C extension to access temperature and humidity reading taken by
+  the DHT-XX type sensors, see (http://www.adafruit.com/products/385)
+email:
+- benguest@gmail.com
+executables: []
+extensions:
+- ext/dht_sensor/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dht_sensor.gemspec
+- example.rb
+- ext/dht_sensor/dht_sensor.c
+- ext/dht_sensor/dhtreader.c
+- ext/dht_sensor/dhtreader.h
+- ext/dht_sensor/extconf.rb
+- lib/dht_sensor.rb
+- lib/dht_sensor/dht_stub.rb
+- lib/dht_sensor/version.rb
+- spec/dht_stub_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/bguest/dht_sensor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby C extension to use the DHT-XX type humidity/temperature sensors
+test_files:
+- spec/dht_stub_spec.rb
+- spec/spec_helper.rb