From 382999b378dfeb1dc224c74e8830e64fa1ed0d61 Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 16 Jan 2017 23:08:35 +0100 Subject: [PATCH 1/5] Moved examples to new folders / categories. Removed example numbers from example names --- examples/{05_ble_adv => bluetooth/ble_adv}/Makefile | 0 .../{05_ble_adv => bluetooth/ble_adv}/README.rst | 0 .../{05_ble_adv => bluetooth/ble_adv}/main/app_bt.c | 0 .../ble_adv}/main/component.mk | 0 .../ble_adv}/sdkconfig.defaults | 0 examples/{12_blufi => bluetooth/blufi}/Makefile | 0 examples/{12_blufi => bluetooth/blufi}/README.rst | 0 .../{12_blufi => bluetooth/blufi}/main/blufi_demo.h | 0 .../{12_blufi => bluetooth/blufi}/main/blufi_main.c | 0 .../blufi}/main/blufi_security.c | 0 .../{12_blufi => bluetooth/blufi}/main/component.mk | 0 .../blufi}/sdkconfig.defaults | 0 .../gatt_client}/Makefile | 0 .../gatt_client}/README.rst | 0 .../gatt_client}/main/component.mk | 0 .../gatt_client}/main/gattc_demo.c | 0 .../gatt_client}/sdkconfig.defaults | 0 .../gatt_server}/Makefile | 0 .../gatt_server}/README.rst | 0 .../gatt_server}/main/component.mk | 0 .../gatt_server}/main/gatts_demo.c | 0 .../gatt_server}/sdkconfig.defaults | 0 .../gatt_server_service_table}/Makefile | 0 .../gatt_server_service_table}/README.rst | 0 .../gatt_server_service_table}/main/component.mk | 0 .../main/gatts_table_creat_demo.c | 0 .../main/gatts_table_creat_demo.h | 0 .../gatt_server_service_table}/sdkconfig.defaults | 0 .../{17_ethernet => ethernet/ethernet}/Makefile | 0 .../{17_ethernet => ethernet/ethernet}/README.md | 0 .../ethernet}/main/component.mk | 0 .../ethernet}/main/ethernet_main.c | 0 .../ethernet}/main/tlk110_phy.h | 0 examples/{02_blink => get-started/blink}/Makefile | 0 examples/{02_blink => get-started/blink}/README.md | 0 .../blink}/main/Kconfig.projbuild | 0 .../{02_blink => get-started/blink}/main/blink.c | 0 .../blink}/main/component.mk | 0 .../blink}/sdkconfig.defaults | 0 .../hello_world}/Makefile | 0 .../hello_world}/README.md | 0 .../hello_world}/main/component.mk | 0 .../hello_world}/main/hello_world_main.c | 0 examples/{21_gpio => peripherals/gpio}/Makefile | 0 examples/{21_gpio => peripherals/gpio}/README.md | 0 .../gpio}/main/component.mk | 0 .../{21_gpio => peripherals/gpio}/main/gpio_test.c | 0 examples/{18_i2c => peripherals/i2c}/Makefile | 0 examples/{18_i2c => peripherals/i2c}/README.md | 0 .../{16_pcnt => peripherals/i2c}/main/component.mk | 0 .../{18_i2c => peripherals/i2c}/main/i2c_test.c | 0 examples/{22_i2s => peripherals/i2s}/Makefile | 0 .../{22_i2s => peripherals/i2s}/main/app_main.c | 0 .../{22_i2s => peripherals/i2s}/main/component.mk | 0 examples/{29_ledc => peripherals/ledc}/Makefile | 0 examples/{29_ledc => peripherals/ledc}/README.md | 0 .../{18_i2c => peripherals/ledc}/main/component.mk | 0 .../{29_ledc => peripherals/ledc}/main/ledc_fade.c | 0 examples/{16_pcnt => peripherals/pcnt}/Makefile | 0 examples/{16_pcnt => peripherals/pcnt}/README.md | 0 .../{20_uart => peripherals/pcnt}/main/component.mk | 0 .../{16_pcnt => peripherals/pcnt}/main/pcnt_test.c | 0 .../rmt_nec_tx_rx}/Makefile | 0 .../rmt_nec_tx_rx}/README.md | 0 .../rmt_nec_tx_rx}/main/component.mk | 0 .../rmt_nec_tx_rx}/main/infrared_nec.c | 0 .../rmt_nec_tx_rx}/main/infrared_nec_main.c | 0 .../sigmadelta}/Makefile | 0 .../sigmadelta}/README.md | 0 .../sigmadelta}/main/component.mk | 0 .../sigmadelta}/main/sigmadelta_test.c | 0 .../spi_master}/Makefile | 0 .../spi_master}/main/component.mk | 0 .../spi_master}/main/spi_master.c | 0 .../timer_group}/Makefile | 0 .../timer_group}/README.md | 0 .../timer_group}/main/component.mk | 0 .../timer_group}/main/timer_group.c | 0 examples/{20_uart => peripherals/uart}/Makefile | 0 .../{21_gpio => peripherals/uart}/main/component.mk | 0 .../{20_uart => peripherals/uart}/main/uart_test.c | 0 .../coap_client}/Makefile | 0 .../coap_client}/main/Kconfig.projbuild | 0 .../coap_client}/main/coap_client.c | 0 .../coap_client}/main/component.mk | 0 .../coap_server}/Makefile | 0 .../coap_server}/main/Kconfig.projbuild | 0 .../coap_server}/main/coap_server.c | 0 .../coap_server}/main/component.mk | 0 .../http_request}/Makefile | 0 .../http_request}/README.md | 0 .../http_request}/main/Kconfig.projbuild | 0 .../http_request}/main/component.mk | 0 .../http_request}/main/http_request_main.c | 0 .../https_request}/Makefile | 0 .../https_request}/README.md | 0 .../https_request}/main/Kconfig.projbuild | 0 .../https_request}/main/component.mk | 0 .../https_request}/main/https_request_main.c | 0 .../https_request}/main/server_root_cert.pem | 0 .../{30_mdns_example => protocols/mdns}/Makefile | 0 .../{30_mdns_example => protocols/mdns}/README.md | 0 .../mdns}/main/Kconfig.projbuild | 0 .../mdns}/main/component.mk | 0 .../mdns}/main/mdns_example_main.c | 0 .../openssl_client}/Makefile | 0 .../openssl_client}/README.md | 0 .../openssl_client}/main/Kconfig.projbuild | 0 .../openssl_client}/main/component.mk | 0 .../openssl_client}/main/openssl_client.c | 0 .../openssl_client}/main/openssl_client.h | 0 .../openssl_server}/Makefile | 0 .../openssl_server}/README.md | 0 .../openssl_server}/main/Kconfig.projbuild | 0 .../openssl_server}/main/cacert.pem | 0 .../openssl_server}/main/component.mk | 0 .../openssl_server}/main/openssl_server.c | 0 .../openssl_server}/main/openssl_server.h | 0 .../openssl_server}/main/prvtkey.pem | 0 examples/{06_sntp => protocols/sntp}/Makefile | 0 examples/{06_sntp => protocols/sntp}/README.md | 0 .../sntp}/main/Kconfig.projbuild | 0 .../{25_ota => protocols/sntp}/main/component.mk | 0 .../{06_sntp => protocols/sntp}/main/sntp_main.c | 0 .../nvs_rw_blob}/Makefile | 0 .../nvs_rw_blob}/README.md | 0 .../nvs_rw_blob}/main/component.mk | 0 .../nvs_rw_blob}/main/nvs_rw_blob.c | 0 .../nvs_rw_value}/Makefile | 0 .../nvs_rw_value}/README.md | 0 .../nvs_rw_value}/main/component.mk | 0 .../nvs_rw_value}/main/nvs_rw_value.c | 0 examples/{27_sd_card => storage/sd_card}/Makefile | 0 examples/{27_sd_card => storage/sd_card}/README.md | 0 .../sd_card}/main/component.mk | 0 .../{27_sd_card => storage/sd_card}/main/sd_card.c | 0 examples/{25_ota => system/ota}/Makefile | 0 examples/{25_ota => system/ota}/OTA_workflow.png | Bin examples/{25_ota => system/ota}/README.md | 0 .../{25_ota => system/ota}/main/Kconfig.projbuild | 0 .../ota}/main/component.mk | 0 examples/{25_ota => system/ota}/main/ota.c | 0 examples/{25_ota => system/ota}/sdkconfig.defaults | 0 .../wpa2_enterprise}/Makefile | 0 .../wpa2_enterprise}/README.md | 0 .../wpa2_enterprise}/main/Kconfig.projbuild | 0 .../wpa2_enterprise}/main/component.mk | 0 .../wpa2_enterprise}/main/wpa2_ca.pem | 0 .../wpa2_enterprise}/main/wpa2_client.crt | 0 .../wpa2_enterprise}/main/wpa2_client.key | 0 .../wpa2_enterprise}/main/wpa2_client.pem | 0 .../wpa2_enterprise}/main/wpa2_enterprise_main.c | 0 .../wpa2_enterprise}/main/wpa2_server.crt | 0 .../wpa2_enterprise}/main/wpa2_server.key | 0 .../wpa2_enterprise}/main/wpa2_server.pem | 0 155 files changed, 0 insertions(+), 0 deletions(-) rename examples/{05_ble_adv => bluetooth/ble_adv}/Makefile (100%) rename examples/{05_ble_adv => bluetooth/ble_adv}/README.rst (100%) rename examples/{05_ble_adv => bluetooth/ble_adv}/main/app_bt.c (100%) rename examples/{02_blink => bluetooth/ble_adv}/main/component.mk (100%) rename examples/{05_ble_adv => bluetooth/ble_adv}/sdkconfig.defaults (100%) rename examples/{12_blufi => bluetooth/blufi}/Makefile (100%) rename examples/{12_blufi => bluetooth/blufi}/README.rst (100%) rename examples/{12_blufi => bluetooth/blufi}/main/blufi_demo.h (100%) rename examples/{12_blufi => bluetooth/blufi}/main/blufi_main.c (100%) rename examples/{12_blufi => bluetooth/blufi}/main/blufi_security.c (100%) rename examples/{12_blufi => bluetooth/blufi}/main/component.mk (100%) rename examples/{12_blufi => bluetooth/blufi}/sdkconfig.defaults (100%) rename examples/{15_gatt_client => bluetooth/gatt_client}/Makefile (100%) rename examples/{15_gatt_client => bluetooth/gatt_client}/README.rst (100%) rename examples/{15_gatt_client => bluetooth/gatt_client}/main/component.mk (100%) rename examples/{15_gatt_client => bluetooth/gatt_client}/main/gattc_demo.c (100%) rename examples/{14_gatt_server => bluetooth/gatt_client}/sdkconfig.defaults (100%) rename examples/{14_gatt_server => bluetooth/gatt_server}/Makefile (100%) rename examples/{14_gatt_server => bluetooth/gatt_server}/README.rst (100%) rename examples/{14_gatt_server => bluetooth/gatt_server}/main/component.mk (100%) rename examples/{14_gatt_server => bluetooth/gatt_server}/main/gatts_demo.c (100%) rename examples/{15_gatt_client => bluetooth/gatt_server}/sdkconfig.defaults (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/Makefile (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/README.rst (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/main/component.mk (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/main/gatts_table_creat_demo.c (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/main/gatts_table_creat_demo.h (100%) rename examples/{33_gatt_server_service_table => bluetooth/gatt_server_service_table}/sdkconfig.defaults (100%) rename examples/{17_ethernet => ethernet/ethernet}/Makefile (100%) rename examples/{17_ethernet => ethernet/ethernet}/README.md (100%) rename examples/{03_http_request => ethernet/ethernet}/main/component.mk (100%) rename examples/{17_ethernet => ethernet/ethernet}/main/ethernet_main.c (100%) rename examples/{17_ethernet => ethernet/ethernet}/main/tlk110_phy.h (100%) rename examples/{02_blink => get-started/blink}/Makefile (100%) rename examples/{02_blink => get-started/blink}/README.md (100%) rename examples/{02_blink => get-started/blink}/main/Kconfig.projbuild (100%) rename examples/{02_blink => get-started/blink}/main/blink.c (100%) rename examples/{05_ble_adv => get-started/blink}/main/component.mk (100%) rename examples/{02_blink => get-started/blink}/sdkconfig.defaults (100%) rename examples/{01_hello_world => get-started/hello_world}/Makefile (100%) rename examples/{01_hello_world => get-started/hello_world}/README.md (100%) rename examples/{01_hello_world => get-started/hello_world}/main/component.mk (100%) rename examples/{01_hello_world => get-started/hello_world}/main/hello_world_main.c (100%) rename examples/{21_gpio => peripherals/gpio}/Makefile (100%) rename examples/{21_gpio => peripherals/gpio}/README.md (100%) rename examples/{09_openssl_client => peripherals/gpio}/main/component.mk (100%) rename examples/{21_gpio => peripherals/gpio}/main/gpio_test.c (100%) rename examples/{18_i2c => peripherals/i2c}/Makefile (100%) rename examples/{18_i2c => peripherals/i2c}/README.md (100%) rename examples/{16_pcnt => peripherals/i2c}/main/component.mk (100%) rename examples/{18_i2c => peripherals/i2c}/main/i2c_test.c (100%) rename examples/{22_i2s => peripherals/i2s}/Makefile (100%) rename examples/{22_i2s => peripherals/i2s}/main/app_main.c (100%) rename examples/{22_i2s => peripherals/i2s}/main/component.mk (100%) rename examples/{29_ledc => peripherals/ledc}/Makefile (100%) rename examples/{29_ledc => peripherals/ledc}/README.md (100%) rename examples/{18_i2c => peripherals/ledc}/main/component.mk (100%) rename examples/{29_ledc => peripherals/ledc}/main/ledc_fade.c (100%) rename examples/{16_pcnt => peripherals/pcnt}/Makefile (100%) rename examples/{16_pcnt => peripherals/pcnt}/README.md (100%) rename examples/{20_uart => peripherals/pcnt}/main/component.mk (100%) rename examples/{16_pcnt => peripherals/pcnt}/main/pcnt_test.c (100%) rename examples/{11_rmt_nec_tx_rx => peripherals/rmt_nec_tx_rx}/Makefile (100%) rename examples/{11_rmt_nec_tx_rx => peripherals/rmt_nec_tx_rx}/README.md (100%) rename examples/{11_rmt_nec_tx_rx => peripherals/rmt_nec_tx_rx}/main/component.mk (100%) rename examples/{11_rmt_nec_tx_rx => peripherals/rmt_nec_tx_rx}/main/infrared_nec.c (100%) rename examples/{11_rmt_nec_tx_rx => peripherals/rmt_nec_tx_rx}/main/infrared_nec_main.c (100%) rename examples/{19_sigmadelta => peripherals/sigmadelta}/Makefile (100%) rename examples/{19_sigmadelta => peripherals/sigmadelta}/README.md (100%) rename examples/{19_sigmadelta => peripherals/sigmadelta}/main/component.mk (100%) rename examples/{19_sigmadelta => peripherals/sigmadelta}/main/sigmadelta_test.c (100%) rename examples/{26_spi_master => peripherals/spi_master}/Makefile (100%) rename examples/{26_spi_master => peripherals/spi_master}/main/component.mk (100%) rename examples/{26_spi_master => peripherals/spi_master}/main/spi_master.c (100%) rename examples/{13_timer_group => peripherals/timer_group}/Makefile (100%) rename examples/{13_timer_group => peripherals/timer_group}/README.md (100%) rename examples/{07_nvs_rw_value => peripherals/timer_group}/main/component.mk (100%) rename examples/{13_timer_group => peripherals/timer_group}/main/timer_group.c (100%) rename examples/{20_uart => peripherals/uart}/Makefile (100%) rename examples/{21_gpio => peripherals/uart}/main/component.mk (100%) rename examples/{20_uart => peripherals/uart}/main/uart_test.c (100%) rename examples/{23_coap_client => protocols/coap_client}/Makefile (100%) rename examples/{23_coap_client => protocols/coap_client}/main/Kconfig.projbuild (100%) rename examples/{23_coap_client => protocols/coap_client}/main/coap_client.c (100%) rename examples/{08_nvs_rw_blob => protocols/coap_client}/main/component.mk (100%) rename examples/{24_coap_server => protocols/coap_server}/Makefile (100%) rename examples/{24_coap_server => protocols/coap_server}/main/Kconfig.projbuild (100%) rename examples/{24_coap_server => protocols/coap_server}/main/coap_server.c (100%) rename examples/{13_timer_group => protocols/coap_server}/main/component.mk (100%) rename examples/{03_http_request => protocols/http_request}/Makefile (100%) rename examples/{03_http_request => protocols/http_request}/README.md (100%) rename examples/{03_http_request => protocols/http_request}/main/Kconfig.projbuild (100%) rename examples/{06_sntp => protocols/http_request}/main/component.mk (100%) rename examples/{03_http_request => protocols/http_request}/main/http_request_main.c (100%) rename examples/{04_https_request => protocols/https_request}/Makefile (100%) rename examples/{04_https_request => protocols/https_request}/README.md (100%) rename examples/{04_https_request => protocols/https_request}/main/Kconfig.projbuild (100%) rename examples/{04_https_request => protocols/https_request}/main/component.mk (100%) rename examples/{04_https_request => protocols/https_request}/main/https_request_main.c (100%) rename examples/{04_https_request => protocols/https_request}/main/server_root_cert.pem (100%) rename examples/{30_mdns_example => protocols/mdns}/Makefile (100%) rename examples/{30_mdns_example => protocols/mdns}/README.md (100%) rename examples/{30_mdns_example => protocols/mdns}/main/Kconfig.projbuild (100%) rename examples/{17_ethernet => protocols/mdns}/main/component.mk (100%) rename examples/{30_mdns_example => protocols/mdns}/main/mdns_example_main.c (100%) rename examples/{09_openssl_client => protocols/openssl_client}/Makefile (100%) rename examples/{09_openssl_client => protocols/openssl_client}/README.md (100%) rename examples/{09_openssl_client => protocols/openssl_client}/main/Kconfig.projbuild (100%) rename examples/{29_ledc => protocols/openssl_client}/main/component.mk (100%) rename examples/{09_openssl_client => protocols/openssl_client}/main/openssl_client.c (100%) rename examples/{09_openssl_client => protocols/openssl_client}/main/openssl_client.h (100%) rename examples/{10_openssl_server => protocols/openssl_server}/Makefile (100%) rename examples/{10_openssl_server => protocols/openssl_server}/README.md (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/Kconfig.projbuild (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/cacert.pem (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/component.mk (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/openssl_server.c (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/openssl_server.h (100%) rename examples/{10_openssl_server => protocols/openssl_server}/main/prvtkey.pem (100%) rename examples/{06_sntp => protocols/sntp}/Makefile (100%) rename examples/{06_sntp => protocols/sntp}/README.md (100%) rename examples/{06_sntp => protocols/sntp}/main/Kconfig.projbuild (100%) rename examples/{25_ota => protocols/sntp}/main/component.mk (100%) rename examples/{06_sntp => protocols/sntp}/main/sntp_main.c (100%) rename examples/{08_nvs_rw_blob => storage/nvs_rw_blob}/Makefile (100%) rename examples/{08_nvs_rw_blob => storage/nvs_rw_blob}/README.md (100%) rename examples/{23_coap_client => storage/nvs_rw_blob}/main/component.mk (100%) rename examples/{08_nvs_rw_blob => storage/nvs_rw_blob}/main/nvs_rw_blob.c (100%) rename examples/{07_nvs_rw_value => storage/nvs_rw_value}/Makefile (100%) rename examples/{07_nvs_rw_value => storage/nvs_rw_value}/README.md (100%) rename examples/{24_coap_server => storage/nvs_rw_value}/main/component.mk (100%) rename examples/{07_nvs_rw_value => storage/nvs_rw_value}/main/nvs_rw_value.c (100%) rename examples/{27_sd_card => storage/sd_card}/Makefile (100%) rename examples/{27_sd_card => storage/sd_card}/README.md (100%) rename examples/{27_sd_card => storage/sd_card}/main/component.mk (100%) rename examples/{27_sd_card => storage/sd_card}/main/sd_card.c (100%) rename examples/{25_ota => system/ota}/Makefile (100%) rename examples/{25_ota => system/ota}/OTA_workflow.png (100%) rename examples/{25_ota => system/ota}/README.md (100%) rename examples/{25_ota => system/ota}/main/Kconfig.projbuild (100%) rename examples/{30_mdns_example => system/ota}/main/component.mk (100%) rename examples/{25_ota => system/ota}/main/ota.c (100%) rename examples/{25_ota => system/ota}/sdkconfig.defaults (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/Makefile (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/README.md (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/Kconfig.projbuild (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/component.mk (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_ca.pem (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_client.crt (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_client.key (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_client.pem (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_enterprise_main.c (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_server.crt (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_server.key (100%) rename examples/{31_wpa2_enterprise => wifi/wpa2_enterprise}/main/wpa2_server.pem (100%) diff --git a/examples/05_ble_adv/Makefile b/examples/bluetooth/ble_adv/Makefile similarity index 100% rename from examples/05_ble_adv/Makefile rename to examples/bluetooth/ble_adv/Makefile diff --git a/examples/05_ble_adv/README.rst b/examples/bluetooth/ble_adv/README.rst similarity index 100% rename from examples/05_ble_adv/README.rst rename to examples/bluetooth/ble_adv/README.rst diff --git a/examples/05_ble_adv/main/app_bt.c b/examples/bluetooth/ble_adv/main/app_bt.c similarity index 100% rename from examples/05_ble_adv/main/app_bt.c rename to examples/bluetooth/ble_adv/main/app_bt.c diff --git a/examples/02_blink/main/component.mk b/examples/bluetooth/ble_adv/main/component.mk similarity index 100% rename from examples/02_blink/main/component.mk rename to examples/bluetooth/ble_adv/main/component.mk diff --git a/examples/05_ble_adv/sdkconfig.defaults b/examples/bluetooth/ble_adv/sdkconfig.defaults similarity index 100% rename from examples/05_ble_adv/sdkconfig.defaults rename to examples/bluetooth/ble_adv/sdkconfig.defaults diff --git a/examples/12_blufi/Makefile b/examples/bluetooth/blufi/Makefile similarity index 100% rename from examples/12_blufi/Makefile rename to examples/bluetooth/blufi/Makefile diff --git a/examples/12_blufi/README.rst b/examples/bluetooth/blufi/README.rst similarity index 100% rename from examples/12_blufi/README.rst rename to examples/bluetooth/blufi/README.rst diff --git a/examples/12_blufi/main/blufi_demo.h b/examples/bluetooth/blufi/main/blufi_demo.h similarity index 100% rename from examples/12_blufi/main/blufi_demo.h rename to examples/bluetooth/blufi/main/blufi_demo.h diff --git a/examples/12_blufi/main/blufi_main.c b/examples/bluetooth/blufi/main/blufi_main.c similarity index 100% rename from examples/12_blufi/main/blufi_main.c rename to examples/bluetooth/blufi/main/blufi_main.c diff --git a/examples/12_blufi/main/blufi_security.c b/examples/bluetooth/blufi/main/blufi_security.c similarity index 100% rename from examples/12_blufi/main/blufi_security.c rename to examples/bluetooth/blufi/main/blufi_security.c diff --git a/examples/12_blufi/main/component.mk b/examples/bluetooth/blufi/main/component.mk similarity index 100% rename from examples/12_blufi/main/component.mk rename to examples/bluetooth/blufi/main/component.mk diff --git a/examples/12_blufi/sdkconfig.defaults b/examples/bluetooth/blufi/sdkconfig.defaults similarity index 100% rename from examples/12_blufi/sdkconfig.defaults rename to examples/bluetooth/blufi/sdkconfig.defaults diff --git a/examples/15_gatt_client/Makefile b/examples/bluetooth/gatt_client/Makefile similarity index 100% rename from examples/15_gatt_client/Makefile rename to examples/bluetooth/gatt_client/Makefile diff --git a/examples/15_gatt_client/README.rst b/examples/bluetooth/gatt_client/README.rst similarity index 100% rename from examples/15_gatt_client/README.rst rename to examples/bluetooth/gatt_client/README.rst diff --git a/examples/15_gatt_client/main/component.mk b/examples/bluetooth/gatt_client/main/component.mk similarity index 100% rename from examples/15_gatt_client/main/component.mk rename to examples/bluetooth/gatt_client/main/component.mk diff --git a/examples/15_gatt_client/main/gattc_demo.c b/examples/bluetooth/gatt_client/main/gattc_demo.c similarity index 100% rename from examples/15_gatt_client/main/gattc_demo.c rename to examples/bluetooth/gatt_client/main/gattc_demo.c diff --git a/examples/14_gatt_server/sdkconfig.defaults b/examples/bluetooth/gatt_client/sdkconfig.defaults similarity index 100% rename from examples/14_gatt_server/sdkconfig.defaults rename to examples/bluetooth/gatt_client/sdkconfig.defaults diff --git a/examples/14_gatt_server/Makefile b/examples/bluetooth/gatt_server/Makefile similarity index 100% rename from examples/14_gatt_server/Makefile rename to examples/bluetooth/gatt_server/Makefile diff --git a/examples/14_gatt_server/README.rst b/examples/bluetooth/gatt_server/README.rst similarity index 100% rename from examples/14_gatt_server/README.rst rename to examples/bluetooth/gatt_server/README.rst diff --git a/examples/14_gatt_server/main/component.mk b/examples/bluetooth/gatt_server/main/component.mk similarity index 100% rename from examples/14_gatt_server/main/component.mk rename to examples/bluetooth/gatt_server/main/component.mk diff --git a/examples/14_gatt_server/main/gatts_demo.c b/examples/bluetooth/gatt_server/main/gatts_demo.c similarity index 100% rename from examples/14_gatt_server/main/gatts_demo.c rename to examples/bluetooth/gatt_server/main/gatts_demo.c diff --git a/examples/15_gatt_client/sdkconfig.defaults b/examples/bluetooth/gatt_server/sdkconfig.defaults similarity index 100% rename from examples/15_gatt_client/sdkconfig.defaults rename to examples/bluetooth/gatt_server/sdkconfig.defaults diff --git a/examples/33_gatt_server_service_table/Makefile b/examples/bluetooth/gatt_server_service_table/Makefile similarity index 100% rename from examples/33_gatt_server_service_table/Makefile rename to examples/bluetooth/gatt_server_service_table/Makefile diff --git a/examples/33_gatt_server_service_table/README.rst b/examples/bluetooth/gatt_server_service_table/README.rst similarity index 100% rename from examples/33_gatt_server_service_table/README.rst rename to examples/bluetooth/gatt_server_service_table/README.rst diff --git a/examples/33_gatt_server_service_table/main/component.mk b/examples/bluetooth/gatt_server_service_table/main/component.mk similarity index 100% rename from examples/33_gatt_server_service_table/main/component.mk rename to examples/bluetooth/gatt_server_service_table/main/component.mk diff --git a/examples/33_gatt_server_service_table/main/gatts_table_creat_demo.c b/examples/bluetooth/gatt_server_service_table/main/gatts_table_creat_demo.c similarity index 100% rename from examples/33_gatt_server_service_table/main/gatts_table_creat_demo.c rename to examples/bluetooth/gatt_server_service_table/main/gatts_table_creat_demo.c diff --git a/examples/33_gatt_server_service_table/main/gatts_table_creat_demo.h b/examples/bluetooth/gatt_server_service_table/main/gatts_table_creat_demo.h similarity index 100% rename from examples/33_gatt_server_service_table/main/gatts_table_creat_demo.h rename to examples/bluetooth/gatt_server_service_table/main/gatts_table_creat_demo.h diff --git a/examples/33_gatt_server_service_table/sdkconfig.defaults b/examples/bluetooth/gatt_server_service_table/sdkconfig.defaults similarity index 100% rename from examples/33_gatt_server_service_table/sdkconfig.defaults rename to examples/bluetooth/gatt_server_service_table/sdkconfig.defaults diff --git a/examples/17_ethernet/Makefile b/examples/ethernet/ethernet/Makefile similarity index 100% rename from examples/17_ethernet/Makefile rename to examples/ethernet/ethernet/Makefile diff --git a/examples/17_ethernet/README.md b/examples/ethernet/ethernet/README.md similarity index 100% rename from examples/17_ethernet/README.md rename to examples/ethernet/ethernet/README.md diff --git a/examples/03_http_request/main/component.mk b/examples/ethernet/ethernet/main/component.mk similarity index 100% rename from examples/03_http_request/main/component.mk rename to examples/ethernet/ethernet/main/component.mk diff --git a/examples/17_ethernet/main/ethernet_main.c b/examples/ethernet/ethernet/main/ethernet_main.c similarity index 100% rename from examples/17_ethernet/main/ethernet_main.c rename to examples/ethernet/ethernet/main/ethernet_main.c diff --git a/examples/17_ethernet/main/tlk110_phy.h b/examples/ethernet/ethernet/main/tlk110_phy.h similarity index 100% rename from examples/17_ethernet/main/tlk110_phy.h rename to examples/ethernet/ethernet/main/tlk110_phy.h diff --git a/examples/02_blink/Makefile b/examples/get-started/blink/Makefile similarity index 100% rename from examples/02_blink/Makefile rename to examples/get-started/blink/Makefile diff --git a/examples/02_blink/README.md b/examples/get-started/blink/README.md similarity index 100% rename from examples/02_blink/README.md rename to examples/get-started/blink/README.md diff --git a/examples/02_blink/main/Kconfig.projbuild b/examples/get-started/blink/main/Kconfig.projbuild similarity index 100% rename from examples/02_blink/main/Kconfig.projbuild rename to examples/get-started/blink/main/Kconfig.projbuild diff --git a/examples/02_blink/main/blink.c b/examples/get-started/blink/main/blink.c similarity index 100% rename from examples/02_blink/main/blink.c rename to examples/get-started/blink/main/blink.c diff --git a/examples/05_ble_adv/main/component.mk b/examples/get-started/blink/main/component.mk similarity index 100% rename from examples/05_ble_adv/main/component.mk rename to examples/get-started/blink/main/component.mk diff --git a/examples/02_blink/sdkconfig.defaults b/examples/get-started/blink/sdkconfig.defaults similarity index 100% rename from examples/02_blink/sdkconfig.defaults rename to examples/get-started/blink/sdkconfig.defaults diff --git a/examples/01_hello_world/Makefile b/examples/get-started/hello_world/Makefile similarity index 100% rename from examples/01_hello_world/Makefile rename to examples/get-started/hello_world/Makefile diff --git a/examples/01_hello_world/README.md b/examples/get-started/hello_world/README.md similarity index 100% rename from examples/01_hello_world/README.md rename to examples/get-started/hello_world/README.md diff --git a/examples/01_hello_world/main/component.mk b/examples/get-started/hello_world/main/component.mk similarity index 100% rename from examples/01_hello_world/main/component.mk rename to examples/get-started/hello_world/main/component.mk diff --git a/examples/01_hello_world/main/hello_world_main.c b/examples/get-started/hello_world/main/hello_world_main.c similarity index 100% rename from examples/01_hello_world/main/hello_world_main.c rename to examples/get-started/hello_world/main/hello_world_main.c diff --git a/examples/21_gpio/Makefile b/examples/peripherals/gpio/Makefile similarity index 100% rename from examples/21_gpio/Makefile rename to examples/peripherals/gpio/Makefile diff --git a/examples/21_gpio/README.md b/examples/peripherals/gpio/README.md similarity index 100% rename from examples/21_gpio/README.md rename to examples/peripherals/gpio/README.md diff --git a/examples/09_openssl_client/main/component.mk b/examples/peripherals/gpio/main/component.mk similarity index 100% rename from examples/09_openssl_client/main/component.mk rename to examples/peripherals/gpio/main/component.mk diff --git a/examples/21_gpio/main/gpio_test.c b/examples/peripherals/gpio/main/gpio_test.c similarity index 100% rename from examples/21_gpio/main/gpio_test.c rename to examples/peripherals/gpio/main/gpio_test.c diff --git a/examples/18_i2c/Makefile b/examples/peripherals/i2c/Makefile similarity index 100% rename from examples/18_i2c/Makefile rename to examples/peripherals/i2c/Makefile diff --git a/examples/18_i2c/README.md b/examples/peripherals/i2c/README.md similarity index 100% rename from examples/18_i2c/README.md rename to examples/peripherals/i2c/README.md diff --git a/examples/16_pcnt/main/component.mk b/examples/peripherals/i2c/main/component.mk similarity index 100% rename from examples/16_pcnt/main/component.mk rename to examples/peripherals/i2c/main/component.mk diff --git a/examples/18_i2c/main/i2c_test.c b/examples/peripherals/i2c/main/i2c_test.c similarity index 100% rename from examples/18_i2c/main/i2c_test.c rename to examples/peripherals/i2c/main/i2c_test.c diff --git a/examples/22_i2s/Makefile b/examples/peripherals/i2s/Makefile similarity index 100% rename from examples/22_i2s/Makefile rename to examples/peripherals/i2s/Makefile diff --git a/examples/22_i2s/main/app_main.c b/examples/peripherals/i2s/main/app_main.c similarity index 100% rename from examples/22_i2s/main/app_main.c rename to examples/peripherals/i2s/main/app_main.c diff --git a/examples/22_i2s/main/component.mk b/examples/peripherals/i2s/main/component.mk similarity index 100% rename from examples/22_i2s/main/component.mk rename to examples/peripherals/i2s/main/component.mk diff --git a/examples/29_ledc/Makefile b/examples/peripherals/ledc/Makefile similarity index 100% rename from examples/29_ledc/Makefile rename to examples/peripherals/ledc/Makefile diff --git a/examples/29_ledc/README.md b/examples/peripherals/ledc/README.md similarity index 100% rename from examples/29_ledc/README.md rename to examples/peripherals/ledc/README.md diff --git a/examples/18_i2c/main/component.mk b/examples/peripherals/ledc/main/component.mk similarity index 100% rename from examples/18_i2c/main/component.mk rename to examples/peripherals/ledc/main/component.mk diff --git a/examples/29_ledc/main/ledc_fade.c b/examples/peripherals/ledc/main/ledc_fade.c similarity index 100% rename from examples/29_ledc/main/ledc_fade.c rename to examples/peripherals/ledc/main/ledc_fade.c diff --git a/examples/16_pcnt/Makefile b/examples/peripherals/pcnt/Makefile similarity index 100% rename from examples/16_pcnt/Makefile rename to examples/peripherals/pcnt/Makefile diff --git a/examples/16_pcnt/README.md b/examples/peripherals/pcnt/README.md similarity index 100% rename from examples/16_pcnt/README.md rename to examples/peripherals/pcnt/README.md diff --git a/examples/20_uart/main/component.mk b/examples/peripherals/pcnt/main/component.mk similarity index 100% rename from examples/20_uart/main/component.mk rename to examples/peripherals/pcnt/main/component.mk diff --git a/examples/16_pcnt/main/pcnt_test.c b/examples/peripherals/pcnt/main/pcnt_test.c similarity index 100% rename from examples/16_pcnt/main/pcnt_test.c rename to examples/peripherals/pcnt/main/pcnt_test.c diff --git a/examples/11_rmt_nec_tx_rx/Makefile b/examples/peripherals/rmt_nec_tx_rx/Makefile similarity index 100% rename from examples/11_rmt_nec_tx_rx/Makefile rename to examples/peripherals/rmt_nec_tx_rx/Makefile diff --git a/examples/11_rmt_nec_tx_rx/README.md b/examples/peripherals/rmt_nec_tx_rx/README.md similarity index 100% rename from examples/11_rmt_nec_tx_rx/README.md rename to examples/peripherals/rmt_nec_tx_rx/README.md diff --git a/examples/11_rmt_nec_tx_rx/main/component.mk b/examples/peripherals/rmt_nec_tx_rx/main/component.mk similarity index 100% rename from examples/11_rmt_nec_tx_rx/main/component.mk rename to examples/peripherals/rmt_nec_tx_rx/main/component.mk diff --git a/examples/11_rmt_nec_tx_rx/main/infrared_nec.c b/examples/peripherals/rmt_nec_tx_rx/main/infrared_nec.c similarity index 100% rename from examples/11_rmt_nec_tx_rx/main/infrared_nec.c rename to examples/peripherals/rmt_nec_tx_rx/main/infrared_nec.c diff --git a/examples/11_rmt_nec_tx_rx/main/infrared_nec_main.c b/examples/peripherals/rmt_nec_tx_rx/main/infrared_nec_main.c similarity index 100% rename from examples/11_rmt_nec_tx_rx/main/infrared_nec_main.c rename to examples/peripherals/rmt_nec_tx_rx/main/infrared_nec_main.c diff --git a/examples/19_sigmadelta/Makefile b/examples/peripherals/sigmadelta/Makefile similarity index 100% rename from examples/19_sigmadelta/Makefile rename to examples/peripherals/sigmadelta/Makefile diff --git a/examples/19_sigmadelta/README.md b/examples/peripherals/sigmadelta/README.md similarity index 100% rename from examples/19_sigmadelta/README.md rename to examples/peripherals/sigmadelta/README.md diff --git a/examples/19_sigmadelta/main/component.mk b/examples/peripherals/sigmadelta/main/component.mk similarity index 100% rename from examples/19_sigmadelta/main/component.mk rename to examples/peripherals/sigmadelta/main/component.mk diff --git a/examples/19_sigmadelta/main/sigmadelta_test.c b/examples/peripherals/sigmadelta/main/sigmadelta_test.c similarity index 100% rename from examples/19_sigmadelta/main/sigmadelta_test.c rename to examples/peripherals/sigmadelta/main/sigmadelta_test.c diff --git a/examples/26_spi_master/Makefile b/examples/peripherals/spi_master/Makefile similarity index 100% rename from examples/26_spi_master/Makefile rename to examples/peripherals/spi_master/Makefile diff --git a/examples/26_spi_master/main/component.mk b/examples/peripherals/spi_master/main/component.mk similarity index 100% rename from examples/26_spi_master/main/component.mk rename to examples/peripherals/spi_master/main/component.mk diff --git a/examples/26_spi_master/main/spi_master.c b/examples/peripherals/spi_master/main/spi_master.c similarity index 100% rename from examples/26_spi_master/main/spi_master.c rename to examples/peripherals/spi_master/main/spi_master.c diff --git a/examples/13_timer_group/Makefile b/examples/peripherals/timer_group/Makefile similarity index 100% rename from examples/13_timer_group/Makefile rename to examples/peripherals/timer_group/Makefile diff --git a/examples/13_timer_group/README.md b/examples/peripherals/timer_group/README.md similarity index 100% rename from examples/13_timer_group/README.md rename to examples/peripherals/timer_group/README.md diff --git a/examples/07_nvs_rw_value/main/component.mk b/examples/peripherals/timer_group/main/component.mk similarity index 100% rename from examples/07_nvs_rw_value/main/component.mk rename to examples/peripherals/timer_group/main/component.mk diff --git a/examples/13_timer_group/main/timer_group.c b/examples/peripherals/timer_group/main/timer_group.c similarity index 100% rename from examples/13_timer_group/main/timer_group.c rename to examples/peripherals/timer_group/main/timer_group.c diff --git a/examples/20_uart/Makefile b/examples/peripherals/uart/Makefile similarity index 100% rename from examples/20_uart/Makefile rename to examples/peripherals/uart/Makefile diff --git a/examples/21_gpio/main/component.mk b/examples/peripherals/uart/main/component.mk similarity index 100% rename from examples/21_gpio/main/component.mk rename to examples/peripherals/uart/main/component.mk diff --git a/examples/20_uart/main/uart_test.c b/examples/peripherals/uart/main/uart_test.c similarity index 100% rename from examples/20_uart/main/uart_test.c rename to examples/peripherals/uart/main/uart_test.c diff --git a/examples/23_coap_client/Makefile b/examples/protocols/coap_client/Makefile similarity index 100% rename from examples/23_coap_client/Makefile rename to examples/protocols/coap_client/Makefile diff --git a/examples/23_coap_client/main/Kconfig.projbuild b/examples/protocols/coap_client/main/Kconfig.projbuild similarity index 100% rename from examples/23_coap_client/main/Kconfig.projbuild rename to examples/protocols/coap_client/main/Kconfig.projbuild diff --git a/examples/23_coap_client/main/coap_client.c b/examples/protocols/coap_client/main/coap_client.c similarity index 100% rename from examples/23_coap_client/main/coap_client.c rename to examples/protocols/coap_client/main/coap_client.c diff --git a/examples/08_nvs_rw_blob/main/component.mk b/examples/protocols/coap_client/main/component.mk similarity index 100% rename from examples/08_nvs_rw_blob/main/component.mk rename to examples/protocols/coap_client/main/component.mk diff --git a/examples/24_coap_server/Makefile b/examples/protocols/coap_server/Makefile similarity index 100% rename from examples/24_coap_server/Makefile rename to examples/protocols/coap_server/Makefile diff --git a/examples/24_coap_server/main/Kconfig.projbuild b/examples/protocols/coap_server/main/Kconfig.projbuild similarity index 100% rename from examples/24_coap_server/main/Kconfig.projbuild rename to examples/protocols/coap_server/main/Kconfig.projbuild diff --git a/examples/24_coap_server/main/coap_server.c b/examples/protocols/coap_server/main/coap_server.c similarity index 100% rename from examples/24_coap_server/main/coap_server.c rename to examples/protocols/coap_server/main/coap_server.c diff --git a/examples/13_timer_group/main/component.mk b/examples/protocols/coap_server/main/component.mk similarity index 100% rename from examples/13_timer_group/main/component.mk rename to examples/protocols/coap_server/main/component.mk diff --git a/examples/03_http_request/Makefile b/examples/protocols/http_request/Makefile similarity index 100% rename from examples/03_http_request/Makefile rename to examples/protocols/http_request/Makefile diff --git a/examples/03_http_request/README.md b/examples/protocols/http_request/README.md similarity index 100% rename from examples/03_http_request/README.md rename to examples/protocols/http_request/README.md diff --git a/examples/03_http_request/main/Kconfig.projbuild b/examples/protocols/http_request/main/Kconfig.projbuild similarity index 100% rename from examples/03_http_request/main/Kconfig.projbuild rename to examples/protocols/http_request/main/Kconfig.projbuild diff --git a/examples/06_sntp/main/component.mk b/examples/protocols/http_request/main/component.mk similarity index 100% rename from examples/06_sntp/main/component.mk rename to examples/protocols/http_request/main/component.mk diff --git a/examples/03_http_request/main/http_request_main.c b/examples/protocols/http_request/main/http_request_main.c similarity index 100% rename from examples/03_http_request/main/http_request_main.c rename to examples/protocols/http_request/main/http_request_main.c diff --git a/examples/04_https_request/Makefile b/examples/protocols/https_request/Makefile similarity index 100% rename from examples/04_https_request/Makefile rename to examples/protocols/https_request/Makefile diff --git a/examples/04_https_request/README.md b/examples/protocols/https_request/README.md similarity index 100% rename from examples/04_https_request/README.md rename to examples/protocols/https_request/README.md diff --git a/examples/04_https_request/main/Kconfig.projbuild b/examples/protocols/https_request/main/Kconfig.projbuild similarity index 100% rename from examples/04_https_request/main/Kconfig.projbuild rename to examples/protocols/https_request/main/Kconfig.projbuild diff --git a/examples/04_https_request/main/component.mk b/examples/protocols/https_request/main/component.mk similarity index 100% rename from examples/04_https_request/main/component.mk rename to examples/protocols/https_request/main/component.mk diff --git a/examples/04_https_request/main/https_request_main.c b/examples/protocols/https_request/main/https_request_main.c similarity index 100% rename from examples/04_https_request/main/https_request_main.c rename to examples/protocols/https_request/main/https_request_main.c diff --git a/examples/04_https_request/main/server_root_cert.pem b/examples/protocols/https_request/main/server_root_cert.pem similarity index 100% rename from examples/04_https_request/main/server_root_cert.pem rename to examples/protocols/https_request/main/server_root_cert.pem diff --git a/examples/30_mdns_example/Makefile b/examples/protocols/mdns/Makefile similarity index 100% rename from examples/30_mdns_example/Makefile rename to examples/protocols/mdns/Makefile diff --git a/examples/30_mdns_example/README.md b/examples/protocols/mdns/README.md similarity index 100% rename from examples/30_mdns_example/README.md rename to examples/protocols/mdns/README.md diff --git a/examples/30_mdns_example/main/Kconfig.projbuild b/examples/protocols/mdns/main/Kconfig.projbuild similarity index 100% rename from examples/30_mdns_example/main/Kconfig.projbuild rename to examples/protocols/mdns/main/Kconfig.projbuild diff --git a/examples/17_ethernet/main/component.mk b/examples/protocols/mdns/main/component.mk similarity index 100% rename from examples/17_ethernet/main/component.mk rename to examples/protocols/mdns/main/component.mk diff --git a/examples/30_mdns_example/main/mdns_example_main.c b/examples/protocols/mdns/main/mdns_example_main.c similarity index 100% rename from examples/30_mdns_example/main/mdns_example_main.c rename to examples/protocols/mdns/main/mdns_example_main.c diff --git a/examples/09_openssl_client/Makefile b/examples/protocols/openssl_client/Makefile similarity index 100% rename from examples/09_openssl_client/Makefile rename to examples/protocols/openssl_client/Makefile diff --git a/examples/09_openssl_client/README.md b/examples/protocols/openssl_client/README.md similarity index 100% rename from examples/09_openssl_client/README.md rename to examples/protocols/openssl_client/README.md diff --git a/examples/09_openssl_client/main/Kconfig.projbuild b/examples/protocols/openssl_client/main/Kconfig.projbuild similarity index 100% rename from examples/09_openssl_client/main/Kconfig.projbuild rename to examples/protocols/openssl_client/main/Kconfig.projbuild diff --git a/examples/29_ledc/main/component.mk b/examples/protocols/openssl_client/main/component.mk similarity index 100% rename from examples/29_ledc/main/component.mk rename to examples/protocols/openssl_client/main/component.mk diff --git a/examples/09_openssl_client/main/openssl_client.c b/examples/protocols/openssl_client/main/openssl_client.c similarity index 100% rename from examples/09_openssl_client/main/openssl_client.c rename to examples/protocols/openssl_client/main/openssl_client.c diff --git a/examples/09_openssl_client/main/openssl_client.h b/examples/protocols/openssl_client/main/openssl_client.h similarity index 100% rename from examples/09_openssl_client/main/openssl_client.h rename to examples/protocols/openssl_client/main/openssl_client.h diff --git a/examples/10_openssl_server/Makefile b/examples/protocols/openssl_server/Makefile similarity index 100% rename from examples/10_openssl_server/Makefile rename to examples/protocols/openssl_server/Makefile diff --git a/examples/10_openssl_server/README.md b/examples/protocols/openssl_server/README.md similarity index 100% rename from examples/10_openssl_server/README.md rename to examples/protocols/openssl_server/README.md diff --git a/examples/10_openssl_server/main/Kconfig.projbuild b/examples/protocols/openssl_server/main/Kconfig.projbuild similarity index 100% rename from examples/10_openssl_server/main/Kconfig.projbuild rename to examples/protocols/openssl_server/main/Kconfig.projbuild diff --git a/examples/10_openssl_server/main/cacert.pem b/examples/protocols/openssl_server/main/cacert.pem similarity index 100% rename from examples/10_openssl_server/main/cacert.pem rename to examples/protocols/openssl_server/main/cacert.pem diff --git a/examples/10_openssl_server/main/component.mk b/examples/protocols/openssl_server/main/component.mk similarity index 100% rename from examples/10_openssl_server/main/component.mk rename to examples/protocols/openssl_server/main/component.mk diff --git a/examples/10_openssl_server/main/openssl_server.c b/examples/protocols/openssl_server/main/openssl_server.c similarity index 100% rename from examples/10_openssl_server/main/openssl_server.c rename to examples/protocols/openssl_server/main/openssl_server.c diff --git a/examples/10_openssl_server/main/openssl_server.h b/examples/protocols/openssl_server/main/openssl_server.h similarity index 100% rename from examples/10_openssl_server/main/openssl_server.h rename to examples/protocols/openssl_server/main/openssl_server.h diff --git a/examples/10_openssl_server/main/prvtkey.pem b/examples/protocols/openssl_server/main/prvtkey.pem similarity index 100% rename from examples/10_openssl_server/main/prvtkey.pem rename to examples/protocols/openssl_server/main/prvtkey.pem diff --git a/examples/06_sntp/Makefile b/examples/protocols/sntp/Makefile similarity index 100% rename from examples/06_sntp/Makefile rename to examples/protocols/sntp/Makefile diff --git a/examples/06_sntp/README.md b/examples/protocols/sntp/README.md similarity index 100% rename from examples/06_sntp/README.md rename to examples/protocols/sntp/README.md diff --git a/examples/06_sntp/main/Kconfig.projbuild b/examples/protocols/sntp/main/Kconfig.projbuild similarity index 100% rename from examples/06_sntp/main/Kconfig.projbuild rename to examples/protocols/sntp/main/Kconfig.projbuild diff --git a/examples/25_ota/main/component.mk b/examples/protocols/sntp/main/component.mk similarity index 100% rename from examples/25_ota/main/component.mk rename to examples/protocols/sntp/main/component.mk diff --git a/examples/06_sntp/main/sntp_main.c b/examples/protocols/sntp/main/sntp_main.c similarity index 100% rename from examples/06_sntp/main/sntp_main.c rename to examples/protocols/sntp/main/sntp_main.c diff --git a/examples/08_nvs_rw_blob/Makefile b/examples/storage/nvs_rw_blob/Makefile similarity index 100% rename from examples/08_nvs_rw_blob/Makefile rename to examples/storage/nvs_rw_blob/Makefile diff --git a/examples/08_nvs_rw_blob/README.md b/examples/storage/nvs_rw_blob/README.md similarity index 100% rename from examples/08_nvs_rw_blob/README.md rename to examples/storage/nvs_rw_blob/README.md diff --git a/examples/23_coap_client/main/component.mk b/examples/storage/nvs_rw_blob/main/component.mk similarity index 100% rename from examples/23_coap_client/main/component.mk rename to examples/storage/nvs_rw_blob/main/component.mk diff --git a/examples/08_nvs_rw_blob/main/nvs_rw_blob.c b/examples/storage/nvs_rw_blob/main/nvs_rw_blob.c similarity index 100% rename from examples/08_nvs_rw_blob/main/nvs_rw_blob.c rename to examples/storage/nvs_rw_blob/main/nvs_rw_blob.c diff --git a/examples/07_nvs_rw_value/Makefile b/examples/storage/nvs_rw_value/Makefile similarity index 100% rename from examples/07_nvs_rw_value/Makefile rename to examples/storage/nvs_rw_value/Makefile diff --git a/examples/07_nvs_rw_value/README.md b/examples/storage/nvs_rw_value/README.md similarity index 100% rename from examples/07_nvs_rw_value/README.md rename to examples/storage/nvs_rw_value/README.md diff --git a/examples/24_coap_server/main/component.mk b/examples/storage/nvs_rw_value/main/component.mk similarity index 100% rename from examples/24_coap_server/main/component.mk rename to examples/storage/nvs_rw_value/main/component.mk diff --git a/examples/07_nvs_rw_value/main/nvs_rw_value.c b/examples/storage/nvs_rw_value/main/nvs_rw_value.c similarity index 100% rename from examples/07_nvs_rw_value/main/nvs_rw_value.c rename to examples/storage/nvs_rw_value/main/nvs_rw_value.c diff --git a/examples/27_sd_card/Makefile b/examples/storage/sd_card/Makefile similarity index 100% rename from examples/27_sd_card/Makefile rename to examples/storage/sd_card/Makefile diff --git a/examples/27_sd_card/README.md b/examples/storage/sd_card/README.md similarity index 100% rename from examples/27_sd_card/README.md rename to examples/storage/sd_card/README.md diff --git a/examples/27_sd_card/main/component.mk b/examples/storage/sd_card/main/component.mk similarity index 100% rename from examples/27_sd_card/main/component.mk rename to examples/storage/sd_card/main/component.mk diff --git a/examples/27_sd_card/main/sd_card.c b/examples/storage/sd_card/main/sd_card.c similarity index 100% rename from examples/27_sd_card/main/sd_card.c rename to examples/storage/sd_card/main/sd_card.c diff --git a/examples/25_ota/Makefile b/examples/system/ota/Makefile similarity index 100% rename from examples/25_ota/Makefile rename to examples/system/ota/Makefile diff --git a/examples/25_ota/OTA_workflow.png b/examples/system/ota/OTA_workflow.png similarity index 100% rename from examples/25_ota/OTA_workflow.png rename to examples/system/ota/OTA_workflow.png diff --git a/examples/25_ota/README.md b/examples/system/ota/README.md similarity index 100% rename from examples/25_ota/README.md rename to examples/system/ota/README.md diff --git a/examples/25_ota/main/Kconfig.projbuild b/examples/system/ota/main/Kconfig.projbuild similarity index 100% rename from examples/25_ota/main/Kconfig.projbuild rename to examples/system/ota/main/Kconfig.projbuild diff --git a/examples/30_mdns_example/main/component.mk b/examples/system/ota/main/component.mk similarity index 100% rename from examples/30_mdns_example/main/component.mk rename to examples/system/ota/main/component.mk diff --git a/examples/25_ota/main/ota.c b/examples/system/ota/main/ota.c similarity index 100% rename from examples/25_ota/main/ota.c rename to examples/system/ota/main/ota.c diff --git a/examples/25_ota/sdkconfig.defaults b/examples/system/ota/sdkconfig.defaults similarity index 100% rename from examples/25_ota/sdkconfig.defaults rename to examples/system/ota/sdkconfig.defaults diff --git a/examples/31_wpa2_enterprise/Makefile b/examples/wifi/wpa2_enterprise/Makefile similarity index 100% rename from examples/31_wpa2_enterprise/Makefile rename to examples/wifi/wpa2_enterprise/Makefile diff --git a/examples/31_wpa2_enterprise/README.md b/examples/wifi/wpa2_enterprise/README.md similarity index 100% rename from examples/31_wpa2_enterprise/README.md rename to examples/wifi/wpa2_enterprise/README.md diff --git a/examples/31_wpa2_enterprise/main/Kconfig.projbuild b/examples/wifi/wpa2_enterprise/main/Kconfig.projbuild similarity index 100% rename from examples/31_wpa2_enterprise/main/Kconfig.projbuild rename to examples/wifi/wpa2_enterprise/main/Kconfig.projbuild diff --git a/examples/31_wpa2_enterprise/main/component.mk b/examples/wifi/wpa2_enterprise/main/component.mk similarity index 100% rename from examples/31_wpa2_enterprise/main/component.mk rename to examples/wifi/wpa2_enterprise/main/component.mk diff --git a/examples/31_wpa2_enterprise/main/wpa2_ca.pem b/examples/wifi/wpa2_enterprise/main/wpa2_ca.pem similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_ca.pem rename to examples/wifi/wpa2_enterprise/main/wpa2_ca.pem diff --git a/examples/31_wpa2_enterprise/main/wpa2_client.crt b/examples/wifi/wpa2_enterprise/main/wpa2_client.crt similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_client.crt rename to examples/wifi/wpa2_enterprise/main/wpa2_client.crt diff --git a/examples/31_wpa2_enterprise/main/wpa2_client.key b/examples/wifi/wpa2_enterprise/main/wpa2_client.key similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_client.key rename to examples/wifi/wpa2_enterprise/main/wpa2_client.key diff --git a/examples/31_wpa2_enterprise/main/wpa2_client.pem b/examples/wifi/wpa2_enterprise/main/wpa2_client.pem similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_client.pem rename to examples/wifi/wpa2_enterprise/main/wpa2_client.pem diff --git a/examples/31_wpa2_enterprise/main/wpa2_enterprise_main.c b/examples/wifi/wpa2_enterprise/main/wpa2_enterprise_main.c similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_enterprise_main.c rename to examples/wifi/wpa2_enterprise/main/wpa2_enterprise_main.c diff --git a/examples/31_wpa2_enterprise/main/wpa2_server.crt b/examples/wifi/wpa2_enterprise/main/wpa2_server.crt similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_server.crt rename to examples/wifi/wpa2_enterprise/main/wpa2_server.crt diff --git a/examples/31_wpa2_enterprise/main/wpa2_server.key b/examples/wifi/wpa2_enterprise/main/wpa2_server.key similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_server.key rename to examples/wifi/wpa2_enterprise/main/wpa2_server.key diff --git a/examples/31_wpa2_enterprise/main/wpa2_server.pem b/examples/wifi/wpa2_enterprise/main/wpa2_server.pem similarity index 100% rename from examples/31_wpa2_enterprise/main/wpa2_server.pem rename to examples/wifi/wpa2_enterprise/main/wpa2_server.pem From f7a9a2f50b9c5ba6075c9da61b37b011de00a3f0 Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 16 Jan 2017 23:08:35 +0100 Subject: [PATCH 2/5] Modified buid_examples.sh to handle new locations of examples --- make/build_examples.sh | 52 +++++++++++++++++++++++------------------- 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/make/build_examples.sh b/make/build_examples.sh index ab59208795..e85ec26a70 100755 --- a/make/build_examples.sh +++ b/make/build_examples.sh @@ -15,34 +15,38 @@ FAILED_EXAMPLES="" RESULT_WARNINGS=22 # magic number result code for "warnings found" -for example in ${IDF_PATH}/examples/*; do - [ -f ${example}/Makefile ] || continue - echo "Building ${example} as ${EXAMPLE_NUM}..." - mkdir -p example_builds/${EXAMPLE_NUM} - cp -r ${example} example_builds/${EXAMPLE_NUM} - pushd example_builds/${EXAMPLE_NUM}/`basename ${example}` +# traverse categories +for category in ${IDF_PATH}/examples/*; do + # traverse examples within each category + for example in ${category}/*; do + [ -f ${example}/Makefile ] || continue + echo "Building ${example} as ${EXAMPLE_NUM}..." + mkdir -p example_builds/${EXAMPLE_NUM} + cp -r ${example} example_builds/${EXAMPLE_NUM} + pushd example_builds/${EXAMPLE_NUM}/`basename ${example}` - # be stricter in the CI build than the default IDF settings - export EXTRA_CFLAGS="-Werror -Werror=deprecated-declarations" - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS} + # be stricter in the CI build than the default IDF settings + export EXTRA_CFLAGS="-Werror -Werror=deprecated-declarations" + export EXTRA_CXXFLAGS=${EXTRA_CFLAGS} - # build non-verbose first - BUILDLOG=$(mktemp -t examplebuild.XXXX.log) - ( - set -o pipefail # so result of make all isn't lost when piping to tee - set -e - make clean defconfig - make $* all 2>&1 | tee $BUILDLOG - ) || { RESULT=$?; FAILED_EXAMPLES+=" ${example}"; make V=1; } # only build verbose if there's an error - popd - EXAMPLE_NUM=$(( $EXAMPLE_NUM + 1 )) + # build non-verbose first + BUILDLOG=$(mktemp -t examplebuild.XXXX.log) + ( + set -o pipefail # so result of make all isn't lost when piping to tee + set -e + make clean defconfig + make $* all 2>&1 | tee $BUILDLOG + ) || { RESULT=$?; FAILED_EXAMPLES+=" ${example}"; make V=1; } # only build verbose if there's an error + popd + EXAMPLE_NUM=$(( $EXAMPLE_NUM + 1 )) - if grep -q ": warning:" $BUILDLOG; then - [ $RESULT -eq 0 ] && RESULT=$RESULT_WARNINGS - FAILED_EXAMPLES+=" ${example} (warnings)" - fi + if grep -q ": warning:" $BUILDLOG; then + [ $RESULT -eq 0 ] && RESULT=$RESULT_WARNINGS + FAILED_EXAMPLES+=" ${example} (warnings)" + fi - rm -f $BUILDLOG + rm -f $BUILDLOG + done done if [ $RESULT -eq $RESULT_WARNINGS ]; then From 469d390d46f7f397e1434e791ef279983250885c Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 16 Jan 2017 23:08:35 +0100 Subject: [PATCH 3/5] Moved api documentation to new folders / categories --- docs/api/{ => bluetooth}/bt_common.rst | 0 docs/api/{ => bluetooth}/bt_le.rst | 0 docs/api/{ => bluetooth}/controller_vhci.rst | 0 docs/api/{ => bluetooth}/esp_blufi.rst | 0 docs/api/{ => bluetooth}/esp_bt_defs.rst | 0 docs/api/{ => bluetooth}/esp_bt_device.rst | 0 docs/api/{ => bluetooth}/esp_bt_main.rst | 0 docs/api/{ => bluetooth}/esp_gap_ble.rst | 0 docs/api/{ => bluetooth}/esp_gatt_defs.rst | 0 docs/api/{ => bluetooth}/esp_gattc.rst | 0 docs/api/{ => bluetooth}/esp_gatts.rst | 0 docs/api/{bt.rst => bluetooth/index.rst} | 7 +- docs/api/{ => ethernet}/esp_eth.rst | 0 docs/api/ethernet/index.rst | 8 ++ docs/api/{ => peripherals}/gpio.rst | 0 docs/api/{ => peripherals}/i2c.rst | 0 docs/api/peripherals/index.rst | 16 +++ docs/api/{ => peripherals}/ledc.rst | 0 docs/api/{ => peripherals}/pcnt.rst | 0 docs/api/{ => peripherals}/rmt.rst | 0 docs/api/{ => peripherals}/sigmadelta.rst | 0 docs/api/{ => peripherals}/spi_master.rst | 0 docs/api/{ => peripherals}/timer.rst | 0 docs/api/{ => peripherals}/uart.rst | 0 docs/api/protocols/index.rst | 8 ++ docs/api/{ => protocols}/mdns.rst | 0 docs/api/{ => storage}/fatfs.rst | 0 docs/api/storage/index.rst | 12 ++ docs/api/{ => storage}/nvs_flash.rst | 0 docs/api/{ => storage}/sdmmc.rst | 0 docs/api/{ => storage}/spi_flash.rst | 0 docs/api/{ => storage}/vfs.rst | 0 docs/api/{ => system}/deep_sleep.rst | 0 docs/api/system/index.rst | 13 ++ docs/api/{ => system}/intr_alloc.rst | 0 docs/api/{ => system}/log.rst | 0 docs/api/{ => system}/mem_alloc.rst | 0 docs/api/{ => system}/ota.rst | 0 docs/api/{ => system}/wdts.rst | 0 docs/api/{ => wifi}/esp_smartconfig.rst | 0 docs/api/{ => wifi}/esp_wifi.rst | 0 docs/api/wifi/index.rst | 8 ++ docs/index.rst | 127 ++++--------------- docs/{api => }/ulp.rst | 0 44 files changed, 96 insertions(+), 103 deletions(-) rename docs/api/{ => bluetooth}/bt_common.rst (100%) rename docs/api/{ => bluetooth}/bt_le.rst (100%) rename docs/api/{ => bluetooth}/controller_vhci.rst (100%) rename docs/api/{ => bluetooth}/esp_blufi.rst (100%) rename docs/api/{ => bluetooth}/esp_bt_defs.rst (100%) rename docs/api/{ => bluetooth}/esp_bt_device.rst (100%) rename docs/api/{ => bluetooth}/esp_bt_main.rst (100%) rename docs/api/{ => bluetooth}/esp_gap_ble.rst (100%) rename docs/api/{ => bluetooth}/esp_gatt_defs.rst (100%) rename docs/api/{ => bluetooth}/esp_gattc.rst (100%) rename docs/api/{ => bluetooth}/esp_gatts.rst (100%) rename docs/api/{bt.rst => bluetooth/index.rst} (71%) rename docs/api/{ => ethernet}/esp_eth.rst (100%) create mode 100644 docs/api/ethernet/index.rst rename docs/api/{ => peripherals}/gpio.rst (100%) rename docs/api/{ => peripherals}/i2c.rst (100%) create mode 100644 docs/api/peripherals/index.rst rename docs/api/{ => peripherals}/ledc.rst (100%) rename docs/api/{ => peripherals}/pcnt.rst (100%) rename docs/api/{ => peripherals}/rmt.rst (100%) rename docs/api/{ => peripherals}/sigmadelta.rst (100%) rename docs/api/{ => peripherals}/spi_master.rst (100%) rename docs/api/{ => peripherals}/timer.rst (100%) rename docs/api/{ => peripherals}/uart.rst (100%) create mode 100644 docs/api/protocols/index.rst rename docs/api/{ => protocols}/mdns.rst (100%) rename docs/api/{ => storage}/fatfs.rst (100%) create mode 100644 docs/api/storage/index.rst rename docs/api/{ => storage}/nvs_flash.rst (100%) rename docs/api/{ => storage}/sdmmc.rst (100%) rename docs/api/{ => storage}/spi_flash.rst (100%) rename docs/api/{ => storage}/vfs.rst (100%) rename docs/api/{ => system}/deep_sleep.rst (100%) create mode 100644 docs/api/system/index.rst rename docs/api/{ => system}/intr_alloc.rst (100%) rename docs/api/{ => system}/log.rst (100%) rename docs/api/{ => system}/mem_alloc.rst (100%) rename docs/api/{ => system}/ota.rst (100%) rename docs/api/{ => system}/wdts.rst (100%) rename docs/api/{ => wifi}/esp_smartconfig.rst (100%) rename docs/api/{ => wifi}/esp_wifi.rst (100%) create mode 100644 docs/api/wifi/index.rst rename docs/{api => }/ulp.rst (100%) diff --git a/docs/api/bt_common.rst b/docs/api/bluetooth/bt_common.rst similarity index 100% rename from docs/api/bt_common.rst rename to docs/api/bluetooth/bt_common.rst diff --git a/docs/api/bt_le.rst b/docs/api/bluetooth/bt_le.rst similarity index 100% rename from docs/api/bt_le.rst rename to docs/api/bluetooth/bt_le.rst diff --git a/docs/api/controller_vhci.rst b/docs/api/bluetooth/controller_vhci.rst similarity index 100% rename from docs/api/controller_vhci.rst rename to docs/api/bluetooth/controller_vhci.rst diff --git a/docs/api/esp_blufi.rst b/docs/api/bluetooth/esp_blufi.rst similarity index 100% rename from docs/api/esp_blufi.rst rename to docs/api/bluetooth/esp_blufi.rst diff --git a/docs/api/esp_bt_defs.rst b/docs/api/bluetooth/esp_bt_defs.rst similarity index 100% rename from docs/api/esp_bt_defs.rst rename to docs/api/bluetooth/esp_bt_defs.rst diff --git a/docs/api/esp_bt_device.rst b/docs/api/bluetooth/esp_bt_device.rst similarity index 100% rename from docs/api/esp_bt_device.rst rename to docs/api/bluetooth/esp_bt_device.rst diff --git a/docs/api/esp_bt_main.rst b/docs/api/bluetooth/esp_bt_main.rst similarity index 100% rename from docs/api/esp_bt_main.rst rename to docs/api/bluetooth/esp_bt_main.rst diff --git a/docs/api/esp_gap_ble.rst b/docs/api/bluetooth/esp_gap_ble.rst similarity index 100% rename from docs/api/esp_gap_ble.rst rename to docs/api/bluetooth/esp_gap_ble.rst diff --git a/docs/api/esp_gatt_defs.rst b/docs/api/bluetooth/esp_gatt_defs.rst similarity index 100% rename from docs/api/esp_gatt_defs.rst rename to docs/api/bluetooth/esp_gatt_defs.rst diff --git a/docs/api/esp_gattc.rst b/docs/api/bluetooth/esp_gattc.rst similarity index 100% rename from docs/api/esp_gattc.rst rename to docs/api/bluetooth/esp_gattc.rst diff --git a/docs/api/esp_gatts.rst b/docs/api/bluetooth/esp_gatts.rst similarity index 100% rename from docs/api/esp_gatts.rst rename to docs/api/bluetooth/esp_gatts.rst diff --git a/docs/api/bt.rst b/docs/api/bluetooth/index.rst similarity index 71% rename from docs/api/bt.rst rename to docs/api/bluetooth/index.rst index 2eae5dd4cf..fffe674425 100644 --- a/docs/api/bt.rst +++ b/docs/api/bluetooth/index.rst @@ -1,9 +1,10 @@ -Bluetooth -========= +Bluetooth API +************* .. toctree:: - :caption: Bluetooth APIs + :maxdepth: 2 Bluetooth Controller && VHCI Bluetooth Common Bluetooth LE + diff --git a/docs/api/esp_eth.rst b/docs/api/ethernet/esp_eth.rst similarity index 100% rename from docs/api/esp_eth.rst rename to docs/api/ethernet/esp_eth.rst diff --git a/docs/api/ethernet/index.rst b/docs/api/ethernet/index.rst new file mode 100644 index 0000000000..aeb0137c5e --- /dev/null +++ b/docs/api/ethernet/index.rst @@ -0,0 +1,8 @@ +Ethernet API +************ + +.. toctree:: + :maxdepth: 1 + + Ethernet + diff --git a/docs/api/gpio.rst b/docs/api/peripherals/gpio.rst similarity index 100% rename from docs/api/gpio.rst rename to docs/api/peripherals/gpio.rst diff --git a/docs/api/i2c.rst b/docs/api/peripherals/i2c.rst similarity index 100% rename from docs/api/i2c.rst rename to docs/api/peripherals/i2c.rst diff --git a/docs/api/peripherals/index.rst b/docs/api/peripherals/index.rst new file mode 100644 index 0000000000..9ea0c41ab6 --- /dev/null +++ b/docs/api/peripherals/index.rst @@ -0,0 +1,16 @@ +Peripherals API +*************** + +.. toctree:: + :maxdepth: 1 + + GPIO + UART + I2C + SPI Master + Timer + Pulse Counter + Sigma-delta Modulation + LED Control + Remote Control + diff --git a/docs/api/ledc.rst b/docs/api/peripherals/ledc.rst similarity index 100% rename from docs/api/ledc.rst rename to docs/api/peripherals/ledc.rst diff --git a/docs/api/pcnt.rst b/docs/api/peripherals/pcnt.rst similarity index 100% rename from docs/api/pcnt.rst rename to docs/api/peripherals/pcnt.rst diff --git a/docs/api/rmt.rst b/docs/api/peripherals/rmt.rst similarity index 100% rename from docs/api/rmt.rst rename to docs/api/peripherals/rmt.rst diff --git a/docs/api/sigmadelta.rst b/docs/api/peripherals/sigmadelta.rst similarity index 100% rename from docs/api/sigmadelta.rst rename to docs/api/peripherals/sigmadelta.rst diff --git a/docs/api/spi_master.rst b/docs/api/peripherals/spi_master.rst similarity index 100% rename from docs/api/spi_master.rst rename to docs/api/peripherals/spi_master.rst diff --git a/docs/api/timer.rst b/docs/api/peripherals/timer.rst similarity index 100% rename from docs/api/timer.rst rename to docs/api/peripherals/timer.rst diff --git a/docs/api/uart.rst b/docs/api/peripherals/uart.rst similarity index 100% rename from docs/api/uart.rst rename to docs/api/peripherals/uart.rst diff --git a/docs/api/protocols/index.rst b/docs/api/protocols/index.rst new file mode 100644 index 0000000000..632bd141dc --- /dev/null +++ b/docs/api/protocols/index.rst @@ -0,0 +1,8 @@ +Protocols API +************* + +.. toctree:: + :maxdepth: 1 + + mDNS + diff --git a/docs/api/mdns.rst b/docs/api/protocols/mdns.rst similarity index 100% rename from docs/api/mdns.rst rename to docs/api/protocols/mdns.rst diff --git a/docs/api/fatfs.rst b/docs/api/storage/fatfs.rst similarity index 100% rename from docs/api/fatfs.rst rename to docs/api/storage/fatfs.rst diff --git a/docs/api/storage/index.rst b/docs/api/storage/index.rst new file mode 100644 index 0000000000..30fb2088c7 --- /dev/null +++ b/docs/api/storage/index.rst @@ -0,0 +1,12 @@ +Storage API +*********** + +.. toctree:: + :maxdepth: 1 + + SPI Flash and Partition APIs + SD/MMC + Non-Volatile Storage + Virtual Filesystem + FAT Filesystem + diff --git a/docs/api/nvs_flash.rst b/docs/api/storage/nvs_flash.rst similarity index 100% rename from docs/api/nvs_flash.rst rename to docs/api/storage/nvs_flash.rst diff --git a/docs/api/sdmmc.rst b/docs/api/storage/sdmmc.rst similarity index 100% rename from docs/api/sdmmc.rst rename to docs/api/storage/sdmmc.rst diff --git a/docs/api/spi_flash.rst b/docs/api/storage/spi_flash.rst similarity index 100% rename from docs/api/spi_flash.rst rename to docs/api/storage/spi_flash.rst diff --git a/docs/api/vfs.rst b/docs/api/storage/vfs.rst similarity index 100% rename from docs/api/vfs.rst rename to docs/api/storage/vfs.rst diff --git a/docs/api/deep_sleep.rst b/docs/api/system/deep_sleep.rst similarity index 100% rename from docs/api/deep_sleep.rst rename to docs/api/system/deep_sleep.rst diff --git a/docs/api/system/index.rst b/docs/api/system/index.rst new file mode 100644 index 0000000000..6bbd7c10c5 --- /dev/null +++ b/docs/api/system/index.rst @@ -0,0 +1,13 @@ +System API +********** + +.. toctree:: + :maxdepth: 1 + + Memory Allocation + Interrupt Allocation + Watchdogs + OTA + Deep Sleep + Logging + diff --git a/docs/api/intr_alloc.rst b/docs/api/system/intr_alloc.rst similarity index 100% rename from docs/api/intr_alloc.rst rename to docs/api/system/intr_alloc.rst diff --git a/docs/api/log.rst b/docs/api/system/log.rst similarity index 100% rename from docs/api/log.rst rename to docs/api/system/log.rst diff --git a/docs/api/mem_alloc.rst b/docs/api/system/mem_alloc.rst similarity index 100% rename from docs/api/mem_alloc.rst rename to docs/api/system/mem_alloc.rst diff --git a/docs/api/ota.rst b/docs/api/system/ota.rst similarity index 100% rename from docs/api/ota.rst rename to docs/api/system/ota.rst diff --git a/docs/api/wdts.rst b/docs/api/system/wdts.rst similarity index 100% rename from docs/api/wdts.rst rename to docs/api/system/wdts.rst diff --git a/docs/api/esp_smartconfig.rst b/docs/api/wifi/esp_smartconfig.rst similarity index 100% rename from docs/api/esp_smartconfig.rst rename to docs/api/wifi/esp_smartconfig.rst diff --git a/docs/api/esp_wifi.rst b/docs/api/wifi/esp_wifi.rst similarity index 100% rename from docs/api/esp_wifi.rst rename to docs/api/wifi/esp_wifi.rst diff --git a/docs/api/wifi/index.rst b/docs/api/wifi/index.rst new file mode 100644 index 0000000000..2abe2b2fff --- /dev/null +++ b/docs/api/wifi/index.rst @@ -0,0 +1,8 @@ +Wi-Fi API +********* + +.. toctree:: + :maxdepth: 1 + + Wi-Fi + Smart Config diff --git a/docs/index.rst b/docs/index.rst index eafe102447..d1072b6511 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,118 +26,46 @@ Contents: .. toctree:: :caption: What Else? :maxdepth: 1 - - General Notes - partition-tables - build_system - openocd - core_dump - Flash encryption - Secure Boot - ULP coprocessor -.. API Reference - .. - Table of Contents Outline - .. - 1. System - TBA - 1.1. Fundamentals of multiprocessor programming with FreeRTOS - TBA - 1.2. Application startup flow - TBA - 1.3. Flash encryption and secure boot: how they work and APIs - 1.4. Lower Power Coprocessor - TBA - 1.5. Watchdogs - 1.6. Memory allocation - 1.7. ... - 2. Memory - TBA - 2.1. Memory layout of the application (IRAM/IROM, limitations of each) - TBA - 2.2. Flash layout and partitions - TBA - 2.3. Flash access APIs - TBA - 2.4. Partition APIs - TBA - 2.5. OTA mechanism (app partitions, OTA partition) and APIs - TBA - 2.6. ... - 3. Wi-Fi - 4. Bluetooth - 4.1. BT Classic - TBA - 4.2. BLE - 5. Ethernet - TBA - 6. Interfaces - 6.1. GPIO - 6.2. ADC - TBA - 6.3. DAC - TBA - 6.4. UART - 6.5. I2C - TBA - 6.6. I2S - TBA - 6.7. SPI - - 6.8. CAN - TBA - 6.9. SD Controller - TBA - 6.10. Infrared - TBA - 6.11. Pulse Counter - TBA - 6.12. PWM - TBA - 6.13. LED PWM - 6.14. ... - 7. Sensors - TBA - 7.1. Hall Sensor - TBA - 7.2. Temperature Sensor - TBA - 7.3. Touch Sensor - TBA - 8. Protocols - TBA - 9. Components - 9.1. Logging - 9.2 Non-Volatile Storage - 9.3 Virtual Filesystem - 9.3. Http sever - TBA - 10. Applications - TBA - .. - API Dcoumentation Teamplate - .. + General Notes + Build System + Debugging + ESP32 Core Dump + Partition Tables + Flash Encryption + Secure Boot + Deep Sleep Wake Stubs + ULP Coprocessor .. toctree:: :caption: API Reference - :maxdepth: 1 + :maxdepth: 2 - Wi-Fi - Smart Config - Bluetooth - Watchdogs - OTA - GPIO - UART - LED Control - Remote Control - Timer - I2C - Pulse Counter - Sigma-delta Modulation - SD/MMC - SPI Flash and Partition APIs - SPI Master API - Logging - Non-Volatile Storage - Virtual Filesystem - FAT Filesystem - Ethernet - Interrupt Allocation - Memory Allocation - Deep Sleep - deep-sleep-stub - - mDNS - Template + Wi-Fi + Bluetooth + Ethernet + Peripherals + System + Storage + Protocols .. toctree:: - :caption: Technical Reference + :caption: Hardware Reference - Technical Reference - -.. Resources - TBA + Technical Reference Manual + Pin List and Functions + Chip Pinout + Silicon Errata .. toctree:: :caption: Contribute :maxdepth: 1 - contributing + Contributions Guide Style Guide - documenting-code - contributor-agreement + Documenting Code + API Template + Contributor Agreement .. toctree:: :caption: Legal @@ -147,8 +75,7 @@ Contents: Indices -------- +======= * :ref:`genindex` -* :ref:`search` diff --git a/docs/api/ulp.rst b/docs/ulp.rst similarity index 100% rename from docs/api/ulp.rst rename to docs/ulp.rst From 47a0b88f6e4498ce70f8aa0482289f8987338d33 Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 16 Jan 2017 23:08:35 +0100 Subject: [PATCH 4/5] Updated relative paths to included documents --- docs/api/storage/nvs_flash.rst | 6 +++--- docs/api/storage/spi_flash.rst | 4 ++-- docs/api/storage/vfs.rst | 6 ++++-- docs/api/system/log.rst | 8 +++----- docs/ulp.rst | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/storage/nvs_flash.rst b/docs/api/storage/nvs_flash.rst index e2ac34ada8..00094d8697 100644 --- a/docs/api/storage/nvs_flash.rst +++ b/docs/api/storage/nvs_flash.rst @@ -1,11 +1,11 @@ -.. include:: ../../components/nvs_flash/README.rst +.. include:: ../../../components/nvs_flash/README.rst Application Example ------------------- Two examples are provided in ESP-IDF examples directory: -`07_nvs_rw_value `_ +`storage/nvs_rw_value `_ Demonstrates how to read and write a single integer value using NVS. @@ -13,7 +13,7 @@ Two examples are provided in ESP-IDF examples directory: Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way. -`08_nvs_rw_blob `_ +`storage/nvs_rw_blob `_ Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts. diff --git a/docs/api/storage/spi_flash.rst b/docs/api/storage/spi_flash.rst index 5903c0902d..209b413779 100644 --- a/docs/api/storage/spi_flash.rst +++ b/docs/api/storage/spi_flash.rst @@ -1,11 +1,11 @@ -.. include:: ../../components/spi_flash/README.rst +.. include:: ../../../components/spi_flash/README.rst Application Example ------------------- `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference ------------- diff --git a/docs/api/storage/vfs.rst b/docs/api/storage/vfs.rst index 71550f111c..d4e5d24ab7 100644 --- a/docs/api/storage/vfs.rst +++ b/docs/api/storage/vfs.rst @@ -1,9 +1,11 @@ -.. include:: ../../components/vfs/README.rst +.. include:: ../../../components/vfs/README.rst Application Example ------------------- -`Instructions `_ +`Instructions`_ + +.. _Instructions: ../template.html API Reference ------------- diff --git a/docs/api/system/log.rst b/docs/api/system/log.rst index d2f2fcd073..d812740bb2 100644 --- a/docs/api/system/log.rst +++ b/docs/api/system/log.rst @@ -1,17 +1,15 @@ -.. include:: ../../components/log/README.rst +.. include:: ../../../components/log/README.rst Application Example ------------------- `Instructions`_ +.. _Instructions: ../template.html + API Reference ------------- -`Instructions`_ - -.. _Instructions: template.html - Header Files ^^^^^^^^^^^^ diff --git a/docs/ulp.rst b/docs/ulp.rst index 9db42e633e..4ee6ed7a2f 100644 --- a/docs/ulp.rst +++ b/docs/ulp.rst @@ -1 +1 @@ -.. include:: ../../components/ulp/README.rst +.. include:: ../components/ulp/README.rst From ad25997349b2b513dc8b2ab2513b7072b83a2087 Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Mon, 16 Jan 2017 23:08:36 +0100 Subject: [PATCH 5/5] Updated links to examples in new folders / categories in api documentation --- docs/api/bluetooth/controller_vhci.rst | 4 ++-- docs/api/bluetooth/esp_blufi.rst | 2 +- docs/api/bluetooth/esp_bt_defs.rst | 2 +- docs/api/bluetooth/esp_bt_device.rst | 2 +- docs/api/bluetooth/esp_bt_main.rst | 2 +- docs/api/bluetooth/esp_gap_ble.rst | 6 +++--- docs/api/bluetooth/esp_gatt_defs.rst | 2 +- docs/api/bluetooth/esp_gattc.rst | 4 ++-- docs/api/bluetooth/esp_gatts.rst | 4 ++-- docs/api/ethernet/esp_eth.rst | 2 +- docs/api/peripherals/gpio.rst | 2 +- docs/api/peripherals/i2c.rst | 2 +- docs/api/peripherals/ledc.rst | 2 +- docs/api/peripherals/pcnt.rst | 2 +- docs/api/peripherals/rmt.rst | 2 +- docs/api/peripherals/timer.rst | 2 +- docs/api/peripherals/uart.rst | 2 +- docs/api/protocols/mdns.rst | 2 +- docs/api/storage/sdmmc.rst | 2 +- docs/api/wifi/esp_wifi.rst | 2 +- docs/build_system.rst | 2 +- examples/storage/nvs_rw_blob/README.md | 2 +- examples/storage/nvs_rw_value/README.md | 2 +- examples/system/ota/README.md | 4 ++-- 24 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/api/bluetooth/controller_vhci.rst b/docs/api/bluetooth/controller_vhci.rst index a9c1a79289..3868d9cec7 100644 --- a/docs/api/bluetooth/controller_vhci.rst +++ b/docs/api/bluetooth/controller_vhci.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`05_ble_adv `_ +`bluetooth/ble_adv `_ This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference ------------- diff --git a/docs/api/bluetooth/esp_blufi.rst b/docs/api/bluetooth/esp_blufi.rst index 13432dc154..a281c3d3d6 100644 --- a/docs/api/bluetooth/esp_blufi.rst +++ b/docs/api/bluetooth/esp_blufi.rst @@ -13,7 +13,7 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`12_blufi `_ +`bluetooth/blufi `_ This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections. diff --git a/docs/api/bluetooth/esp_bt_defs.rst b/docs/api/bluetooth/esp_bt_defs.rst index 801b13df78..217dfb7620 100644 --- a/docs/api/bluetooth/esp_bt_defs.rst +++ b/docs/api/bluetooth/esp_bt_defs.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_bt_device.rst b/docs/api/bluetooth/esp_bt_device.rst index c344a5e633..79c2e9c9bf 100644 --- a/docs/api/bluetooth/esp_bt_device.rst +++ b/docs/api/bluetooth/esp_bt_device.rst @@ -13,7 +13,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_bt_main.rst b/docs/api/bluetooth/esp_bt_main.rst index 48bb0c9cc0..f44dc7eebc 100644 --- a/docs/api/bluetooth/esp_bt_main.rst +++ b/docs/api/bluetooth/esp_bt_main.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gap_ble.rst b/docs/api/bluetooth/esp_gap_ble.rst index 856ed27302..088ab27dba 100644 --- a/docs/api/bluetooth/esp_gap_ble.rst +++ b/docs/api/bluetooth/esp_gap_ble.rst @@ -11,14 +11,14 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`14_gatts_demo `_ -`15_gattc_demo `_ +`14_gatts_demo `_ +`15_gattc_demo `_ The two demos use different gap api, such like advertising, scan, set device name and others. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gatt_defs.rst b/docs/api/bluetooth/esp_gatt_defs.rst index 70e808a5d7..621c6d95e1 100644 --- a/docs/api/bluetooth/esp_gatt_defs.rst +++ b/docs/api/bluetooth/esp_gatt_defs.rst @@ -11,7 +11,7 @@ Application Example `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gattc.rst b/docs/api/bluetooth/esp_gattc.rst index 7ff1e9de7e..eada883fd7 100644 --- a/docs/api/bluetooth/esp_gattc.rst +++ b/docs/api/bluetooth/esp_gattc.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`15_gattc_demo `_ +`15_gattc_demo `_ This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/bluetooth/esp_gatts.rst b/docs/api/bluetooth/esp_gatts.rst index 4278e6b33e..877840402c 100644 --- a/docs/api/bluetooth/esp_gatts.rst +++ b/docs/api/bluetooth/esp_gatts.rst @@ -11,13 +11,13 @@ Application Example Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: -`14_gatts_demo `_ +`14_gatts_demo `_ This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery. `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html API Reference diff --git a/docs/api/ethernet/esp_eth.rst b/docs/api/ethernet/esp_eth.rst index 371aa5b233..5702389af8 100644 --- a/docs/api/ethernet/esp_eth.rst +++ b/docs/api/ethernet/esp_eth.rst @@ -4,7 +4,7 @@ ETHERNET Application Example ------------------- -ethernet example: `examples/17_ethernet `_. +ethernet example: `examples/ethernet/ethernet `_. API Reference ------------- diff --git a/docs/api/peripherals/gpio.rst b/docs/api/peripherals/gpio.rst index f331b9d265..643eac1f4d 100644 --- a/docs/api/peripherals/gpio.rst +++ b/docs/api/peripherals/gpio.rst @@ -10,7 +10,7 @@ Note that GPIO6-11 are usually used for SPI flash. GPIO34-39 can only be set as Application Example ------------------- -GPIO output and input interrupt example: `examples/21_gpio `_. +GPIO output and input interrupt example: `examples/peripherals/gpio `_. API Reference ------------- diff --git a/docs/api/peripherals/i2c.rst b/docs/api/peripherals/i2c.rst index 2f89681f1d..93d863da6b 100644 --- a/docs/api/peripherals/i2c.rst +++ b/docs/api/peripherals/i2c.rst @@ -9,7 +9,7 @@ ESP32 has two I2C controllers which can be set as master mode or slave mode. Application Example ------------------- -I2C master and slave example: `examples/18_i2c `_. +I2C master and slave example: `examples/peripherals/i2c `_. API Reference ------------- diff --git a/docs/api/peripherals/ledc.rst b/docs/api/peripherals/ledc.rst index 12d7cd16d0..8c55e2413b 100644 --- a/docs/api/peripherals/ledc.rst +++ b/docs/api/peripherals/ledc.rst @@ -12,7 +12,7 @@ decrease the duty cycle gradually, allowing for fades without any processor inte Application Example ------------------- -LEDC change duty cycle and fading control example: `examples/29_ledc `_. +LEDC change duty cycle and fading control example: `examples/peripherals/ledc `_. API Reference ------------- diff --git a/docs/api/peripherals/pcnt.rst b/docs/api/peripherals/pcnt.rst index 7fe73e6f47..bf4fcd0406 100644 --- a/docs/api/peripherals/pcnt.rst +++ b/docs/api/peripherals/pcnt.rst @@ -9,7 +9,7 @@ The PCNT (Pulse Counter) module is designed to count the number of rising and/or Application Example ------------------- -Pulse counter with control signal and event interrupt example: `examples/16_pcnt `_. +Pulse counter with control signal and event interrupt example: `examples/peripherals/pcnt `_. API Reference ------------- diff --git a/docs/api/peripherals/rmt.rst b/docs/api/peripherals/rmt.rst index 9d834b1e28..715bc46786 100644 --- a/docs/api/peripherals/rmt.rst +++ b/docs/api/peripherals/rmt.rst @@ -9,7 +9,7 @@ The RMT (Remote Control) module driver can be used to send and receive infrared Application Example ------------------- -NEC remote control TX and RX example: `examples/11_rmt_nec_tx_rx `_. +NEC remote control TX and RX example: `examples/peripherals/rmt_nec_tx_rx `_. API Reference ------------- diff --git a/docs/api/peripherals/timer.rst b/docs/api/peripherals/timer.rst index 0db0a12c23..203c6b0d30 100644 --- a/docs/api/peripherals/timer.rst +++ b/docs/api/peripherals/timer.rst @@ -12,7 +12,7 @@ They are all 64-bit generic timers based on 16-bit prescalers and 64-bit auto-re Application Example ------------------- -64-bit hardware timer example: `examples/13_timer_group `_. +64-bit hardware timer example: `examples/peripherals/timer_group `_. API Reference ------------- diff --git a/docs/api/peripherals/uart.rst b/docs/api/peripherals/uart.rst index fa83309e2a..8684b2afa3 100644 --- a/docs/api/peripherals/uart.rst +++ b/docs/api/peripherals/uart.rst @@ -16,7 +16,7 @@ API Reference `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html Header Files ^^^^^^^^^^^^ diff --git a/docs/api/protocols/mdns.rst b/docs/api/protocols/mdns.rst index 95789444f5..d674e25a08 100644 --- a/docs/api/protocols/mdns.rst +++ b/docs/api/protocols/mdns.rst @@ -163,7 +163,7 @@ Example of using the methods above: Application Example ------------------- -mDNS server/scanner example: `examples/30_mdns_example `_. +mDNS server/scanner example: `examples/protocols/mdsn `_. API Reference ------------- diff --git a/docs/api/storage/sdmmc.rst b/docs/api/storage/sdmmc.rst index e751852f95..fe2e5c27f8 100644 --- a/docs/api/storage/sdmmc.rst +++ b/docs/api/storage/sdmmc.rst @@ -15,7 +15,7 @@ Protocol layer works with the host via ``sdmmc_host_t`` structure. This structur Application Example ------------------- -An example which combines SDMMC driver with FATFS library is provided in ``examples/27_sd_card`` directory. This example initializes the card, writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information. +An example which combines SDMMC driver with FATFS library is provided in ``examples/storage/sd_card`` directory. This example initializes the card, writes and reads data from it using POSIX and C library APIs. See README.md file in the example directory for more information. Protocol layer APIs diff --git a/docs/api/wifi/esp_wifi.rst b/docs/api/wifi/esp_wifi.rst index c13d3d751a..1fe832a2c5 100644 --- a/docs/api/wifi/esp_wifi.rst +++ b/docs/api/wifi/esp_wifi.rst @@ -16,7 +16,7 @@ API Reference `Instructions`_ -.. _Instructions: template.html +.. _Instructions: ../template.html Header Files ^^^^^^^^^^^^ diff --git a/docs/build_system.rst b/docs/build_system.rst index 7a33a41256..d4353287b9 100644 --- a/docs/build_system.rst +++ b/docs/build_system.rst @@ -464,7 +464,7 @@ The file's contents will be added to the .rodata section in flash, and are avail The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files. -For an example of using this technique, see examples/04_https_request - the certificate file contents are loaded from the text .pem file at compile time. +For an example of using this technique, see examples/protocols/https_request - the certificate file contents are loaded from the text .pem file at compile time. Fully Overriding The Component Makefile diff --git a/examples/storage/nvs_rw_blob/README.md b/examples/storage/nvs_rw_blob/README.md index 81a0e36c71..94b8549b36 100644 --- a/examples/storage/nvs_rw_blob/README.md +++ b/examples/storage/nvs_rw_blob/README.md @@ -7,7 +7,7 @@ Demonstrates how to read and write a single integer value and a blob (binary lar Example also shows how to implement diagnostics if read / write operation was successful. -If not done already, consider checking simpler example *07_nvs_rw_value*, that has been used as a starting point for preparing this one. +If not done already, consider checking simpler example *storage/nvs_rw_value*, that has been used as a starting point for preparing this one. Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html). diff --git a/examples/storage/nvs_rw_value/README.md b/examples/storage/nvs_rw_value/README.md index 09cd364e8d..797e8d422a 100644 --- a/examples/storage/nvs_rw_value/README.md +++ b/examples/storage/nvs_rw_value/README.md @@ -6,7 +6,7 @@ The value holds the number of ESP32 module restarts. Since it is written to NVS, Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way. -Check another example *08_nvs_rw_blob*, that shows how to read and write variable length binary data (blob). +Check another example *storage/nvs_rw_blob*, that shows how to read and write variable length binary data (blob). Detailed functional description of NVS and API is provided in [documentation](http://esp-idf.readthedocs.io/en/latest/api/nvs_flash.html). diff --git a/examples/system/ota/README.md b/examples/system/ota/README.md index 49a47d3799..886dbf5fbb 100644 --- a/examples/system/ota/README.md +++ b/examples/system/ota/README.md @@ -30,12 +30,12 @@ Connect your host PC to the same AP that you will use for the ESP32. Python has a built-in HTTP server that can be used for example purposes. -For our upgrade example OTA file, we're going to use the `01_hello_world` example. +For our upgrade example OTA file, we're going to use the `get-started/hello_world` example. Open a new terminal to run the HTTP server, then run these commands to build the example and start the server: ``` -cd $IDF_PATH/examples/01_hello_world +cd $IDF_PATH/examples/get-started/hello_world make cd build python -m SimpleHTTPServer 8070