denko 0.14.0 → 0.15.0

data/test/test_helper.rb

@@ -12,84 +12,6 @@ end
 require 'bundler/setup'
 require 'denko'
 
-# Touch each class to trigger auto load for simplecov.
-# Analog IO
-Denko::AnalogIO::ADS1118
-Denko::AnalogIO::Input
-Denko::AnalogIO::Output
-Denko::AnalogIO::Potentiometer
-
-# Behaviors
-# Not needed, since every behavior will be included by at least one class.
-
-# Board
-# BoardMock inherits from Denko::Board
-
-# Connection
-Denko::Connection::Serial
-Denko::Connection::TCP
-
-# Digital IO
-Denko::DigitalIO::Button
-Denko::DigitalIO::Input
-Denko::DigitalIO::Output
-Denko::DigitalIO::Relay
-Denko::DigitalIO::RotaryEncoder
-
-# Display
-Denko::Display::Canvas
-Denko::Display::HD44780
-Denko::Display::SSD1306
-
-# EEPROM
-Denko::EEPROM::BuiltIn
-
-# I2C
-Denko::I2C::Bus
-Denko::I2C::Peripheral
-
-# LED
-Denko::LED::APA102
-Denko::LED::Base
-Denko::LED::RGB
-Denko::LED::SevenSegment
-Denko::LED::WS2812
-
-# Motor
-Denko::Motor::L298
-Denko::Motor::Servo
-Denko::Motor::Stepper
-
-# OneWire
-Denko::OneWire::Bus
-Denko::OneWire::Peripheral
-Denko::OneWire::Helper
-
-# Pulse IO
-Denko::PulseIO::Buzzer
-Denko::PulseIO::IROutput
-Denko::PulseIO::PWMOutput
-
-# RTC
-Denko::RTC::DS3231
-
-# Sensor
-Denko::Sensor::BME280
-Denko::Sensor::BMP280
-Denko::Sensor::DHT
-Denko::Sensor::DS18B20
-Denko::Sensor::HTU21D
-
-# SPI
-Denko::SPI::BaseRegister
-Denko::SPI::BitBang
-Denko::SPI::Bus
-Denko::SPI::InputRegister
-Denko::SPI::OutputRegister
-
-# UART
-Denko::UART::BitBang
-
 # Helper module to redefine constants quietly.
 module Constants
   def self.redefine(const, value, opts={})
@@ -145,73 +67,71 @@ class ConnectionMock
 end
 
 class BoardMock < Denko::Board
-  def initialize
+  def initialize(connection=nil, options={})
     super(ConnectionMock.new)
-    @read_injection_mutex = Mutex.new
   end
 
-  WAITING_ON_READ_KEYS = [:read, :bus_controller, :board_proxy, :force_udpate]
-
-  def waiting_on_read(component)
-    WAITING_ON_READ_KEYS.each do |key|
-      return true if component.callbacks[key]
-    end
+  def is_a_register?
     false
   end
 
-  def single_pin_component_exists(pin)
-    return single_pin_components[pin]
-    false
+  #
+  # Reads are async, in a background thread. This is a way to detect when a Component has
+  # initiated a read, and is waiting on a response that will eventually call its #update.
+  #
+  WAITING_ON_READ_KEYS = [:read, :read_raw, :bus_controller, :board_proxy, :force_update]
+
+  def read_injection_mutex
+    @read_injection_mutex ||= Mutex.new
   end
 
-  def hw_i2c_exists(index)
-    return hw_i2c_comps[index]
+  def expects_reading?(component)
+    WAITING_ON_READ_KEYS.each { |key| return true if component.callbacks[key] }
     false
   end
 
+  def wait_for_component_read(component)
+    sleep(0.001) while !component.callbacks
+    sleep(0.001) while !expects_reading?(component)
+  end
+
   #
-  # Inject a message into the Board instance as if it were coming from the phsyical board.
-  # Use this to mock input data for the blocking #read pattern in the Reader behavior.
+  # Inject a message that will call the Component#update directly after it reads,
+  # bypassing Board. Use for testing above the Board interface.
   #
