RubyGems - raspberry_pi_iot - Versions diffs - 0.0.6 - Mend

raspberry_pi_iot 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

checksums.yaml +7 -0
data/doc/Actuator.html +145 -0
data/doc/BH1750.html +535 -0
data/doc/BME280.html +276 -0
data/doc/BMP280.html +276 -0
data/doc/BMxSensor.html +559 -0
data/doc/BinaryActuator.html +177 -0
data/doc/BinaryEffector.html +246 -0
data/doc/BinaryReceptor.html +387 -0
data/doc/BinarySensor.html +168 -0
data/doc/Bus.html +126 -0
data/doc/Button.html +986 -0
data/doc/DHT11.html +287 -0
data/doc/DHT22.html +287 -0
data/doc/DHTxxSensor.html +361 -0
data/doc/DS18B20.html +339 -0
data/doc/DigitalActuator.html +164 -0
data/doc/DigitalEffector.html +636 -0
data/doc/DigitalReceptor.html +242 -0
data/doc/DigitalSensor.html +162 -0
data/doc/Effector.html +257 -0
data/doc/HCSR501.html +172 -0
data/doc/HumitureSensor.html +453 -0
data/doc/IoT.html +116 -0
data/doc/LED.html +784 -0
data/doc/MAX44009.html +830 -0
data/doc/RaspberryPi.html +309 -0
data/doc/Receptor.html +257 -0
data/doc/Sensor.html +145 -0
data/doc/TemperatureSensor.html +644 -0
data/doc/_index.html +379 -0
data/doc/class_list.html +51 -0
data/doc/file_list.html +51 -0
data/doc/frames.html +17 -0
data/doc/index.html +379 -0
data/doc/method_list.html +715 -0
data/doc/top-level-namespace.html +112 -0
data/lib/bh1750.rb +43 -0
data/lib/binary_effector.rb +16 -0
data/lib/binary_receptor.rb +23 -0
data/lib/bmx_sensor.rb +86 -0
data/lib/bus.rb +26 -0
data/lib/button.rb +70 -0
data/lib/dht_sensor.rb +36 -0
data/lib/digital_effector.rb +56 -0
data/lib/digital_receptor.rb +20 -0
data/lib/ds18b20.rb +24 -0
data/lib/effector.rb +32 -0
data/lib/hcsr501.rb +7 -0
data/lib/humiture_sensor.rb +26 -0
data/lib/iot.rb +4 -0
data/lib/led.rb +58 -0
data/lib/led_pwm.rb +6 -0
data/lib/led_rgb.rb +100 -0
data/lib/max44009.rb +77 -0
data/lib/raspberry_pi.rb +41 -0
data/lib/raspberry_pi_iot.rb +3 -0
data/lib/receptor.rb +33 -0
data/lib/temperature_sensor.rb +49 -0
data/lib/thermal_sensor.rb +22 -0
metadata +203 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.16
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Bus.html" title="Bus (module)">Bus</a></span>, <span class='object_link'><a href="IoT.html" title="IoT (module)">IoT</a></span>, <span class='object_link'><a href="RaspberryPi.html" title="RaspberryPi (module)">RaspberryPi</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Actuator.html" title="Actuator (class)">Actuator</a></span>, <span class='object_link'><a href="BH1750.html" title="BH1750 (class)">BH1750</a></span>, <span class='object_link'><a href="BME280.html" title="BME280 (class)">BME280</a></span>, <span class='object_link'><a href="BMP280.html" title="BMP280 (class)">BMP280</a></span>, <span class='object_link'><a href="BMxSensor.html" title="BMxSensor (class)">BMxSensor</a></span>, <span class='object_link'><a href="BinaryActuator.html" title="BinaryActuator (class)">BinaryActuator</a></span>, <span class='object_link'><a href="BinaryEffector.html" title="BinaryEffector (class)">BinaryEffector</a></span>, <span class='object_link'><a href="BinaryReceptor.html" title="BinaryReceptor (class)">BinaryReceptor</a></span>, <span class='object_link'><a href="BinarySensor.html" title="BinarySensor (class)">BinarySensor</a></span>, <span class='object_link'><a href="Button.html" title="Button (class)">Button</a></span>, <span class='object_link'><a href="DHT11.html" title="DHT11 (class)">DHT11</a></span>, <span class='object_link'><a href="DHT22.html" title="DHT22 (class)">DHT22</a></span>, <span class='object_link'><a href="DHTxxSensor.html" title="DHTxxSensor (class)">DHTxxSensor</a></span>, <span class='object_link'><a href="DS18B20.html" title="DS18B20 (class)">DS18B20</a></span>, <span class='object_link'><a href="DigitalActuator.html" title="DigitalActuator (class)">DigitalActuator</a></span>, <span class='object_link'><a href="DigitalEffector.html" title="DigitalEffector (class)">DigitalEffector</a></span>, <span class='object_link'><a href="DigitalReceptor.html" title="DigitalReceptor (class)">DigitalReceptor</a></span>, <span class='object_link'><a href="DigitalSensor.html" title="DigitalSensor (class)">DigitalSensor</a></span>, <span class='object_link'><a href="Effector.html" title="Effector (class)">Effector</a></span>, <span class='object_link'><a href="HCSR501.html" title="HCSR501 (class)">HCSR501</a></span>, <span class='object_link'><a href="HumitureSensor.html" title="HumitureSensor (class)">HumitureSensor</a></span>, <span class='object_link'><a href="LED.html" title="LED (class)">LED</a></span>, <span class='object_link'><a href="MAX44009.html" title="MAX44009 (class)">MAX44009</a></span>, <span class='object_link'><a href="Receptor.html" title="Receptor (class)">Receptor</a></span>, <span class='object_link'><a href="Sensor.html" title="Sensor (class)">Sensor</a></span>, <span class='object_link'><a href="TemperatureSensor.html" title="TemperatureSensor (class)">TemperatureSensor</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Tue Dec 11 17:46:24 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.3.3).
+</div>
+    </div>
+  </body>
+</html>

