denko 0.13.3 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082654ef6ccaec931c9cba643db7c528cc8b20d33e969af6a101a735078b7c02'
-  data.tar.gz: 780397a81acfa1a44591deb0c1beedb6f39071b606fb108914c79af334e47847
+  metadata.gz: e165f677a5af1dc4d7a924e7b2387bafaca1c84c754b72eac8960fcea42117a7
+  data.tar.gz: f1c795bff6917284d3b31fbff4d1ea44de78f2871492b466f45d9f36abc340af
 SHA512:
-  metadata.gz: 58e7ec2753368aa202a63792c6f142bd150a386c95d37605ee4c1985022d4c06e552108f504675c599effcde0e0438b7d1029d0c700ec7fee40fffdffc60d1f4
-  data.tar.gz: fec058bef713c8f5c7e84eed3dd87a84db93267e921abb27d3c4966b40bf66a223a3a76442559742bec04a58665e18d3d8d30cd3954fdb846148e5d1fb3b0cd2
+  metadata.gz: c897cca6c4a59ce2fbd73e517c380ba272ad0c6a621a9ba7034dffe1f83e151c21cad0671df872443eff8376ff646933a0a68cda07e25860869a06a9306fcfac
+  data.tar.gz: 6f90da47a6bb960400d9986668b2f9320248616f0a4f0a12a930e9ffda4dad0d75e1c08ecf8aae223f8882b72bd56e73dfe113a79c3973ff91c326c4ed31f941

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## 0.13.4
+
+### New Components
+
+- Generic PIR sensors:
+  - Class: `Denko::Sensor::GenericPIR`
+  - Based on `Denko::DigitalIO::Input` class.
+  - Tested with AS312 and HC-SR501 sensors. Should work with AM312 and others.
+
+- Bosch BMP 180 Temperature + Pressure Sensor:
+  - Class: `Denko::Sensor::BMP180`
+  - Connects via I2C bus. Ruby driver.
+  - Similar to BMP280, but fewer features (older version).
+  - Should work for BMP085 sensor as well.
+
+- SHT30/31/35 Temperature + Humidity Sensor:
+  - Class: `Denko::Sensor::SHTX`
+  - Connects via I2C bus. Ruby driver.
+  - One-shot reading mode only.
+
+- RCWL-9620 Ultrasonic Distance Sensor:
+  - Class: `Denko::Sensor::RCWL9620`
+  - Connects via I2C bus. Ruby driver.
+  - Very simple interface. `#read` returns a distance in mm.
+
+### Component Changes
+
+- HTU21D:
+  - Humidity values outside the 0-100% range will be clipped to those values automatically.
+
+### Example Changes
+
+- Added a simple button example, separate from tutorial.
+- Standardize temp/pressure/humidity sensor examples (except DHT, DS18B20, HTU21D) so readings display the same.
+
+### Bug Fixes
+
+- Fixed bug where `BMP280`` sensor class would not autoload.
+
 ## 0.13.3
 
 ### Board Updates / Fixes

data/HARDWARE.md

@@ -37,6 +37,12 @@
 | ATWINC1500            | :green_heart:   | MKR1000, WiFi Shield 101 | #define WIFI_101 for shield. Automatic for MKR1000
 | u-blox NINA-W102      | :question:      | Uno WiFi Rev 2, MKR WiFi 1010, Nano 33 IOT | Should work. No hardware
 
+### AVR Chips from [MightyCore](https://github.com/MCUdude/MightyCore)
+
+|    Chip        | Status          | Products         | Notes |
+| :--------      | :------:        | :--------------- |------ |
+| ATmega1284     | :heart:         | Used in many 8-bit 3D printer boards. | 
+
 ### Espressif Chips with Built-In Wi-Fi
 [![ESP8266 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp8266.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp8266.yml)
 [![ESP32 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32.yml)
@@ -119,6 +125,7 @@ Polling and reading follow a call and response pattern.
 | LED                | :green_heart:      | Digi/Ana Out      | `LED::Base`           |
 | RGB LED            | :green_heart:      | Digi/Ana Out      | `LED::RGB`            |
 | 7 Segment Display  | :yellow_heart:     | Digital Out       | `LED::SevenSegment`   | No decimal point
+| 8x8 LED (MAX7219)  | :heart:            | SPI               | `LED::MAX7219`        |
 | TM1637             | :heart:            | BitBang SPI       | `LED::TM1637`         | 4x 7 Segment + Colon
 | Neopixel / WS2812B | :yellow_heart:     | Adafruit Library  | `LED::WS2812`         | Not working on RP2040
 | Dotstar / APA102   | :green_heart:      | SPI               | `LED::APA102`         |
@@ -129,6 +136,12 @@ Polling and reading follow a call and response pattern.
 | :---------------         | :------:       | :--------                    | :---------------    |------ |
 | HD44780 LCD              | :green_heart:  | Digital Out, Output Register | `Display::HD44780`  |
 | SSD1306 OLED             | :yellow_heart: | I2C                          | `Display::SSD1306`  | 1 font, some graphics
+| ST7565R (128x64 Mono)    | :heart:        | SPI                          | `Display::ST7565R`  |
+| ST7735S (160x128 RGB)    | :heart:        | SPI                          | `Display::ST7735S`  |
+| ILI9341 (240x320 RGB)    | :heart:        | SPI                          | `Display::ILI9341`  |
+| GC9107 (128x128 RGB)     | :heart:        | SPI                          | `Display::GC9107`   |
+| GC9A01 (240x240 Round)   | :heart:        | SPI                          | `Display::GCA9A01`  |
+| IL0373 (212x104 E-Paper) | :heart:        | SPI                          | `Display::IL0373`   |
 
 ### Sound
 
@@ -144,7 +157,9 @@ Polling and reading follow a call and response pattern.
 | Generic ESC          | :yellow_heart: | Servo/ESC PWM  | `Motor::Servo`     | Works. Needs its own class.
 | PCA9685              | :heart:        | I2C            | `PulseIO::PCA9685` | 16ch 12-bit PWM for servo or LED
 | L298N                | :green_heart:  | Digi + PWM Out | `Motor::L298`      | H-Bridge DC motor driver
+| DRV8833              | :heart:        | Digi + PWM Out | `Motor::DRV8833`   | H-Bridge DC motor driver
 | A3967                | :green_heart:  | Digital Out    | `Motor::Stepper`   | 1ch microstepper (EasyDriver)
+| A4988                | :yellow_heart: | DigitalOut     | `Motor::Stepper`   | 1-ch microstepper
 | TMC2209              | :heart:        | -              | -                  | 1ch silent stepper driver
 
 ### I/O Expansion
@@ -162,55 +177,67 @@ Polling and reading follow a call and response pattern.
 
 ### Environmental Sensors
 
-| Name             | Status         | Interface   | Component Class    | Notes |
-| :--------------- | :------:       | :--------   | :---------------   |------ |
-| DS18B20          | :green_heart:  | OneWire     | `Sensor::DS18B20`  | Temp
-| DHT 11/21/22     | :green_heart:  | Digi In/Out | `Sensor::DHT`      | Temp/RH
-| SHT30            | :heart:        | I2C         | `Sensor::SHT30`    | Temp/RH
-| QMP6988          | :heart:        | I2C         | `Sensor::QMP6988`  | Pressure
-| BME280           | :green_heart:  | I2C         | `Sensor::BME280`   | Temp/RH/Press
-| BMP280           | :green_heart:  | I2C         | `Sensor::BMP280`   | Temp/Press
-| HTU21D           | :green_heart:  | I2C         | `Sensor::HTU21D`   | Temp/RH. User register read not implemented.
-| HTU31D           | :green_heart:  | I2C         | `Sensor::HTU31D`   | Temp/RH. Diagnostic read not implemented.
-| AHT10/15         | :green_heart:  | I2C         | `Sensor::AHT10`    | Temp/RH. Always uses calibrated mode.
-| AHT20/21/25      | :green_heart:  | I2C         | `Sensor::AHT20`    | Temp/RH. Always uses calibrated mode + CRC.
-| ENS160           | :heart:        | I2C         | `Sensor::ENS160`   | CO2e/TVOC/AQI
-| AGS02MA          | :heart:        | I2C         | `Sensor::AGS02MA`  | TVOC
-| MAX31850         | :heart:        | OneWire     | `Sensor::MAX31850` | Thermocouple Amplifier
+| Name             | Status         | Interface   | Component Class    | Type               | Notes                  |
+| :--------------- | :------:       | :--------   | :---------------   |---------------     | ---------------------- |
+| MAX31850         | :heart:        | OneWire     | `Sensor::MAX31850` | Thermocouple       |
+| MAX6675          | :heart:        | SPI         | `Sensor::MAX6675`  | Thermocouple       |
+| DS18B20          | :green_heart:  | OneWire     | `Sensor::DS18B20`  | Temp               |
+| DHT11/21/22      | :green_heart:  | Digi In/Out | `Sensor::DHT`      | Temp / RH          |
+| SHT30/31/35      | :green_heart:  | I2C         | `Sensor::SHT3X`    | Temp / RH          | M5Stack ENV III, one-shot only
+| QMP6988          | :green_heart:  | I2C         | `Sensor::QMP6988`  | Temp / Press       | M5Stack ENV III
+| BMP180           | :green_heart:  | I2C         | `Sensor::BMP180`   | Temp / Press       |
+| BMP280           | :green_heart:  | I2C         | `Sensor::BMP280`   | Temp / Press       |
+| BME280           | :green_heart:  | I2C         | `Sensor::BME280`   | Temp / Press / RH  |
+| HTU21D           | :green_heart:  | I2C         | `Sensor::HTU21D`   | Temp / RH          | No user register read
+| HTU31D           | :green_heart:  | I2C         | `Sensor::HTU31D`   | Temp / RH          | No diagnostic read
+| AHT10/15         | :green_heart:  | I2C         | `Sensor::AHT10`    | Temp / RH          |
+| AHT20/21/25      | :green_heart:  | I2C         | `Sensor::AHT20`    | Temp / RH          |
+| ENS160           | :heart:        | I2C         | `Sensor::ENS160`   | CO2e / TVOC / AQI  |
+| AGS02MA          | :heart:        | I2C         | `Sensor::AGS02MA`  | TVOC               |
+| SCD40            | :heart:        | I2C         | `Sensor::SDC40`    | Temp / Press / CO2 |
 
 ### Light Sensors
 
 | Name             | Status         | Interface    | Component Class    | Notes |
 | :--------------- | :------:       | :--------    | :---------------   |------ |
 | BH1750           | :heart:        | Digital In   | `Sensor::BH1750`   | Ambient Light
-| HC-SR501         | :yellow_heart: | Digital In   | `DigitalIO::Input` | PIR. Needs class: `Sensor::HC-SR501`
-| AS312            | :heart:        | I2C          | `Sensor::AS312`    | PIR
+| TCS34725         | :heart:        | I2C          | `Sensor::TCS34725` | RGB
 | APDS9960         | :heart:        | I2C          | `Sensor::APDS9960` | Proximity, RGB, Gesture
 
+### PIR Motion Sensors
+| Name             | Status         | Interface    | Component Class      | Notes |
+| :--------------- | :------:       | :--------    | :---------------     |------ |
+| HC-SR501         | :green_heart:  | Digital In   | `Sensor::GenericPIR` |
+| AS312            | :green_heart:  | Digital In   | `Sensor::GenericPIR` |
+
 ### Distance Sensors
 
 | Name             | Status         | Interface    | Component Class    | Notes |
 | :--------------- | :------:       | :--------    | :---------------   |------ |
 | HC-SR04          | :heart:        | Digi In/Out  | `Sensor::HCSR04`   | Ultrasonic, 20-4000mm
-| RCWL-9620        | :heart:        | I2C          | `Sensor::RCWL9260` | Ultrasonic, 20-4500mm
+| RCWL-9620        | :green_heart:  | I2C          | `Sensor::RCWL9260` | Ultrasonic, 20-4500mm
 | VL53L0X          | :heart:        | I2C          | `Sensor::VL53L0X`  | Laser, 30 - 1000mm
 | GP2Y0E03         | :heart:        | I2C          | `Sensor::GP2Y0E03` | Infrared, 40 - 500mm
 
-### Motion Sensors
+### Inertial Measurement Units
 
 | Name             | Status         | Interface | Component Class    | Notes |
 | :--------------- | :------:       | :-------- | :---------------   |------ |
-| ADXL345          | :heart:        | I2C       | `Sensor::ADXL345`  | 3-axis Accelerometer
-| IT3205           | :heart:        | I2C       | `Sensor::IT3205`   | 3-axis Gyroscope
-| HMC5883L         | :heart:        | I2C       | `Sensor::HMC5883L` | 3-axis Compass
-| MPU6886          | :heart:        | I2C       | `Sensor::MPU6886`  | 3-axis Gyro + Accel
+| ADXL345          | :heart:        | I2C       | `Sensor::ADXL345`  | Accelerometer
+| IT3205           | :heart:        | I2C       | `Sensor::IT3205`   | Gyroscope
+| HMC5883L         | :heart:        | I2C       | `Sensor::HMC5883L` | Compass
+| MPU6886          | :heart:        | I2C       | `Sensor::MPU6886`  | Gyro + Accelerometer
+| BMI160           | :heart:        | I2C       | `Sensor::BMI160`   | Gyro + Accelerometer
+| LSM6DS3          | :heart:        | I2C       | `Sensor:LSM6DS3`   | Gyro + Accelerometer
 
 ### Real Time Clocks
 
 | Name             | Status         | Interface | Component Class   | Notes |
 | :--------------- | :------:       | :-------- | :---------------  |------ |
 | DS1302           | :heart:        | I2C       | `RTC::DS1302`     |
+| DS1307           | :heart:        | I2C       | `RTC::DS1307`     |
 | DS3231           | :green_heart:  | I2C       | `RTC::DS3231`     | Alarms not implemented
+| PCF8563          | :heart:        | I2C       | `RTC::PCF8563`    |
 
 ### GPS
 

data/README.md

@@ -1,4 +1,4 @@
-# Denko 0.13.3 [![Test Status](https://github.com/denko-rb/denko/actions/workflows/ruby.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/ruby.yml)
+# Denko 0.13.4 [![Test Status](https://github.com/denko-rb/denko/actions/workflows/ruby.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/ruby.yml)
 ### Ruby Meets Microcontrollers
 Denko gives you a high-level Ruby interface to low-level hardware, without writing microcontroller code. Use LEDs, buttons, sensors and more, just as easily as any Ruby object:
 
@@ -23,10 +23,10 @@ High-level abstraction in Ruby makes hardware classes easy to implement, with in
 Full list of supported mircocontroller platforms, interfaces, and peripherals is located [here](HARDWARE.md).
 
 ##### denko-piboard
-There's an add-on  in development, [denko-piboard](https://github.com/denko-rb/denko-piboard), which supports the Raspberry Pi's built in GPIO pins, as `Denko::PiBoard`, class-compatible with `Denko::Board`. Connect peripherals directly to the Pi, with no microcontroller between, then use the peripheral classes from this gem.
+The add-on gem, [denko-piboard](https://github.com/denko-rb/denko-piboard), allows you to use a Raspberry Pi's built in GPIO pins in place of an attached microcontroller. Connect things directly to the Pi, and use the same peripheral classes from this gem.
 
 ##### mruby-denko
-A solo Raspberry Pi (or other small SBC + microcontroller) is a great standalone setup if your project needs the compute power anyway, but what if you don't? Why not run Ruby on the microcontroller itself? 
+A solo Raspberry Pi (or other small SBC + microcontroller) is a great standalone setup if your project needs the compute power anyway, but what if you don't? Why not run Ruby on the microcontroller itself?
 
 That's the goal of [mruby-denko](https://github.com/denko-rb/mruby-denko): write mruby on the ESP32, using peripheral classes as close to this gem as possible. Still early in development, so limited features, but already usable.
 

data/examples/advanced/m5_env.rb

@@ -0,0 +1,48 @@
+#
+# This example combines the SHTX and QMP6988 examples. The M5Stack ENV III unit
+# contains both sensors, accessible over a single I2C connection.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
+sht = Denko::Sensor::SHT3X.new(bus: bus) # address: 0x44 default
+qmp = Denko::Sensor::QMP6988.new(bus: bus) # address: 0x70 default
+
+# Configure for higher accuracy.
+sht.repeatability = :high
+qmp.temperature_samples = 2
+qmp.pressure_samples = 16
+qmp.iir_coefficient = 2
+
+# Buggy on ESP32-S3 in forced mode. Data registers return zeroes on all but first read.
+# Can't recreate on ESP32 V1, AVR or SAMD21. Put it in contiuous mode just in case.
+qmp.continuous_mode
+
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative '../sensor/neat_tph_readings'
+
+# How many degrees C the two temperature values can differ by before a warning.
+TOLERANCE = 0.50
+
+loop do
+  # Read both sensors.
+  qmp_reading = qmp.read
+  sht_reading = sht.read
+
+  # Retry immediately if either failed.
+  next unless (sht_reading && qmp_reading)
+  
+  # Warn if large gap between temperature readings.
+  difference = (qmp_reading[:temperature] - sht_reading[:temperature]).abs
+  if (difference > TOLERANCE)
+    puts "WARNING: temperature values differed by more than #{TOLERANCE}\xC2\xB0C (#{difference.round(4)} \xC2\xB0C actual)"
+  end
+
+  # Combine values from both sensors, averaging their temperatures.
+  average_temperature = (qmp_reading[:temperature] + sht_reading[:temperature]) / 2.0
+  print_tph_reading(temperature: average_temperature, humidity: sht_reading[:humidity], pressure: qmp_reading[:pressure])
+
+  sleep 5
+end

data/examples/digital_io/button.rb

@@ -0,0 +1,13 @@
+#
+# Simple button example.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+button = Denko::DigitalIO::Button.new(board: board, pin: 5, pullup: true)
+
+button.up   { puts "Button released!" } 
+button.down { puts "Button pressed!" }
+
+sleep

data/examples/sensor/aht10.rb

@@ -6,10 +6,14 @@ require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
 bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
-aht10 = Denko::Sensor::AHT10.new(bus: bus)
+sensor = Denko::Sensor::AHT10.new(bus: bus) # address: 0x38 default
 
-aht10.poll(2) do |reading|
-  puts "Polled Reading: #{reading[:temperature].round(3)} \xC2\xB0C | #{reading[:humidity].round(3)} % RH"
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
+
+# Poll it and print readings.
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
 end
 
 sleep

data/examples/sensor/aht20.rb

@@ -6,10 +6,14 @@ require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
 bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
-aht20 = Denko::Sensor::AHT20.new(bus: bus)
+sensor = Denko::Sensor::AHT20.new(bus: bus) # address: 0x38 default
 
-aht20.poll(2) do |reading|
-  puts "Polled Reading: #{reading[:temperature].round(3)} \xC2\xB0C | #{reading[:humidity].round(3)} % RH"
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
+
+# Poll it and print readings.
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
 end
 
 sleep

data/examples/sensor/bme280.rb

@@ -5,28 +5,11 @@ require 'bundler/setup'
 require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
-
-#
-# Default pins for the I2C0 (first) interface on most chips:
-#
-# ATmega 328p:       SDA = 'A4'  SCL = 'A5' - Arduino Uno, Nano
-# ATmega 32u4:       SDA =   2   SCL =   3  - Arduino Leonardo, Pro Micro
-# ATmega1280 / 2560: SDA =  20   SCL =  21  - Arduino Mega
-# SAM3X8E:           SDA =  20   SCL =  21  - Arduino Due
-# SAMD21G18:         SDA =  20   SCL =  21  - Arduino Zero, M0, M0 Pro
-# ESP8266:           SDA =   4   SCL =   5
-# ESP32:             SDA =  21   SCL =  22
-# RP2040:            SDA =   4   SCL =   5  - Raspberry Pi Pico (W)
-#
-# Only give the SDA pin of the I2C bus. SCL (clock) pin must be 
-# connected for it to work, but we don't need to control it.
-#
 bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
 
-sensor = Denko::Sensor::BME280.new(bus: bus, address: 0x76)
-
+sensor = Denko::Sensor::BME280.new(bus: bus) # address: 0x76 default
 # Use A BMP280 with no humidity instead.
-# sensor = Denko::Sensor::BMP280.new(bus: bus, address: 0x76)
+# sensor = Denko::Sensor::BMP280.new(bus: bus) # address: 0x76
 
 # Default reading mode is oneshot ("forced" in datasheet).
 # sensor.oneshot_mode
@@ -44,32 +27,12 @@ sensor = Denko::Sensor::BME280.new(bus: bus, address: 0x76)
 # Print raw config register bits.
 # print sensor.config_register_bits
 
-def display_reading(reading)
-  # Time
-  print "#{Time.now.strftime '%Y-%m-%d %H:%M:%S'} - "
-  
-  # Temperature
-  formatted_temp = reading[:temperature].round(2).to_s.ljust(5, '0')
-  print "Temperature: #{formatted_temp} \xC2\xB0C"
-  
-  # Pressure
-  if reading[:pressure]
-    formatted_pressure = (reading[:pressure] / 101325).round(5).to_s.ljust(7, '0')
-    print " | Pressure #{formatted_pressure} atm"
-  end
-  
-  # Humidity  
-  if reading[:humidity]
-    formatted_humidity = reading[:humidity].round(2).to_s.ljust(5, '0')
-    print " | Humidity #{formatted_humidity} %"
-  end
-  
-  puts
-end
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
 
-# Poll the sensor and print readings.
+# Poll it and print readings.
 sensor.poll(5) do |reading|
-  display_reading(reading)
+  print_tph_reading(reading)
 end
 
 sleep

data/examples/sensor/bmp180.rb

@@ -0,0 +1,22 @@
+#
+# Example using a BMP180 sensor over I2C, for temperature and pressure.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
+sensor = Denko::Sensor::BMP180.new(bus: bus) # address: 0x77 default
+
+# Enable oversampling for the pressure sensor only (1,2,4, 8).
+# sensor.pressure_samples = 8
+
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
+
+# Poll it and print readings.
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
+end
+
+sleep

data/examples/sensor/generic_pir.rb

@@ -0,0 +1,25 @@
+#
+# Example using a PIR motion sensor. Tested with AS312 and HC-SR501 sensors.
+#
+# General notes:
+#   - Both sensors have a few seconds "dead time" after "motion stop" (logical 0), where further
+#     motion will not trigger "motion start" (logical 1).
+#
+# HC-SR501 notes:
+#   - Needs some time to warm up and start working properly.
+#   - Set the time potentiometer to its lowest value.
+#   - Make sure retriggering is enabled. It might be default, but there's a jumper to solder too.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+sensor = Denko::Sensor::GenericPIR.new(board: board, pin: 8)
+
+sensor.on_motion_start { print "Motion detected!      \r" }
+sensor.on_motion_stop  { print "No motion detected... \r" }
+
+# Read initial state.
+sensor.read
+
+sleep

data/examples/sensor/htu21d.rb

@@ -6,7 +6,7 @@ require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
 bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
-htu21d = Denko::Sensor::HTU21D.new(bus: bus)
+htu21d = Denko::Sensor::HTU21D.new(bus: bus) # address: 0x40 default
 
 # Get and set heater state.
 htu21d.heater_on

data/examples/sensor/htu31d.rb

@@ -6,26 +6,30 @@ require 'denko'
 
 board = Denko::Board.new(Denko::Connection::Serial.new)
 bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
-htu31d = Denko::Sensor::HTU31D.new(bus: bus)
+sensor = Denko::Sensor::HTU31D.new(bus: bus)
 
 # Get and set heater state.
-htu31d.heater_on
-puts "Heater on: #{htu31d.heater_on?}"
-htu31d.heater_off
-puts "Heater off: #{htu31d.heater_off?}"
+sensor.heater_on
+puts "Heater on: #{sensor.heater_on?}"
+sensor.heater_off
+puts "Heater off: #{sensor.heater_off?}"
 
 # Back to default settings, including heater off, unlike HTU21D.
-htu31d.reset
-puts "Resetting HTU31D... Heater off: #{htu31d.heater_off?}"
+sensor.reset
+puts "Resetting HTU31D..."
+puts "Heater off: #{sensor.heater_off?}"
 puts
 
 # Resolution goes from 0..3 separately for temperature and humidity. See datasheet.
-htu31d.temperature_resolution = 3
-htu31d.humidity_resolution = 3
+sensor.temperature_resolution = 3
+sensor.humidity_resolution = 3
+
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
 
 # Unlike HTU21D, HTU31D works as a regular polled sensor.
-htu31d.poll(2) do |reading|
-  puts "Polled Reading: #{reading[:temperature].round(3)} \xC2\xB0C | #{reading[:humidity].round(3)} % RH"
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
 end
 
 sleep

data/examples/sensor/neat_tph_readings.rb

@@ -0,0 +1,26 @@
+#
+# This helper method can be used in temp/pressure/humidity sensor examples.
+# Give a hash with readings as float values and it prints them neatly.
+#
+def print_tph_reading(reading)
+  # Time
+  print "#{Time.now.strftime '%Y-%m-%d %H:%M:%S'} - "
+  
+  # Temperature
+  formatted_temp = reading[:temperature].to_f.round(2).to_s.ljust(5, '0')
+  print "Temperature: #{formatted_temp} \xC2\xB0C"
+  
+  # Pressure
+  if reading[:pressure]
+    formatted_pressure = (reading[:pressure] / 101325).round(5).to_s.ljust(7, '0')
+    print " | Pressure #{formatted_pressure} atm"
+  end
+  
+  # Humidity  
+  if reading[:humidity]
+    formatted_humidity = reading[:humidity].round(2).to_s.ljust(5, '0')
+    print " | Humidity #{formatted_humidity} %"
+  end
+  
+  puts
+end

data/examples/sensor/qmp6988.rb

@@ -0,0 +1,53 @@
+#
+# Example using QMP6988 sensor over I2C, for air temperature and pressure.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
+sensor = Denko::Sensor::QMP6988.new(bus: bus) # address: 0x70 default
+
+# Verify chip_id.
+print "I2C device has chip ID: 0x#{sensor.chip_id.to_s(16).upcase}. "
+if sensor.chip_id == 0x5C
+  puts "This matches the QMP6988."
+else
+  puts "This does not match the QMP6988."
+end
+puts
+
+#
+# Change measurement settings:
+#   temperature_samples can be 1,2,4,8,16,32 or 64 (default: 1)
+#   pressure_samples    can be 1,2,4,8,16,32 or 64 (default: 1)
+#   iir_coefficient     can be 0,2,4,8,16 or 32    (default: 0)
+#
+# High accuracy settings from datasheet, with IIR of 2.
+sensor.temperature_samples = 2
+sensor.pressure_samples = 16
+sensor.iir_coefficient = 2
+
+#
+# Change mode (default: forced_mode)
+#
+# Buggy on ESP32S3 in forced mode. Data registers return zeroes on all but first read.
+# Can't recreate on ESP32 V1, AVR or SAMD21. Put it in contiuous mode just in case.
+sensor.continuous_mode
+# sensor.forced_mode
+
+#
+# Set standby time (between measurements) for continuous mode only:
+#   standby_time (given in ms) can be 1,5,20,250,500,1000,2000 or 4000 (default: 1)
+#
+# sensor.standby_time = 500
+
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
+
+# Poll it and print readings.
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
+end
+
+sleep

data/examples/sensor/rcwl9620.rb

@@ -0,0 +1,15 @@
+#
+# Example using an RCWL-9620 sensor over I2C to measure distance.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
+sensor = Denko::Sensor::RCWL9620.new(bus: bus) # address: 0x57 default
+
+sensor.poll(1) do |distance|
+  puts "Distance is #{distance} mm"
+end
+
+sleep

data/examples/sensor/sht3x.rb

@@ -0,0 +1,34 @@
+#
+# Example using SHT30/31/35 sensor over I2C, for temperature and humidity.
+#
+require 'bundler/setup'
+require 'denko'
+
+board = Denko::Board.new(Denko::Connection::Serial.new)
+bus = Denko::I2C::Bus.new(board: board, pin: :SDA)
+sensor = Denko::Sensor::SHT3X.new(bus: bus) # address: 0x44 default
+
+# Heater control
+sensor.heater_on
+puts "Heater on: #{sensor.heater_on?}"
+sensor.heater_off
+puts "Heater off: #{sensor.heater_off?}"
+
+# Reset (turns heater off)
+sensor.reset
+puts "Resetting..."
+puts "Heater off: #{sensor.heater_off?}"
+puts
+
+# Set repeatability= :low, :medium or :high (default). See datasheet for details.
+sensor.repeatability = :high
+
+# Get the shared #print_tph_reading method to print readings neatly.
+require_relative 'neat_tph_readings'
+
+# Poll it and print readings.
+sensor.poll(5) do |reading|
+  print_tph_reading(reading)
+end
+
+sleep

data/lib/denko/sensor/bme280.rb

@@ -28,7 +28,7 @@ module Denko
       # be skipped, since the other 2 calculations depend on it.
       #
       # General formula:
-      #   2 ^ (n-1), where n is the decimal value of the bits, up to 16x max oversampling.
+      #   2 ** (n-1), where n is the decimal value of the bits, up to 16x max oversampling.
       #
       OVERSAMPLE_FACTORS = {
                               0  =>  0b000, # Sensor skipped. Value will be 0x800000.