dredger-iot 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3249f8a115ef3351b820037510c1ef0259ae227eb881d191353ddd20378c7520
-  data.tar.gz: 1bbc867919f8ba1faa5640d5b1f39370646b4a41d133dab98da0966fe44c2bdc
+  metadata.gz: 84cb846712d4d17f969147389859dfae1bdc8a67fb304e491e857891726d7234
+  data.tar.gz: 5c905f7f6e651692f6eff7145e9b9399357df33e340d4694eceab260f31b1b00
 SHA512:
-  metadata.gz: 10d9397170fa1c21e34a969595c21a48a4605cbceeb6b79c6833930a65bddaac5798d4537c881d0bda30decbb76a5029d35e5924180978c265b61e5a7f739e84
-  data.tar.gz: 6d9f92320c43eb23c92aee74cc60cc24bcbb5b44cf5409487047aa2e34b8380011d3a8a508612216edf2e9ff00c7eafda562e4e683c46fd7bb988898f22d0552
+  metadata.gz: a0cfe26a32e99b21b3a6ccbddede15162bf85f7a85aac6e32715f34cc8a300218515e358bbd271cd5dd648d9ca6df892eb4fda2cd3bf08761a128c25887142ba
+  data.tar.gz: 179a10159ea14047fa146ed5a03223c2f362591357c39c754fef36718d75c2c35fff7bb0e7facafc9c094e48d0015e5eef0a367ca10cb4f93674e0369f2fa6f8

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-10-05
+
+### Added
+- New sensors: SHT31 (I2C temp/humidity), BH1750 (I2C lux), TSL2561 (I2C lux), INA219 (I2C bus voltage/current)
+- CLI: --shunt option for INA219 to specify shunt resistance (default 0.1 Ω)
+- Examples: example scripts for SHT31, BH1750, TSL2561, INA219
+
+### Changed
+- README: document new sensors and CLI usage
+- Coverage: exclude all provider implementations from coverage (hardware-dependent)
+
 ## [0.1.2] - 2025-10-04
 
 ### Added
@@ -53,7 +64,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - RuboCop configuration and compliance
 - Comprehensive documentation and usage examples
 
-[Unreleased]: https://github.com/TheMadBotterINC/dredger-iot/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/TheMadBotterINC/dredger-iot/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/TheMadBotterINC/dredger-iot/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/TheMadBotterINC/dredger-iot/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/TheMadBotterINC/dredger-iot/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/TheMadBotterINC/dredger-iot/releases/tag/v0.1.0

data/README.md

@@ -98,9 +98,58 @@ Dredger-IoT includes drivers for popular embedded sensors:
 - **DS18B20** - 1-Wire digital temperature sensor
 - **BMP180** - I2C barometric pressure/temperature sensor
 - **MCP9808** - I2C high-accuracy temperature sensor
+- **SHT31** - I2C temperature/humidity sensor
+- **BH1750** - I2C ambient light sensor (lux)
+- **TSL2561** - I2C ambient light sensor (lux)
+- **INA219** - I2C bus voltage/current monitor
 
 Sensors use a provider pattern for testability and hardware abstraction.
 
+## CLI Usage
+
+Commands:
+- list-sensors
+  - List available sensor types supported by dredger-iot.
+- read SENSOR [ARGS]
+  - Read once or continuously from a sensor.
+  - Examples:
+    - dredger read bme280 0x76
+    - dredger read dht22 P9_12
+    - dredger read ina219 0x40 --shunt 0.1
+- test-gpio PIN
+  - Simple blink test to verify GPIO output works.
+- test-i2c
+  - Scans a few common I2C addresses (hardware backend only).
+- info
+  - Prints version, detected backends, and environment variables.
+
+Options:
+- --backend BACKEND
+  - auto (default), simulation, hardware
+  - simulation forces both GPIO and I2C simulation backends
+  - hardware forces libgpiod (GPIO) and linux (I2C)
+- --format FORMAT
+  - text (default) or json
+- --interval SECONDS
+  - Poll continuously at the specified interval (e.g., 2.0)
+- --shunt OHMS
+  - INA219-only: specify the shunt resistance in ohms (default 0.1)
+
+Examples:
+```bash
+# Read a BME280 once (auto-detected backends)
+dredger read bme280 0x76
+
+# Read a DHT22 every 2 seconds, JSON output
+dredger read dht22 P9_12 --interval 2 --format json
+
+# Force simulation backends for local testing
+dredger --backend simulation read bh1750 0x23
+
+# INA219 with custom shunt
+dredger read ina219 0x40 --shunt 0.05
+```
+
 ## Usage Examples
 
 ### DHT22 Temperature/Humidity Sensor