data/lib/bh1750.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'bus'
+# BH1750 - ambient light sensor
+class BH1750
+  DEVICE     = 0x23 # I2C sensor address
+  POWER_DOWN = 0x00 # off state
+  POWER_ON   = 0x01 # on state
+  RESET      = 0x07 # reset state: POWER_DOWN = 0x00
+  CONTINUOUS_LOW_RES_MODE = 0x13    # Measure with resolution 4.0 lx and timing ~16 ms
+  CONTINUOUS_HIGH_RES_MODE_1 = 0x10 # Measure with resolution 1.0 lx and timing ~120 ms
+  CONTINUOUS_HIGH_RES_MODE_2 = 0x11 # Measure with resolution 0.5 lx and timing ~120 ms
+  ONE_TIME_LOW_RES_MODE = 0x23      # Measure with resolution 4.0 lx, POWER DOWN after measuring
+  ONE_TIME_HIGH_RES_MODE_1 = 0x20   # Measure with resolution 1.0 lx, POWER DOWN after measuring
+  ONE_TIME_HIGH_RES_MODE_2 = 0x21   # Measure with resolution 0.5 lx, POWER DOWN after measuring
+  def initialize(i2c_bus='/dev/i2c-1')
+    @sensor_name = 'BH1750'
+    @i2c_bus = i2c_bus
+    @device = I2CDevice.new(address: DEVICE, driver: I2CDevice::Driver::I2CDev.new(@i2c_bus))
+    @resolution = ONE_TIME_HIGH_RES_MODE_1
+    @length = 2
+    @value = read_sensor
+  end
+  # Read raw data from sensor and convert it to numeric
+  def read_sensor
+    data = @device.i2cget(@resolution, @length)
+    @value = to_f(data)
+  end
+  # Return value in Lux
+  def lux
+    read_sensor
+    @value
+  end
+private
+  # Convert 2 bytes of sensor data to a float number
+  def to_f(data)
+    return ((data[1].ord + (256 * data[0].ord)) / 1.2)
+  end
+end

data/lib/binary_effector.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'digital_effector'
+# BinaryEffector - effector with binary logic
+class BinaryEffector < DigitalEffector
+  @pin = nil # pin
+  def initialize(pin=25, state=:low)
+    super({:pin => pin}, :low)
+    @pin = pin
+  end
+end
+# BinaryActuator - synomym for BinaryEffector
+class BinaryActuator < BinaryEffector
+end

