From 5b9c9cd0971fda60e7e6375c17bda32d3a3407d6 Mon Sep 17 00:00:00 2001 From: Seon Rozenblum Date: Wed, 27 Oct 2021 16:10:16 +1100 Subject: [PATCH] esp32/boards: Update board and deploy metadata for UM_xxx boards. --- ports/esp32/boards/UM_FEATHERS2/board.json | 9 +++- ports/esp32/boards/UM_FEATHERS2/board.md | 2 + ports/esp32/boards/UM_FEATHERS2/deploy.md | 50 +++++++++++++++++++ ports/esp32/boards/UM_FEATHERS2NEO/board.json | 12 +++-- ports/esp32/boards/UM_FEATHERS2NEO/board.md | 2 + ports/esp32/boards/UM_FEATHERS2NEO/deploy.md | 50 +++++++++++++++++++ ports/esp32/boards/UM_TINYPICO/board.json | 14 +++++- ports/esp32/boards/UM_TINYPICO/board.md | 3 ++ ports/esp32/boards/UM_TINYPICO/deploy.md | 46 +++++++++++++++++ ports/esp32/boards/UM_TINYS2/board.json | 10 +++- ports/esp32/boards/UM_TINYS2/board.md | 2 + ports/esp32/boards/UM_TINYS2/deploy.md | 50 +++++++++++++++++++ 12 files changed, 242 insertions(+), 8 deletions(-) create mode 100644 ports/esp32/boards/UM_FEATHERS2/board.md create mode 100644 ports/esp32/boards/UM_FEATHERS2/deploy.md create mode 100644 ports/esp32/boards/UM_FEATHERS2NEO/board.md create mode 100644 ports/esp32/boards/UM_FEATHERS2NEO/deploy.md create mode 100644 ports/esp32/boards/UM_TINYPICO/board.md create mode 100644 ports/esp32/boards/UM_TINYPICO/deploy.md create mode 100644 ports/esp32/boards/UM_TINYS2/board.md create mode 100644 ports/esp32/boards/UM_TINYS2/deploy.md diff --git a/ports/esp32/boards/UM_FEATHERS2/board.json b/ports/esp32/boards/UM_FEATHERS2/board.json index d2da16a6ee..19d7219ec5 100644 --- a/ports/esp32/boards/UM_FEATHERS2/board.json +++ b/ports/esp32/boards/UM_FEATHERS2/board.json @@ -1,6 +1,6 @@ { "deploy": [ - "../deploy_s2.md" + "deploy.md" ], "docs": "", "features": [ @@ -8,7 +8,12 @@ "Feather", "Battery Charging", "STEMMA QT/QWIIC", - "USB-C" + "USB-C", + "RGB LED", + "SPIRAM" + ], + "features_non_filterable": [ + "Second LDO" ], "id": "featherS2", "images": [ diff --git a/ports/esp32/boards/UM_FEATHERS2/board.md b/ports/esp32/boards/UM_FEATHERS2/board.md new file mode 100644 index 0000000000..e04a8936c8 --- /dev/null +++ b/ports/esp32/boards/UM_FEATHERS2/board.md @@ -0,0 +1,2 @@ +The following files are daily firmware for the FeatherS2. This firmware is +compiled using ESP-IDF v4.3 or later. diff --git a/ports/esp32/boards/UM_FEATHERS2/deploy.md b/ports/esp32/boards/UM_FEATHERS2/deploy.md new file mode 100644 index 0000000000..24bced3cda --- /dev/null +++ b/ports/esp32/boards/UM_FEATHERS2/deploy.md @@ -0,0 +1,50 @@ +Program your board using the esptool.py program, found [here](https://github.com/espressif/esptool). + +To flash or erase your FeatherS2, you have to first put it into download mode. +To do this, follow these steps: + +- Press and hold the [BOOT] button +- Press and release the [RESET] button +- Release the [BOOT] button + +Now the board is in download mode and the native USB will have enumerated as a serial device. + +If you are putting MicroPython on your board for the first time then you should +first erase the entire flash using: + +### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 erase_flash +``` + +### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 erase_flash +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) erase_flash +``` + +Now download the version of the firmware you would like to install from the options +below, then use the following command to program the firmware starting at address +0x1000, remembering to replace `feathers2-micropython-firmware-version.bin` with the +name of the firmware you just downloaded: + +### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 write_flash -z 0x1000 feathers2-micropython-firmware-version.bin +``` + +### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 write_flash -z 0x1000 feathers2-micropython-firmware-version.bin +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) write_flash -z 0x1000 feathers2-micropython-firmware-version.bin +``` diff --git a/ports/esp32/boards/UM_FEATHERS2NEO/board.json b/ports/esp32/boards/UM_FEATHERS2NEO/board.json index 1e3e2c0e3b..be7a1371fa 100644 --- a/ports/esp32/boards/UM_FEATHERS2NEO/board.json +++ b/ports/esp32/boards/UM_FEATHERS2NEO/board.json @@ -1,6 +1,6 @@ { "deploy": [ - "../deploy_s2.md" + "deploy.md" ], "docs": "", "features": [ @@ -9,10 +9,16 @@ "Battery Charging", "STEMMA QT/QWIIC", "USB-C", - "Neopixels" + "RGB LED", + "SPIRAM" + ], + "features_non_filterable": [ + "5x5 RGB LED Matrix" ], "id": "featherS2neo", - "images": [], + "images": [ + "FeatherS2_Neo_White_Product2.jpg" + ], "mcu": "esp32s2", "product": "Feather S2 Neo", "thumbnail": "", diff --git a/ports/esp32/boards/UM_FEATHERS2NEO/board.md b/ports/esp32/boards/UM_FEATHERS2NEO/board.md new file mode 100644 index 0000000000..60ee024a12 --- /dev/null +++ b/ports/esp32/boards/UM_FEATHERS2NEO/board.md @@ -0,0 +1,2 @@ +The following files are daily firmware for the FeatherS2 Neo. This firmware is +compiled using ESP-IDF v4.3 or later. diff --git a/ports/esp32/boards/UM_FEATHERS2NEO/deploy.md b/ports/esp32/boards/UM_FEATHERS2NEO/deploy.md new file mode 100644 index 0000000000..b1a116e807 --- /dev/null +++ b/ports/esp32/boards/UM_FEATHERS2NEO/deploy.md @@ -0,0 +1,50 @@ +Program your board using the esptool.py program, found [here](https://github.com/espressif/esptool). + +To flash or erase your FeatherS2 Neo, you have to first put it into download mode. +To do this, follow these steps: + +- Press and hold the [BOOT] button +- Press and release the [RESET] button +- Release the [BOOT] button + +Now the board is in download mode and the native USB will have enumerated as a serial device. + +If you are putting MicroPython on your board for the first time then you should +first erase the entire flash using: + +### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 erase_flash +``` + +### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 erase_flash +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) erase_flash +``` + +Now download the version of the firmware you would like to install from the options below, +then use the following command to program the firmware starting at address 0x1000, +remembering to replace `feathers2neo-micropython-firmware-version.bin` with the name of +the firmware you just downloaded: + +### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 write_flash -z 0x1000 feathers2neo-micropython-firmware-version.bin +``` + +### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 write_flash -z 0x1000 feathers2neo-micropython-firmware-version.bin +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) write_flash -z 0x1000 feathers2-feathers2neo-firmware-version.bin +``` diff --git a/ports/esp32/boards/UM_TINYPICO/board.json b/ports/esp32/boards/UM_TINYPICO/board.json index 6b5a01d57f..6fb7803fe2 100644 --- a/ports/esp32/boards/UM_TINYPICO/board.json +++ b/ports/esp32/boards/UM_TINYPICO/board.json @@ -1,9 +1,19 @@ { "deploy": [ - "../deploy.md" + "deploy.md" ], "docs": "", - "features": [], + "features": [ + "BLE", + "WiFi", + "Battery Charging", + "USB-C", + "RGB LED", + "SPIRAM" + ], + "features_non_filterable": [ + "TinyPICO Compatible" + ], "id": "tinypico", "images": [ "tinypico-v2-both.jpg" diff --git a/ports/esp32/boards/UM_TINYPICO/board.md b/ports/esp32/boards/UM_TINYPICO/board.md new file mode 100644 index 0000000000..d0b1266d2e --- /dev/null +++ b/ports/esp32/boards/UM_TINYPICO/board.md @@ -0,0 +1,3 @@ +The following files are daily firmware for the TinyPICO. This firmware is compiled +using ESP-IDF v4.2 or later. Some older releases are also provided that are +compiled with ESP-IDF v3.x. diff --git a/ports/esp32/boards/UM_TINYPICO/deploy.md b/ports/esp32/boards/UM_TINYPICO/deploy.md new file mode 100644 index 0000000000..ed29478675 --- /dev/null +++ b/ports/esp32/boards/UM_TINYPICO/deploy.md @@ -0,0 +1,46 @@ +Program your board using the esptool.py program, found [here](https://github.com/espressif/esptool). + +Your TinyPICO has an auto-reset circuit on it, so there is no need to put it into a +download mode first to erase or flash it. + +If you are putting MicroPython on your board for the first time then you should +first erase the entire flash using: + +### Linux +```bash +esptool.py --chip esp32 --port /dev/ttyUSB0 erase_flash +``` + +### Mac +```bash +esptool.py --chip esp32 --port /dev/tty.SLAB_USBtoUART erase_flash +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32 --port COM(X) erase_flash +``` + +Now download the version of the firmware you would like to install from the options below, +then use the following command to program the firmware starting at address 0x1000, +remembering to replace `tinypico-micropython-firmware-version.bin` with the name of the +firmware you just downloaded: + +From then on program the firmware starting at address 0x1000: + +### Linux +```bash +esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 912600 write_flash -z 0x1000 tinypico-micropython-firmware-version.bin +``` + +### Mac +```bash +esptool.py --chip esp32 --port /dev/tty.SLAB_USBtoUART --baud 912600 write_flash -z 0x1000 tinypico-micropython-firmware-version.bin +``` + +### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32 --port COM(X) --baud 912600 write_flash -z 0x1000 tinypico-micropython-firmware-version.bin +``` diff --git a/ports/esp32/boards/UM_TINYS2/board.json b/ports/esp32/boards/UM_TINYS2/board.json index d378f6b9d8..20c1c6d847 100644 --- a/ports/esp32/boards/UM_TINYS2/board.json +++ b/ports/esp32/boards/UM_TINYS2/board.json @@ -1,11 +1,19 @@ { "deploy": [ - "../deploy_s2.md" + "deploy.md" ], "docs": "", "features": [ "WiFi", "USB-C" + "Battery Charging", + "STEMMA QT/QWIIC", + "USB-C", + "RGB LED", + "SPIRAM" + ], + "features_non_filterable": [ + "TinyPICO Compatible" ], "id": "tinys2", "images": [ diff --git a/ports/esp32/boards/UM_TINYS2/board.md b/ports/esp32/boards/UM_TINYS2/board.md new file mode 100644 index 0000000000..9a61374edf --- /dev/null +++ b/ports/esp32/boards/UM_TINYS2/board.md @@ -0,0 +1,2 @@ +The following files are daily firmware for the TinyS2. This firmware is compiled +using ESP-IDF v4.3 or later. diff --git a/ports/esp32/boards/UM_TINYS2/deploy.md b/ports/esp32/boards/UM_TINYS2/deploy.md new file mode 100644 index 0000000000..a46bc9bd1a --- /dev/null +++ b/ports/esp32/boards/UM_TINYS2/deploy.md @@ -0,0 +1,50 @@ +Program your board using the esptool.py program, found [here](https://github.com/espressif/esptool). + +To flash or erase your TinyS2, you have to first put it into download mode. +To do this, follow these steps: + +- Press and hold the [BOOT] button +- Press and release the [RESET] button +- Release the [BOOT] button + +Now the board is in download mode and the native USB will have enumerated as a serial device. + +If you are putting MicroPython on your board for the first time then you should +first erase the entire flash using: + +### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 erase_flash +``` + +### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 erase_flash +``` + +#### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) erase_flash +``` + +Now download the version of the firmware you would like to install from the options below, +then use the following command to program the firmware starting at address 0x1000, +remembering to replace `tinys2-micropython-firmware-version.bin` with the name of the +firmware you just downloaded: + +#### Linux +```bash +esptool.py --chip esp32s2 --port /dev/ttyACM0 write_flash -z 0x1000 tinys2-micropython-firmware-version.bin +``` + +#### Mac +```bash +esptool.py --chip esp32s2 --port /dev/cu.usbmodem01 write_flash -z 0x1000 tinys2-micropython-firmware-version.bin +``` + +#### Windows +Change (X) to whatever COM port is being used by the board +```bash +esptool --chip esp32s2 --port COM(X) write_flash -z 0x1000 tinys2-micropython-firmware-version.bin +```