@@ -483,6 +532,26 @@ reading.timestamp    # Time object when reading was taken
 - **`MCP9808`** - High-accuracy temperature (I2C)
   - Parameters: `i2c_addr` (default: `0x18`), `provider`
   - Returns: temperature (celsius)
+  
+- **`SHT31`** - Temperature/humidity (I2C)
+  - Parameters: `i2c_addr` (default: `0x44`), `provider`
+  - Returns: temperature (celsius), humidity (%)
+  
+- **`BH1750`** - Ambient light (I2C)
+  - Parameters: `i2c_addr` (default: `0x23`), `provider`
+  - Returns: illuminance (lux)
+  
+- **`TSL2561`** - Ambient light (I2C)
+  - Parameters: `i2c_addr` (default: `0x39`), `provider`
+  - Returns: illuminance (lux)
+  
+- **`INA219`** - Bus voltage/current monitor (I2C)
+  - Parameters: `i2c_addr` (default: `0x40`), `provider`
+  - Returns: bus_voltage (V), current (mA)
+  - CLI example:
+    ```bash path=null start=null
+    dredger read ina219 0x40 --shunt 0.1
+    ```
 
 ### Scheduling
 

data/bin/dredger

@@ -69,6 +69,10 @@ class DredgerCLI
         @options[:interval] = i
       end
 
+      opts.on('--shunt OHMS', Float, 'INA219 shunt resistance in ohms (default: 0.1)') do |ohms|
+        @options[:ina219_shunt] = ohms
+      end
+
       opts.on('-h', '--help', 'Show this help') do
         puts opts
         exit
@@ -87,7 +91,11 @@ class DredgerCLI
       'bme280' => 'BME280 - Temperature/Humidity/Pressure (I2C)',
       'ds18b20' => 'DS18B20 - Waterproof Temperature (1-Wire)',
       'bmp180' => 'BMP180 - Barometric Pressure/Temperature (I2C)',
-      'mcp9808' => 'MCP9808 - High-Accuracy Temperature (I2C)'
+      'mcp9808' => 'MCP9808 - High-Accuracy Temperature (I2C)',
+      'sht31' => 'SHT31 - Temperature/Humidity (I2C)',
+      'bh1750' => 'BH1750 - Ambient Light (I2C)',
+      'tsl2561' => 'TSL2561 - Ambient Light (I2C)',
+      'ina219' => 'INA219 - Bus Voltage/Current (I2C)'
     }
 
     puts 'Available Sensors:'
@@ -136,6 +144,27 @@ class DredgerCLI
         exit 1
       end
       Dredger::IoT::Sensors::DS18B20.new(device_id: device_id, provider: provider)
