denko 0.13.0

data/vendor/board-maps/README.md

@@ -0,0 +1,51 @@
+# Arduino Board Maps in YAML Format
+
+The aim of this script is to map common identifiers used in the [Arduino](https://github.com/arduino) IDE to their integer pin numbers. For example, on many Arduino boards, the analog input pin labeled `A0` maps to an integer pin number of `14`, but this isn't always the case. With the large variety of boards the Arduino IDE supports, it's difficult to keep track of mappings manually.
+
+### How to identify the board?
+
+Along with the maps inside the `yaml` folder, there is `BoardMap.h`. Include that in a sketch, and it will `#define BOARD_MAP`, based on your board selection in Arduino. The value of `BOARD_MAP` is the filename for that board's map, minus the `.yml` extension.
+
+### Why map the pins?
+
+If the sketch tells a remote machine its `BOARD_MAP`, the map can be loaded from its file. From there, the remote machine uses it to translate between pin identifiers and integers, before sending instructions to the board, or receiving messages from it.
+
+This is the exact use case this was deisgned for, in support of the [denko](https://github.com/denko-rb/denko) Ruby gem. It allows more intuitive pin referencing in Ruby, while simplifying the Arduino sketch so it only handles pins as integers.
+
+## Supported Arduino Cores
+
+- [avr](https://github.com/arduino/ArduinoCore-avr)
+- [megaavr](https://github.com/arduino/ArduinoCore-megaavr)
+- [sam](https://github.com/arduino/ArduinoCore-sam)
+- [samd](https://github.com/arduino/ArduinoCore-samd)
+- [esp8266](https://github.com/esp8266/Arduino)
+- [esp32](https://github.com/espressif/arduino-esp32)
+- [rp2040](https://github.com/earlephilhower/arduino-pico)
+
+## Mappings
+
+- `A0` analog input pins (sequential on AVR, disordered on others)
+- `DAC0` digital-to-analog-pins
+- `D0` pins (some on RP2040. Many on ESP8266 where DX doesn't map to GPIOX)
+- `T0` pins (capacitive touch pins on ESP32)
+- `SCL`, `SDA`, `SCLX`, `SDAX`, default and numbered hardware I2C pins
+- `MOSI`, `MISO`, `SCK`, `SS`, `MOSIX`, `MISOX`, `SCKX`, `SSX`, default and numbered hardware SPI pins
+- `LED_BUILTIN` which is usually defined for the on-board LED
+
+TODO: Add UART and CAN?
+
+## Usage
+
+Clone or download this repo. Use `BoardMap.h` and all the files inside `yaml` as descibed above.
+
+Each map is a flat dictionary where each key (an identifier) maps to one integer.
+
+**Note:** All keys are prefixed with `:`, so they automatically translate to Ruby symbols when loaded.
+
+## Development
+
+Be warned. This is mostly a hack that runs a bunch of regex matches on `boards.txt` and header files from each Arduino core. :man_shrugging:
+
+- Clone this repo.
+- Clone the submodules inside the `core` folder with `git submodule init` and `git submodule update`. No need for recursion, but will still be close to 4GB.
+- Make changes and `ruby run.rb` to udpate `BoardMap.h` and all the YAML files.

data/vendor/board-maps/lib/boards_parser.rb

@@ -0,0 +1,66 @@
+class BoardsParser
+  #
+  # This catches the following styles of edge cases (only seen in ESP8266 core so far):
+  #
+  # 1) Main board defines a variant (header) folder, sub-models define none, so they all use the main folder:
+  #     sonoff.build.board=ESP8266_SONOFF_SV
+  #     sonoff.build.variant=itead
+  #     sonoff.menu.BoardModel.sonoffBasic.build.board=ESP8266_SONOFF_BASIC
+  #     sonoff.menu.BoardModel.sonoffS20.build.board=ESP8266_SONOFF_S20
+  #     sonoff.menu.BoardModel.sonoffSV.build.board=ESP8266_SONOFF_SV
+  #     sonoff.menu.BoardModel.sonoffTH.build.board=ESP8266_SONOFF_TH
+  #
+  # 2) Main board is defined. Sub-models each define their own variant (header) folder:
+  #     arduino-esp8266.build.board=ESP8266_ARDUINO
+  #     arduino-esp8266.menu.BoardModel.primo.build.board=ESP8266_ARDUINO_PRIMO
+  #     arduino-esp8266.menu.BoardModel.primo.build.variant=arduino_spi
+  #     arduino-esp8266.menu.BoardModel.starottodeved.build.board=ESP8266_ARDUINO_STAR_OTTO
+  #     arduino-esp8266.menu.BoardModel.starottodeved.build.variant=arduino_uart
+  #     arduino-esp8266.menu.BoardModel.unowifideved.build.board=ESP8266_ARDUINO_UNOWIFI
+  #     arduino-esp8266.menu.BoardModel.unowifideved.build.variant=arduino_uart
+  #
+  # If both of these are ever combined in the same variant, this parser WILL fail.
+  #
+  def self.parse(core_root_path)
+    boards = {}
+    board_identifier = nil
+    header_folder = nil
+    
+    File.readlines("#{core_root_path}/boards.txt").each do |line|
+      # Lines matching this define a board or board sub-model.
+      match = line.match(/build.board=(.*)\s*\z/)
+      if match
+        board_identifier = "ARDUINO_#{match[1]}"
+
+        # If there's a board and header set, add it to the hash.
+        # Will catch when a sub-model with different name reuses the main board header.
+        if board_identifier && header_folder
+          boards[board_identifier] = header_folder
+        end
+        next
+      end
+
+      # Lines matching this give the folder name for the board's header file.
+      match = line.match(/build.variant=(.*)\s*\z/)
+      if match
+        header_folder = "#{core_root_path}/variants/#{match[1]}"
+
+        # If there's a board and header set, add it to the hash.
+        # Will catch when sub-models use different headers.
+        if board_identifier && header_folder
+          boards[board_identifier] = header_folder
+        end
+        next
+      end
+
+      # Reset state if end of board section reached.
+      match = line.match(/######/)
+      if match
+        board_identifier = nil
+        header_folder = nil
+      end
+    end
+
+    return boards
+  end
+end

data/vendor/board-maps/lib/header_parser.rb

@@ -0,0 +1,164 @@
+class HeaderParser
+  attr_reader :map
+
+  def initialize(folder)
+    # Empty hash to fill and return with the pin map.
+    @map = {}
+    @folder = folder
+
+    # Gotta try all .h files since there's no naming consistency...
+    # No idea if this puts them in the right order, but it shouldn't matter.
+    header_files = Dir["#{@folder}/*.h"]
+    header_files.each do |path|
+      parse_file(path)
+    end
+
+    clean_map
+  end
+
+  def parse_file(path)
+    begin
+      file = File.open(path)
+    rescue => exception
+      # Fail silently if file not found. Some of these headers include standard libs...
+      return
+    end
+
+    file.each_line do |line|
+      # Reject comments.
+      next if line.match /\A\/\//
+
+      # Reject lines that end with pin-style identifiers, instead of numbers.
+      next if line.match /(PIN_)*(A|D|DAC|T)(\d+)\s*;*\s*\z/
+      next if line.match /(PIN_SPI_|PIN_WIRE_)*(SDA|SCL|SS|MOSI|MISO|SCK)\s*;*\s*\z/
+
+      # Recursively parse included headers...smh
+      included = line.match /\A\s*#include\s*("|<)(.*)("|>)/
+      if included
+        path = File.expand_path(included[2], @folder)
+        parse_file(path)
+      end
+
+      # Match RP2040 analog overrides and store them with prefixed keys like :_A0
+      # Will substitute them later in #clean_map
+      rp2040_analog = line.match /__PIN(_A\d+)\s*\(?(\d+)\w*\)?/
+      if rp2040_analog
+        @map[rp2040_analog[1].to_sym] = rp2040_analog[2].to_i
+        next
+      end
+
+      #
+      # Match analog input and DAC pins declared like:
+      #     #define PIN_A0 (14ul)
+      #     #define PIN_DAC0 (14)
+      #     #define PIN_A0 14
+      #     #define A0 14
+      #
+      pin = line.match /(PIN_)*((A|DAC)\d+)\s*\(?(\d+)\w*\)?/
+      if pin
+        @map[pin[2].to_sym] = pin[4].to_i
+        next
+      end
+
+      #
+      # Match I2C/SPI pins declared like:
+      #     #define PIN_WIRE_SDA (20ul)
+      #     #define PIN_SPI0_MOSI (51)
+      #     #define PIN_WIRE2_SDA 20
+      #     #define WIRE1_SDA 21
+      #
+      pin = line.match /(PIN_)*((WIRE|SPI)\d*_\w+)\s*\(?(\d+)\w*\)?/
+      if pin
+        @map[pin[2].to_sym] = pin[4].to_i
+        next
+      end
+
+      #
+      # Match custom labeled D* pins (eg. ESP8266) declared like: 
+      #     static const uint D4 = (2)
+      #
+      # Match analog pins declared like:
+      #     static const uint8_t A0 = 14
+      #
+      # Match DAC pins declared like:
+      #     static const uint8_t DAC1 = 25
+      #
+      # Match capacitive touch pins declared like:
+      #     static const uint8_t T0 = 4
+      #
+      pin = line.match /((A|D|DAC|T)\d+)\s*=\s*\(?(\d+)\w*\)?/
+      if pin
+        @map[pin[1].to_sym] = pin[3].to_i
+        next
+      end
+
+      #
+      # Match I2C/SPI pins declared like:
+      #     static const uint8_t SDA = 21
+      #
+      pin = line.match /(SDA|SCL|SS|MOSI|MISO|SCK)\s*=\s*\(?(\d+)\w*\)?/
+      if pin
+        @map[pin[1].to_sym] = pin[2].to_i
+        next
+      end
+
+      #
+      # Match LED_BUILTIN declared like:
+      #     #define LED_BUILTIN 13
+      #     #define PIN_LED      2
+      #     #define PIN_LED13   13
+      #
+      led = line.match /(PIN_LED|LED_BUILTIN)(_13)*\s+\(?(\d+)\w*\)?/
+      if led
+        @map[:LED_BUILTIN] = led[3].to_i unless line.match /2812/
+        next
+      end
+
+      #
+      # Match LED_BUILTIN declared like:
+      #     static const uint8_t LED_BUILTIN   = 2
+      #     static const uint8_t LED_BUILTIN13 = 13
+      #     static const uint8_t PIN_LED       = 4
+      #
+      led = line.match /(PIN_LED|LED_BUILTIN)(_13)*\s*=\s*\(?(\d+)\w*\)?/
+      if led
+        @map[:LED_BUILTIN] = led[3].to_i unless line.match /2812/
+        next
+      end
+    end
+  end
+
+  def clean_map
+    # Updated references to merge with the map after.
+    map_updates = {}
+
+    @map.each do |key, value|
+      # One board double defines SPI_SS and SPI_CS.
+      @map.delete(key) if key.to_s.match /CS/
+
+      # Filter out some stuff we shouldn't be catching.
+      if key.to_s.match /(HOWMANY|PIN_DEFINED|INTERFACES_COUNT|CHANNELS_NUM|PAD)/
+        @map.delete(key)
+        next
+      end
+
+      # Fix RP2040 analog pin overrides.
+      if key.to_s.match /_A\d+/
+        new_key = key.to_s.gsub("_", "")
+        map_updates[new_key.to_sym] = value
+        @map.delete(key)
+      end
+
+      # Standardize SPI / WIRE styling.
+      spi_match = key.to_s.match /(SPI|WIRE)(\d*)_(\w+)/
+      if spi_match
+        new_key = "#{spi_match[3]}#{spi_match[2]}"
+        map_updates[new_key.to_sym] = value 
+        @map.delete(key)
+        next
+      end
+    end
+
+    @map = @map.merge(map_updates)
+  end
+end

data/vendor/board-maps/run.rb

@@ -0,0 +1,47 @@
+require_relative "lib/boards_parser"
+require_relative "lib/header_parser"
+
+CORES = ["avr", "esp32", "esp8266", "megaavr", "rp2040", "sam3x", "samd"]
+
+# This will end up containing a map for each board identified. Each key
+# is a board's identifier and the value is its pin map as a hash.
+board_maps = {}
+
+CORES.each do |core|
+  core_root = "#{Dir.pwd}/cores/#{core}"
+
+  # Get a hash that maps each board to its variant folder.
+  board_headers = BoardsParser.parse(core_root)
+
+  # For each board, parse its header and add it to the hash of maps.
+  board_headers.each do |board, header_folder|
+    parser = HeaderParser.new(header_folder)
+    board_maps[board] = parser.map
+  end
+end
+
+# Remove chars from board identifier that won't work in a filename.
+def board_to_filename(board_identifier)
+  board_identifier.gsub(":", "_").gsub(",", "_").gsub(/\AARDUINO_/, "")
+end
+
+# Define every board name in BoardMap.h
+File.open("#{Dir.pwd}/BoardMap.h", "w") do |file|
+  board_maps.each_key do |board_identifier|
+    file.write "#ifdef #{board_identifier}\n"
+    file.write "  #define BOARD_MAP \"#{board_to_filename(board_identifier)}\"\n"
+    file.write "#endif\n"
+    file.write "\n"
+  end
+end
+
+# Generate a YAML file for each board.
+require 'yaml'
+board_maps.each do |board_identifier, map|
+  filename = board_to_filename(board_identifier)
+  File.open("#{Dir.pwd}/yaml/#{filename}.yml", "w") do |file|
+    file.write(map.to_yaml)
+  end
+end
+
+puts "Parsed #{board_maps.count} boards."

data/vendor/board-maps/yaml/0XCB_HELIOS.yml

@@ -0,0 +1,48 @@
+---
+:LED_BUILTIN: 17
+:D0: 0
+:D1: 1
+:D2: 2
+:D3: 3
+:D4: 4
+:D5: 5
+:D6: 6
+:D7: 7
+:D8: 8
+:D9: 9
+:D10: 10
+:D11: 11
+:D12: 12
+:D13: 13
+:D14: 14
+:D15: 15
+:D16: 16
+:D17: 17
+:D18: 18
+:D19: 19
+:D20: 20
+:D21: 21
+:D22: 22
+:D23: 23
+:D24: 24
+:D25: 25
+:D26: 26
+:D27: 27
+:D28: 28
+:D29: 29
+:A0: 26
+:A1: 27
+:A2: 28
+:A3: 29
+:MISO0: 20
+:MOSI0: 23
+:SCK0: 22
+:SS0: 21
+:MISO1: 31
+:MOSI1: 31
+:SCK1: 31
+:SS1: 31
+:SDA0: 31
+:SCL0: 31
+:SDA1: 2
+:SCL1: 3

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

@@ -0,0 +1,25 @@
+---
+:LED_BUILTIN: 13
+:SDA: 3
+:SCL: 4
+:SS: 42
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 17
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14
+:DAC1: 17
+:DAC2: 18

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

@@ -0,0 +1,25 @@
+---
+:LED_BUILTIN: 13
+:SDA: 3
+:SCL: 4
+:SS: 42
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 17
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14
+:DAC1: 17
+:DAC2: 18

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

@@ -0,0 +1,27 @@
+---
+:LED_BUILTIN: 13
+:SDA: 42
+:SCL: 41
+:SS: 7
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 17
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:T1: 1
+:T2: 2
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14
+:DAC1: 17
+:DAC2: 18

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

@@ -0,0 +1,29 @@
+---
+:LED_BUILTIN: 13
+:SDA: 3
+:SCL: 4
+:SS: 42
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 4
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:A6: 3
+:A7: 4
+:A8: 5
+:A9: 6
+:T3: 3
+:T4: 4
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14

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

@@ -0,0 +1,29 @@
+---
+:LED_BUILTIN: 13
+:SDA: 3
+:SCL: 4
+:SS: 42
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 4
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:A6: 3
+:A7: 4
+:A8: 5
+:A9: 6
+:T3: 3
+:T4: 4
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14

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

@@ -0,0 +1,25 @@
+---
+:LED_BUILTIN: 13
+:SDA: 3
+:SCL: 4
+:SS: 42
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 17
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14
+:DAC1: 17
+:DAC2: 18

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

@@ -0,0 +1,27 @@
+---
+:LED_BUILTIN: 13
+:SDA: 42
+:SCL: 41
+:SS: 7
+:MOSI: 35
+:SCK: 36
+:MISO: 37
+:A0: 18
+:A1: 17
+:A2: 16
+:A3: 15
+:A4: 14
+:A5: 8
+:T1: 1
+:T2: 2
+:T5: 5
+:T6: 6
+:T8: 8
+:T9: 9
+:T10: 10
+:T11: 11
+:T12: 12
+:T13: 13
+:T14: 14
+:DAC1: 17
+:DAC2: 18

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

@@ -0,0 +1,30 @@
+---
+:LED_BUILTIN: 13
+:SDA: 22
+:SCL: 20
+:SS: 33
+:MOSI: 19
+:MISO: 21
+:SCK: 5
+:A0: 26
+:A1: 3
+:A2: 34
+:A3: 39
+:A4: 36
+:A5: 4
+:A6: 14
+:A7: 32
+:A8: 15
+:A9: 33
+:T0: 4
+:T1: 0
+:T2: 2
+:T3: 15
+:T4: 13
+:T5: 12
+:T6: 14
+:T7: 27
+:T8: 33
+:T9: 32
+:DAC1: 25
+:DAC2: 26

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

@@ -0,0 +1,48 @@
+---
+:LED_BUILTIN: 13
+:D0: 0
+:D1: 1
+:D2: 2
+:D3: 3
+:D4: 4
+:D5: 5
+:D6: 6
+:D7: 7
+:D8: 8
+:D9: 9
+:D10: 10
+:D11: 11
+:D12: 12
+:D13: 13
+:D14: 14
+:D15: 15
+:D16: 16
+:D17: 17
+:D18: 18
+:D19: 19
+:D20: 20
+:D21: 21
+:D22: 22
+:D23: 23
+:D24: 24
+:D25: 25
+:D26: 26
+:D27: 27
+:D28: 28
+:D29: 29
+:A0: 26
+:A1: 27
+:A2: 28
+:A3: 29
+:MISO0: 20
+:MOSI0: 19
+:SCK0: 18
+:SS0: 17
+:MISO1: 31
+:MOSI1: 31
+:SCK1: 31
+:SS1: 31
+:SDA0: 2
+:SCL0: 3
+:SDA1: 24
+:SCL1: 25

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

@@ -0,0 +1,48 @@
+---
+:LED_BUILTIN: 13
+:D0: 0
+:D1: 1
+:D2: 2
+:D3: 3
+:D4: 4
+:D5: 5
+:D6: 6
+:D7: 7
+:D8: 8
+:D9: 9
+:D10: 10
+:D11: 11
+:D12: 12
+:D13: 13
+:D14: 14
+:D15: 15
+:D16: 16
+:D17: 17
+:D18: 18
+:D19: 19
+:D20: 20
+:D21: 21
+:D22: 22
+:D23: 23
+:D24: 24
+:D25: 25
+:D26: 26
+:D27: 27
+:D28: 28
+:D29: 29
+:A0: 26
+:A1: 27
+:A2: 28
+:A3: 29
+:MISO0: 8
+:MOSI0: 15
+:SCK0: 14
+:SS0: 13
+:MISO1: 31
+:MOSI1: 31
+:SCK1: 31
+:SS1: 31
+:SDA0: 2
+:SCL0: 3
+:SDA1: 31
+:SCL1: 31