denko 0.14.0 → 0.15.0

data/HARDWARE.md

@@ -1,263 +0,0 @@
-# Microcontrollers
-
-:green_heart: Full support :yellow_heart: Partial support :heart: Planned. No support yet :question: Works in theory. Untested in real hardware.
-
-### Espressif Chips with Wi-Fi (Except H2)
-[![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)
-[![ESP32-C3 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32c3.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32c3.yml)
-[![ESP32-C6 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32c6.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32c6.yml)
-[![ESP32-H2 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32h2.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32h2.yml)
-[![ESP32-S2 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32s2.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32s2.yml)
-[![ESP32-S3 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_esp32s3.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_esp32s3.yml)
-
-|    Chip        | Status          | Board Tested         | Notes |
-| :--------      | :------:        | :---------------     |------ |
-| ESP8266        | :green_heart:   | NodeMCU              |
-| ESP8285        | :question:      | DOIT ESP-Mx DevKit   | Should be identical to 8266. Not tested in hardware.
-| ESP32          | :green_heart:   | DOIT ESP32 DevKit V1 |
-| ESP32-S2       | :green_heart:   | LOLIN S2 Pico        | Native USB-CDC (broken in core 3.0+)
-| ESP32-S3       | :green_heart:   | LOLIN S3 V1.0.0      | Native USB-CDC (broken in core 3.0+)
-| ESP32-C3       | :green_heart:   | LOLIN C3 Mini V2.1.0 | Native USB-CDC (broken in core 3.0+)
-| ESP32-H2       | :green_heart:   | ESP32-H2-MINI-1      | No Wi-Fi. Native USB-CDC (broken in core 3.0+)
-| ESP32-C6       | :green_heart:   | ESP32-C6-WROOM-1     | Native USB-CDC (broken in core 3.0+)
-
-**Note:** For ESP32 chips using native USB-CDC, make sure `USB CDC On Boot` is `Enabled` in the IDE's `Tools` menu. Flashing from the CLI doesn't automatically enable this, so the IDE is recommended for now.
-
-**Note:** Since Arduino ESP32 Core version 3.0+, USB-CDC is very unreliable when sending lots of data both directions (something denko can do). It's a known issue in the core. Use a regular UART until it's fixed.
-
-### AVR/MegaAVR Based Arduino Products (and Clones)
-[![AVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_atmega_avr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_atmega_avr.yml)
-[![MegaAVR Build Status](https://github.com/denko-rb/denko/actions/workflows/build_atmega_megaavr.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_atmega_megaavr.yml)
-
-|    Chip        | Status          | Products         | Notes |
-| :--------      | :------:        | :--------------- |------ |
-| ATmega168      | :green_heart:   | Duemilanove, Diecimila, Pro | Omits features. `denko targets` for info.
-| ATmega328      | :green_heart:   | Uno R3, Uno WiFi, Nano, Fio, Pro  |
-| ATmega32u4     | :green_heart:   | Leonardo, Micro, Leonardo ETH, Esplora, LilyPad USB |
-| ATmega1280     | :green_heart:   | Mega |
-| ATmega2560     | :green_heart:   | Mega2560, Arduino Mega ADK |
-| ATmega4809     | :green_heart:   | Nano Every, Uno WiFi Rev2 |
-
-**Note:** Only USB boards listed. Any board with a supported chip should work, once you can flash it and connect to serial.
-
-### ARM Based Arduino Products (and Clones)
-[![SAM3X Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_atsam3x.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_atsam3x.yml)
-[![SAMD Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_atsamd21.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_atsamd21.yml)
-[![RA4M1 Build Satus](https://github.com/denko-rb/denko/actions/workflows/build_ra4m1.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_ra4m1.yml)
-
-|    Chip        | Status          | Products         | Notes |
-| :--------      | :------:        | :--------------- |------ |
-| ATSAM3X8E      | :yellow_heart:  | Due | Uses Native USB. Tone and IR Out don't work.
-| ATSAMD21       | :green_heart:   | Zero, M0 Series, Nano 33 IOT, MKR WiFi 1010 | Native USB
-| RA4M1          | :yellow_heart:  | Uno R4 Minima, Uno R4 WiFi | IR and WS2812 libraries don't support this yet
-
-### Arduino Networking
-
-|    Chip               | Status          | Products         | Notes |
-| :--------             | :------:        | :--------------- |------ |
-| Wiznet W5100/5500     | :green_heart:   | Ethernet Shield  | Wired Ethernet for Uno/Mega pin-compatibles
-| HDG204 + AT32UC3      | :question:      | WiFi Shield      | Compiles, but no hardware
-| 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. |
-
-### Raspberry Pi Microcontrollers
-[![RP2040 Build Status](https://github.com/denko-rb/denko/actions/workflows/build_rp2040.yml/badge.svg)](https://github.com/denko-rb/denko/actions/workflows/build_rp2040.yml)
-
-|    Chip        | Status          | Board Tested          | Notes |
-| :--------      | :------:        | :---------------      |------ |
-| RP2040         | :green_heart:   | Raspberry Pi Pico (W) |
-
-# Single Board Computers
-
-See the [Support](https://github.com/denko-rb/denko-piboard?tab=readme-ov-file#support) section of denko-piboard.
-
-# Peripherals
-
-:green_heart: Full support :yellow_heart: Partial support :heart: Planned. No support yet
-
-### Interfaces
-
-| Name                  | Status          | HW/SW | Component Class          | Notes |
-| :---------------      | :------:        | :---  | :--------------          | :---- |
-| Digital In            | :green_heart:   | H     | `DigitalIO::Input`       | 1ms - 128ms (4ms default) listen, poll, or read
-| Analog In (ADC)       | :green_heart:   | H     | `AnalogIO::Input`        | 1ms - 128ms (16ms default) listen, poll, or read
-| Digital Out           | :green_heart:   | H     | `DigitalIO::Output`      |
-| Analog Out (DAC)      | :green_heart:   | H     | `AnalogIO::Output`       | **Only** SAM3X, SAMD21, RA4M1, ESP32, ESP32-S2
-| PWM Out               | :green_heart:   | H     | `PulseIO::PWMOutput`     |
-| Servo/ESC Motor Drive | :green_heart:   | H     | See Motor Driver Table   | Depends on PWM
-| Tone Out (Sq. Wave)   | :green_heart:   | H     | `PulseIO::Buzzer`        | Except SAM3X. Uses PWM
-| I2C                   | :green_heart:   | H     | `I2C::Bus`               | Predetermined pins per board
-| I2C Bit-Bang          | :green_heart:   | S     | `I2C::BitBang`           | Any pins
-| SPI                   | :green_heart:   | H     | `SPI::Bus`               | Predetermined pins per board
-| SPI Bit-Bang          | :green_heart:   | S     | `SPI::BitBang`           | Any pins
-| UART                  | :green_heart:   | H     | `UART::Hardware`         | **Except** Atmega328, ATmega168
-| UART Bit-Bang         | :green_heart:   | S     | `UART::BitBang`          | **Only** ATmega328
-| Maxim OneWire         | :green_heart:   | S     | `OneWire::Bus`           | No overdrive
-| Infrared Output       | :green_heart:   | S     | `PulseIO::IROutput`      | **Except** SAM3X, RA4M1
-| Infrared Input        | :heart:         | S     | `PulseIO::IRInput`       | Doable with existing library
-| WS2812 RGB LEDs       | :green_heart:   | S     | `LED::WS2812`            | **Except** RA4M1
-| ESP32-PCNT            | :heart:         | H     | -                        | **Only** ESP32. Pulse and encoder counter
-| ESP32-MCPWM           | :heart:         | H     | -                        | **Only** ESP32. Motor control PWM
-
-**Note:** When listening, the board checks the pin's value every **_2^n_** milliseconds (**_n_** from **_0_** to **_7_**), without further commands.
-Polling and reading follow a call and response pattern.
-
-### Basic Input/Output
-
-| Name             | Status         | Interface    | Component Class            | Notes |
-| :--------------- | :------:       | :--------    | :---------------           |------ |
-| Button           | :green_heart:  | Digital In   | `DigitalIO::Button`        |
-| Rotary Encoder   | :green_heart:  | Digital In   | `DigitalIO::RotaryEncoder` | Listens every 1ms
-| Potentiometer    | :green_heart:  | Analog In    | `AnalogIO::Potentiometer`  | Smoothing on by default
-| Relay            | :green_heart:  | Digital Out  | `DigitalIO::Relay`         |
-
-### LEDs
-
-| Name               | Status             | Interface         | Component Class       | Notes |
-| :---------------   | :------:           | :--------         | :---------------      |------ |
-| 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`         |
-
-### Displays
-
-| Name                     | Status         | Interface                    | Component Class     | Notes |
-| :---------------         | :------:       | :--------                    | :---------------    |------ |
-| HD44780 LCD              | :green_heart:  | Digital Out, Output Register | `Display::HD44780`  |
-| SSD1306 OLED             | :yellow_heart: | I2C or SPI                   | `Display::SSD1306`  | 1 font, some graphics
-| SH1106  OLED             | :yellow_heart: | I2C or SPI                   | `Display::SH1106`   | Works same as SSD1306
-| 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
-
-| Name             | Status         | Interface    | Component Class            | Notes |
-| :--------------- | :------:       | :--------    | :---------------           |------ |
-| Piezo Buzzer     | :green_heart:  | Tone Out     | `PulseIO::Buzzer`          | Frequency > 30Hz
-
-### Motors / Motor Drivers
-
-| Name                 | Status         | Interface      | Component Class    | Notes |
-| :---------------     | :------:       | :--------      | :---------------   |------ |
-| Generic Hobby Servo  | :green_heart:  | Servo/ESC PWM  | `Motor::Servo`     | Max depends on PWM channel count
-| Generic ESC          | :yellow_heart: | Servo/ESC PWM  | `Motor::Servo`     | Works. Needs its own class.
-| PCA9685              | :heart:        | I2C            | `PulseIO::PCA9685` | 16-ch, 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
-| TB6612               | :heart:        | Digi + PWM Out | `Motor::TB6612`    | H-Bridge DC motor driver
-| A3967                | :green_heart:  | Digital Out    | `Motor::Stepper`   | 1-ch microstepper (EasyDriver)
-| A4988                | :yellow_heart: | DigitalOut     | `Motor::Stepper`   | 1-ch microstepper
-| TMC2209              | :heart:        | -              | -                  | 1-ch silent stepper driver
-
-### I/O Expansion
-
-| Name             | Status         | Interface  | Component Class      | Notes |
-| :--------------- | :------:       | :--------  | :---------------     |------ |
-| Input Register   | :green_heart:  | SPI        | `SPI::InputRegister` | Tested on CD4021B
-| Output Register  | :green_heart:  | SPI        | `SPI::OutputRegister`| Tested on 74HC595
-| PCF8574 Expander | :heart:        | I2C        | `DigitalIO::PCF8574` | 8-ch bi-directional digital I/O
-| ADS1100 ADC      | :green_heart:  | I2C        | `AnalogIO::ADS1100`  | 1-ch, 16-bit ADC. No continuous mode.
-| ADS1115 ADC      | :green_heart:  | I2C        | `AnalogIO::ADS1115`  | 4-ch, 16-bit ADC. Comparator not implemented.
-| ADS1118 ADC      | :green_heart:  | SPI        | `AnalogIO::ADS1118`  | 4-ch, 16-bit ADC + temperature
-| ADS1232 ADC      | :heart:        | SPI        | `AnalogIO::ADS1232`  | 2-ch, 24-bit ADC + temperature
-| PCF8591 ADC/DAC  | :heart:        | I2C        | `AnalogIO::PCF8591`  | 4-ch, 8-bit ADC + 1-ch 8-bit DAC
-| MCP4725 DAC      | :heart:        | I2C        | `AnalogIO::MCP4275`  | 1-ch, 12-bit DAC
-| PCA9548 I2C Mux  | :heart:        | I2C        | `I2C::PCA9548`       | 8-way I2C multiplexer
-
-### Environmental Sensors
-
-| 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
-| SHT40/41         | :heart:        | I2C         | `Sensor::SHT4X`    | Temp / RH                |
-| 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        |
-| BME680           | :heart:        | I2C         | `Sensor::BME680`   | Temp / Press / RH / TVOC |
-| 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`   | eCO2 / TVOC / AQI        |
-| AGS02MA          | :heart:        | I2C         | `Sensor::AGS02MA`  | TVOC                     |
-| SCD40            | :heart:        | I2C         | `Sensor::SDC40`    | Temp / Press / CO2       |
-| CCS811           | :heart:        | I2C         | `Sensor::CCS811`   | eCO2                     |
-
-### Light Sensors
-
-| Name             | Status         | Interface    | Component Class    | Notes |
-| :--------------- | :------:       | :--------    | :---------------   |------ |
-| BH1750           | :heart:        | Digital In   | `Sensor::BH1750`   | Ambient Light
-| 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` |
-| HC-SR505         | :yellow_heart: | Digital In   | `Sensor::GenericPIR` |
-| AS312            | :green_heart:  | Digital In   | `Sensor::GenericPIR` |
-| AM312            | :yellow_heart: | Digital In   | `Sensor::GenericPIR` |
-
-### Distance Sensors
-
-| Name             | Status         | Interface    | Component Class    | Notes |
-| :--------------- | :------:       | :--------    | :---------------   |------ |
-| HC-SR04          | :green_heart:  | Digi In/Out  | `Sensor::HCSR04`   | Ultrasonic, 20-4000mm
-| 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
-
-### Inertial Measurement Units
-
-| Name             | Status         | Interface | Component Class    | Notes |
-| :--------------- | :------:       | :-------- | :---------------   |------ |
-| ADXL345          | :heart:        | I2C       | `Sensor::ADXL345`  | Accelerometer
-| IT3205           | :heart:        | I2C       | `Sensor::IT3205`   | Gyroscope
-| HMC5883L         | :heart:        | I2C       | `Sensor::HMC5883L` | Compass
-| MPU6050          | :heart:        | I2C       | `Sensor::MPU6050`  | Gyro + Accelerometer
-| 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
-
-| Name             | Status         | Interface | Component Class   | Notes |
-| :--------------- | :------:       | :-------- | :---------------  |------ |
-| GT-U7            | :heart:        | UART      | -                 |
-
-### Miscellaneous
-
-| Name             | Status         | Interface  | Component Class      | Notes |
-| :--------------- | :------:       | :--------  | :---------------     |------ |
-| Board EEPROM     | :green_heart:  | Built-In   | `EEPROM::BuiltIn`    | Arduino ARM boards have no EEPROM
-| MFRC522          | :heart:        | SPI/I2C    | `DigitalIO::MFRC522` | RFID tag reader / writer

data/benchmarks/analog_listen.rb

@@ -1,49 +0,0 @@
-#
-# Find how much analog listen throughput is available from a Board.
-#
-# To find the limit, add more pins and/or reduce the divider until
-# the rate per input pin can't meet the target.
-#   Example: Rate per input pin is < 500 Hz when divider is 2 ms.
-#
-require 'bundler/setup'
-require 'denko'
-
-# In seconds
-TEST_TIME = 30
-
-# Millisecond interval for analog listeners
-# Valid values: 1, 2, 4, 8, 16, 32, 64, 128
-DIVIDER = 2
-
-# Input pins to read
-PINS = [:A0, :A1]
-
-connection = Denko::Connection::Serial.new
-board      = Denko::Board.new(connection)
-inputs     = PINS.map { |pin| Denko::AnalogIO::Input.new(pin: pin, board: board) }
-
-# No mutex. Denko::Board callbacks are sequential, regardless of Ruby engine.
-$readings = 0
-inputs.each do |input|
-  input.add_callback { $readings += 1 }
-  input.listen(DIVIDER)
-end
-
-print "Sampling for #{TEST_TIME} seconds... "
-
-# Main test
-start = Time.now
-$readings = 0
-sleep TEST_TIME
-finish = Time.now
-# Copy immediately to another variable before stopping inputs.
-readings = $readings
-inputs.each { |input| input.stop }
-
-puts "Done."; puts
-
-rps   = (readings / (finish - start))
-rpspi = rps / inputs.count
-puts "Total analog readings : #{readings}"
-puts "Analog readings /s    : #{rps.round(3)}"
-puts "Rate per input pin    : #{rpspi.round(3)} Hz"

data/benchmarks/digital_write.rb

@@ -1,28 +0,0 @@
-#
-# Benchmark digital write throughput for a Denko::Board instance.
-#
-require 'bundler/setup'
-require 'denko'
-
-# Pins > 63 will not benefit from the single-byte message optimization.
-PIN          = 4
-TOTAL_WRITES = 200_000
-
-connection = Denko::Connection::Serial.new
-board      = Denko::Board.new(connection)
-output     = Denko::DigitalIO::Output.new(board: board, pin: PIN)
-
-print "Testing #{TOTAL_WRITES} digital writes... "
-
-start = Time.now
-(TOTAL_WRITES / 2).times do
-  output.high
-  output.low
-end
-board.finish_write
-finish = Time.now
-
-puts "Done."; puts
-
-wps = TOTAL_WRITES / (finish - start)
-puts "Digital writes per second : #{wps.round(3)}"

data/benchmarks/i2c_ssd1306_refresh.rb

@@ -1,91 +0,0 @@
-#
-# Repeatedly writes filled and empty frames to the OLED
-# Calculates frames per second. Higher is better.
-#
-# RESULTS:
-# July 6 2023 | i7 8700k CPU | CRuby 3.2.1 | 100 frames | 1 Mhz I2C frequency | Average of 3 runs
-#
-#   Arduino Uno R3      :  5.3 fps (ATmega16u2 UART bridge @ 115200, no I2C level shifter)
-#   Arduino Uno R3      :  7.1 fps (ATmega16u2 UART bridge @ 230400, no I2C level shifter)
-#   Arduino Leonardo    : 12.9 fps (native USB, no I2C level shifter)
-#   Arduino Due         : 43.0 fps (native USB)
-#   Arduino Due         :  7.9 fps (programming USB @ 115200)
-#   Arduino Zero        : 28.6 fps (native USB)
-#   Arduino Zero        :  9.4 fps (programming USB @ 115200)
-#   Arduino Zero        : 13.6 fps (programming USB @ 230400)
-#   ESP8266 (Node MCU)  :  9.9 fps (Silicon Labs UART bridge @ 115200)
-#   ESP8266 (Node MCU)  : 19.7 fps (Silicon Labs UART bridge @ 230400)
-#   ESP32 V1            :  9.8 fps (Silicon Labs UART bridge @ 115200)
-#   ESP32 V1            : 19.4 fps (Silicon Labs UART bridge @ 230400)
-#   ESP32-S3            : 58.8 fps (native USB)
-#   Raspberry Pi Pico W : 36.4 fps (native USB)
-#
-# July 15 2023 | i7 8700k CPU | CRuby 3.2.1 | 100 frames | 1 Mhz I2C frequency | Average of 3 runs
-#
-#   Arduino Uno R4 WiFi :  7.5 fps (USB through ESP32-S3 @ 115200, 32-byte I2C limit, no I2C level shifter)
-#   Arduino Uno R4 WiFi :  7.8 fps (USB through ESP32-S3 @ 230400, 32-byte I2C limit, no I2C level shifter)
-#
-# August 13 2023 | i7 8700k CPU | CRuby 3.2.1 | 100 frames | 1 Mhz I2C frequency | Average of 3 runs
-#
-#   Arduino Nano Every  :  9.2 fps (USB through ATSAMD11 @ 115200, 128-byte I2C limit, no I2C level shifter)
-#   Arduino Nano Every  : 13.0 fps (USB through ATSAMD11 @ 230400, 128-byte I2C limit, no I2C level shifter)
-#
-# February 25 2024 | i7 8700k CPU | CRuby 3.2.1 | 100 frames | 1 Mhz I2C frequency | Average of 3 runs
-#
-#   ESP32-S3            : 51.8 fps (native USB) - Changed from 64 to 128 serial ACK interval
-#   ESP32-C3            : 51.7 fps (native USB) - Changed from 64 to 128 serial ACK interval
-#
-# July 27 2024 | i7 8700k CPU | CRuby 3.3.1 | 100 frames | Average of 3 runs
-#
-#   ESP32-H2            :  7.3 fps (WCH UART bridge @ 115200, I2C @ 400kHz)
-#   ESP32-H2            : 10.9 fps (WCH UART bridge @ 230400, I2C @ 400kHz)
-#   ESP32-C6            :  8.0 fps (WCH UART bridge @ 115200, I2C @ 1MHz)
-#   ESP32-C6            : 13.2 fps (WCH UART bridge @ 230400, I2C @ 1MHz)
-#
-require 'bundler/setup'
-require 'denko'
-
-# Settings
-# Must match speed in the sketch for UART briges. Doesn't matter for native USB.
-BAUD_RATE     = 115_200
-FRAME_COUNT   = 100
-# Request 1 Mhz I2C frequency. Wire libraries will fall back to fastest available speed.
-I2C_FREQUENCY = 1_000_000
-# Use :SDA0 for RP2040
-I2C_PIN       = :SDA
-
-# Setup
-board  = Denko::Board.new(Denko::Connection::Serial.new(baud: BAUD_RATE))
-bus    = Denko::I2C::Bus.new(board: board)
-oled   = Denko::Display::SSD1306.new(bus: bus, rotate: true, i2c_frequency: I2C_FREQUENCY)
-canvas = oled.canvas
-
-# Intro
-canvas.print "SSD1306 Benchmark"
-oled.draw
-sleep 1
-
-# Run
-start = Time.now
-(FRAME_COUNT / 2).times do
-  canvas.fill
-  oled.draw
-  canvas.clear
-  oled.draw
-end
-board.finish_write
-finish = Time.now
-
-# Calculate results
-fps = FRAME_COUNT / (finish - start)
-
-# Print to terminal
-puts "SSD1306 benchmark result: #{fps.round(2)} fps"
-puts
-
-# Print to screen
-canvas.clear
-canvas.text_cursor = [0,0]
-canvas.print "#{fps.round(2)} fps"
-oled.draw
-board.finish_write

data/examples/advanced/m5_env3.rb

@@ -1,46 +0,0 @@
-#
-# 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'
-require_relative '../sensor/neat_tph_readings'
-
-# How many degrees C the two temperature values can differ by before a warning.
-TOLERANCE = 0.50
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-bus   = Denko::I2C::Bus.new(board: board)
-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
-
-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)"
-  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/advanced/rotary_encoder_mac_volume.rb

@@ -1,53 +0,0 @@
-#
-# Example using a KY-040 (30 detent) rotary encoder as a mac volume control.
-#
-require 'bundler/setup'
-require 'denko'
-
-PIN_A = 4
-PIN_B = 5
-
-board   = Denko::Board.new(Denko::Connection::Serial.new)
-encoder = Denko::DigitalIO::RotaryEncoder.new  board: board,
-                                               pins:  { a: PIN_A, b: PIN_B }
-
-# Set up a pseudo terminal with osascript (AppleScript) in interactive mode.
-# Calling a separate script each update is too slow.
-class AppleVolumeWrapper
-  require 'pty'
-  require 'expect'
-
-  def initialize
-    @in, @out, pid = PTY.spawn('osascript -i')
-    @in.expect(/>> /) # Terminal ready.
-  end
-
-  def get
-    @out.write("output volume of (get volume settings)\r\n")
-    @in.expect(/=> (\d+)\r\n/)[1].to_i
-  end
-
-  def set(value)
-    @out.write("set volume output volume #{value}\r\n")
-    @in.expect(/>> /)
-  end
-end
-
-volumeWrapper= AppleVolumeWrapper.new
-# volumeWrapper.get can return imprecise values.
-# Display those, but keep exact value in this variable.
-volume = volumeWrapper.get
-puts "Current volume: #{volume}%"
-
-encoder.add_callback do |update|
-  # update[:change] is always either +1 or -1.
-  volume = volume += update[:change]
-  volume = 0 if volume < 0
-  volume = 100 if volume > 100
-
-  volumeWrapper.set(volume)
-  current_volume = volumeWrapper.get
-  puts "Current volume: #{current_volume}%"
-end
-
-sleep

data/examples/advanced/ssd1306_time_temp_rh.rb

@@ -1,43 +0,0 @@
-#
-# This example polls an HTU21D (temp/humidity sensor) in the background.
-# The main thread refreshes an SSD1306 OLED ~20 times per second,
-# showing the latest temperature and humidity values, and current time.
-# Both devices are conected to the same I2C bus.
-#
-require 'bundler/setup'
-require 'denko'
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-i2c   = Denko::I2C::Bus.new(board: board)
-
-# Get temperature and humidity every second.
-htu21d = Denko::Sensor::HTU21D.new(bus: i2c)
-htu21d.poll(2)
-
-oled   = Denko::Display::SSD1306.new(bus: i2c, rotate: true)
-canvas = oled.canvas
-
-last_refresh = Time.now
-loop do
-  elapsed = Time.now - last_refresh
-
-  # Aim for 20 fps.
-  if elapsed > 0.049
-    canvas.clear
-
-    canvas.text_cursor = [0,0]
-    canvas.print "Time:  #{Time.now.strftime("%H:%M:%S.%L")}"
-
-    canvas.text_cursor = [0,8]
-    canvas.print "Temp:     " + ('%.3f' % htu21d.temperature).rjust(7, " ") + " C"
-
-    canvas.text_cursor = [0,16]
-    canvas.print "Humidity: " + ('%.3f' % htu21d.humidity).rjust(7, " ") + " %"
-
-    # Only refresh the area in use.
-    oled.draw(0, 127, 0, 24)
-    last_refresh = Time.now
-  else
-    sleep 0.001
-  end
-end

data/examples/analog_io/ads1100.rb

@@ -1,48 +0,0 @@
-#
-# Example using an ADS1100 ADC over the I2C bus.
-#
-require 'bundler/setup'
-require 'denko'
-
-# Helper method so readings look nice.
-def print_reading(name, raw, voltage)
-  print "#{Time.now.strftime '%Y-%m-%d %H:%M:%S'} - "
-  print "#{name.rjust(9, " ")} | "
-  print "Raw: #{raw.to_s.rjust(6, " ")} | "
-  print "Voltage: "
-  print ("%.10f" % voltage).rjust(13, " ")
-  puts " V"
-end
-
-board = Denko::Board.new(Denko::Connection::Serial.new)
-bus   = Denko::I2C::Bus.new(board: board)
-
-# Unlike the ADS1115/1118, full-scale voltage depends on Vdd. Give during setup.
-# This works for my M5Stack ADC unit (0-12V) when checked against a multimeter.
-ads = Denko::AnalogIO::ADS1100.new  bus: bus,
-                                    full_scale_voltage: 26.408,
-                                    sample_rate: 16,
-                                    gain: 2
-                                    # address: 0x48 default
-
-#
-# Configure gain and sample rate. See datasheet for more info.
-# Valid values:
-#   Gain:         1 (default), 2,  4,  8
-#   Sample Rate:  8 (default), 16, 32, 128
-#
-ads.gain        = 1
-ads.sample_rate = 8
-
-# Configure smoothing.
-ads.smoothing       = true
-ads.smoothing_size  = 8
-
-# Poll and print indefinitely.
-ads.poll(0.25) do |reading|
-  # volts_per_bit calculated from full-scale voltage, gain and sample rate.
-  voltage = reading * ads.volts_per_bit
-  print_reading("ADS1100:", reading, voltage)
-end
-
-sleep