add README
This commit is contained in:
Elias Ahokas
@@ -1,13 +0,0 @@
|
|||||||
ARG DOCKER_TAG=latest
|
|
||||||
FROM espressif/idf:${DOCKER_TAG}
|
|
||||||
|
|
||||||
ENV LC_ALL=C.UTF-8
|
|
||||||
ENV LANG=C.UTF-8
|
|
||||||
|
|
||||||
RUN apt-get update -y && apt-get install udev -y
|
|
||||||
|
|
||||||
RUN echo "source /opt/esp/idf/export.sh > /dev/null 2>&1" >> ~/.bashrc
|
|
||||||
|
|
||||||
ENTRYPOINT [ "/opt/esp/entrypoint.sh" ]
|
|
||||||
|
|
||||||
CMD ["/bin/bash", "-c"]
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "ESP-IDF QEMU",
|
|
||||||
"build": {
|
|
||||||
"dockerfile": "Dockerfile"
|
|
||||||
},
|
|
||||||
"customizations": {
|
|
||||||
"vscode": {
|
|
||||||
"settings": {
|
|
||||||
"terminal.integrated.defaultProfile.linux": "bash",
|
|
||||||
"idf.espIdfPath": "/opt/esp/idf",
|
|
||||||
"idf.toolsPath": "/opt/esp",
|
|
||||||
"idf.gitPath": "/usr/bin/git"
|
|
||||||
},
|
|
||||||
"extensions": [
|
|
||||||
"espressif.esp-idf-extension",
|
|
||||||
"espressif.esp-idf-web"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"runArgs": ["--privileged"]
|
|
||||||
}
|
|
||||||
23
.vscode/c_cpp_properties.json
vendored
23
.vscode/c_cpp_properties.json
vendored
@@ -1,23 +0,0 @@
|
|||||||
{
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "ESP-IDF",
|
|
||||||
"compilerPath": "${config:idf.toolsPath}/tools/xtensa-esp-elf/esp-14.2.0_20241119/xtensa-esp-elf/bin/xtensa-esp32-elf-gcc",
|
|
||||||
"compileCommands": "${config:idf.buildPath}/compile_commands.json",
|
|
||||||
"includePath": [
|
|
||||||
"${config:idf.espIdfPath}/components/**",
|
|
||||||
"${config:idf.espIdfPathWin}/components/**",
|
|
||||||
"${workspaceFolder}/**"
|
|
||||||
],
|
|
||||||
"browse": {
|
|
||||||
"path": [
|
|
||||||
"${config:idf.espIdfPath}/components",
|
|
||||||
"${config:idf.espIdfPathWin}/components",
|
|
||||||
"${workspaceFolder}"
|
|
||||||
],
|
|
||||||
"limitSymbolsToIncludedHeaders": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"version": 4
|
|
||||||
}
|
|
||||||
15
.vscode/launch.json
vendored
15
.vscode/launch.json
vendored
@@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"type": "gdbtarget",
|
|
||||||
"request": "attach",
|
|
||||||
"name": "Eclipse CDT GDB Adapter"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "espidf",
|
|
||||||
"name": "Launch",
|
|
||||||
"request": "launch"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
14
.vscode/settings.json
vendored
14
.vscode/settings.json
vendored
@@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"C_Cpp.intelliSenseEngine": "default",
|
|
||||||
"idf.espIdfPath": "/home/sirian/esp/esp-idf",
|
|
||||||
"idf.pythonInstallPath": "/usr/bin/python3",
|
|
||||||
"idf.openOcdConfigs": [
|
|
||||||
"board/esp32-wrover-kit-3.3v.cfg"
|
|
||||||
],
|
|
||||||
"idf.port": "/dev/ttyS1",
|
|
||||||
"idf.toolsPath": "/home/sirian/.espressif",
|
|
||||||
"idf.customExtraVars": {
|
|
||||||
"IDF_TARGET": "esp32"
|
|
||||||
},
|
|
||||||
"idf.flashType": "UART"
|
|
||||||
}
|
|
||||||
35
README.md
35
README.md
@@ -1,32 +1,11 @@
|
|||||||
# _Sample project_
|
# OLED display counter
|
||||||
|
|
||||||
(See the README.md file in the upper level 'examples' directory for more information about examples.)
|
A simple counter on an oled display.
|
||||||
|
|
||||||
This is the simplest buildable example. The example is used by command `idf.py create-project`
|
## References
|
||||||
that copies the project to user specified path and set it's name. For more information follow the [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project)
|
|
||||||
|
|
||||||
|
- [Esp32 programming guide](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/index.html)
|
||||||
|
- [Esp32 datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-wroom-32d_esp32-wroom-32u_datasheet_en.pdf)
|
||||||
|
- [SSD1306 datasheet](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf)
|
||||||
|
- [lvgl programming guide](https://docs.lvgl.io/master/intro/introduction/index.html)
|
||||||
|
|
||||||
|
|
||||||
## How to use example
|
|
||||||
We encourage the users to use the example as a template for the new projects.
|
|
||||||
A recommended way is to follow the instructions on a [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project).
|
|
||||||
|
|
||||||
## Example folder contents
|
|
||||||
|
|
||||||
The project **sample_project** contains one source file in C language [main.c](main/main.c). The file is located in folder [main](main).
|
|
||||||
|
|
||||||
ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt`
|
|
||||||
files that provide set of directives and instructions describing the project's source files and targets
|
|
||||||
(executable, library, or both).
|
|
||||||
|
|
||||||
Below is short explanation of remaining files in the project folder.
|
|
||||||
|
|
||||||
```
|
|
||||||
├── CMakeLists.txt
|
|
||||||
├── main
|
|
||||||
│ ├── CMakeLists.txt
|
|
||||||
│ └── main.c
|
|
||||||
└── README.md This is the file you are currently reading
|
|
||||||
```
|
|
||||||
Additionally, the sample project contains Makefile and component.mk files, used for the legacy Make based build system.
|
|
||||||
They are not used or needed when building with CMake and idf.py.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user