Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.65 KB

esp32.md

File metadata and controls

48 lines (33 loc) · 1.65 KB
Raw

Install ESP-IDF

Make sure ESP-IDF is properly installed, see to the official documentation. Espressif provides a very clear and detailed explanation of each installation step.

Install Library

All components are located in the components directory. It's a default directory name where the ESP-IDF build system looks up for the project libraries, or components in terms of the ESP-IDF SDK. See the build system documentation for more details.

These components can be manually copied into the project components directory, or added as a git submodule:

git submodule add [email protected]:open-control-systems/control-components.git control-components
git submodule update --init --recursive

and then the project's root CMakeLists.txt should be updated file as follows:

# For more information about build system see
# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
# The following five 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.16)

set(EXTRA_COMPONENT_DIRS
    "control-components/components"
)

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(main)

Configuration

The firmware can be configured using the following command:

idf.py menuconfig

There are many configuration options. Each of them contains the prefix "OCS_".

Build and Flash

idf.py build
idf.py flash