data/lib/binary_receptor.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require 'receptor'
+# BinaryReceptor - receptor/actuator with binary logic
+class BinaryReceptor < Receptor
+  @pin = nil # pin
+  def initialize(pin=21, pull=:up)
+    @pin = pin
+    RPi::GPIO.setup pin, :as => :input, :pull => pull
+  end
+  def high?
+    RPi::GPIO.high? @pin
+  end
+  def low?
+    RPi::GPIO.low? @pin
+  end
+end
+# BinarySensor - a synonym for BinaryReceptor
+class BinarySensor < BinaryReceptor
+end

data/lib/bmx_sensor.rb ADDED Viewed

@@ -0,0 +1,86 @@
+gem 'i2c'
+require 'i2c'
+gem 'i2c-bme280'
+require 'i2c/bme280'
+require 'humiture_sensor'
+# BMP/BME humidity, temperature & atmospheric pressure sensor family
+class BMxSensor < HumitureSensor
+  def initialize(sensor_name, bus=1)
+    @sensor_name = sensor_name
+    @sensor = I2C::Driver::BME280.new(device: bus)
+    @temperature, @humidity, @pressure = read_data
+  end
+  def read_data
+    data = @sensor.all
+    @temperature = data[:t]
+    @pressure = data[:p]
+    @humidity = data[:h]
+    [@temperature, @humidity, @pressure]
+  end
+  # standard atmospheric pressure @ sea level = 1.01325 bar = 1013.25 mbar = 101.325 kPa
+  def hPa
+    @pressure
+  end
+  def pressure(mode=:hPa)
+    case mode
+    when :hPa       # 1 hPa = 100 Pa = 1 mbar = 1 hPa = 0.750062 mmHg [@ 0°C]
+      hPa
+    when :kPa       # 1 kPa = 1000 Pa = 10 hPa
+      hPa / 10.0
+    when :Pa        # 1 Pa = 0.01 hPa = 0.001 kPa
+      hPa * 100.0
+    when :mmHg      # 1 mmHg = 1.3332236842105263 hPa = 133.322387415 Pa = 1.000000142466321... Torr
+      hPa / (1013.25 / 760) # 760 mmHg = 101.3250144354 kPa
+    when :atm       # 1 atm = 101325 Pa = 101.325 kPa
+      hPa / 1013.25
+    when :bar       # 1 bar ≡ 100000 Pa = 1000 hPa = 0.987 atm = 750.06 mmHg = 750.06 Torr
+      hPa / 1000.0
+    when :mbar      # 1 mbar = 0.001 bar
+      bar * 1000.0
+    when :Torr      # 1 Torr = 1/760 atm = 101325/760 Pa = 0.999999857533699... mmHg
+      (hPa / 1013.25) / 760
+    else
+      hPa
+    end
+  end
+  def to_s
+    sprintf "%5.2f°C, %5.2f %%, %5.2f mmHg", @temperature, @humidity, pressure(:mmHg)
+  end
+# OLD implementation with 'i2c-devices.gem'
+#require 'bus'
+#require 'i2c/device/bme280'
+# BMP/BME humidity, temperature & atmospheric pressure sensor family
+#  def initialize(sensor_name)
+#    @sensor_name = sensor_name
+#    @sensor = I2CDevice::Bme280.new
+#    @temperature, @humidity, @pressure = read_data
+#  end
+#  def read_data
+#    data = @sensor.calc_sensor_data
+#    @temperature = data[:temp]
+#    @pressure = data[:pressure]
+#    @humidity = data[:hum]
+#    [@temperature, @humidity, @pressure]
+#  end
+end
+class BMP280 < BMxSensor
+  def initialize
+    super('BMP280')
+  end
+end
+class BME280 < BMxSensor
+  def initialize
+    super('BME280')
+  end
+end

data/lib/bus.rb ADDED Viewed

@@ -0,0 +1,26 @@
+#$LOAD_PATH << '~/lib/ruby-i2c-devices/lib'
+gem 'i2c-devices'
+require 'i2c'
+require 'i2c/driver/i2c-dev'
+# Bus - interfaces for physical devices
+module Bus
+  # 1-wire interface to devices
+  class OneWire
+    @@one_wire_bus = '/sys/bus/w1/devices'
+    @sensor_file = nil
+  end
+  # I2C interface to devices
+  class I2C
+    @@i2c_bus = '/dev/i2c-1'
+    def self.set_bus(bus=1)
+      @@i2c_bus = "/dev/i2c-#{bus}"
+    end
+  end
+  # SPI interface to devices
+  class SPI
+  end
+end

