DRAFT: Add submodule to latest esp-idf and updated readme #54
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/bot run formatting |
Skptak
reviewed
Oct 8, 2023
| @@ -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 | |||
| @@ -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.
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.
Sounds like a good idea, but a link to latest esp-idf document might also makes sense. what you think?
| @@ -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. | |||
|
|
|||
| - 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.
This is incorrect now if we're telling users to use 5.1.1
There was a problem hiding this comment.
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
| @@ -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.) | |||
|
|
|||
|
|
|||
| 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)` | ||
| 8. Go back to main menu, Save and Exit. |
| 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.
Think this line should be "If you want to use the FreeRTOS-Kernel's Symmetrical multiprocessing feature..."?
rawalexe
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add submodule to latest esp-idf and updated readme
Description
Updates the Readme to add instruction on how to use the Amazon's version of FreeRTOS and adds a submodule pointer to latest esp-idf
Test Steps
Checklist:
Related Issue
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.