+    when 'sht31'
+      addr = (args.shift || '0x44').to_i(16)
+      i2c = Dredger::IoT::Bus::Auto.i2c
+      provider = Dredger::IoT::Sensors::SHT31Provider.new(i2c_bus: i2c)
+      Dredger::IoT::Sensors::SHT31.new(i2c_addr: addr, provider: provider)
+    when 'bh1750'
+      addr = (args.shift || '0x23').to_i(16)
+      i2c = Dredger::IoT::Bus::Auto.i2c
+      provider = Dredger::IoT::Sensors::BH1750Provider.new(i2c_bus: i2c)
+      Dredger::IoT::Sensors::BH1750.new(i2c_addr: addr, provider: provider)
+    when 'tsl2561'
+      addr = (args.shift || '0x39').to_i(16)
+      i2c = Dredger::IoT::Bus::Auto.i2c
+      provider = Dredger::IoT::Sensors::TSL2561Provider.new(i2c_bus: i2c)
+      Dredger::IoT::Sensors::TSL2561.new(i2c_addr: addr, provider: provider)
+    when 'ina219'
+      addr = (args.shift || '0x40').to_i(16)
+      i2c = Dredger::IoT::Bus::Auto.i2c
+      shunt = @options[:ina219_shunt] || 0.1
+      provider = Dredger::IoT::Sensors::INA219Provider.new(i2c_bus: i2c, shunt_resistance_ohms: shunt)
+      Dredger::IoT::Sensors::INA219.new(i2c_addr: addr, provider: provider)
     else
       puts "Error: Unknown sensor type '#{type}'"
       exit 1

