mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
Espressif IoT Development Framework for ESP32-XX
15 336 Commity
20 Gałęzie
153 Tagi
440 MiB
C 95.7%
Python 2.1%
C++ 1.1%
CMake 0.7%
Assembly 0.3%
 
 
 
 
 
Go to file
David Cermak 467e4d997b MQTT: Update submodule reference: config, error handle, minor fixes 
Updates esp-mqtt reference to include fixes below related mainly to:
* configuration update (disable keepalive, network timeout)
* minor fixes (size_t for all sizes, unbalanced lock, api for
  outbox-size)
* extended error handle to include socket's errno

Closes https://github.com/espressif/esp-idf/issues/5906

Config: Added config value to disable keepalive mechanism
esp-mqtt commit: 8562437c8a
Related https://github.com/espressif/esp-mqtt/issues/179

Added esp_mqtt_client_get_outbox_size API
esp-mqtt commit: 0a1d9d0300
Related https://github.com/espressif/esp-mqtt/pull/178

mqtt_outbox: Removed unused retry_count field from outbox_item_t
esp-mqtt commit: 673086e13a

config: Fixed typo for configuring OUTBOX_EXPIRED_TIMEOUT_MS
esp-mqtt commit: 259baaec96

Fixed missing MQTT_API_UNLOCK in esp_mqtt_client_stop error path
esp-mqtt commit: 845c2a3a1e
Related https://github.com/espressif/esp-mqtt/issues/173
Related https://github.com/espressif/esp-mqtt/pull/174

Extended mqtt error handle to capture transport's socket errno (IDF
v4.3+)
esp-mqtt commit: 23c8e1ecf5

Config: Added configuration value to set network timeout
esp-mqtt commit: a03228ac46
Related https://github.com/espressif/esp-mqtt/pull/166

Used size_t for all lengths to allow for other architectures
esp-mqtt commit: b9db8d9020
 		2020-11-19 17:17:40 +01:00
.github Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
.gitlab Merge branch 'feature/template_add_ci' into 'master' 2020-11-13 18:40:07 +08:00
components MQTT: Update submodule reference: config, error handle, minor fixes 2020-11-19 17:17:40 +01:00
docs Merge branch 'feature/fatfs_fast_seek' into 'master' 2020-11-17 07:17:31 +08:00
examples Merge branch 'bugfix/ipv6_address_value_issue' into 'master' 2020-11-19 21:13:12 +08:00
make Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
tools Merge branch 'ci/build_example_cmake_artifacts_always' into 'master' 2020-11-18 21:18:17 +08:00
.editorconfig
…
.flake8
…
.gitignore Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
.gitlab-ci.yml
…
.gitmodules
…
.pre-commit-config.yaml pre-commit: Rearrange the YAML file to avoid the warning 2020-11-13 14:22:18 +11:00
.pylintrc
…
.readthedocs.yml Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
CMakeLists.txt
…
CONTRIBUTING.rst
…
Kconfig Updates for riscv support 2020-11-13 07:49:11 +11:00
LICENSE
…
README.md
…
README_CN.md
…
SUPPORT_POLICY.md
…
SUPPORT_POLICY_CN.md
…
add_path.sh Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
export.bat
…
export.fish
…
export.ps1
…
export.sh Redirect warning to stderr and unset temporary shell procedure 2020-11-11 15:12:58 +01:00
install.bat
…
install.fish Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
install.ps1
…
install.sh
…
requirements.txt esptool: Update to v3.0 release version 2020-11-10 02:36:18 +00:00
sdkconfig.rename Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00

README.md

Espressif IoT Development Framework

ESP-IDF is the official development framework for the ESP32 and ESP32-S Series SoCs provided for Windows, Linux and macOS.

Developing With ESP-IDF

Setting Up ESP-IDF

See setup guides for detailed instructions to set up the ESP-IDF:

Chip Getting Started Guides for ESP-IDF
ESP32
ESP32-S2

Note: Each ESP-IDF release has its own documentation. Please see Section Versions how to find documentation and how to checkout specific release of ESP-IDF.

Non-GitHub forks

ESP-IDF uses relative locations as its submodules URLs (.gitmodules). So they link to GitHub. If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script tools/set-submodules-to-github.sh after git clone. The script sets absolute URLs for all submodules, allowing git submodule update --init --recursive to complete. If cloning ESP-IDF from GitHub, this step is not needed.

Finding a Project

As well as the esp-idf-template project mentioned in Getting Started, ESP-IDF comes with some example projects in the examples directory.

Once you've found the project you want to work with, change to its directory and you can configure and build it.

To start your own project based on an example, copy the example project directory outside of the ESP-IDF directory.

Quick Reference

See the Getting Started guide links above for a detailed setup guide. This is a quick reference for common commands when working with ESP-IDF projects:

Setup Build Environment

(See the Getting Started guide listed above for a full list of required steps with more details.)

  • Install host build dependencies mentioned in the Getting Started guide.
  • Run the install script to set up the build environment. The options include install.bat or install.ps1 for Windows, and install.sh or install.fish for Unix shells.
  • Run the export script on Windows (export.bat) or source it on Unix (source export.sh) in every shell environment before using ESP-IDF.

Configuring the Project

  • idf.py set-target <chip_name> sets the target of the project to <chip_name>. Run idf.py set-target without any arguments to see a list of supported targets.
  • idf.py menuconfig opens a text-based configuration menu where you can configure the project.

Compiling the Project

idf.py build

... will compile app, bootloader and generate a partition table based on the config.

Flashing the Project

When the build finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this automatically by running:

idf.py -p PORT flash

Replace PORT with the name of your serial port (like COM3 on Windows, /dev/ttyUSB0 on Linux, or /dev/cu.usbserial-X on MacOS. If the -p option is left out, idf.py flash will try to flash the first available serial port.

This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with idf.py menuconfig.

You don't need to run idf.py build before running idf.py flash, idf.py flash will automatically rebuild anything which needs it.

Viewing Serial Output

The idf.py monitor target uses the idf_monitor tool to display serial output from ESP32 or ESP32-S Series SoCs. idf_monitor also has a range of features to decode crash output and interact with the device. Check the documentation page for details.

Exit the monitor by typing Ctrl-].

To build, flash and monitor output in one pass, you can run:

idf.py flash monitor

Compiling & Flashing Only the App

After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:

  • idf.py app - build just the app.
  • idf.py app-flash - flash just the app.

idf.py app-flash will automatically rebuild the app if any source files have changed.

(In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)

Erasing Flash

The idf.py flash target does not erase the entire flash contents. However it is sometimes useful to set the device back to a totally erased state, particularly when making partition table changes or OTA app updates. To erase the entire flash, run idf.py erase_flash.

This can be combined with other targets, ie idf.py -p PORT erase_flash flash will erase everything and then re-flash the new app, bootloader and partition table.

Resources