data/lib/button.rb ADDED Viewed

@@ -0,0 +1,70 @@
+require 'binary_receptor'
+# Button - simple push button
+class Button < BinaryReceptor
+  attr_writer :measure_pause
+  def initialize(pin)
+    receptor_name = 'BUTTON'
+    super(pin)
+    @measure_pause = 0.01
+    @long_click = 1.0
+    @short_interval = 0.2
+    @intervals = []
+  end
+  # Is button pressed?
+  def pressed?
+    low?
+  end
+  # Is button not pressed?
+  def not_pressed?
+    high?
+  end
+  # Wait for the 1st pressing of button
+  def wait_for_press
+    wait_for_presses(1)
+  end
+  # Wait for several sequential presses
+  def wait_for_presses(attempts=2)
+    @intervals = []
+    attempts.times do
+      interval = []
+      timer = Time.now
+      while not_pressed? do
+        sleep @measure_pause
+      end
+      interval << Time.now-timer
+      timer = Time.now
+      while pressed? do
+        sleep @measure_pause
+      end
+      interval << Time.now-timer
+      @intervals << interval
+    end
+    @intervals
+  end
+  # Was the button pressed once?
+  def single_press?(intervals=@intervals)
+    intervals.size == 1
+  end
+  # Was the button pressed twice?
+  def double_press?(intervals=@intervals)
+    intervals.size == 2 && intervals[1][0] <= @short_interval
+  end
+  # Was the button pressed 3 times?
+  def triple_press?(intervals=@intervals)
+    intervals.size == 3
+  end
+  # Was the button pressed for more than @long_click?
+  def long_press?(intervals=@intervals)
+    intervals.size == 1 && intervals[0][1] >= @long_click
+  end
+end

data/lib/dht_sensor.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'humiture_sensor'
+require 'dht-sensor-ffi'
+# DHT11/22 humidity & temperature sensor family
+class DHTxxSensor < HumitureSensor
+  def initialize(pin, sensor_model)
+    @pin = pin
+    @sensor_name = 'DHT'+sensor_model.to_s
+    @sensor_model = sensor_model.to_i
+    @temperature, @humidity = read_data
+  end
+  # Read values by 'DhtSensor.read' from 'dht-sensor-ffi'
+  def read_data
+    sensor_data = DhtSensor.read(@pin, @sensor_model)
+    @temperature = sensor_data.temp
+    @humidity = sensor_data.humidity
+    [@temperature, @humidity]
+  end
+end
+# DHT11 - junior model, lower presicion
+class DHT11 < DHTxxSensor
+  def initialize(pin)
+    super(pin, 11)
+  end
+end
+# DHT11 - senior model, higher presicion
+class DHT22 < DHTxxSensor
+  def initialize(pin)
+    super(pin, 22)
+  end
+end

data/lib/digital_effector.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'effector'
+RPi::GPIO.set_warnings(false)
+RPi::GPIO.set_numbering :bcm
+# DigitalEffector - effector/actuator with digitized control
+class DigitalEffector < Effector
+  @pin = nil
+  @pins = {} # GPIO pins
+  def initialize(pins, state=:low)
+    @states = {}
+    @pins = pins
+    @pins.each_value do |pin|
+      RPi::GPIO.setup pin, :as => :output, :initialize => state
+      @states[pin] = (state == :high)
+    end
+    @pin = pins.values[0]
+  end
+  def self.on(pin=@pin)
+    RPi::GPIO.set_high pin
+  end
+  def self.off(pin=@pin)
+    RPi::GPIO.set_low pin
+  end
+  def on(pin=@pin)
+    BinaryEffector.on @pin
+    @states[pin] = true
+  end
+  def off(pin=@pin)
+    BinaryEffector.off @pin
+    @states[pin] = false
+  end
+  def on?(pin=@pin)
+    state = nil
+    if pin.class.name == 'Fixnum' # by number
+      state = @states[pin]
+    elsif @pins[pin]              # by name
+      state = @states[@pins[pin]]
+    end
+    state
+  end
+  def off?(pin=@pin)
+    not on(pin)
+  end
+end
+# DigitalActuator - synonym for DigitalEffector
+class DigitalActuator < DigitalEffector
+end

data/lib/digital_receptor.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'receptor'
+# DigitalReceptor - receptor with digitized values
+class DigitalReceptor < Receptor
+  @@one_wire_bus = '/sys/bus/w1/devices'
+  @sensor_file = nil
+  def self.one_wire_file(prefix='28*', device='w1_slave')
+    files = Dir[@@one_wire_bus+'/'+prefix]
+    if files.size > 0 then
+      @sensor_file = files[0]+'/'+device
+    end
+    @sensor_file
+  end
+end
+# DigitalSensor - a synonym for DigitalReceptor
+class DigitalSensor < DigitalReceptor
+end

data/lib/ds18b20.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'temperature_sensor'
+# DS18B20 - high precision temperature sensor with 1-wire interface
+class DS18B20 < TemperatureSensor
+  def initialize(device='w1_slave')
+    self.name = 'DS18B20'
+    @sensor_file = DigitalReceptor.one_wire_file('28*', device)
+    if @sensor_file
+      @temperature = read_data
+    else
+      raise "#{@sensor_name} - Sensor NOT FOUND!"
+    end
+  end
+  def read_data
+    File.open(@sensor_file, 'r') do |f|
+      value = f.read
+      @temperature = value.scan(/t=(\d+)/).flatten[0].to_i/1000.0
+    end
+    @temperature
+  end
+end

data/lib/effector.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# https://github.com/ClockVapor/rpi_gpio
+require 'rpi_gpio'
+RPi::GPIO.set_warnings(false)
+RPi::GPIO.set_numbering :bcm
+# Effector - a controlled physical device that performs some (useful) action
+class Effector
+  @model = 'N/A'
+  @name = 'N/A'
+  def name
+    @name
+  end
+  def model_name
+    @model
+  end
+protected
+  def name=(name)
+    @name = name
+  end
+  def model_name=(name)
+    @model_name = name
+  end
+end
+# Actuator - a synonym for Effector
+class Actuator < Effector
+end

data/lib/hcsr501.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'binary_receptor'
+# HCSR501 - PIR sensor
+class HCSR501 < BinarySensor
+  # TODO: implement and test
+end

data/lib/humiture_sensor.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require 'temperature_sensor'
+# HumitureSensor - combined humidity & temperature sensor
+class HumitureSensor < TemperatureSensor
+  @humidity = 0.0
+  @temperature = 0.0
+  def initialize
+    @humidity, @temperature = read_data
+  end
+  def read_data
+    [@humidity, @temperature]
+  end
+  # Humidity in per cents
+  def humidity
+    @humidity
+  end
+  # Temperature & humidity as a string
+  def to_s
+    sprintf "%5.2f°, %5.2f %%", @temperature, @humidity
+  end
+end

data/lib/iot.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# IoT - Internet of Things classes and modules
+module IoT
+end

data/lib/led.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require 'binary_effector'
+# LED - Light Emitting Diode
+class LED < BinaryEffector
+  def initialize(pin)
+    super(pin)
+    self.name = 'LED'
+  end
+  def on(pin=@pin)
+    super(pin)
+  end
+  def off(pin=@pin)
+    super(pin)
+  end
+  # Repeat 'repeat' times: light the LED for 'switched_on' secs, then pause for 'switched_off' secs
+  def blink(repeat=3, switched_on=0.25, switched_off=0.5)
+    repeat.times do |n|
+      on
+      sleep switched_on
+      off
+      sleep switched_off
+    end
+  end
+  def on_for(seconds=1)
+    on
+    sleep seconds
+    off
+  end
+  def off_for(seconds=1)
+    off
+    sleep seconds
+    on
+  end
+end
+# Experimental methods with names in Russian
+class LED
+  def LED.создать(pin = 25)
+    LED.new(pin)
+  end
+  def включить
+    on
+  end
+  def выключить
+    off
+  end
+  def мигать(repeat=3, switched_on=0.25, switched_off=0.5)
+    blink(repeat, switched_on, switched_off)
+  end
+end

data/lib/led_pwm.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'led'
+class LED
+ class PWM
+ end
+end