[esp-hosted.git] / esp_hosted_ng / esp / esp_driver / README.md

# Espressif Wireless Framework

## Introduction

This project is used to build firmware for esp-hosted-ng solution

## Update build firmware for esp-hosted-ng solution

1. run `cmake .` to setup environment, it will setup esp-idf as submodule to be used by `network_adapter`

2. setup compiling environment by `. ./export.sh` in esp-idf directory

3. In the `network_adapter` directory of this project, input command `idf.py set-target <chip_name>` to set target.

4. Use `idf.py build` to recompile `network_adapter` and generate new firmware.

## Building on Windows 11 using Command Prompt

1. Install and setup ESP-IDF on Windows as documented in the [Standard Setup of Toolchain for
Windows](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html).

2. Use the ESP-IDF [Powershell Command
Prompt](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html#using-the-command-prompt) to execute `setup.ps1`. It will setup `esp-idf` as a submodule to be used by `network_adapter`.
:warning: **This command is dangerous. It will revert all your local changes. Stash if need to keep them**.

3. Setup compiling environment by running `export.ps1` in `esp-idf`
directory

4. In the `network_adapter` directory of this project, input command
`idf.py set-target <chip_name>` to set target.

5. Use `idf.py build` to recompile `network_adapter` and generate new
firmware.

6. Use `idf.py flash` to flash the firmware.

7. Use `idf.py monitor` to monitor the serial out. You can combine
these two steps (flash and monitor) by running `idf.py flash monitor`.
Commit	Line	Data
c66bdf88 KG	1	# Espressif Wireless Framework
	2
	3	## Introduction
	4
	5	This project is used to build firmware for esp-hosted-ng solution
	6
	7	## Update build firmware for esp-hosted-ng solution
	8
315ebaaf	9	1. run `cmake .` to setup environment, it will setup esp-idf as submodule to be used by `network_adapter`
c66bdf88 KG	10
	11	2. setup compiling environment by `. ./export.sh` in esp-idf directory
	12
5d60388d	13	3. In the `network_adapter` directory of this project, input command `idf.py set-target <chip_name>` to set target.
63dc47b9	14
5d60388d	15	4. Use `idf.py build` to recompile `network_adapter` and generate new firmware.
315ebaaf SKY	16
	17	## Building on Windows 11 using Command Prompt
	18
	19	1. Install and setup ESP-IDF on Windows as documented in the [Standard Setup of Toolchain for
	20	Windows](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html).
	21
	22	2. Use the ESP-IDF [Powershell Command
	23	Prompt](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html#using-the-command-prompt) to execute `setup.ps1`. It will setup `esp-idf` as a submodule to be used by `network_adapter`.
	24	:warning: This command is dangerous. It will revert all your local changes. Stash if need to keep them.
	25
	26	3. Setup compiling environment by running `export.ps1` in `esp-idf`
	27	directory
	28
	29	4. In the `network_adapter` directory of this project, input command
	30	`idf.py set-target <chip_name>` to set target.
	31
	32	5. Use `idf.py build` to recompile `network_adapter` and generate new
	33	firmware.
	34
	35	6. Use `idf.py flash` to flash the firmware.
	36
	37	7. Use `idf.py monitor` to monitor the serial out. You can combine
	38	these two steps (flash and monitor) by running `idf.py flash monitor`.