https://github.com/adolbyb/esp32-freertos-cli
A Command Line Interface Using Arduino Framework written with the ESP32 Multicore port of FreeRTOS
https://github.com/adolbyb/esp32-freertos-cli
arduino-framework cli esp-idf esp32 freertos multicore
Last synced: about 1 month ago
JSON representation
A Command Line Interface Using Arduino Framework written with the ESP32 Multicore port of FreeRTOS
- Host: GitHub
- URL: https://github.com/adolbyb/esp32-freertos-cli
- Owner: ADolbyB
- Created: 2023-06-25T01:56:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-03T04:12:40.000Z (almost 3 years ago)
- Last Synced: 2025-03-13T23:14:05.409Z (over 1 year ago)
- Topics: arduino-framework, cli, esp-idf, esp32, freertos, multicore
- Language: C++
- Homepage:
- Size: 633 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESP32 FreeRTOS CLI
This is a Command Line Interface for the ESP32 using the ESP32 multicore port of FreeRTOS.
This project started in the [`ADolbyB/rtos-esp32-examples`](https://github.com/ADolbyB/rtos-esp32-examples)
repository as `04-LED-CLI`, but it took on a life of its own and it turned into this project.
Currently, the CLI can perform the following on the ESP32 Thing Plus C from SparkFun.
- 4 functions to control the RGB LED connected to `GPIO_2`.
- 2 functions to control the Blue LED connected to `GPIO_13`.
- [In Progress] The on-board SD Card Slot connected to `GPIO_5`.
- Test Code: [SD_Test](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32_WROOM_C/blob/main/Firmware/Test%20Sketches/SD_Test/SD_Test.ino)
- [In Progress] The on-board MAX17048 $I^2C$ LiPo Battery Fuel Guage.
- Test Code: [MAX17048_FuelGuage](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32_WROOM_C/blob/main/Firmware/Test%20Sketches/MAX17048_FuelGauge/MAX17048_FuelGauge.ino)
This is a work in progress.
## Status:
[](https://github.com/ADolbyB/esp32-freertos-cli/actions/workflows/push.yml) 
## References:
Other Repos Worth Mentioning:
- [liscolab](https://github.com/abellisco/liscolab) CLI port of FreeRTOS CLI to ESP32.
- [FreeRTOS-Plus-CLI](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_CLI/FreeRTOS_Plus_Command_Line_Interface.html) Command Line Interface Framework. Useful for adding custom commands.
General FreeRTOS:
- FreeRTOS is Currently Documented by [AWS: FreeRTOS Documentation](https://docs.aws.amazon.com/freertos/index.html)
- Also see links listed here by [FreeRTOS.org: FreeRTOS Documentation](https://www.freertos.org/Documentation/RTOS_book.html)
Setup & Programming:
- Read the official [Getting Started with VS Code IDE](https://docs.espressif.com/projects/esp-idf/en/v4.2.5/esp32/get-started/vscode-setup.html) Setup Guide, including the [VS Code ESP IDF Extension](https://github.com/espressif/vscode-esp-idf-extension).
- Read the official [ESP32 Arduino Core Documentation](https://espressif-docs.readthedocs-hosted.com/projects/arduino-esp32/en/latest/index.html).
- Read the official [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html).
Firmware Flashing:
- [Flash AT Firmware into Your Device](https://docs.espressif.com/projects/esp-at/en/latest/esp32/Get_Started/Downloading_guide.html) in the Espressif ESP-AT User Guide.
- [ESP32 AT](https://www.espressif.com/en/products/socs/esp32/resources) .bin files.
Hardware:
- The board I use for practice is an [ESP32 Thing Plus C](https://www.sparkfun.com/products/18018) from [SparkFun](https://www.sparkfun.com/).
- Specs from `hello_world` sample sketch: 