mirror of
https://github.com/BotChain-Robots/firmware.git
synced 2026-07-08 17:47:21 +02:00
Add windows instructions
This commit is contained in:
43
README.md
43
README.md
@@ -2,6 +2,9 @@
|
|||||||
|
|
||||||
**This project is currently setup to work with the ESP32, we will be using the ESP32-c6 in the future.**
|
**This project is currently setup to work with the ESP32, we will be using the ESP32-c6 in the future.**
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
This project uses ESP-IDF version 5.4.
|
||||||
|
|
||||||
### Install Dependencies
|
### Install Dependencies
|
||||||
#### MacOS
|
#### MacOS
|
||||||
Install xcode command line tools (if you do not already have them)
|
Install xcode command line tools (if you do not already have them)
|
||||||
@@ -9,10 +12,9 @@ Install xcode command line tools (if you do not already have them)
|
|||||||
xcode-select --install
|
xcode-select --install
|
||||||
```
|
```
|
||||||
|
|
||||||
Install project & ESP-IDF dependencies
|
Install project & ESP-IDF dependencies (if you do not already have them)
|
||||||
```
|
```
|
||||||
brew install cmake ninja dfu-util
|
brew install cmake ninja dfu-util python3
|
||||||
brew install python3
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Setup ESP-IDF
|
Setup ESP-IDF
|
||||||
@@ -24,10 +26,23 @@ cd ~/esp/isp-idf
|
|||||||
./install.sh esp32
|
./install.sh esp32
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Windows
|
||||||
|
Install ESP-IDF with with the GUI [Windows installer](https://dl.espressif.com/dl/esp-idf/?idf=4.4).
|
||||||
|
- 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.
|
||||||
|
- Select version v5.4.x.
|
||||||
|
- The installer will automatically provide
|
||||||
|
- Embedded Python
|
||||||
|
- Required cross compilers
|
||||||
|
- OpenOCD
|
||||||
|
- CMake and Ninja
|
||||||
|
- ESP-IDF
|
||||||
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
### Command Line Tools
|
|
||||||
The board is flashed via UART. A USB to UART adapter is provided as part of the devboard.
|
The board is flashed via UART. A USB to UART adapter is provided as part of the devboard.
|
||||||
|
|
||||||
|
### Command Line Tools
|
||||||
#### MacOS
|
#### MacOS
|
||||||
Export environment variables
|
Export environment variables
|
||||||
```
|
```
|
||||||
@@ -39,6 +54,26 @@ Build the project
|
|||||||
idf.py build
|
idf.py build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Flash and open serial monitor (Use Ctrl+] to exit)
|
||||||
|
```
|
||||||
|
idf.py flash monitor
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Windows
|
||||||
|
Run the following commands in a command prompt.
|
||||||
|
|
||||||
|
Export environment variables (alternatively run the ESP-IDF Command Prompt shortcut)
|
||||||
|
```
|
||||||
|
# Example path: C:\Espressif\frameworks\esp-idf-v5.4.1-3\
|
||||||
|
|
||||||
|
/Path/To/ESP-IDF/export.bat
|
||||||
|
```
|
||||||
|
|
||||||
|
Build the project
|
||||||
|
```
|
||||||
|
idf.py build
|
||||||
|
```
|
||||||
|
|
||||||
Flash and open serial monitor
|
Flash and open serial monitor
|
||||||
```
|
```
|
||||||
idf.py flash monitor
|
idf.py flash monitor
|
||||||
|
|||||||
Reference in New Issue
Block a user