-
Notifications
You must be signed in to change notification settings - Fork 50
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.
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
DRAFT: Add submodule to latest esp-idf and updated readme #54
Changes from all commits
ba21ccc
096eb53
4f15436
1c67021
11f67d8
0bb8e08
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,6 @@ | |
[submodule "components/esp-aws-iot"] | ||
path = components/esp-aws-iot | ||
url = https://github.com/espressif/esp-aws-iot.git | ||
[submodule "esp-idf"] | ||
path = esp-idf | ||
url = [email protected]:espressif/esp-idf.git | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,6 +45,7 @@ Once completed, one can progress to the [Use Security Features](UseSecurityFeatu | |
- WiFi access point with access to the internet. | ||
|
||
### 1.2 Software Requirements | ||
> **NOTE:** For convenience sake, there is an esp-idf v5.1.1 submoduled at the root of the directory, other versions on esp-idf may also be used but does not guarantee full compatibility. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we're going to add this submodule we should change the instructions to tell users to run the install and export scripts There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sounds like a good idea, but a link to latest esp-idf document might also makes sense. what you think? |
||
|
||
- ESP-IDF 4.4.3 or higher to configure, build, and flash the project. To setup for the ESP32-C3, follow Espressif's [Getting Started Guide for the ESP32-C3](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/get-started/index.html). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is incorrect now if we're telling users to use 5.1.1 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Well we still want people to use other version of esp-idf but just are saying the full support will be only for 1. Might help us with ops burden. Also a standardized setting for debugging for future |
||
- [Python3](https://www.python.org/downloads/) | ||
|
@@ -61,6 +62,7 @@ Once completed, one can progress to the [Use Security Features](UseSecurityFeatu | |
to configure the basic settings (security credentials, the default AWS output format and the default AWS Region) | ||
that AWS CLI uses to interact with AWS. (If you don't have an AWS account and user, follow steps 1 and 2 in the AWS IoT Core Setup Guide below before following the Configuration basics for the AWS CLI.) | ||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blank line |
||
## 2 Demo setup | ||
|
||
### 2.1 Setup AWS IoT Core | ||
|
@@ -71,14 +73,18 @@ After you have followed the instructions in the AWS IoT Core Setup Guide, you wi | |
### 2.2 Configure the project with the AWS IoT Thing Name and AWS device Endpoint | ||
|
||
The demo will connect to the AWS IoT device Endpoint that you configure here. | ||
> Note: remember to set your build target using `idf.py set-target <target>` | ||
rawalexe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
1. From a terminal/command prompt, run `idf.py menuconfig`. This assumes the ESP-IDF environment is exported-- i.e. that export.bat/export.sh, which can be found under the ESP-IDF directory, has been run, or that you are using the ESP-IDF command prompt/terminal. For Visual Studio (VS) Code users who are using the Espressif IDF extension, do ->View->Command Palette->Search for `ESP-IDF: SDK Configuration editor (menuconfig)` and select the command. The `SDK Configuration editor` window should pop up after a moment. | ||
(Note: If running menuconfig from within a VS Code command prompt, 'j' and 'k' may have to be used in place of the 'up' and 'down' arrow keys. Alternately, one can use a command prompt/terminal outside of the VS Code editor). | ||
2. Select `Featured FreeRTOS IoT Integration` from the menu. | ||
3. Set `Endpoint for MQTT Broker to use` to your **AWS device Endpoint**. | ||
4. Set `Port for MQTT Broker to use` to `8883`. | ||
5. Set `Thing name` to your **Thing Name**. | ||
6. Go back to main menu, Save and Exit. | ||
6. If you are using the `ESP32` chip you may experience buffer overflow, feel free to decrease the task's buffer size of the demo or `coreMQTT-Agent network buffer size` to fit your use case. | ||
7. You may also increase the `Timeout for receiving CONNACK in milliseconds` if you are experiencing timeout issues. | ||
8. Furthermore you may want to use the Amazon's FreeRTOS that can be enabled from `Component config > FreeRTOS > Kernel> Run the Amazon SMP FreeRTOS kernel instead (FEATURE UNDER DEVELOPMENT)` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Think this line should be "If you want to use the FreeRTOS-Kernel's Symmetrical multiprocessing feature..."? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. noted, thank you |
||
8. Go back to main menu, Save and Exit. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be 9. Right? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. correct will update |
||
|
||
### 2.3 Provision the ESP32-C3 with the private key, device certificate and CA certificate in Development Mode | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the https url here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will do