Sync dev to main: DEV-1 and DEV-2 pinout fixes

docs/products/dev1/introduction.md

@@ -2,7 +2,7 @@
 title: Apollo DEV-1 Introduction
 description: Apollo DEV-1 Introduction.
 ---
-![](../../assets/apollo-dev-1-pinout-1.png)
+![Apollo DEV-1 pinout showing the GPIO number and functions of every header pin](/assets/apollo-dev-1-pinout.webp)
 
 The Apollo DEV-1 is a very small dev board that we use to prototype before creating other new products. It has a built in RGB light (using GPIO3) and can push up to 600mA out of the 3.3v pin however 100-200mA of that will be used by the microcontroller itself. You are able to back-feed power via the 5v and G (ground) pins or use the USB-C port to power it, but NOT both at the same time.
 
@@ -27,15 +27,15 @@ i2c:
   sda: GPIO1
   scl: GPIO0
 
-RX: 20
-TX: 21
+#These are the UART pins
+uart:
+  tx_pin: GPIO21
+  rx_pin: GPIO20
+  baud_rate: 115200 #match the device you connect
 
-ADC Pins: 0,1,2,3,4,5
-```
+#ADC pins: GPIO0, GPIO1, GPIO2, GPIO4
 
-```yaml
-#This is the onboard LED pin
-GPIO3
+#Onboard RGB LED: GPIO3
 ```
 
 **Example ESPHome yaml:**
@@ -53,7 +53,7 @@ esphome:
   comment: Apollo DEV-1
 
   project:
-    name: "ApolloAutomation.MSR-2"
+    name: "ApolloAutomation.DEV-1"
     version: "${version}"
 
 # Define Board

docs/products/dev2/introduction.md

@@ -2,7 +2,7 @@
 title: Apollo DEV-2 Introduction
 description: Apollo DEV-2 Introduction.
 ---
-![](../../assets/apollo-dev-2-pinout-1.png)
+![Apollo DEV-2 pinout showing the GPIO number and functions of every header pin](/assets/apollo-dev-2-pinout.webp)
 
 The Apollo DEV-2 is a very small dev board that we use to prototype before creating other new products. It has a built in RGB light (using GPIO3) and can push up to 600mA out of the 3.3v pin however 100-200mA of that will be used by the microcontroller itself. You are able to back-feed power via the 5v and G (ground) pins or use the USB-C port to power it, but NOT both at the same time.
 
@@ -31,15 +31,15 @@ i2c:
   sda: GPIO1
   scl: GPIO0
 
-RX: 30
-TX: 31
+#These are the UART pins
+uart:
+  tx_pin: GPIO16
+  rx_pin: GPIO17
+  baud_rate: 115200 #match the device you connect
 
-ADC Pins: 0,1,2,3,4,5
-```
+#ADC pins: GPIO0, GPIO1, GPIO2, GPIO4, GPIO5, GPIO6
 
-```yaml
-#This is the onboard LED pin
-GPIO3
+#Onboard RGB LED: GPIO3
 ```
 
 **Example ESPHome yaml:**

tools/pinouts/README.md