-  def inject_read_for_pin(pin, message)
+  def inject_component_update(component, data)
     Thread.new do
-      # Wait for a component to be added.
-      component = false
-      while !component
-        sleep(0.001)
-        component = single_pin_component_exists(pin)
-      end
-      inject_read(component, "#{pin}:#{message}")
+      wait_for_component_read(component)
+      sleep 0.005 unless RUBY_ENGINE == "ruby"
+      read_injection_mutex.synchronize { component.update(data) }
     end
   end
 
-  def inject_read_for_i2c(index, message)
-    Thread.new do
-      # Wait for a component to be added.
-      component = false
-      while !component
-        sleep(0.001)
-        component = hw_i2c_exists(index)
-      end
-      inject_read(component, "I2C#{index}:#{message}")
+  #
+  # We also want to inject readings at the pin or bus level, to test Board itself,
+  # or for integration tests. This waits for a pin to have a Component attached to it.
+  #
+  def wait_for_component_on_pin(pin)
+    component = false
+    while !component
+      sleep(0.001)
+      component = single_pin_components[pin]
     end
+    component
   end
 
-  def inject_read_for_component(component, pin, message)
+  #
+  # Inject a message into the Board instance as if coming from a pin on the phsyical board.
+  # Use for testing Board internals, Board interface, and integration tests.
+  #
+  def inject_read_for_pin(pin, message)
     Thread.new do
-      inject_read(component, "#{pin}:#{message}")
-    end
-  end
-
-  def inject_read(component, string)
-    # Wait for the component to have a "WAITING_ON_READ" callback.
-    sleep(0.001) while !component.callback_mutex
-    sleep(0.001) while !component.callbacks
-    sleep(0.001) while !waiting_on_read(component)
-
-    # Then inject the message.
-    @read_injection_mutex.synchronize do
-      self.update(string)
+      component = wait_for_component_on_pin(pin)
+      wait_for_component_read(component)
+      sleep 0.005 unless RUBY_ENGINE == "ruby"
+      read_injection_mutex.synchronize do
+        self.update("#{pin}:#{message}")
+      end
     end
   end
 end

data/vendor/board-maps/BoardMap.h

@@ -110,6 +110,10 @@
   #define BOARD_MAP "ESP32C2_DEV"
 #endif
 
+#ifdef ARDUINO_ESP32P4_DEV
+  #define BOARD_MAP "ESP32P4_DEV"
+#endif
+
 #ifdef ARDUINO_ESP32H2_DEV
   #define BOARD_MAP "ESP32H2_DEV"
 #endif
@@ -166,10 +170,26 @@
   #define BOARD_MAP "AVENTEN_S3_SYNC"
 #endif
 
+#ifdef ARDUINO_BHARATPI_NODE_WIFI
+  #define BOARD_MAP "BHARATPI_NODE_WIFI"
+#endif
+
+#ifdef ARDUINO_BHARATPI_A7672S_4G
+  #define BOARD_MAP "BHARATPI_A7672S_4G"
+#endif
+
+#ifdef ARDUINO_BHARATPI_LORA
+  #define BOARD_MAP "BHARATPI_LORA"
+#endif
+
 #ifdef ARDUINO_BLING
   #define BOARD_MAP "BLING"
 #endif
 
+#ifdef ARDUINO_EDGES3D
+  #define BOARD_MAP "EDGES3D"
+#endif
+
 #ifdef ARDUINO_FEATHERS2
   #define BOARD_MAP "FEATHERS2"
 #endif
@@ -190,10 +210,18 @@
   #define BOARD_MAP "NANOS3"
 #endif
 
+#ifdef ARDUINO_OMGS3
+  #define BOARD_MAP "OMGS3"
+#endif
+
 #ifdef ARDUINO_PROS3
   #define BOARD_MAP "PROS3"
 #endif
 
+#ifdef ARDUINO_SQUIXL
+  #define BOARD_MAP "SQUIXL"
+#endif
+
 #ifdef ARDUINO_TINYPICO
   #define BOARD_MAP "TINYPICO"
 #endif
