From 9e4c0d5214d7919937645e25404f235c263f295f Mon Sep 17 00:00:00 2001 From: Nathaniel Wesley Filardo Date: Thu, 30 Dec 2021 04:09:46 +0000 Subject: [PATCH] tests: Slam docs together Notably, move updated wiring description to README and remove it from HardwareTestHarness --- tests/HardwareTestHarness.md | 100 ++++++----------------------------- tests/README.md | 87 +++++++++++++++++------------- 2 files changed, 65 insertions(+), 122 deletions(-) diff --git a/tests/HardwareTestHarness.md b/tests/HardwareTestHarness.md index 64bdb0cf..96f50511 100644 --- a/tests/HardwareTestHarness.md +++ b/tests/HardwareTestHarness.md @@ -48,43 +48,13 @@ Peripherals ### I2C Bus -There is an I2C bus hanging off DUT 0. Attached hardware is used both as -tests of modules directly and also to facilitate testing other modules -(e.g., gpio). - Most of the positions on the board are connected to the DUT1 I2C bus. -#### MCP23017: I/O Expander +#### MCP23017: I/O Expander (DUT 0, 0x20) -At address 0x20. An 16-bit tristate GPIO expander, this chip is used to -test I2C, GPIO, and ADC functionality. This chip's interconnections are -as follows: +As per the [Generic Framework](README.md). -MPC23017 | Purpose ----------|-------------------------------------------------------------- -/RESET |DUT0 reset. This resets the chip whenever the host computer resets DUT 0 over its serial link (using DTR/RTS). -B 0 |4K7 resistor to DUT 0 ADC. -B 1 |2K2 resistor to DUT 0 ADC. -B 2 |Direct to DUT1 RST -B 3 |Direct to DUT1 D3 -B 4 |When low, connects the alternate UART pins on DUT0 to RX,TX on DUT1 -B 5 |DUT1 GPIO16/WAKE via 4K7 resitor -B 6 |DUT0 GPIO13 via 4K4 resistor and DUT1 GPIO15 via 4K7 resistor (also feeds in the primary TX from DUT1 when enabled by B4) -B 7 |DUT0 GPIO15 via 4K7 resistor and DUT1 GPIO13 via 4K7 resistor (also feeds the primary RX on DUT1 when enabled by B4) - -Notes: - -- DUT 0's ADC pin is connected via a 2K2 reistor to this chip's port - B, pin 1 and via a 4K7 resistor to port B, pin 0. This gives us the - ability to produce approximately 0 (both pins low), 1.1 (pin 0 high, - pin 1 low), 2.2 (pin 1 high, pin 0 low), and 3.3V (both pins high) - on the ADC pin. -- Port B pins 6 and 7 sit on the UART cross-wiring between DUT 0 and - DUT 1. The 23017 will be tristated for inter-DUT UART tests, but - these -- All of port A, remain available for expansion and are routed to the breadboard area. - -#### WS2812s +### WS2812s There are three WS2812s connected on DUT1/D4. The last Ws2812 is positioned so that a TCS34725 module can be mounted upside down over it to read out the color of the WS2812. That device is connected to @@ -94,22 +64,34 @@ LED is connected to the INT pin and so you can disable the LED under software co #### Oled Displays Each of the D1 Minis is connected to a position for a 128x64 OLED display, again on the primary I2C bus. +Note: Not yet used in the test harness. #### Servo On DUT1 pin D4/GPIO 2 there is a connection to a position for a small servo. The servo is powered by the 5V voltage rail. +Note: Not yet used in the test harness. + #### DHTxx On DUT1 pin D6/GPIO 12 there is a connection to a position for a DHTxx device. The silk screen indicates the orientation of the device. +Note: Not yet used in the test harness. + #### DS18B20 There are two positions for DS18B20s -- one with the VCC pin connected and one without. The data pin is connected to DUT1 pin D5/GPIO 14. +Note: Not yet used in the test harness. + +Note: It would make sense to augment the 1-Wire testing facility to +include bus-drive power, perhaps via the MCP23017, especially if we ever +augment the driver as per +https://github.com/nodemcu/nodemcu-firmware/issues/1995 + #### I2C devices with VCC/GND/SCL/SDA pin order There are three positions for I2C devices which have the pins in the VCC/GND/SCL/SDA order. These @@ -121,61 +103,9 @@ There are three positions for I2C devices with other pin orders. Each of these p to a crossbar switch and so four blobs of solder can configure each of these headers into any desired pin order. As far as I can tell, most of the cheap modules use the VCC/GND/SCL/SDA order. - Breadboard Area =============== All the pins on each D1 Mini and the A port of the MCP23017 are brought out to a breadboard area. This can be used to solder components and/or wires, or even a header could be soldered on to transfer all the signals to a conventional breadboard. - - -ESP8266 Device 0 Connections ----------------------------- - -ESP | Usage -----------|---------------------------------------------------------- -D3/GPIO 0 |Used to enter programming mode; otherwise unused in test environment. -TX/GPIO 1 |Primary UART transmit; reserved for host communication -D4/GPIO 2 |[reserved for 1-Wire] [+ reserved for 23017 INT[AB] connections] -RX/GPIO 3 |Primary UART recieve; reserved for host communication -D2/GPIO 4 |I2C SDA. Connected to MCP23017, Oled display and the TCS34725 if present. -D1/GPIO 5 |I2C SCL -GPIO 6 |[Reserved for on-chip flash] -GPIO 7 |[Reserved for on-chip flash] -GPIO 8 |[Reserved for on-chip flash] -GPIO 9 |[Reserved for on-chip flash] -GPIO 10 |[Reserved for on-chip flash] -GPIO 11 |[Reserved for on-chip flash] -D6/GPIO 12 | -D7/GPIO 13 |Secondary UART RX; DUT 1 GPIO 15, I/O expander B 6 -D5/GPIO 14 | -D8/GPIO 15 |Secondary UART TX; DUT 1 GPIO 13, I/O expander B 7 -D0/GPIO 16 | -A0/ADC 0 |Resistor divider with I/O expander - -ESP8266 Device 1 Connections ----------------------------- - -ESP | Usage -----------|---------------------------------------------------------- -D3/GPIO 0 |Used to enter programming mode; otherwise unused in test environment. -TX/GPIO 1 |Primary UART transmit; reserved for host communication -D4/GPIO 2 |Connected to chain of 3 WS2812s. Also connected to the servo position. -RX/GPIO 3 |Primary UART recieve; reserved for host communication -D2/GPIO 4 |I2C SDA. Connected to all the other I2C positions on the board -D1/GPIO 5 |I2C SCL -GPIO 6 |[Reserved for on-chip flash] -GPIO 7 |[Reserved for on-chip flash] -GPIO 8 |[Reserved for on-chip flash] -GPIO 9 |[Reserved for on-chip flash] -GPIO 10 |[Reserved for on-chip flash] -GPIO 11 |[Reserved for on-chip flash] -D6/GPIO 12 |Connected to data pin for DHTxx -D7/GPIO 13 |Secondary UART RX; DUT 0 GPIO 15, I/O exp B 7 via 4K7 Also used as HSPI MOSI for SPI tests -D5/GPIO 14 |Connected to data pin for DS18B20s. -D8/GPIO 15 |Secondary UART TX; DUT 0 GPIO 13, I/O exp B 6 via 4K7 Also used as HSPI /CS for SPI tests -D0/GPIO 16 |I/O expander B 5 via 4K7 resistor, for deep-sleep tests -A0/ADC 0 | - - diff --git a/tests/README.md b/tests/README.md index 5fea6c97..6477a9aa 100644 --- a/tests/README.md +++ b/tests/README.md @@ -136,30 +136,34 @@ devices, as found on almost all ESP8266 boards with USB to UART adapters, but the host does not necessarily need to use USB to connect, so long as TXD, RXD, DTR, and RTS are wired across. -A particular implementation of this can be found at [Test Harness](HardwareTestHarness.md). +A particular implementation of this, with some additional goodies, can +be found at [Test Harness Board](HardwareTestHarness.md). ## Peripherals ### I2C Bus -There is an I2C bus hanging off DUT 0. Attached hardware is used both as -tests of modules directly and also to facilitate testing other modules -(e.g., gpio). +There is an I2C bus hanging off each DUT. Attached hardware is used both +as tests of modules directly and also to facilitate testing other +modules (e.g., gpio). -#### MCP23017: I/O Expander +#### MCP23017: I/O Expander (DUT 0, 0x20) -At address 0x20. An 16-bit tristate GPIO expander, this chip is used to -test I2C, GPIO, and ADC functionality. This chip's interconnections are -as follows: +At address 0x20 off DUT 0. An 16-bit tristate GPIO expander, this chip +is used to test I2C, GPIO, and ADC functionality. This chip's +interconnections are as follows: MPC23017 | Purpose ---------|-------------------------------------------------------------- /RESET |DUT0 reset. This resets the chip whenever the host computer resets DUT 0 over its serial link (using DTR/RTS). B 0 |4K7 resistor to DUT 0 ADC. B 1 |2K2 resistor to DUT 0 ADC. +B 2 |Direct to DUT1 RST +B 3 |Direct to DUT1 D3 +B 4 |When low, connects the alternate UART pins on DUT0 to RX,TX on DUT1 (NOTE: not yet used in the test harness) B 5 |DUT1 GPIO16/WAKE via 4K7 resitor -B 6 |DUT0 GPIO13 via 4K7 resistor and DUT1 GPIO15 via 4K7 resistor -B 7 |DUT0 GPIO15 via 4K7 resistor and DUT1 GPIO13 via 4K7 resistor +B 6 |DUT0 GPIO13 via 4K4 resistor and DUT1 GPIO15 via 4K7 resistor (also feeds in the primary TX from DUT1 when enabled by B4) +B 7 |DUT0 GPIO15 via 4K7 resistor and DUT1 GPIO13 via 4K7 resistor (also feeds the primary RX on DUT1 when enabled by B4) Notes: @@ -168,39 +172,48 @@ Notes: ability to produce approximately 0 (both pins low), 1.1 (pin 0 high, pin 1 low), 2.2 (pin 1 high, pin 0 low), and 3.3V (both pins high) on the ADC pin. + - Port B pins 6 and 7 sit on the UART cross-wiring between DUT 0 and DUT 1. The 23017 will be tristated for inter-DUT UART tests, but - these -- Port B pins 2, 3, and 4, as well as all of port A, remain available - for expansion. -- The interrupt pins are not yet routed, but could be. We reserve DUT - 0 GPIO 2 for this purpose with the understanding that the 23017's - interrupt functionality will be disabled (INTA, INTB set to - open-drain, GPINTEN set to 0) when not explicitly under test. + these are also useful for GPIO tests on DUT1. + +- All of port A remains available for expansion and are routed to the + breadboard area. + +- The interrupt pins are not yet routed to DUTs, but could be. We + reserve DUT 0 GPIO 2 for this purpose with the understanding that + the 23017's interrupt functionality will be disabled (INTA, INTB + set to open-drain, GPINTEN set to 0) when not explicitly under test. + +### WS2812s + +The test harness reserves DUT1/D4 for connection to WS2812. + +# DUT Connections ESP8266 Device 0 Connections ---------------------------- -ESP | Usage -----------|---------------------------------------------------------- -GPIO 0 |Used to enter programming mode; otherwise unused in test environment. -GPIO 1 |Primary UART transmit; reserved for host communication -GPIO 2 |[reserved for 1-Wire] [+ reserved for 23017 INT[AB] connections] -GPIO 3 |Primary UART recieve; reserved for host communication -GPIO 4 |I2C SDA -GPIO 5 |I2C SCL -GPIO 6 |[Reserved for on-chip flash] -GPIO 7 |[Reserved for on-chip flash] -GPIO 8 |[Reserved for on-chip flash] -GPIO 9 |[Reserved for on-chip flash] -GPIO 10 |[Reserved for on-chip flash] -GPIO 11 |[Reserved for on-chip flash] -GPIO 12 | -GPIO 13 |Secondary UART RX; DUT 1 GPIO 15, I/O expander B 6 -GPIO 14 | -GPIO 15 |Secondary UART TX; DUT 1 GPIO 13, I/O expander B 7 -GPIO 16 | -ADC 0 |Resistor divider with I/O expander +ESP | Usage +-----------|---------------------------------------------------------- +D3/GPIO 0 |Used to enter programming mode; otherwise unused in test environment. +TX/GPIO 1 |Primary UART transmit; reserved for host communication +D4/GPIO 2 |(+ reserved for 23017 INT[AB] connections) +RX/GPIO 3 |Primary UART recieve; reserved for host communication +D2/GPIO 4 |I2C SDA bus 0. Connected to MCP23017, DUT0 Oled display and the TCS34725 if present. +D1/GPIO 5 |I2C SCL bus 0 +GPIO 6 |(Reserved for on-chip flash) +GPIO 7 |(Reserved for on-chip flash) +GPIO 8 |(Reserved for on-chip flash) +GPIO 9 |(Reserved for on-chip flash) +GPIO 10 |(Reserved for on-chip flash) +GPIO 11 |(Reserved for on-chip flash) +D6/GPIO 12 | +D7/GPIO 13 |Secondary UART RX; DUT 1 GPIO 15, I/O expander B 6 +D5/GPIO 14 | +D8/GPIO 15 |Secondary UART TX; DUT 1 GPIO 13, I/O expander B 7 +D0/GPIO 16 | +A0/ADC 0 |Resistor divider with I/O expander ESP8266 Device 1 Connections ----------------------------