Skip to content
Snippets Groups Projects
Commit d802ff97 authored by Sindre Mandelid Kvam's avatar Sindre Mandelid Kvam
Browse files

Updated README

parent a7f7d3a7
No related branches found
No related tags found
No related merge requests found
# _Sample project_
(See the README.md file in the upper level 'examples' directory for more information about examples.)
This is the simplest buildable example. The example is used by command `idf.py create-project`
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)
## 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.
# README # README
## Prerequisites ## Prerequisites
If you are using VSCode, install the ESP-IDF extension and follow the installation guide. Clone this repository
in the same folder you install your ESP-IDF installation, open a terminal and run the following command: If you are using VSCode, install the ESP-IDF extension and follow the installation guide.
```bash
git clone https://github.com/espressif/esp-zigbee-sdk.git
```
When install, use the ESP-IDF to set up a new project. Add your name and project directory to whatever you want. Choose ESP-IDF target to be `ESP32-C6 chip (via ESP-PROG)`. Build :D
In ESP-IDF Component directory, find the paths to your ESP-IDF installation and find the folder named `components`, do the same for the esp-zigbee-sdk folder. ## Hardware
If using custom PCB, to be able to enter the correct download mode, add a 10k pull-up resistor to pin 10 (IO8).
The main folder and CMakeList.txt in this repository should replace the corresponding folder and files in the generated folder. To enter download mode to flash the device, hold the enable and boot button. Release the enable button while holding the boot button.
\ No newline at end of file The blue LED should light up and stay on, the boot button can be released, you are now ready to flash the device.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment