raspberry_pi_iot 0.0.8 → 0.1.3

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.16
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -82,12 +82,10 @@
 <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="modules">Modules:</strong> <span class='object_link'><a href="IoT.html" title="IoT (module)">IoT</a></span>, <span class='object_link'><a href="RaspberryPiIoT.html" title="RaspberryPiIoT (module)">RaspberryPiIoT</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>
 
@@ -102,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue Dec 18 16:03:38 2018 by
+  Generated on Wed Jun 10 16:52:49 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.16 (ruby-2.3.3).
+  0.9.20 (ruby-2.5.5).
 </div>
 
     </div>

data/lib/bus.rb

@@ -1,5 +1,3 @@
-
-#$LOAD_PATH << '~/lib/ruby-i2c-devices/lib'
 gem 'i2c-devices'
 require 'i2c'
 require 'i2c/driver/i2c-dev'

data/lib/iot.rb

@@ -1,9 +1,11 @@
+require_relative 'iot/receptor'
+require_relative 'iot/effector'
+
 # IoT - Internet of Things classes and modules
 module IoT
-
   # Logging events and  actions
   class Log
-    @file_name = nil
+    attr_accessor :file_name
 
     def initialize(file_name='/tmp/iot.log')
       @file_name = file_name

data/lib/iot/actuator.rb

@@ -0,0 +1,7 @@
+require_relative 'effector'
+
+module IoT
+  # Actuator - a synonym for Effector
+  class Actuator < IoT::Effector
+  end
+end

data/lib/iot/bh1750.rb

@@ -0,0 +1,54 @@
+require 'bus'
+require_relative 'digital_receptor'
+
+module IoT
+  # BH1750 - ambient light sensor
+  class BH1750 < IoT::DigitalReceptor
+    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(device_address=DEVICE, bus_number=1)
+      @sensor_name = 'BH1750'
+      Bus::I2C.bus_number = bus_number
+      @device_address = device_address
+
+      @i2c_bus = 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
+    end
+
+    # Read raw data from sensor and convert it to numeric
+    def read
+      data = @device.i2cget(@resolution, @length)
+      @value = to_f(data)
+    end
+
+    # Return value in Lux
+    def lux
+      read
+      @value
+    end
+
+
+    def name
+      @sensor_name
+    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
+end

data/lib/iot/binary_actuator.rb

@@ -0,0 +1,7 @@
+require_relative 'binary_effector'
+
+module IoT
+  # BinaryActuator - a synomym for BinaryEffector
+  class BinaryActuator < IoT::BinaryEffector
+  end
+end

data/lib/iot/binary_effector.rb

@@ -0,0 +1,11 @@
+require_relative 'digital_effector'
+
+module IoT
+  # BinaryEffector - effector with binary logic
+  class BinaryEffector < IoT::DigitalEffector
+    def initialize(pin=25, state=:low)
+      super({:pin => pin}, :low)
+      @pin = pin
+    end
+  end
+end

data/lib/iot/binary_receptor.rb

@@ -0,0 +1,20 @@
+require_relative 'receptor'
+
+module IoT
+  # BinaryReceptor - receptor/actuator with binary logic
+  class BinaryReceptor < IoT::Receptor
+
+    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
+end

data/lib/iot/binary_sensor.rb

@@ -0,0 +1,7 @@
+require_relative 'binary_receptor'
+
+module IoT
+  # BinarySensor - a synonym for BinaryReceptor
+  class BinarySensor < IoT::BinaryReceptor
+  end
+end

data/lib/iot/bmx_sensor.rb

@@ -0,0 +1,73 @@
+require 'i2c/backends/i2c-dev.rb'
+require 'i2c/bme280'
+require_relative 'humiture_sensor'
+
+module IoT
+  # Bosch BMP/BME humidity, temperature & atmospheric pressure sensor family
+  class BMxSensor < IoT::HumitureSensor
+
+    def initialize(sensor_name='BMx280', bus=1)
+      @sensor_name = sensor_name
+
+      device = I2C::Dev.create("/dev/i2c-#{bus}")
+      @sensor = I2C::Driver::BME280.new(device: device)
+      @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
+
+    def name
+      @sensor_name
+    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
+  end
+
+  class BMP280 < IoT::BMxSensor # combined atmospheric pressure & temperature sensor
+    def initialize
+      super('BMP280')
+    end
+  end
+
+  class BME280 < IoT::BMxSensor # combined atmospheric pressure, temperature & humidity sensor
+    def initialize
+      super('BME280')
+    end
+  end
+end

