botchain/firmware
1
0
Fork 0
mirror of https://github.com/BotChain-Robots/firmware.git synced 2026-07-08 09:37:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to esp v6.0

Browse Source
This commit is contained in:
Johnathon Slightham
2026-01-14 13:37:15 -05:00
parent c289a641df
commit 9e7f15d548
1 changed files with 11 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,24 +1,14 @@
# Firmware # Firmware
1. [Setup](#Setup) [[_TOC_]]
1. [Install Dependencies](#InstallDependencies)
1. [MacOS](#MacOS1)
2. [Windows](#Windows1)
2. [Development](#Development)
1. [Command Line Tools](#CommandLineTools)
1. [MacOS](#MacOS2)
2. [Windows](#Windows2)
2. [Using an IDE](#UsinganIDE)
1. [Visual Studio Code](#VisualStudioCode)
2. [JetBrains CLion](#JetBrainsCLion)
<hr> <hr>
## Setup <a name="Setup"></a> ## Setup <a name="Setup"></a>
**This project is currently setup to work with the ESP32-S3 board.** **This project is currently setup to work with the ESP32-S3 board.**
We use ESP-IDF version 5.5.1. We use ESP-IDF version 6.0.
The Espressif docs have a [well written article](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html) that explains the build system. The Espressif docs have a [well written article](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html) that explains the build system.
Versions before 5.5 are incompatible due to an issue with the CMakeLists.txt file in the ledc component (that we depend on). Versions before 6.0 are incompatible due to an issue with the CMakeLists.txt file in the ledc component (that we depend on).
### Install Dependencies <a name="InstallDependencies"></a> ### Install Dependencies <a name="InstallDependencies"></a>
#### MacOS <a name="MacOS1"></a> #### MacOS <a name="MacOS1"></a>
@@ -37,15 +27,16 @@ Setup ESP-IDF
mkdir -p ~/esp mkdir -p ~/esp
cd ~/esp cd ~/esp
git clone --recursive https://github.com/espressif/esp-idf.git git clone --recursive https://github.com/espressif/esp-idf.git
cd ~/esp/isp-idf cd ~/esp/esp-idf
./install.sh esp32,esp32s3 git switch release/v6.0
./install.sh esp32s3
``` ```
#### Windows <a name="Windows1"></a> #### Windows <a name="Windows1"></a>
Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4). Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4).
- Use default options. - Use default options.
- You may install ESP-IDF to a path that is different than the default, however, keep the length of the path under 90 characters and do not include any spaces or non ASCII characters. - You may install ESP-IDF to a path that is different than the default, however, keep the length of the path under 90 characters and do not include any spaces or non ASCII characters.
- Select version v5.5.x. - Select version v6.0.x.
- Ensure that the `esp32s3` checkbox is selected (should be by default) - Ensure that the `esp32s3` checkbox is selected (should be by default)
- The installer will automatically provide - The installer will automatically provide
- Embedded Python - Embedded Python
@@ -153,4 +144,4 @@ CLion is compatible with this project. Follow [the tutorial on Espressif's site]
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⢆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡏⠘⣆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⢆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡏⠘⣆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠃⠀⠈⠳⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠃⠀⠈⠳⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⠁⠀⠀⠀⠀⠀⠙⠓⠤⢤⣤⣀⣀⣀⣀⣀⣠⡤⢖⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⠁⠀⠀⠀⠀⠀⠙⠓⠤⢤⣤⣀⣀⣀⣀⣀⣠⡤⢖⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⢀⠀⠀⢀⡔⠉⠀⠀⢀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠀⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⢀⠀⠀⢀⡔⠉⠀⠀⢀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