From 3f1fab64dd891a95b349adc30b74dac222e3137d Mon Sep 17 00:00:00 2001 From: impressionyang Date: Wed, 28 Sep 2022 22:26:04 +0800 Subject: [PATCH] first add --- .gitignore | 6 +++++ CMakeLists.txt | 6 +++++ Makefile | 8 +++++++ README.md | 52 +++++++++++++++++++++++++++++++++++++++++ example_test.py | 20 ++++++++++++++++ main/CMakeLists.txt | 2 ++ main/component.mk | 4 ++++ main/hello_world_main.c | 43 ++++++++++++++++++++++++++++++++++ sdkconfig.ci | 0 9 files changed, 141 insertions(+) create mode 100644 .gitignore create mode 100644 CMakeLists.txt create mode 100644 Makefile create mode 100644 README.md create mode 100644 example_test.py create mode 100644 main/CMakeLists.txt create mode 100644 main/component.mk create mode 100644 main/hello_world_main.c create mode 100644 sdkconfig.ci diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8f5d909 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +components/ +.vscode/ +.devcontainer/ +*.o +*.d + diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..d970055 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,6 @@ +# The following lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.5) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(ESP32S2_FH4_Testboard) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..6d4e24f --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +# +# This is a project Makefile. It is assumed the directory this Makefile resides in is a +# project subdirectory. +# + +PROJECT_NAME := hello_world + +include $(IDF_PATH)/make/project.mk diff --git a/README.md b/README.md new file mode 100644 index 0000000..7afca17 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Hello World Example + +Starts a FreeRTOS task to print "Hello World". + +(See the README.md file in the upper level 'examples' directory for more information about examples.) + +## How to use example + +Follow detailed instructions provided specifically for this example. + +Select the instructions depending on Espressif chip installed on your development board: + +- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html) +- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html) + + +## Example folder contents + +The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_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 +├── example_test.py Python script used for automated example testing +├── main +│   ├── CMakeLists.txt +│   ├── component.mk Component make file +│   └── hello_world_main.c +├── Makefile Makefile used by legacy GNU Make +└── README.md This is the file you are currently reading +``` + +For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide. + +## Troubleshooting + +* Program upload failure + + * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs. + * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again. + +## Technical support and feedback + +Please use the following feedback channels: + +* For technical queries, go to the [esp32.com](https://esp32.com/) forum +* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues) + +We will get back to you as soon as possible. diff --git a/example_test.py b/example_test.py new file mode 100644 index 0000000..9901d5c --- /dev/null +++ b/example_test.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python + +from __future__ import division, print_function, unicode_literals + +import ttfw_idf + + +@ttfw_idf.idf_example_test(env_tag='Example_GENERIC', target=['esp32', 'esp32s2', 'esp32c3'], ci_target=['esp32']) +def test_examples_hello_world(env, extra_data): + app_name = 'hello_world' + dut = env.get_dut(app_name, 'examples/get-started/hello_world') + dut.start_app() + res = dut.expect(ttfw_idf.MINIMUM_FREE_HEAP_SIZE_RE) + if not res: + raise ValueError('Maximum heap size info not found') + ttfw_idf.print_heap_size(app_name, dut.app.config_name, dut.TARGET, res[0]) + + +if __name__ == '__main__': + test_examples_hello_world() diff --git a/main/CMakeLists.txt b/main/CMakeLists.txt new file mode 100644 index 0000000..07686dc --- /dev/null +++ b/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "hello_world_main.c" + INCLUDE_DIRS "") diff --git a/main/component.mk b/main/component.mk new file mode 100644 index 0000000..a98f634 --- /dev/null +++ b/main/component.mk @@ -0,0 +1,4 @@ +# +# "main" pseudo-component makefile. +# +# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.) diff --git a/main/hello_world_main.c b/main/hello_world_main.c new file mode 100644 index 0000000..ebc5eb0 --- /dev/null +++ b/main/hello_world_main.c @@ -0,0 +1,43 @@ +/* Hello World Example + + This example code is in the Public Domain (or CC0 licensed, at your option.) + + Unless required by applicable law or agreed to in writing, this + software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR + CONDITIONS OF ANY KIND, either express or implied. +*/ +#include +#include "sdkconfig.h" +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "esp_system.h" +#include "esp_spi_flash.h" + +void app_main(void) +{ + printf("Hello world!\n"); + + /* Print chip information */ + esp_chip_info_t chip_info; + esp_chip_info(&chip_info); + printf("This is %s chip with %d CPU core(s), WiFi%s%s, ", + CONFIG_IDF_TARGET, + chip_info.cores, + (chip_info.features & CHIP_FEATURE_BT) ? "/BT" : "", + (chip_info.features & CHIP_FEATURE_BLE) ? "/BLE" : ""); + + printf("silicon revision %d, ", chip_info.revision); + + printf("%dMB %s flash\n", spi_flash_get_chip_size() / (1024 * 1024), + (chip_info.features & CHIP_FEATURE_EMB_FLASH) ? "embedded" : "external"); + + printf("Minimum free heap size: %d bytes\n", esp_get_minimum_free_heap_size()); + + for (int i = 10; i >= 0; i--) { + printf("Restarting in %d seconds...\n", i); + vTaskDelay(1000 / portTICK_PERIOD_MS); + } + printf("Restarting now.\n"); + fflush(stdout); + esp_restart(); +} diff --git a/sdkconfig.ci b/sdkconfig.ci new file mode 100644 index 0000000..e69de29