OVMS3-idf/examples
Jon Shallow bc9d1a65d7 Update component/coap to libcoap version release-4.2.0
This takes the code up to the latest released version of libcoap.

As there have been API changes, coap_client and coap_server in
examples/protocols have been updated to use the new APIs.

Further information on the new libcoap APIs can be found at
https://libcoap.net/doc/reference/4.2.0/

coap_client has been updated to handle BLOCK2 responses from
"coap://californium.eclipse.org"
coap_client has been modified to only send out one request (and wait for
the response)

coap_server has been updated to support Observe subscriptions, and well as
adding in PUT and DELETE handlers to work on the Espressif resource

coap_server and coap_client have had their stack sizes increased.

port/coap_io.c has been added, a copy of libcoap/src/coap_io.c with support
added for systems that do not have RFC 3542 section 20 support.

port/coap_io_socket.c has been removed as a lot of the code is now
replicated in different libcoap files.

Once this PR is place, then adding in DTLS will be a lot simpler (as a
separate PR)

Signed-off-by: Jitin George <jitin@espressif.com>

Merges https://github.com/espressif/esp-idf/pull/3148
2019-03-18 12:33:52 +00:00
..
bluetooth Modify esp_bt_gap_set_scan_mode() to be able to set connection modes as well as discoverable modes 2019-03-13 11:24:00 +05:30
build_system/cmake examples: generic cmake support examples 2018-11-27 13:59:26 +08:00
ethernet examples: don't enable buffering on stdout in console examples 2019-03-13 20:32:37 +08:00
get-started examples: Move blink code to main task 2019-02-28 12:12:24 +05:30
mesh Correct Kconfigs according to the coding style 2019-01-29 13:37:01 +01:00
peripherals examples: don't enable buffering on stdout in console examples 2019-03-13 20:32:37 +08:00
protocols Update component/coap to libcoap version release-4.2.0 2019-03-18 12:33:52 +00:00
provisioning provisioning examples : typos fixed and minor change in timer callback execution 2019-02-15 10:45:34 +00:00
storage test: get bin path from dut.app.flash_files instead of dut.download_config 2019-01-03 09:57:47 +08:00
system examples: don't enable buffering on stdout in console examples 2019-03-13 20:32:37 +08:00
wifi examples: don't enable buffering on stdout in console examples 2019-03-13 20:32:37 +08:00
README.md examples: generic cmake support examples 2018-11-27 13:59:26 +08:00

Examples

This directory contains a range of example ESP-IDF projects. These are intended to demonstrate parts of ESP-IDF functionality, and to provide code that you can copy and adapt into your own projects.

Example Layout

The examples are grouped into subdirectories by category. Each category directory contains one or more example projects:

  • bluetooth contains Bluetooth (BLE & BT Classic) examples.
  • ethernet contains Ethernet examples.
  • get-started contains some very simple examples with minimal functionality.
  • mesh contains Wi-Fi Mesh examples.
  • peripherals contains examples showing driver functionality for the various onboard ESP32 peripherals.
  • protocols contains examples showing network protocol interactions.
  • storage contains examples showing data storage methods using SPI flash or external storage like the SD/MMC interface.
  • system contains examples which demonstrate some internal chip features, or debugging & development tools.
  • wifi contains examples of advanced Wi-Fi features. (For network protocol examples, see protocols instead.)
  • build_system contains examples of build system features

Using Examples

Building an example is the same as building any other project:

  • Follow the Getting Started instructions which include building the "Hello World" example.
  • Change into the directory of the new example you'd like to build.
  • make menuconfig to configure the example. Most examples have a project-specific "Example Configuration" section here (for example, to set the WiFi SSID & password to use).
  • make to build the example.
  • Follow the printed instructions to flash, or run make flash.

Copying Examples

Each example is a standalone project. The examples do not have to be inside the esp-idf directory. You can copy an example directory to anywhere on your computer in order to make a copy that you can modify and work with.

The IDF_PATH environment variable is the only thing that connects the example to the rest of ESP-IDF.

If you're looking for a more bare-bones project to start from, try esp-idf-template.

Contributing Examples

If you have a new example you think we'd like, please consider sending it to us as a Pull Request.

In the ESP-IDF documentation, you can find a "Creating Examples" page which lays out the steps to creating a top quality example.