data/lib/iot/button.rb

@@ -0,0 +1,100 @@
+require_relative 'binary_receptor'
+
+module IoT
+  # Button - simple tactile / push button
+  class Button < IoT::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
+      @timeout = 30
+      @intervals = []
+      # samples:        wait time    press time     wait time    press time
+      # double press: [[1.486804292, 0.090814152], [0.131284967, 0.13125429]]
+      # long press:   [[0.910878286, 1.109352219]]
+    end
+
+    def name
+      @receptor_name
+    end
+
+    # Is button being pressed?
+    def pressed?
+      low?
+    end
+
+    # Is button not being pressed?
+    def not_pressed?
+      high?
+    end
+
+    def was_pressed?
+      @intervals.size > 0
+    end
+
+    def was_not_pressed?
+      !was_pressed?
+    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, timeout=@timeout)
+      @intervals = []
+      attempts.times do
+        interval = []
+        timer = Time.now
+        while not_pressed? && (Time.now-timer) < timeout 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
+
+    def set_timeout(timeout)
+      @timeout = timeout
+    end
+
+    def timeout?
+      min_wait_time = 60.0*60.0*60.00
+      @intervals.each do |interval|
+        min_wait_time = [min_wait_time, interval[0]].min
+      end
+      min_wait_time > @timeout
+    end
+  end
+end

data/lib/iot/dht_sensor.rb

@@ -0,0 +1,41 @@
+require_relative 'humiture_sensor'
+require 'dht-sensor-ffi'
+
+module IoT
+  # DHT11/22 humidity & temperature sensor family
+  class DHTxxSensor < IoT::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
+
+    def name
+      @sensor_name
+    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
+
+  # DHT22 - senior model, higher presicion
+  class DHT22 < DHTxxSensor
+    def initialize(pin)
+      super(pin, 22)
+    end
+  end
+end

data/lib/iot/digital_actuator.rb

@@ -0,0 +1,7 @@
+require_relative 'digital_effector'
+
+module IoT
+  # DigitalActuator - a synonym for DigitalEffector
+  class DigitalActuator < IoT::DigitalEffector
+  end
+end

data/lib/iot/digital_effector.rb

@@ -0,0 +1,67 @@
+require_relative 'effector'
+
+RPi::GPIO.set_warnings(false)
+RPi::GPIO.set_numbering :bcm
+
+module IoT
+  # DigitalEffector - effector/actuator with digitized control
+  class DigitalEffector < IoT::Effector
+    def initialize(pins={}, state=:low)
+      @pin = nil
+      @states = {} # ON / Off states for pin numbers
+      @pins = pins # DigitalEffector.new {red: 17, green: 28, blue: 22}
+      @pins.each_value do |pin|
+        RPi::GPIO.setup pin, :as => :output, :initialize => state
+        @states[pin] = (state == :high)
+      end
+      @pin = pins.values[0] # default pin
+    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)
+      DigitalEffector.on pin
+      @states[pin_number(pin)] = true
+    end
+
+    def off(pin=@pin)
+      DigitalEffector.off pin
+      @states[pin_number(pin)] = false
+    end
+
+    def on?(pin=@pin)
+      @states[pin_number(pin)]
+    end
+
+    def off?(pin=@pin)
+      !on?(pin)
+    end
+
+private
+    def pin_number(pin)
+      if (pin.class.name == 'Integer') || (pin.class.name == 'Fixnum') # by number
+        pin
+      elsif @pins[pin]              # by name as Symbol
+        @pins[pin]
+      end
+    end
+
+    def high?(pin=@pin)
+      RPi::GPIO.high? pin
+    end
+
+    def low?(pin=@pin)
+      RPi::GPIO.low? pin
+    end
+
+    def state
+     [@pins, @states]
+    end
+  end
+end