@@ -246,6 +274,38 @@
   #define BOARD_MAP "LILYGO_T3S3_LR1121"
 #endif
 
+#ifdef ARDUINO_T_WATCH_S3
+  #define BOARD_MAP "T_WATCH_S3"
+#endif
+
+#ifdef ARDUINO_LILYGO_LORA_SX1262
+  #define BOARD_MAP "LILYGO_LORA_SX1262"
+#endif
+
+#ifdef ARDUINO_LILYGO_LORA_SX1280
+  #define BOARD_MAP "LILYGO_LORA_SX1280"
+#endif
+
+#ifdef ARDUINO_LILYGO_LORA_CC1101
+  #define BOARD_MAP "LILYGO_LORA_CC1101"
+#endif
+
+#ifdef ARDUINO_LILYGO_LORA_LR1121
+  #define BOARD_MAP "LILYGO_LORA_LR1121"
+#endif
+
+#ifdef ARDUINO_LILYGO_LORA_SI4432
+  #define BOARD_MAP "LILYGO_LORA_SI4432"
+#endif
+
+#ifdef ARDUINO_T_WATCH_S3_ULTRA
+  #define BOARD_MAP "T_WATCH_S3_ULTRA"
+#endif
+
+#ifdef ARDUINO_T_LORA_PAGER
+  #define BOARD_MAP "T_LORA_PAGER"
+#endif
+
 #ifdef ARDUINO_MICROS2
   #define BOARD_MAP "MICROS2"
 #endif
@@ -294,6 +354,10 @@
   #define BOARD_MAP "ESP32S2_THING_PLUS"
 #endif
 
+#ifdef ARDUINO_SPARKFUN_ESP32S3_THING_PLUS
+  #define BOARD_MAP "SPARKFUN_ESP32S3_THING_PLUS"
+#endif
+
 #ifdef ARDUINO_ESP32C6_THING_PLUS
   #define BOARD_MAP "ESP32C6_THING_PLUS"
 #endif
@@ -542,6 +606,18 @@
   #define BOARD_MAP "QUALIA_S3_RGB666"
 #endif
 
+#ifdef ARDUINO_SPARKLEMOTION_ESP32
+  #define BOARD_MAP "SPARKLEMOTION_ESP32"
+#endif
+
+#ifdef ARDUINO_SPARKLEMOTIONMINI_ESP32
+  #define BOARD_MAP "SPARKLEMOTIONMINI_ESP32"
+#endif
+
+#ifdef ARDUINO_SPARKLEMOTIONSTICK_ESP32
+  #define BOARD_MAP "SPARKLEMOTIONSTICK_ESP32"
+#endif
+
 #ifdef ARDUINO_NODEMCU_32S
   #define BOARD_MAP "NODEMCU_32S"
 #endif
@@ -722,6 +798,10 @@
   #define BOARD_MAP "M5STACK_DIAL"
 #endif
 
+#ifdef ARDUINO_M5STACK_DINMETER
+  #define BOARD_MAP "M5STACK_DINMETER"
+#endif
+
 #ifdef ARDUINO_M5STACK_NANOC6
   #define BOARD_MAP "M5STACK_NANOC6"
 #endif
@@ -794,6 +874,18 @@
   #define BOARD_MAP "HT_DE01"
 #endif
 
+#ifdef ARDUINO_HELTEC_VISION_MASTER_E290
+  #define BOARD_MAP "HELTEC_VISION_MASTER_E290"
+#endif
+
+#ifdef ARDUINO_HELTEC_VISION_MASTER_T190
+  #define BOARD_MAP "HELTEC_VISION_MASTER_T190"
+#endif
+
+#ifdef ARDUINO_HELTEC_VISION_MASTER_E_213
+  #define BOARD_MAP "HELTEC_VISION_MASTER_E_213"
+#endif
+
 #ifdef ARDUINO_ESPECTRO32
   #define BOARD_MAP "ESPECTRO32"
 #endif
@@ -874,6 +966,10 @@
   #define BOARD_MAP "fm_devkit"
 #endif
 