data/lib/dredger/iot/sensors/bh1750.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # BH1750 ambient light sensor (I2C)
+      # Provider must respond to :read_lux(addr) -> Float (lux)
+      class BH1750 < BaseSensor
+        def initialize(i2c_addr:, provider:, metadata: {})
+          super(metadata: metadata)
+          @i2c_addr = i2c_addr
+          @provider = provider
+        end
+
+        def readings
+          lux = @provider.read_lux(@i2c_addr)
+          [reading(sensor_type: 'illuminance', value: lux, unit: 'lux')]
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/bh1750_provider.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # Hardware provider for BH1750 ambient light sensor (I2C)
+      # Measurement: Continuous High-Resolution Mode (1 lx, typical 120ms)
+      class BH1750Provider
+        POWER_ON = 0x01
+        RESET = 0x07
+        CONT_HIRES = 0x10
+
+        def initialize(i2c_bus:)
+          @i2c = i2c_bus
+        end
+
+        # Returns lux as Float
+        def read_lux(addr)
+          # Power on and reset
+          @i2c.write(addr, [POWER_ON])
+          @i2c.write(addr, [RESET])
+          # Start continuous high-resolution measurement
+          @i2c.write(addr, [CONT_HIRES])
+          # Wait for conversion
+          sleep(0.18)
+          # Read 2 bytes (big-endian)
+          bytes = @i2c.read(addr, 2)
+          raw = (bytes[0] << 8) | bytes[1]
+          (raw / 1.2).to_f
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/ina219.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # INA219 current/voltage/power monitor (I2C)
+      # Provider must respond to :read_measurements(addr) -> { bus_voltage_v:, current_ma:, shunt_voltage_mv: }
+      class INA219 < BaseSensor
+        def initialize(i2c_addr:, provider:, metadata: {})
+          super(metadata: metadata)
+          @i2c_addr = i2c_addr
+          @provider = provider
+        end
+
+        def readings
+          m = @provider.read_measurements(@i2c_addr)
+          [
+            reading(sensor_type: 'bus_voltage', value: m[:bus_voltage_v], unit: 'V'),
+            reading(sensor_type: 'current', value: m[:current_ma], unit: 'mA')
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/ina219_provider.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # Hardware provider for INA219 current/voltage monitor (I2C)
+      # Simplified: computes current from shunt voltage and provided shunt resistance,
+      # avoids calibration register dependency.
+      class INA219Provider
+        REG_SHUNT_VOLTAGE = 0x01
+        REG_BUS_VOLTAGE = 0x02
+
+        def initialize(i2c_bus:, shunt_resistance_ohms: 0.1)
+          @i2c = i2c_bus
+          @r_shunt = shunt_resistance_ohms.to_f
+        end
+
+        # Returns { bus_voltage_v: Float, current_ma: Float, shunt_voltage_mv: Float }
+        def read_measurements(addr)
+          shunt_raw = read_word(addr, REG_SHUNT_VOLTAGE, signed: true)
+          bus_raw = read_word(addr, REG_BUS_VOLTAGE, signed: false)
+
+          # Shunt voltage LSB = 10uV => mV = raw * 0.01
+          shunt_mv = shunt_raw * 0.01
+          # Current (mA) = (shunt_mv / R_ohms)
+          current_ma = (@r_shunt.positive? ? (shunt_mv / @r_shunt) : 0.0)
+
+          # Bus voltage: bits [15:3] * 4mV
+          bus_voltage_v = ((bus_raw >> 3) * 0.004)
+
+          {
+            bus_voltage_v: bus_voltage_v,
+            current_ma: current_ma,
+            shunt_voltage_mv: shunt_mv
+          }
+        end
+
+        private
+
+        # Read 16-bit word
+        # INA219 registers are big-endian; register reads may return bytes LSB-first
+        def read_word(addr, reg, signed: false)
+          bytes = @i2c.read(addr, 2, register: reg)
+          val = (bytes[0] << 8) | bytes[1]
+          if signed && val > 0x7FFF
+            val - 0x1_0000
+          else
+            val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/sht31.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # SHT31 temperature/humidity sensor (I2C)
+      # Provider must respond to :read_measurements(addr) -> { temperature_c:, humidity: }
+      class SHT31 < BaseSensor
+        def initialize(i2c_addr:, provider:, metadata: {})
+          super(metadata: metadata)
+          @i2c_addr = i2c_addr
+          @provider = provider
+        end
+
+        def readings
+          m = @provider.read_measurements(@i2c_addr)
+          [
+            reading(sensor_type: 'temperature', value: m[:temperature_c], unit: 'celsius'),
+            reading(sensor_type: 'humidity', value: m[:humidity], unit: '%')
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/sht31_provider.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # Hardware provider for Sensirion SHT31 temperature/humidity over I2C.
+      # Basic single-shot measurement without CRC checks for simplicity.
+      # Datasheet formula:
+      #  - Temperature (°C) = -45 + 175 * (ST / 65535)
+      #  - Humidity (%RH)  = 100 * (SRH / 65535)
+      class SHT31Provider
+        # I2C commands
+        CMD_SINGLE_SHOT_HIGHREP = [0x24, 0x00].freeze # High repeatability, clock stretching disabled
+
+        def initialize(i2c_bus:)
+          @i2c = i2c_bus
+        end
+
+        # Returns { temperature_c: Float, humidity: Float }
+        def read_measurements(addr)
+          # Trigger single-shot measurement
+          @i2c.write(addr, CMD_SINGLE_SHOT_HIGHREP)
+          # Max measurement duration ~15ms (high repeatability). Add margin.
+          sleep(0.02)
+
+          # Read 6 bytes: T_MSB, T_LSB, T_CRC, RH_MSB, RH_LSB, RH_CRC
+          data = @i2c.read(addr, 6)
+
+          st = (data[0] << 8) | data[1]
+          srh = (data[3] << 8) | data[4]
+
+          temp_c = -45.0 + (175.0 * st / 65_535.0)
+          humidity = (100.0 * srh / 65_535.0)
+          humidity = humidity.clamp(0.0, 100.0)
+
+          { temperature_c: temp_c, humidity: humidity }
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/tsl2561.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # TSL2561 ambient light sensor (I2C)
+      # Provider must respond to :read_lux(addr) -> Float (lux)
+      class TSL2561 < BaseSensor
+        def initialize(i2c_addr:, provider:, metadata: {})
+          super(metadata: metadata)
+          @i2c_addr = i2c_addr
+          @provider = provider
+        end
+
+        def readings
+          lux = @provider.read_lux(@i2c_addr)
+          [reading(sensor_type: 'illuminance', value: lux, unit: 'lux')]
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors/tsl2561_provider.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Dredger
+  module IoT
+    module Sensors
+      # Hardware provider for TSL2561 ambient light sensor (I2C)
+      # Uses simple configuration: integration 402ms, low gain.
+      class TSL2561Provider
+        CMD = 0x80
+        CONTROL = 0x00
+        TIMING = 0x01
+        DATA0LOW = 0x0C
+        DATA1LOW = 0x0E
+
+        POWER_ON = 0x03
+        POWER_OFF = 0x00
+        INTEG_402MS = 0x02 # integration time bits [1:0] = 10
+        GAIN_LOW = 0x00    # gain bit [4] = 0
+
+        def initialize(i2c_bus:)
+          @i2c = i2c_bus
+        end
+
+        # Returns lux as Float
+        def read_lux(addr)
+          # Power on
+          @i2c.write(addr, [POWER_ON], register: CMD | CONTROL)
+          # Set timing: 402ms, low gain
+          @i2c.write(addr, [GAIN_LOW | INTEG_402MS], register: CMD | TIMING)
+
+          # Wait for integration
+          sleep(0.45)
+
+          ch0 = read_word(addr, CMD | DATA0LOW)
+          ch1 = read_word(addr, CMD | DATA1LOW)
+
+          compute_lux(ch0, ch1).to_f
+        ensure
+          # Power off to save energy
+          @i2c.write(addr, [POWER_OFF], register: CMD | CONTROL)
+        end
+
+        private
+
+        # Read 16-bit little-endian word from LSB register
+        def read_word(addr, reg)
+          bytes = @i2c.read(addr, 2, register: reg)
+          bytes[0] | (bytes[1] << 8)
+        end
+
+        # Lux calculation based on TSL2561 datasheet/Adafruit library
+        def compute_lux(ch0, ch1)
+          return 0.0 if ch0.zero?
+
+          ratio = ch1.to_f / ch0
+
+          if ratio <= 0.5
+            (0.0304 * ch0) - (0.062 * ch0 * (ratio**1.4))
+          elsif ratio <= 0.61
+            (0.0224 * ch0) - (0.031 * ch1)
+          elsif ratio <= 0.80
+            (0.0128 * ch0) - (0.0153 * ch1)
+          elsif ratio <= 1.30
+            (0.00146 * ch0) - (0.00112 * ch1)
+          else
+            0.0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dredger/iot/sensors.rb

@@ -9,3 +9,11 @@ require_relative 'sensors/ds18b20'
 require_relative 'sensors/ds18b20_provider'
 require_relative 'sensors/bmp180'
 require_relative 'sensors/mcp9808'
+require_relative 'sensors/sht31'
+require_relative 'sensors/sht31_provider'
+require_relative 'sensors/bh1750'
+require_relative 'sensors/bh1750_provider'
+require_relative 'sensors/tsl2561'
+require_relative 'sensors/tsl2561_provider'
+require_relative 'sensors/ina219'
+require_relative 'sensors/ina219_provider'

data/lib/dredger/iot/version.rb

@@ -2,6 +2,6 @@
 
 module Dredger
   module IoT
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dredger-iot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - The Mad Botter INC
@@ -53,6 +53,8 @@ files:
 - lib/dredger/iot/scheduler.rb
 - lib/dredger/iot/sensors.rb
 - lib/dredger/iot/sensors/base_sensor.rb
+- lib/dredger/iot/sensors/bh1750.rb
+- lib/dredger/iot/sensors/bh1750_provider.rb
 - lib/dredger/iot/sensors/bme280.rb
 - lib/dredger/iot/sensors/bme280_provider.rb
 - lib/dredger/iot/sensors/bmp180.rb
@@ -60,7 +62,13 @@ files:
 - lib/dredger/iot/sensors/dht22_provider.rb
 - lib/dredger/iot/sensors/ds18b20.rb
 - lib/dredger/iot/sensors/ds18b20_provider.rb
+- lib/dredger/iot/sensors/ina219.rb
+- lib/dredger/iot/sensors/ina219_provider.rb
 - lib/dredger/iot/sensors/mcp9808.rb
+- lib/dredger/iot/sensors/sht31.rb
+- lib/dredger/iot/sensors/sht31_provider.rb
+- lib/dredger/iot/sensors/tsl2561.rb
+- lib/dredger/iot/sensors/tsl2561_provider.rb
 - lib/dredger/iot/version.rb
 homepage: https://github.com/TheMadBotterINC/dredger-iot
 licenses:
@@ -75,25 +83,27 @@ metadata:
   rubygems_mfa_required: 'true'
   keywords: iot, embedded, linux, gpio, i2c, beaglebone, raspberry-pi, hardware, sensors,
     dht22, bme280, ds18b20, bmp180, mcp9808, libgpiod, automation
-post_install_message: "\n═══════════════════════════════════════════════════════════════════\n
-  \                                                              \n                  _______________
-  \                             \n                 |  DREDGER-IoT  |                            \n
-  \                |_______________|                            \n                /|
-  \  ___     ___ |                           \n               / |  |___|   |___||
-  \                          \n              /  |______________|                           \n
-  \        ====|========================|====                   \n        |    |    |-----------|
-  \    |    |                   \n        |    |____|           |_____|    |                   \n
-  \    ___|____|                         |____|___             \n~~~~{________|_________________________|________}~~~~~~~
-  \    \n  ~~      |  \\                     //  |         ~~~        \n          |
-  \  \\___________________//   |                    \n          |_____________________________|
-  \                   \n     ~~~       \\                 //          ~~~            \n
-  \               \\_______________//                          \n═══════════════════════════════════════════════════════════════════\n
-  \      Hardware Integration for Embedded Linux v0.1.2\n═══════════════════════════════════════════════════════════════════\n\n\U0001F389
-  Thanks for installing!\n\n\U0001F4DA Hardware Setup (kernel modules & permissions):\n
-  \  https://github.com/TheMadBotterINC/dredger-iot#hardware-setup\n\n\U0001F680 Quick
-  Start:\n   require 'dredger/iot'\n   gpio = Dredger::IoT::Bus::Auto.gpio\n   i2c
-  \ = Dredger::IoT::Bus::Auto.i2c\n\n\U0001F4A1 Supported Sensors:\n   DHT22, BME280,
-  DS18B20, BMP180, MCP9808\n\n\U0001F4D6 Full Documentation:\n   https://github.com/TheMadBotterINC/dredger-iot\n\n"
+post_install_message: "\n    ═══════════════════════════════════════════════════════════════════\n
+  \                                                                  \n                      _______________
+  \                             \n                     |  DREDGER-IoT  |                            \n
+  \                    |_______________|                            \n                    /|
+  \  ___     ___ |                           \n                   / |  |___|   |___||
+  \                          \n                  /  |______________|                           \n
+  \            ====|========================|====                   \n            |
+  \   |    |-----------|     |    |                   \n            |    |____|           |_____|
+  \   |                   \n         ___|____|                         |____|___             \n
+  \   ~~~~{________|_________________________|________}~~~~~~~     \n      ~~      |
+  \ \\                     //  |         ~~~        \n              |   \\___________________//
+  \  |                    \n              |_____________________________|                    \n
+  \        ~~~       \\                 //          ~~~            \n                    \\_______________//
+  \                         \n    ═══════════════════════════════════════════════════════════════════\nHardware
+  Integration for Embedded Linux v0.2.0\n    ═══════════════════════════════════════════════════════════════════\n\n
+  \   \U0001F389 Thanks for installing!\n\n    \U0001F4DA Hardware Setup (kernel modules
+  & permissions):\n       https://github.com/TheMadBotterINC/dredger-iot#hardware-setup\n\n
+  \   \U0001F680 Quick Start:\n       require 'dredger/iot'\n       gpio = Dredger::IoT::Bus::Auto.gpio\n
+  \      i2c  = Dredger::IoT::Bus::Auto.i2c\n\n    \U0001F4A1 Supported Sensors:\n
+  \      DHT22, BME280, DS18B20, BMP180, MCP9808\n\n    \U0001F4D6 Full Documentation:\n
+  \      https://github.com/TheMadBotterINC/dredger-iot\n\n"
 rdoc_options: []
 require_paths:
 - lib