Skip to content

Update Espressif README with Getting Started info. #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ejohnstown merged 1 commit into from
Jun 12, 2025
Merged

Update Espressif README with Getting Started info. #771

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions ide/Espressif/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# wolfSSH Espressif Component Install

For more information on getting started with wolfSSL on the ESP32, see [wolfssl/IDE/Espressif/README.md](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/README.md).

See also [wolfSSH - Now Available as an Espressif Managed Component Includes SSH Echo Server Example](https://www.wolfssl.com/wolfssh-now-available-as-an-espressif-managed-component-includes-ssh-echo-server-example/).

# ESP-IDF port

## Overview

ESP-IDF development framework with wolfSSL by setting *WOLFSSL_ESPIDF* definition

Including the following examples:
Expand All @@ -18,7 +23,7 @@ Including the following examples:


## Setup for Linux
1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree
1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree
2. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/`
3. Find [Example programs](https://github.com/wolfSSL/wolfssl/tree/master/IDE/Espressif/ESP-IDF/examples) under _/path/to/esp_`/esp-idf/examples/protocols/wolfssl_xxx` (where xxx is the project name)

Expand All @@ -28,7 +33,7 @@ Including the following examples:

```
cd ESP-IDF
setup_win.bat
setup_win.bat
```

3. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/`
Expand Down Expand Up @@ -65,7 +70,7 @@ setup_win.bat C:\SysGCC\esp32\esp-idf\v4.4
## Support
For question please email [support@wolfssl.com]

Note: This is tested with :
Note: This is tested with :
- OS: Ubuntu 20.04.3 LTS and Microsoft Windows 10 Pro 10.0.19041 and well as WSL Ubuntu
- ESP-IDF: ESP-IDF v4.3.2
- Module : ESP32-WROOM-32