+#ifdef ARDUINO_FRI3D_2024_ESP32S3
+  #define BOARD_MAP "FRI3D_2024_ESP32S3"
+#endif
+
 #ifdef ARDUINO_FROG_ESP32
   #define BOARD_MAP "FROG_ESP32"
 #endif
@@ -1090,6 +1186,10 @@
   #define BOARD_MAP "XIAO_ESP32S3"
 #endif
 
+#ifdef ARDUINO_XIAO_ESP32S3_PLUS
+  #define BOARD_MAP "XIAO_ESP32S3_PLUS"
+#endif
+
 #ifdef ARDUINO_connaxio_espoir
   #define BOARD_MAP "connaxio_espoir"
 #endif
@@ -1222,6 +1322,30 @@
   #define BOARD_MAP "GEEKBLE_ESP32C3"
 #endif
 
+#ifdef ARDUINO_GEEKBLE_NANO_ESP32S3
+  #define BOARD_MAP "GEEKBLE_NANO_ESP32S3"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_ZERO
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_ZERO"
+#endif
+
+#ifdef ARDUINO_WS_ESP32_S3_MATRIX
+  #define BOARD_MAP "WS_ESP32_S3_MATRIX"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_169
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_169"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_AMOLED_18
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_AMOLED_18"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_LCD_169
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_LCD_169"
+#endif
+
 #ifdef ARDUINO_WAVESHARE_ESP32S3_TOUCH_LCD_128
   #define BOARD_MAP "WAVESHARE_ESP32S3_TOUCH_LCD_128"
 #endif
@@ -1242,6 +1366,142 @@
   #define BOARD_MAP "ELECROW_CROWPANEL_7"
 #endif
 
+#ifdef ARDUINO_CIRCUITART_ZERO_S3
+  #define BOARD_MAP "CIRCUITART_ZERO_S3"
+#endif
+
+#ifdef ARDUINO_ALFREDO_NOU3
+  #define BOARD_MAP "ALFREDO_NOU3"
+#endif
+
+#ifdef ARDUINO_CODECELLC3
+  #define BOARD_MAP "CODECELLC3"
+#endif
+
+#ifdef ARDUINO_ESP32_2432S028R
+  #define BOARD_MAP "ESP32_2432S028R"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_AMOLED_241
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_AMOLED_241"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_43
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_43"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_43B
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_43B"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_7
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_7"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_5
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_5"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_5B
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_5B"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_4
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_4"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_185
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_185"
+#endif
+
+#ifdef ARDUINO_CEZERIO_DEV_ESP32C6
+  #define BOARD_MAP "CEZERIO_DEV_ESP32C6"
+#endif
+
+#ifdef ARDUINO_CEZERIO_MINI_DEV_ESP32C6
+  #define BOARD_MAP "CEZERIO_MINI_DEV_ESP32C6"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_LCD_185
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_LCD_185"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_146
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_146"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_LCD_146
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_LCD_146"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_185_BOX
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_185_BOX"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_LCD_147
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_LCD_147"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_21
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_21"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_LCD_28
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_LCD_28"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_RELAY_6CH
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_RELAY_6CH"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_AMOLED_164
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_AMOLED_164"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_AMOLED_143
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_AMOLED_143"
+#endif
+
+#ifdef ARDUINO_WAVESHARE_ESP32_S3_TOUCH_AMOLED_191
+  #define BOARD_MAP "WAVESHARE_ESP32_S3_TOUCH_AMOLED_191"
+#endif
+
+#ifdef ARDUINO_PCBCUPID_GLYPHC3
+  #define BOARD_MAP "PCBCUPID_GLYPHC3"
+#endif
+
+#ifdef ARDUINO_PCBCUPID_GLYPHH2
+  #define BOARD_MAP "PCBCUPID_GLYPHH2"
+#endif
+
+#ifdef ARDUINO_PCBCUPID_GLYPHC6
+  #define BOARD_MAP "PCBCUPID_GLYPHC6"
+#endif
+
+#ifdef ARDUINO_YB_ESP32S3_AMP_V2
+  #define BOARD_MAP "YB_ESP32S3_AMP_V2"
+#endif
+
+#ifdef ARDUINO_YB_ESP32S3_AMP_V3
+  #define BOARD_MAP "YB_ESP32S3_AMP_V3"
+#endif
+
+#ifdef ARDUINO_YB_ESP32S3_ETH
+  #define BOARD_MAP "YB_ESP32S3_ETH"
+#endif
+
+#ifdef ARDUINO_HUIDU_HD_WF2
+  #define BOARD_MAP "HUIDU_HD_WF2"
+#endif
+
+#ifdef ARDUINO_HUIDU_HD_WF4
+  #define BOARD_MAP "HUIDU_HD_WF4"
+#endif
+
+#ifdef ARDUINO_CYOBOT_V2_ESP32S3
+  #define BOARD_MAP "CYOBOT_V2_ESP32S3"
+#endif
+
 #ifdef ARDUINO_ESP8266_GENERIC
   #define BOARD_MAP "ESP8266_GENERIC"
 #endif