@@ -0,0 +1,22 @@
+# DEV board pinouts
+
+Generates the DEV-1 and DEV-2 pinout diagrams used on the wiki:
+
+- `docs/assets/apollo-dev-1-pinout.webp`
+- `docs/assets/apollo-dev-2-pinout.webp`
+
+The label style follows [boardgen](https://github.com/kuba2k2/boardgen).
+
+## Fix a label
+
+1. Edit the pin table in `boards.json`. Each pad is a list of `kind:text` tags, listed from the board outward. The kinds are `power`, `ground`, `gpio`, `adc`, `i2c`, `uart`, `spi` and `led`.
+2. Run `python tools/pinouts/make_pinout.py` from the repo root. You can also pass one board, such as `dev-2`.
+3. Commit the updated `boards.json` and the regenerated `.webp` files.
+
+Requirements: Python with [Pillow](https://pypi.org/project/Pillow/), plus Chrome or Edge to render the SVG.
+
+Pin numbers are GPIO numbers, not module pin numbers. Check any new label against the module datasheet ([ESP32-C3-MINI-1](https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_en.pdf), [ESP32-C6-MINI-1](https://www.espressif.com/sites/default/files/documentation/esp32-c6-mini-1_mini-1u_datasheet_en.pdf)).
+
+## Board art
+
+`dev1-board.png` and `dev2-board.png` are the EasyEDA 3D renders in `renders/`, cropped to the PCB. Only rerun `python tools/pinouts/prep_renders.py` if a render changes. If the board art moves, the pad positions in `boards.json` (`x`, `y0`, `pitch`) have to be remeasured.

tools/pinouts/boards.json

@@ -0,0 +1,195 @@
+{
+  "dev-1": {
+    "title": "Apollo DEV-1",
+    "chip": "ESP32-C3",
+    "example": "GPIO21",
+    "photo": "dev1-board.png",
+    "left": {
+      "x": 38,
+      "y0": 172,
+      "pitch": 80.8
+    },
+    "right": {
+      "x": 700,
+      "y0": 172,
+      "pitch": 80.8
+    },
+    "pins": {
+      "left": [
+        [
+          "power:3V3"
+        ],
+        [
+          "ground:GND"
+        ],
+        [
+          "gpio:2",
+          "adc:ADC",
+          "spi:MISO"
+        ],
+        [
+          "gpio:4",
+          "adc:ADC"
+        ],
+        [
+          "gpio:5"
+        ],
+        [
+          "gpio:0",
+          "adc:ADC",
+          "i2c:SCL"
+        ],
+        [
+          "gpio:1",
+          "adc:ADC",
+          "i2c:SDA"
+        ]
+      ],
+      "right": [
+        [
+          "power:5V"
+        ],
+        [
+          "ground:GND"
+        ],
+        [
+          "gpio:10",
+          "spi:CS"
+        ],
+        [
+          "gpio:21",
+          "uart:TX"
+        ],
+        [
+          "gpio:20",
+          "uart:RX"
+        ],
+        [
+          "gpio:7",
+          "spi:MOSI"
+        ],
+        [
+          "gpio:6",
+          "spi:CLK"
+        ]
+      ]
+    },
+    "led": {
+      "x": 688,
+      "y": 45,
+      "tags": [
+        "gpio:3",
+        "led:RGB LED"
+      ]
+    }
+  },
+  "dev-2": {
+    "title": "Apollo DEV-2",
+    "chip": "ESP32-C6",
+    "example": "GPIO16",
+    "photo": "dev2-board.png",
+    "left": {
+      "x": 38,
+      "y0": 145,
+      "pitch": 81.3
+    },
+    "right": {
+      "x": 700,
+      "y0": 145,
+      "pitch": 81.3
+    },
+    "pins": {
+      "left": [
+        [
+          "power:3V3"
+        ],
+        [
+          "ground:GND"
+        ],
+        [
+          "gpio:2",
+          "adc:ADC",
+          "spi:MISO"
+        ],
+        [
+          "gpio:4",
+          "adc:ADC"
+        ],
+        [
+          "gpio:5",
+          "adc:ADC"
+        ],
+        [
+          "gpio:0",
+          "adc:ADC",
+          "i2c:SCL"
+        ],
+        [
+          "gpio:1",
+          "adc:ADC",
+          "i2c:SDA"
+        ],
+        [
+          "gpio:6",
+          "adc:ADC",
+          "spi:CLK"
+        ],
+        [
+          "gpio:7",
+          "spi:MOSI"
+        ],
+        [
+          "gpio:14"
+        ],
+        [
+          "ground:GND"
+        ]
+      ],
+      "right": [
+        [
+          "power:5V"
+        ],
+        [
+          "ground:GND"
+        ],
+        [
+          "gpio:16",
+          "uart:TX"
+        ],
+        [
+          "gpio:17",
+          "uart:RX"
+        ],
+        [
+          "gpio:23"
+        ],
+        [
+          "gpio:22"
+        ],
+        [
+          "gpio:21"
+        ],
+        [
+          "gpio:20"
+        ],
+        [
+          "gpio:19"
+        ],
+        [
+          "gpio:18"
+        ],
+        [
+          "gpio:15"
+        ]
+      ]
+    },
+    "led": {
+      "x": 680,
+      "y": 45,
+      "tags": [
+        "gpio:3",
+        "led:RGB LED"
+      ]
+    }
+  }
+}