pi_sensor 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,4 @@
+.rvmrc
 *.gem
 *.rbc
 .bundle

data/README.md

@@ -16,9 +16,24 @@ Or install it yourself as:
 
     $ gem install pi_sensor
 
+## A note about pin numbering
+
+Raspberry Pi pin numbering can be confusing. The pin numbers used in this
+library are the wiringPi pin numbers: https://projects.drogon.net/raspberry-pi/wiringpi/pins
+
 ## Usage
 
-TODO: Write usage instructions here
+Here's an example using the [SHT15](https://www.sparkfun.com/products/8257) temperture/humidty sensor.
+Note that you need to run this code as root or with `sudo`:
+
+    require 'wiringpi'
+
+    # Connects Pi physical pin 11 to SCK and Pi physical pin 12 to DATA
+    sensor = PiSensor::SHT15.new :clock => 0, :data => 1
+
+    # And then simply query for the temperature and humidity
+    puts " Temperature: #{sensor.temperature}°C"
+    puts "    Humidity: #{sensor.humidity}%"
 
 ## Contributing
 

data/lib/pi_sensor/version.rb

@@ -1,3 +1,3 @@
 module PiSensor
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/pi_sensor.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["cannikinn@gmail.com"]
   gem.description   = %q{Use Ruby to talk to a bunch of sensors with your Raspberry Pi.}
   gem.summary       = %q{Use Ruby to talk to a bunch of sensors with your Raspberry Pi.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/cannikin/pi_sensor"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pi_sensor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -43,7 +43,7 @@ files:
 - lib/pi_sensor/sht15.rb
 - lib/pi_sensor/version.rb
 - pi_sensor.gemspec
-homepage: ''
+homepage: https://github.com/cannikin/pi_sensor
 licenses: []
 post_install_message: 
 rdoc_options: []