@@ -1342,6 +1602,10 @@
   #define BOARD_MAP "ESP8266_AGRUMINO_LEMON_V4"
 #endif
 
+#ifdef ARDUINO_mercury
+  #define BOARD_MAP "mercury"
+#endif
+
 #ifdef ARDUINO_ESP8266_NODEMCU_ESP12
   #define BOARD_MAP "ESP8266_NODEMCU_ESP12"
 #endif

data/vendor/board-maps/yaml/ALFREDO_NOU3.yml

@@ -0,0 +1,2 @@
+---
+:LED_BUILTIN: 45

data/vendor/board-maps/yaml/ATD143_S3.yml

@@ -5,6 +5,7 @@
 :MOSI: 11
 :MISO: 13
 :SCK: 12
+:LED_BUILTIN: 5
 :A0: 1
 :A1: 2
 :A2: 3

data/vendor/board-maps/yaml/BHARATPI_A7672S_4G.yml

@@ -0,0 +1,14 @@
+---
+:LED_BUILTIN: 2
+:A0: 14
+:A1: 13
+:A2: 12
+:A3: 4
+:A4: 2
+:A5: 0
+:SDA: 21
+:SCL: 22
+:SS: 5
+:MOSI: 23
+:MISO: 19
+:SCK: 18

data/vendor/board-maps/yaml/BHARATPI_LORA.yml

@@ -0,0 +1,14 @@
+---
+:LED_BUILTIN: 2
+:A0: 14
+:A1: 13
+:A2: 12
+:A3: 4
+:A4: 2
+:A5: 0
+:SS: 5
+:SDA: 21
+:SCL: 22
+:MOSI: 23
+:MISO: 19
+:SCK: 18

data/vendor/board-maps/yaml/BHARATPI_NODE_WIFI.yml

@@ -0,0 +1,14 @@
+---
+:LED_BUILTIN: 2
+:A0: 14
+:A1: 13
+:A2: 12
+:A3: 4
+:A4: 2
+:A5: 0
+:SDA: 21
+:SCL: 22
+:SS: 5
+:MOSI: 23
+:MISO: 19
+:SCK: 18

data/vendor/board-maps/yaml/BPI_LEAF_S3.yml

@@ -1,5 +1,4 @@
 ---
-:LED_BUILTIN: 48
 :SDA: 15
 :SCL: 16
 :SS: 10

data/vendor/board-maps/yaml/CEZERIO_DEV_ESP32C6.yml

@@ -0,0 +1,14 @@
+---
+:SDA: 8
+:SCL: 7
+:SS: 14
+:MOSI: 22
+:MISO: 23
+:SCK: 21
+:A0: 0
+:A1: 1
+:A2: 2
+:A3: 3
+:A4: 4
+:A5: 5
+:A6: 6

data/vendor/board-maps/yaml/CEZERIO_MINI_DEV_ESP32C6.yml

@@ -0,0 +1,12 @@
+---
+:SDA: 23
+:SCL: 22
+:MOSI: 19
+:MISO: 21
+:SCK: 18
+:SS: 17
+:A0: 0
+:A1: 1
+:A2: 2
+:A3: 3
+:A6: 6