diff --git a/components/adrc/idf_component.yml b/components/adrc/idf_component.yml index f307a7368..20e503700 100755 --- a/components/adrc/idf_component.yml +++ b/components/adrc/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/adrc" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/adrc.html" +documentation: "https://esp-cpp.github.io/espp/motor_control/adrc.html" examples: - path: example tags: diff --git a/components/base_component/idf_component.yml b/components/base_component/idf_component.yml index 96a365e93..710699ca6 100644 --- a/components/base_component/idf_component.yml +++ b/components/base_component/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/base_component" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/base_component.html" +documentation: "https://esp-cpp.github.io/espp/core/base_component.html" tags: - cpp - Component diff --git a/components/base_peripheral/idf_component.yml b/components/base_peripheral/idf_component.yml index e5fa0e2fd..5d37e0692 100644 --- a/components/base_peripheral/idf_component.yml +++ b/components/base_peripheral/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/base_peripheral" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/base_peripheral.html" +documentation: "https://esp-cpp.github.io/espp/core/base_peripheral.html" tags: - cpp - Component diff --git a/components/binary-log/idf_component.yml b/components/binary-log/idf_component.yml index ed81965ca..cdb24fb72 100644 --- a/components/binary-log/idf_component.yml +++ b/components/binary-log/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/binary-log" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/logger.html#binary-log" +documentation: "https://esp-cpp.github.io/espp/core/logger.html#binary-log" examples: - path: example tags: diff --git a/components/button/idf_component.yml b/components/button/idf_component.yml index a83a5892f..4c8dd21bc 100644 --- a/components/button/idf_component.yml +++ b/components/button/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/button" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/button.html" +documentation: "https://esp-cpp.github.io/espp/input/button.html" examples: - path: example tags: diff --git a/components/byte90/idf_component.yml b/components/byte90/idf_component.yml index 9397a3369..58b64c7b7 100644 --- a/components/byte90/idf_component.yml +++ b/components/byte90/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/byte90" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/byte90.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/other/byte90.html" examples: - path: example tags: diff --git a/components/cdr/idf_component.yml b/components/cdr/idf_component.yml index 92d805db4..d467f553f 100644 --- a/components/cdr/idf_component.yml +++ b/components/cdr/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/cdr" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/cdr.html" +documentation: "https://esp-cpp.github.io/espp/data/cdr.html" examples: - path: example tags: diff --git a/components/cli/idf_component.yml b/components/cli/idf_component.yml index 67cfbccfd..8d50f422d 100644 --- a/components/cli/idf_component.yml +++ b/components/cli/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/cli" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/cli.html" +documentation: "https://esp-cpp.github.io/espp/core/cli.html" examples: - path: example tags: diff --git a/components/cobs/idf_component.yml b/components/cobs/idf_component.yml index 9ff8c10f0..6c04ff415 100644 --- a/components/cobs/idf_component.yml +++ b/components/cobs/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/cobs" repository: "git://github.com/esp-cpp/espp.git" maintainers: - Sam Boegli -documentation: "https://esp-cpp.github.io/espp/cobs.html" +documentation: "https://esp-cpp.github.io/espp/data/cobs.html" examples: - path: example tags: diff --git a/components/color/idf_component.yml b/components/color/idf_component.yml index d142484bd..67993f86f 100644 --- a/components/color/idf_component.yml +++ b/components/color/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/color" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/color.html" +documentation: "https://esp-cpp.github.io/espp/math/color.html" examples: - path: example tags: diff --git a/components/controller/idf_component.yml b/components/controller/idf_component.yml index 6ab0e71c6..8dfae7287 100644 --- a/components/controller/idf_component.yml +++ b/components/controller/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/controller" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/controller.html" +documentation: "https://esp-cpp.github.io/espp/input/controller.html" examples: - path: example tags: diff --git a/components/csv/idf_component.yml b/components/csv/idf_component.yml index e5c2adf7d..ab08563e8 100644 --- a/components/csv/idf_component.yml +++ b/components/csv/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/csv" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/csv.html" +documentation: "https://esp-cpp.github.io/espp/data/csv.html" examples: - path: example tags: diff --git a/components/esp-box/idf_component.yml b/components/esp-box/idf_component.yml index d971f8f49..13df2a6f1 100644 --- a/components/esp-box/idf_component.yml +++ b/components/esp-box/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/esp-box" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/esp_box.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/espressif/esp_box.html" examples: - path: example tags: diff --git a/components/esp32-p4-function-ev-board/idf_component.yml b/components/esp32-p4-function-ev-board/idf_component.yml index 70af2f282..6a298cbde 100644 --- a/components/esp32-p4-function-ev-board/idf_component.yml +++ b/components/esp32-p4-function-ev-board/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/esp32-p4-function-ev- repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/esp32_p4_function_ev_board.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/espressif/esp32_p4_function_ev_board.html" examples: - path: example tags: diff --git a/components/esp32-timer-cam/idf_component.yml b/components/esp32-timer-cam/idf_component.yml index e34575640..ebb1627d1 100644 --- a/components/esp32-timer-cam/idf_component.yml +++ b/components/esp32-timer-cam/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/esp32-timer-cam" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/esp32_timer_cam.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/espressif/esp32_timer_cam.html" examples: - path: example tags: diff --git a/components/event_manager/idf_component.yml b/components/event_manager/idf_component.yml index c5a53af02..b84e1cf09 100644 --- a/components/event_manager/idf_component.yml +++ b/components/event_manager/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/event_manager" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/event_manager.html" +documentation: "https://esp-cpp.github.io/espp/core/event_manager.html" examples: - path: example tags: diff --git a/components/file_system/idf_component.yml b/components/file_system/idf_component.yml index 58d6df34b..aa71630f3 100644 --- a/components/file_system/idf_component.yml +++ b/components/file_system/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/file_system" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/file_system.html" +documentation: "https://esp-cpp.github.io/espp/storage/file_system.html" examples: - path: example tags: diff --git a/components/format/idf_component.yml b/components/format/idf_component.yml index 851de6b88..061e11aca 100644 --- a/components/format/idf_component.yml +++ b/components/format/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/format" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/logger.html#format" +documentation: "https://esp-cpp.github.io/espp/core/logger.html#format" tags: - cpp - Component diff --git a/components/i2c/idf_component.yml b/components/i2c/idf_component.yml index 8d08402ba..279ef033f 100644 --- a/components/i2c/idf_component.yml +++ b/components/i2c/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/i2c" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/i2c.html" +documentation: "https://esp-cpp.github.io/espp/buses/i2c.html" examples: - path: example tags: diff --git a/components/interrupt/idf_component.yml b/components/interrupt/idf_component.yml index 83479c6bb..1bf92eb97 100644 --- a/components/interrupt/idf_component.yml +++ b/components/interrupt/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/interrupt" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/interrupt.html" +documentation: "https://esp-cpp.github.io/espp/core/interrupt.html" examples: - path: example tags: diff --git a/components/iperf_menu/idf_component.yml b/components/iperf_menu/idf_component.yml index 19756b259..f50ddbed7 100644 --- a/components/iperf_menu/idf_component.yml +++ b/components/iperf_menu/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/iperf_menu" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/iperf_menu.html" +documentation: "https://esp-cpp.github.io/espp/protocols/iperf_menu.html" examples: - path: example tags: diff --git a/components/joystick/idf_component.yml b/components/joystick/idf_component.yml index 0e7f3af9d..99330353d 100644 --- a/components/joystick/idf_component.yml +++ b/components/joystick/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/joystick" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/joystick.html" +documentation: "https://esp-cpp.github.io/espp/input/joystick.html" examples: - path: example tags: diff --git a/components/led/idf_component.yml b/components/led/idf_component.yml index 499c4c2cf..ff9fa4896 100644 --- a/components/led/idf_component.yml +++ b/components/led/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/led" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/led.html" +documentation: "https://esp-cpp.github.io/espp/leds/led.html" examples: - path: example tags: diff --git a/components/led_strip/idf_component.yml b/components/led_strip/idf_component.yml index dc45a4681..d4549fa28 100644 --- a/components/led_strip/idf_component.yml +++ b/components/led_strip/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/led_strip" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/led_strip.html" +documentation: "https://esp-cpp.github.io/espp/leds/led_strip.html" examples: - path: example tags: diff --git a/components/logger/idf_component.yml b/components/logger/idf_component.yml index 6bbe0177d..2e1662402 100644 --- a/components/logger/idf_component.yml +++ b/components/logger/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/logger" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/logger.html#logger" +documentation: "https://esp-cpp.github.io/espp/core/logger.html#logger" examples: - path: example tags: diff --git a/components/m5stack-tab5/idf_component.yml b/components/m5stack-tab5/idf_component.yml index e0c303167..0566c70cb 100644 --- a/components/m5stack-tab5/idf_component.yml +++ b/components/m5stack-tab5/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/m5stack-tab5" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/m5stack_tab5.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/m5stack/m5stack_tab5.html" examples: - path: example tags: diff --git a/components/matouch-rotary-display/idf_component.yml b/components/matouch-rotary-display/idf_component.yml index 35edcbe6c..1f3eddd5e 100644 --- a/components/matouch-rotary-display/idf_component.yml +++ b/components/matouch-rotary-display/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/matouch-rotary-displa repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/matouch_rotary_display.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/other/matouch_rotary_display.html" examples: - path: example tags: diff --git a/components/monitor/idf_component.yml b/components/monitor/idf_component.yml index 44711010a..1e8bedd91 100644 --- a/components/monitor/idf_component.yml +++ b/components/monitor/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/monitor" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/monitor.html" +documentation: "https://esp-cpp.github.io/espp/core/monitor.html" examples: - path: example tags: diff --git a/components/motorgo-axis/idf_component.yml b/components/motorgo-axis/idf_component.yml index d0728b7d3..068fd6657 100755 --- a/components/motorgo-axis/idf_component.yml +++ b/components/motorgo-axis/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/motorgo-axis" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/motorgo_axis.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/motorgo/motorgo_axis.html" examples: - path: example tags: diff --git a/components/motorgo-mini/idf_component.yml b/components/motorgo-mini/idf_component.yml index 711ed6c8e..587b8e3fe 100644 --- a/components/motorgo-mini/idf_component.yml +++ b/components/motorgo-mini/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/motorgo-mini" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/motorgo_mini.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/motorgo/motorgo_mini.html" examples: - path: example tags: diff --git a/components/motorgo-plink/idf_component.yml b/components/motorgo-plink/idf_component.yml index 61512d04d..a9f37971e 100644 --- a/components/motorgo-plink/idf_component.yml +++ b/components/motorgo-plink/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/motorgo-plink" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/motorgo_plink.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/motorgo/motorgo_plink.html" examples: - path: example tags: diff --git a/components/neopixel/idf_component.yml b/components/neopixel/idf_component.yml index 793bd69d5..260c6e417 100644 --- a/components/neopixel/idf_component.yml +++ b/components/neopixel/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/neopixel" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/neopixel.html" +documentation: "https://esp-cpp.github.io/espp/leds/neopixel.html" examples: - path: example tags: diff --git a/components/nvs/idf_component.yml b/components/nvs/idf_component.yml index e9594e885..3c6bdfbd4 100644 --- a/components/nvs/idf_component.yml +++ b/components/nvs/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/nvs" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/nvs.html" +documentation: "https://esp-cpp.github.io/espp/storage/nvs.html" examples: - path: example tags: diff --git a/components/odrive_ascii/idf_component.yml b/components/odrive_ascii/idf_component.yml index 46da48f90..47c0d57f0 100644 --- a/components/odrive_ascii/idf_component.yml +++ b/components/odrive_ascii/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/odrive_ascii" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/odrive_ascii.html" +documentation: "https://esp-cpp.github.io/espp/motor_control/odrive_ascii.html" examples: - path: example tags: diff --git a/components/pid/idf_component.yml b/components/pid/idf_component.yml index 5e5153229..e1ad05150 100644 --- a/components/pid/idf_component.yml +++ b/components/pid/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/pid" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/pid.html" +documentation: "https://esp-cpp.github.io/espp/motor_control/pid.html" examples: - path: example tags: diff --git a/components/qtpy/idf_component.yml b/components/qtpy/idf_component.yml index 9097aa391..141c53800 100644 --- a/components/qtpy/idf_component.yml +++ b/components/qtpy/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/qtpy" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/qtpy.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/adafruit/qtpy.html" examples: - path: example tags: diff --git a/components/qwiicnes/idf_component.yml b/components/qwiicnes/idf_component.yml index 37bf21909..cddc3169c 100644 --- a/components/qwiicnes/idf_component.yml +++ b/components/qwiicnes/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/qwiicnes" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/qwiicnes.html" +documentation: "https://esp-cpp.github.io/espp/input/qwiicnes.html" examples: - path: example tags: diff --git a/components/remote_debug/idf_component.yml b/components/remote_debug/idf_component.yml index 8d38d0153..858bb4563 100644 --- a/components/remote_debug/idf_component.yml +++ b/components/remote_debug/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/remote_debug" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/remote_debug.html" +documentation: "https://esp-cpp.github.io/espp/protocols/remote_debug.html" examples: - path: example tags: diff --git a/components/rmt/idf_component.yml b/components/rmt/idf_component.yml index 1f6257430..d7ff45b54 100644 --- a/components/rmt/idf_component.yml +++ b/components/rmt/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/rmt" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/rmt.html" +documentation: "https://esp-cpp.github.io/espp/buses/rmt.html" examples: - path: example tags: diff --git a/components/rtps/idf_component.yml b/components/rtps/idf_component.yml index 094c82efa..03ce02ae4 100644 --- a/components/rtps/idf_component.yml +++ b/components/rtps/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/rtps" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/rtps.html" +documentation: "https://esp-cpp.github.io/espp/protocols/rtps.html" examples: - path: example tags: diff --git a/components/rtsp/idf_component.yml b/components/rtsp/idf_component.yml index b3ca0a91c..a1dbf5a73 100755 --- a/components/rtsp/idf_component.yml +++ b/components/rtsp/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/rtsp" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/rtsp.html" +documentation: "https://esp-cpp.github.io/espp/protocols/rtsp.html" examples: - path: example tags: diff --git a/components/runqueue/idf_component.yml b/components/runqueue/idf_component.yml index 13978aa6d..033df16d0 100644 --- a/components/runqueue/idf_component.yml +++ b/components/runqueue/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/runqueue" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/runqueue.html" +documentation: "https://esp-cpp.github.io/espp/core/runqueue.html" examples: - path: example tags: diff --git a/components/seeed-studio-round-display/idf_component.yml b/components/seeed-studio-round-display/idf_component.yml index b1f430f4f..e3da19bf1 100644 --- a/components/seeed-studio-round-display/idf_component.yml +++ b/components/seeed-studio-round-display/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/seeed-studio-round-di repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/seeed_studio_round_display.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/seeed/seeed_studio_round_display.html" examples: - path: example tags: diff --git a/components/serialization/idf_component.yml b/components/serialization/idf_component.yml index 9a7405d63..d14f16628 100644 --- a/components/serialization/idf_component.yml +++ b/components/serialization/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/serialization" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/serialization.html" +documentation: "https://esp-cpp.github.io/espp/data/serialization.html" examples: - path: example tags: diff --git a/components/smartpanlee-sc01-plus/idf_component.yml b/components/smartpanlee-sc01-plus/idf_component.yml index 123b731b7..68893ffa9 100755 --- a/components/smartpanlee-sc01-plus/idf_component.yml +++ b/components/smartpanlee-sc01-plus/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/smartpanlee-sc01-plus repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/smartpanlee_sc01_plus.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/other/smartpanlee_sc01_plus.html" examples: - path: example tags: diff --git a/components/spi/idf_component.yml b/components/spi/idf_component.yml index 21b97a95f..a6168a2e4 100644 --- a/components/spi/idf_component.yml +++ b/components/spi/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/spi" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/spi.html" +documentation: "https://esp-cpp.github.io/espp/buses/spi.html" examples: - path: example tags: diff --git a/components/state_machine/idf_component.yml b/components/state_machine/idf_component.yml index f3180e1ca..78d2a799e 100644 --- a/components/state_machine/idf_component.yml +++ b/components/state_machine/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/state_machine" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/state_machine.html" +documentation: "https://esp-cpp.github.io/espp/core/state_machine.html" examples: - path: example tags: diff --git a/components/t-deck/idf_component.yml b/components/t-deck/idf_component.yml index 7f6c16eaf..a661d6172 100644 --- a/components/t-deck/idf_component.yml +++ b/components/t-deck/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/t-deck" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/t_deck.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/lilygo/t_deck.html" examples: - path: example tags: diff --git a/components/t-dongle-s3/idf_component.yml b/components/t-dongle-s3/idf_component.yml index 19c3fe28f..e17a06037 100644 --- a/components/t-dongle-s3/idf_component.yml +++ b/components/t-dongle-s3/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/t-dongle-s3" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/t_dongle_s3.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/lilygo/t_dongle_s3.html" examples: - path: example tags: diff --git a/components/tabulate/idf_component.yml b/components/tabulate/idf_component.yml index 296ced0be..ab2a1cac5 100644 --- a/components/tabulate/idf_component.yml +++ b/components/tabulate/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/tabulate" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/tabulate.html" +documentation: "https://esp-cpp.github.io/espp/data/tabulate.html" examples: - path: example tags: diff --git a/components/task/idf_component.yml b/components/task/idf_component.yml index 5e45253d9..bb7735f2a 100644 --- a/components/task/idf_component.yml +++ b/components/task/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/task" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/task.html" +documentation: "https://esp-cpp.github.io/espp/core/task.html" examples: - path: example tags: diff --git a/components/timer/idf_component.yml b/components/timer/idf_component.yml index 684930483..f9bb4fc48 100644 --- a/components/timer/idf_component.yml +++ b/components/timer/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/timer" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/timer.html" +documentation: "https://esp-cpp.github.io/espp/core/timer.html" examples: - path: example tags: diff --git a/components/wrover-kit/idf_component.yml b/components/wrover-kit/idf_component.yml index c7ab04f9d..0f78cc5fa 100644 --- a/components/wrover-kit/idf_component.yml +++ b/components/wrover-kit/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/wrover-kit" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/wrover_kit.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/espressif/wrover_kit.html" examples: - path: example tags: diff --git a/components/ws-s3-geek/idf_component.yml b/components/ws-s3-geek/idf_component.yml index 885363a5b..f30e569b7 100644 --- a/components/ws-s3-geek/idf_component.yml +++ b/components/ws-s3-geek/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/ws-s3-geek" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/ws_s3_geek.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/waveshare/ws_s3_geek.html" examples: - path: example tags: diff --git a/components/ws-s3-lcd-1-47/idf_component.yml b/components/ws-s3-lcd-1-47/idf_component.yml index 5fe13147c..f7ff6474c 100644 --- a/components/ws-s3-lcd-1-47/idf_component.yml +++ b/components/ws-s3-lcd-1-47/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/ws-s3-lcd-1-47" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/ws_s3_lcd_1_47.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/waveshare/ws_s3_lcd_1_47.html" examples: - path: example tags: diff --git a/components/ws-s3-touch/idf_component.yml b/components/ws-s3-touch/idf_component.yml index 4d53e0c75..e27b926a0 100644 --- a/components/ws-s3-touch/idf_component.yml +++ b/components/ws-s3-touch/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/ws-s3-touch" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/ws_s3_touch.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/waveshare/ws_s3_touch.html" examples: - path: example tags: diff --git a/components/xiao-esp32s3-sense/idf_component.yml b/components/xiao-esp32s3-sense/idf_component.yml index c435fcb45..7e2fc1cb1 100644 --- a/components/xiao-esp32s3-sense/idf_component.yml +++ b/components/xiao-esp32s3-sense/idf_component.yml @@ -5,7 +5,7 @@ url: "https://github.com/esp-cpp/espp/tree/main/components/xiao-esp32s3-sense" repository: "git://github.com/esp-cpp/espp.git" maintainers: - William Emfinger -documentation: "https://esp-cpp.github.io/espp/xiao_esp32s3_sense.html" +documentation: "https://esp-cpp.github.io/espp/dev_boards/seeed/xiao_esp32s3_sense.html" examples: - path: example tags: diff --git a/doc/en/i2c.rst b/doc/en/buses/i2c.rst similarity index 100% rename from doc/en/i2c.rst rename to doc/en/buses/i2c.rst diff --git a/doc/en/i2c_example.md b/doc/en/buses/i2c_example.md similarity index 100% rename from doc/en/i2c_example.md rename to doc/en/buses/i2c_example.md diff --git a/doc/en/buses/index.rst b/doc/en/buses/index.rst new file mode 100644 index 000000000..26a27f890 --- /dev/null +++ b/doc/en/buses/index.rst @@ -0,0 +1,12 @@ +Buses & Low-Level I/O APIs +************************** + +Wrappers around the low-level hardware buses and I/O peripherals used to talk to +external chips. + +.. toctree:: + :maxdepth: 1 + + i2c + spi + rmt diff --git a/doc/en/rmt.rst b/doc/en/buses/rmt.rst similarity index 100% rename from doc/en/rmt.rst rename to doc/en/buses/rmt.rst diff --git a/doc/en/rmt_example.md b/doc/en/buses/rmt_example.md similarity index 100% rename from doc/en/rmt_example.md rename to doc/en/buses/rmt_example.md diff --git a/doc/en/spi.rst b/doc/en/buses/spi.rst similarity index 100% rename from doc/en/spi.rst rename to doc/en/buses/spi.rst diff --git a/doc/en/spi_example.md b/doc/en/buses/spi_example.md similarity index 100% rename from doc/en/spi_example.md rename to doc/en/buses/spi_example.md diff --git a/doc/en/base_component.rst b/doc/en/core/base_component.rst similarity index 100% rename from doc/en/base_component.rst rename to doc/en/core/base_component.rst diff --git a/doc/en/base_peripheral.rst b/doc/en/core/base_peripheral.rst similarity index 100% rename from doc/en/base_peripheral.rst rename to doc/en/core/base_peripheral.rst diff --git a/doc/en/binary_log_example.md b/doc/en/core/binary_log_example.md similarity index 100% rename from doc/en/binary_log_example.md rename to doc/en/core/binary_log_example.md diff --git a/doc/en/cli.rst b/doc/en/core/cli.rst similarity index 100% rename from doc/en/cli.rst rename to doc/en/core/cli.rst diff --git a/doc/en/cli_example.md b/doc/en/core/cli_example.md similarity index 100% rename from doc/en/cli_example.md rename to doc/en/core/cli_example.md diff --git a/doc/en/event_manager.rst b/doc/en/core/event_manager.rst similarity index 100% rename from doc/en/event_manager.rst rename to doc/en/core/event_manager.rst diff --git a/doc/en/event_manager_example.md b/doc/en/core/event_manager_example.md similarity index 100% rename from doc/en/event_manager_example.md rename to doc/en/core/event_manager_example.md diff --git a/doc/en/core/index.rst b/doc/en/core/index.rst new file mode 100644 index 000000000..07ec25562 --- /dev/null +++ b/doc/en/core/index.rst @@ -0,0 +1,21 @@ +Core & RTOS APIs +**************** + +Foundational building blocks used by almost every other component: base classes, +tasks and scheduling, timers, interrupts, events, state machines, logging, and +the command-line interface. + +.. toctree:: + :maxdepth: 1 + + base_component + base_peripheral + task + runqueue + timer + interrupt + event_manager + state_machine + logger + monitor + cli diff --git a/doc/en/interrupt.rst b/doc/en/core/interrupt.rst similarity index 100% rename from doc/en/interrupt.rst rename to doc/en/core/interrupt.rst diff --git a/doc/en/interrupt_example.md b/doc/en/core/interrupt_example.md similarity index 100% rename from doc/en/interrupt_example.md rename to doc/en/core/interrupt_example.md diff --git a/doc/en/logger.rst b/doc/en/core/logger.rst similarity index 100% rename from doc/en/logger.rst rename to doc/en/core/logger.rst diff --git a/doc/en/logger_example.md b/doc/en/core/logger_example.md similarity index 100% rename from doc/en/logger_example.md rename to doc/en/core/logger_example.md diff --git a/doc/en/monitor.rst b/doc/en/core/monitor.rst similarity index 100% rename from doc/en/monitor.rst rename to doc/en/core/monitor.rst diff --git a/doc/en/monitor_example.md b/doc/en/core/monitor_example.md similarity index 100% rename from doc/en/monitor_example.md rename to doc/en/core/monitor_example.md diff --git a/doc/en/runqueue.rst b/doc/en/core/runqueue.rst similarity index 100% rename from doc/en/runqueue.rst rename to doc/en/core/runqueue.rst diff --git a/doc/en/runqueue_example.md b/doc/en/core/runqueue_example.md similarity index 100% rename from doc/en/runqueue_example.md rename to doc/en/core/runqueue_example.md diff --git a/doc/en/state_machine.rst b/doc/en/core/state_machine.rst similarity index 100% rename from doc/en/state_machine.rst rename to doc/en/core/state_machine.rst diff --git a/doc/en/state_machine_example.md b/doc/en/core/state_machine_example.md similarity index 100% rename from doc/en/state_machine_example.md rename to doc/en/core/state_machine_example.md diff --git a/doc/en/task.rst b/doc/en/core/task.rst similarity index 100% rename from doc/en/task.rst rename to doc/en/core/task.rst diff --git a/doc/en/task_example.md b/doc/en/core/task_example.md similarity index 100% rename from doc/en/task_example.md rename to doc/en/core/task_example.md diff --git a/doc/en/timer.rst b/doc/en/core/timer.rst similarity index 100% rename from doc/en/timer.rst rename to doc/en/core/timer.rst diff --git a/doc/en/timer_example.md b/doc/en/core/timer_example.md similarity index 100% rename from doc/en/timer_example.md rename to doc/en/core/timer_example.md diff --git a/doc/en/cdr.rst b/doc/en/data/cdr.rst similarity index 100% rename from doc/en/cdr.rst rename to doc/en/data/cdr.rst diff --git a/doc/en/cdr_example.md b/doc/en/data/cdr_example.md similarity index 100% rename from doc/en/cdr_example.md rename to doc/en/data/cdr_example.md diff --git a/doc/en/cobs.rst b/doc/en/data/cobs.rst similarity index 100% rename from doc/en/cobs.rst rename to doc/en/data/cobs.rst diff --git a/doc/en/cobs_example.md b/doc/en/data/cobs_example.md similarity index 100% rename from doc/en/cobs_example.md rename to doc/en/data/cobs_example.md diff --git a/doc/en/csv.rst b/doc/en/data/csv.rst similarity index 100% rename from doc/en/csv.rst rename to doc/en/data/csv.rst diff --git a/doc/en/csv_example.md b/doc/en/data/csv_example.md similarity index 100% rename from doc/en/csv_example.md rename to doc/en/data/csv_example.md diff --git a/doc/en/data/index.rst b/doc/en/data/index.rst new file mode 100644 index 000000000..718e94229 --- /dev/null +++ b/doc/en/data/index.rst @@ -0,0 +1,14 @@ +Data & Serialization APIs +************************* + +Encoding, serializing, and formatting data: structured serialization, CDR, +byte-stuffing, CSV, and table formatting. + +.. toctree:: + :maxdepth: 1 + + serialization + cdr + cobs + csv + tabulate diff --git a/doc/en/serialization.rst b/doc/en/data/serialization.rst similarity index 100% rename from doc/en/serialization.rst rename to doc/en/data/serialization.rst diff --git a/doc/en/serialization_example.md b/doc/en/data/serialization_example.md similarity index 100% rename from doc/en/serialization_example.md rename to doc/en/data/serialization_example.md diff --git a/doc/en/tabulate.rst b/doc/en/data/tabulate.rst similarity index 100% rename from doc/en/tabulate.rst rename to doc/en/data/tabulate.rst diff --git a/doc/en/tabulate_example.md b/doc/en/data/tabulate_example.md similarity index 100% rename from doc/en/tabulate_example.md rename to doc/en/data/tabulate_example.md diff --git a/doc/en/dev_boards/adafruit/index.rst b/doc/en/dev_boards/adafruit/index.rst new file mode 100644 index 000000000..97f5ee06a --- /dev/null +++ b/doc/en/dev_boards/adafruit/index.rst @@ -0,0 +1,7 @@ +Adafruit Boards +*************** + +.. toctree:: + :maxdepth: 1 + + qtpy diff --git a/doc/en/qtpy.rst b/doc/en/dev_boards/adafruit/qtpy.rst similarity index 100% rename from doc/en/qtpy.rst rename to doc/en/dev_boards/adafruit/qtpy.rst diff --git a/doc/en/qtpy_example.md b/doc/en/dev_boards/adafruit/qtpy_example.md similarity index 100% rename from doc/en/qtpy_example.md rename to doc/en/dev_boards/adafruit/qtpy_example.md diff --git a/doc/en/esp32_p4_function_ev_board.rst b/doc/en/dev_boards/espressif/esp32_p4_function_ev_board.rst similarity index 100% rename from doc/en/esp32_p4_function_ev_board.rst rename to doc/en/dev_boards/espressif/esp32_p4_function_ev_board.rst diff --git a/doc/en/esp32_p4_function_ev_board_example.md b/doc/en/dev_boards/espressif/esp32_p4_function_ev_board_example.md similarity index 100% rename from doc/en/esp32_p4_function_ev_board_example.md rename to doc/en/dev_boards/espressif/esp32_p4_function_ev_board_example.md diff --git a/doc/en/esp32_timer_cam.rst b/doc/en/dev_boards/espressif/esp32_timer_cam.rst similarity index 100% rename from doc/en/esp32_timer_cam.rst rename to doc/en/dev_boards/espressif/esp32_timer_cam.rst diff --git a/doc/en/esp32_timer_cam_example.md b/doc/en/dev_boards/espressif/esp32_timer_cam_example.md similarity index 100% rename from doc/en/esp32_timer_cam_example.md rename to doc/en/dev_boards/espressif/esp32_timer_cam_example.md diff --git a/doc/en/esp_box.rst b/doc/en/dev_boards/espressif/esp_box.rst similarity index 100% rename from doc/en/esp_box.rst rename to doc/en/dev_boards/espressif/esp_box.rst diff --git a/doc/en/esp_box_example.md b/doc/en/dev_boards/espressif/esp_box_example.md similarity index 100% rename from doc/en/esp_box_example.md rename to doc/en/dev_boards/espressif/esp_box_example.md diff --git a/doc/en/dev_boards/espressif/index.rst b/doc/en/dev_boards/espressif/index.rst new file mode 100644 index 000000000..443e55843 --- /dev/null +++ b/doc/en/dev_boards/espressif/index.rst @@ -0,0 +1,10 @@ +Espressif Boards +**************** + +.. toctree:: + :maxdepth: 1 + + esp_box + esp32_p4_function_ev_board + esp32_timer_cam + wrover_kit diff --git a/doc/en/wrover_kit.rst b/doc/en/dev_boards/espressif/wrover_kit.rst similarity index 100% rename from doc/en/wrover_kit.rst rename to doc/en/dev_boards/espressif/wrover_kit.rst diff --git a/doc/en/wrover_kit_example.md b/doc/en/dev_boards/espressif/wrover_kit_example.md similarity index 100% rename from doc/en/wrover_kit_example.md rename to doc/en/dev_boards/espressif/wrover_kit_example.md diff --git a/doc/en/dev_boards/index.rst b/doc/en/dev_boards/index.rst new file mode 100644 index 000000000..e799d9748 --- /dev/null +++ b/doc/en/dev_boards/index.rst @@ -0,0 +1,19 @@ +Dev Boards (BSPs) +***************** + +Board-support packages (BSPs) for supported development boards, grouped by +vendor. Each BSP wires up the board's display, touch, IMU, audio, buttons, and +other on-board peripherals behind a single, easy-to-use component so you can +target a board without configuring each peripheral by hand. + +.. toctree:: + :maxdepth: 2 + + espressif/index + adafruit/index + lilygo/index + m5stack/index + motorgo/index + seeed/index + waveshare/index + other/index diff --git a/doc/en/dev_boards/lilygo/index.rst b/doc/en/dev_boards/lilygo/index.rst new file mode 100644 index 000000000..7df6af30f --- /dev/null +++ b/doc/en/dev_boards/lilygo/index.rst @@ -0,0 +1,8 @@ +LilyGo Boards +************* + +.. toctree:: + :maxdepth: 1 + + t_deck + t_dongle_s3 diff --git a/doc/en/t_deck.rst b/doc/en/dev_boards/lilygo/t_deck.rst similarity index 100% rename from doc/en/t_deck.rst rename to doc/en/dev_boards/lilygo/t_deck.rst diff --git a/doc/en/t_deck_example.md b/doc/en/dev_boards/lilygo/t_deck_example.md similarity index 100% rename from doc/en/t_deck_example.md rename to doc/en/dev_boards/lilygo/t_deck_example.md diff --git a/doc/en/t_dongle_s3.rst b/doc/en/dev_boards/lilygo/t_dongle_s3.rst similarity index 100% rename from doc/en/t_dongle_s3.rst rename to doc/en/dev_boards/lilygo/t_dongle_s3.rst diff --git a/doc/en/t_dongle_s3_example.md b/doc/en/dev_boards/lilygo/t_dongle_s3_example.md similarity index 100% rename from doc/en/t_dongle_s3_example.md rename to doc/en/dev_boards/lilygo/t_dongle_s3_example.md diff --git a/doc/en/dev_boards/m5stack/index.rst b/doc/en/dev_boards/m5stack/index.rst new file mode 100644 index 000000000..d581a09ef --- /dev/null +++ b/doc/en/dev_boards/m5stack/index.rst @@ -0,0 +1,7 @@ +M5Stack Boards +************** + +.. toctree:: + :maxdepth: 1 + + m5stack_tab5 diff --git a/doc/en/m5stack_tab5.rst b/doc/en/dev_boards/m5stack/m5stack_tab5.rst similarity index 100% rename from doc/en/m5stack_tab5.rst rename to doc/en/dev_boards/m5stack/m5stack_tab5.rst diff --git a/doc/en/m5stack_tab5_example.md b/doc/en/dev_boards/m5stack/m5stack_tab5_example.md similarity index 100% rename from doc/en/m5stack_tab5_example.md rename to doc/en/dev_boards/m5stack/m5stack_tab5_example.md diff --git a/doc/en/dev_boards/motorgo/index.rst b/doc/en/dev_boards/motorgo/index.rst new file mode 100644 index 000000000..27ae64694 --- /dev/null +++ b/doc/en/dev_boards/motorgo/index.rst @@ -0,0 +1,12 @@ +MotorGo Boards +************** + +Motor-control development boards. See also the :doc:`../../motor_control/index` +and :doc:`../../bldc/index` APIs for the underlying control components. + +.. toctree:: + :maxdepth: 1 + + motorgo_axis + motorgo_mini + motorgo_plink diff --git a/doc/en/motorgo_axis.rst b/doc/en/dev_boards/motorgo/motorgo_axis.rst similarity index 100% rename from doc/en/motorgo_axis.rst rename to doc/en/dev_boards/motorgo/motorgo_axis.rst diff --git a/doc/en/motorgo_axis_example.md b/doc/en/dev_boards/motorgo/motorgo_axis_example.md similarity index 100% rename from doc/en/motorgo_axis_example.md rename to doc/en/dev_boards/motorgo/motorgo_axis_example.md diff --git a/doc/en/motorgo_mini.rst b/doc/en/dev_boards/motorgo/motorgo_mini.rst similarity index 100% rename from doc/en/motorgo_mini.rst rename to doc/en/dev_boards/motorgo/motorgo_mini.rst diff --git a/doc/en/motorgo_mini_example.md b/doc/en/dev_boards/motorgo/motorgo_mini_example.md similarity index 100% rename from doc/en/motorgo_mini_example.md rename to doc/en/dev_boards/motorgo/motorgo_mini_example.md diff --git a/doc/en/motorgo_plink.rst b/doc/en/dev_boards/motorgo/motorgo_plink.rst similarity index 100% rename from doc/en/motorgo_plink.rst rename to doc/en/dev_boards/motorgo/motorgo_plink.rst diff --git a/doc/en/motorgo_plink_example.md b/doc/en/dev_boards/motorgo/motorgo_plink_example.md similarity index 100% rename from doc/en/motorgo_plink_example.md rename to doc/en/dev_boards/motorgo/motorgo_plink_example.md diff --git a/doc/en/byte90.rst b/doc/en/dev_boards/other/byte90.rst similarity index 100% rename from doc/en/byte90.rst rename to doc/en/dev_boards/other/byte90.rst diff --git a/doc/en/byte90_example.md b/doc/en/dev_boards/other/byte90_example.md similarity index 100% rename from doc/en/byte90_example.md rename to doc/en/dev_boards/other/byte90_example.md diff --git a/doc/en/dev_boards/other/index.rst b/doc/en/dev_boards/other/index.rst new file mode 100644 index 000000000..72d30398a --- /dev/null +++ b/doc/en/dev_boards/other/index.rst @@ -0,0 +1,9 @@ +Other Boards +************ + +.. toctree:: + :maxdepth: 1 + + byte90 + matouch_rotary_display + smartpanlee_sc01_plus diff --git a/doc/en/matouch_rotary_display.rst b/doc/en/dev_boards/other/matouch_rotary_display.rst similarity index 100% rename from doc/en/matouch_rotary_display.rst rename to doc/en/dev_boards/other/matouch_rotary_display.rst diff --git a/doc/en/matouch_rotary_display_example.md b/doc/en/dev_boards/other/matouch_rotary_display_example.md similarity index 100% rename from doc/en/matouch_rotary_display_example.md rename to doc/en/dev_boards/other/matouch_rotary_display_example.md diff --git a/doc/en/smartpanlee_sc01_plus.rst b/doc/en/dev_boards/other/smartpanlee_sc01_plus.rst similarity index 100% rename from doc/en/smartpanlee_sc01_plus.rst rename to doc/en/dev_boards/other/smartpanlee_sc01_plus.rst diff --git a/doc/en/smartpanlee_sc01_plus_example.md b/doc/en/dev_boards/other/smartpanlee_sc01_plus_example.md similarity index 100% rename from doc/en/smartpanlee_sc01_plus_example.md rename to doc/en/dev_boards/other/smartpanlee_sc01_plus_example.md diff --git a/doc/en/dev_boards/seeed/index.rst b/doc/en/dev_boards/seeed/index.rst new file mode 100644 index 000000000..e05a6da4d --- /dev/null +++ b/doc/en/dev_boards/seeed/index.rst @@ -0,0 +1,8 @@ +Seeed Studio Boards +******************* + +.. toctree:: + :maxdepth: 1 + + seeed_studio_round_display + xiao_esp32s3_sense diff --git a/doc/en/seeed_studio_round_display.rst b/doc/en/dev_boards/seeed/seeed_studio_round_display.rst similarity index 100% rename from doc/en/seeed_studio_round_display.rst rename to doc/en/dev_boards/seeed/seeed_studio_round_display.rst diff --git a/doc/en/seeed_studio_round_display_example.md b/doc/en/dev_boards/seeed/seeed_studio_round_display_example.md similarity index 100% rename from doc/en/seeed_studio_round_display_example.md rename to doc/en/dev_boards/seeed/seeed_studio_round_display_example.md diff --git a/doc/en/xiao_esp32s3_sense.rst b/doc/en/dev_boards/seeed/xiao_esp32s3_sense.rst similarity index 100% rename from doc/en/xiao_esp32s3_sense.rst rename to doc/en/dev_boards/seeed/xiao_esp32s3_sense.rst diff --git a/doc/en/xiao_esp32s3_sense_example.md b/doc/en/dev_boards/seeed/xiao_esp32s3_sense_example.md similarity index 100% rename from doc/en/xiao_esp32s3_sense_example.md rename to doc/en/dev_boards/seeed/xiao_esp32s3_sense_example.md diff --git a/doc/en/dev_boards/waveshare/index.rst b/doc/en/dev_boards/waveshare/index.rst new file mode 100644 index 000000000..86c295e17 --- /dev/null +++ b/doc/en/dev_boards/waveshare/index.rst @@ -0,0 +1,9 @@ +Waveshare Boards +**************** + +.. toctree:: + :maxdepth: 1 + + ws_s3_geek + ws_s3_lcd_1_47 + ws_s3_touch diff --git a/doc/en/ws_s3_geek.rst b/doc/en/dev_boards/waveshare/ws_s3_geek.rst similarity index 100% rename from doc/en/ws_s3_geek.rst rename to doc/en/dev_boards/waveshare/ws_s3_geek.rst diff --git a/doc/en/ws_s3_geek_example.md b/doc/en/dev_boards/waveshare/ws_s3_geek_example.md similarity index 100% rename from doc/en/ws_s3_geek_example.md rename to doc/en/dev_boards/waveshare/ws_s3_geek_example.md diff --git a/doc/en/ws_s3_lcd_1_47.rst b/doc/en/dev_boards/waveshare/ws_s3_lcd_1_47.rst similarity index 100% rename from doc/en/ws_s3_lcd_1_47.rst rename to doc/en/dev_boards/waveshare/ws_s3_lcd_1_47.rst diff --git a/doc/en/ws_s3_lcd_1_47_example.md b/doc/en/dev_boards/waveshare/ws_s3_lcd_1_47_example.md similarity index 100% rename from doc/en/ws_s3_lcd_1_47_example.md rename to doc/en/dev_boards/waveshare/ws_s3_lcd_1_47_example.md diff --git a/doc/en/ws_s3_touch.rst b/doc/en/dev_boards/waveshare/ws_s3_touch.rst similarity index 100% rename from doc/en/ws_s3_touch.rst rename to doc/en/dev_boards/waveshare/ws_s3_touch.rst diff --git a/doc/en/ws_s3_touch_example.md b/doc/en/dev_boards/waveshare/ws_s3_touch_example.md similarity index 100% rename from doc/en/ws_s3_touch_example.md rename to doc/en/dev_boards/waveshare/ws_s3_touch_example.md diff --git a/doc/en/getting_started.rst b/doc/en/getting_started.rst new file mode 100644 index 000000000..d4dc09d2d --- /dev/null +++ b/doc/en/getting_started.rst @@ -0,0 +1,60 @@ +Getting Started +*************** + +ESPP (`espp `_) is a collection of C++ +components and abstractions for the `ESP-IDF +`_ framework. Each component is reusable on +its own, and many also build on a few foundational components such as +``format``, ``logger``, and ``task``. + +ESPP currently targets ESP-IDF ``6.0`` while maintaining support for ``5.5.1``. + +How this documentation is organized +=================================== + +The APIs are grouped by capability — :doc:`core/index`, :doc:`sensors +`, :doc:`buses/index`, :doc:`network/index`, and so on — with all of +the supported development boards collected under :doc:`dev_boards/index`. Use the +navigation sidebar to browse a category, or the search box to jump straight to a +component. + +Every component has: + +- an **API Reference** page (the pages linked from each category), and +- an **example** that shows basic usage. The example code lives in that + component's ``example`` directory in the repository and is embedded in the + component's documentation page. + +Using a component +================= + +There are a few ways to pull ESPP components into your project: + +#. Start from the `esp-cpp/template `_ + repository, which is set up for C++ development with ``espp`` already included + as a submodule. + +#. Add individual components with the IDF component manager. All ``espp`` + components are published to the `ESP Component Registry + `_ under the + ``espp`` namespace, for example: + + .. code-block:: console + + idf.py add-dependency "espp/task^1.0" + idf.py add-dependency "espp/ble_gatt_server^1.0" + +#. Clone ``espp`` as a submodule in your project's ``components`` directory and + add it to ``EXTRA_COMPONENT_DIRS`` in your ``CMakeLists.txt``: + + .. code-block:: cmake + + set(EXTRA_COMPONENT_DIRS + "components/espp/components" + ) + + Be sure to clone recursively (or run ``git submodule update --init + --recursive``) so the required submodules are present. + +For questions or to chat, join the `Discord +`_. diff --git a/doc/en/index.rst b/doc/en/index.rst index 14a360e56..6f235c739 100755 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -1,90 +1,102 @@ ESPP Documentation -========================= +================== -This is the documentation for the ESP-IDF C++ library esp-cpp/espp. +This is the documentation for the ESP-IDF C++ library `espp +`_. ESPP provides additional C++ components and +abstractions for building applications from reusable components. +New here? Start with :doc:`getting_started`. The APIs below are grouped by +capability; all supported development boards are collected under +:doc:`dev_boards/index`. -This is the documentation for esp-idf c++ components, ESPP (`espp `_). ESPP provides additional c++ components and abstractions for building applications from reusable components. +.. toctree:: + :maxdepth: 1 + :caption: Introduction + getting_started .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :caption: Core & RTOS + + core/index + +.. toctree:: + :maxdepth: 1 + :caption: Storage & Configuration + + storage/index + +.. toctree:: + :maxdepth: 1 + :caption: Buses & I/O + + buses/index + io_expander/index + +.. toctree:: + :maxdepth: 1 + :caption: Sensors adc/index - adrc - base_component - base_peripheral + imu/index + encoder/index + distance_sensors/index + presence/index battery/index + power/index + rtc/index + thermistor + +.. toctree:: + :maxdepth: 1 + :caption: Motor Control + + motor_control/index bldc/index - ble/index - button - byte90 - controller - cdr - cli - cobs - color - csv + +.. toctree:: + :maxdepth: 1 + :caption: Displays, LEDs & Haptics + display/index - distance_sensors/index - encoder/index - esp32_p4_function_ev_board - esp32_timer_cam - esp_box - event_manager - file_system - filters/index - ftp/index + leds/index + led_driver/index haptics/index - hid/index - i2c - imu/index - interrupt + +.. toctree:: + :maxdepth: 1 + :caption: Input & HID + input/index - io_expander/index - iperf_menu - joystick - led - led_driver/index - led_strip - logger - m5stack_tab5 - math/index - matouch_rotary_display - monitor - motorgo_axis - motorgo_mini - motorgo_plink - neopixel + hid/index + +.. toctree:: + :maxdepth: 1 + :caption: Connectivity & Protocols + network/index - nfc/index - nvs - odrive_ascii - pid - power/index - presence/index - qtpy - qwiicnes - remote_debug - rmt - rtc/index - rtps - rtsp - runqueue - seeed_studio_round_display - serialization - smartpanlee_sc01_plus - spi - state_machine - t_deck - t_dongle_s3 - tabulate - task - thermistor - timer wifi/index - wrover_kit - ws_s3_geek - ws_s3_lcd_1_47 - ws_s3_touch - xiao_esp32s3_sense + ble/index + ftp/index + nfc/index + protocols/index + +.. toctree:: + :maxdepth: 1 + :caption: Math & DSP + + math/index + filters/index + +.. toctree:: + :maxdepth: 1 + :caption: Data & Serialization + + data/index + +.. toctree:: + :maxdepth: 2 + :caption: Dev Boards (BSPs) + + dev_boards/index diff --git a/doc/en/button.rst b/doc/en/input/button.rst similarity index 100% rename from doc/en/button.rst rename to doc/en/input/button.rst diff --git a/doc/en/button_example.md b/doc/en/input/button_example.md similarity index 100% rename from doc/en/button_example.md rename to doc/en/input/button_example.md diff --git a/doc/en/controller.rst b/doc/en/input/controller.rst similarity index 100% rename from doc/en/controller.rst rename to doc/en/input/controller.rst diff --git a/doc/en/controller_example.md b/doc/en/input/controller_example.md similarity index 100% rename from doc/en/controller_example.md rename to doc/en/input/controller_example.md diff --git a/doc/en/input/index.rst b/doc/en/input/index.rst index dc6d2e749..6f9a5456e 100644 --- a/doc/en/input/index.rst +++ b/doc/en/input/index.rst @@ -1,6 +1,22 @@ Input APIs ********** +Human-input devices and the touch / keypad / pointer drivers behind them. + +Input devices +============= + +.. toctree:: + :maxdepth: 1 + + button + joystick + controller + qwiicnes + +Touch & input drivers +===================== + .. toctree:: :maxdepth: 1 diff --git a/doc/en/joystick.rst b/doc/en/input/joystick.rst similarity index 100% rename from doc/en/joystick.rst rename to doc/en/input/joystick.rst diff --git a/doc/en/joystick_example.md b/doc/en/input/joystick_example.md similarity index 100% rename from doc/en/joystick_example.md rename to doc/en/input/joystick_example.md diff --git a/doc/en/qwiicnes.rst b/doc/en/input/qwiicnes.rst similarity index 100% rename from doc/en/qwiicnes.rst rename to doc/en/input/qwiicnes.rst diff --git a/doc/en/qwiicnes_example.md b/doc/en/input/qwiicnes_example.md similarity index 100% rename from doc/en/qwiicnes_example.md rename to doc/en/input/qwiicnes_example.md diff --git a/doc/en/leds/index.rst b/doc/en/leds/index.rst new file mode 100644 index 000000000..ffd56c10d --- /dev/null +++ b/doc/en/leds/index.rst @@ -0,0 +1,12 @@ +LED & Lighting APIs +******************* + +Driving single LEDs and addressable LED strips. See also the +:doc:`../led_driver/index` APIs for dedicated LED-driver ICs. + +.. toctree:: + :maxdepth: 1 + + led + led_strip + neopixel diff --git a/doc/en/led.rst b/doc/en/leds/led.rst similarity index 100% rename from doc/en/led.rst rename to doc/en/leds/led.rst diff --git a/doc/en/led_example.md b/doc/en/leds/led_example.md similarity index 100% rename from doc/en/led_example.md rename to doc/en/leds/led_example.md diff --git a/doc/en/led_strip.rst b/doc/en/leds/led_strip.rst similarity index 100% rename from doc/en/led_strip.rst rename to doc/en/leds/led_strip.rst diff --git a/doc/en/led_strip_example.md b/doc/en/leds/led_strip_example.md similarity index 100% rename from doc/en/led_strip_example.md rename to doc/en/leds/led_strip_example.md diff --git a/doc/en/neopixel.rst b/doc/en/leds/neopixel.rst similarity index 100% rename from doc/en/neopixel.rst rename to doc/en/leds/neopixel.rst diff --git a/doc/en/neopixel_example.md b/doc/en/leds/neopixel_example.md similarity index 100% rename from doc/en/neopixel_example.md rename to doc/en/leds/neopixel_example.md diff --git a/doc/en/color.rst b/doc/en/math/color.rst similarity index 100% rename from doc/en/color.rst rename to doc/en/math/color.rst diff --git a/doc/en/color_example.md b/doc/en/math/color_example.md similarity index 100% rename from doc/en/color_example.md rename to doc/en/math/color_example.md diff --git a/doc/en/math/index.rst b/doc/en/math/index.rst index c7f15c9d7..3d96938fa 100644 --- a/doc/en/math/index.rst +++ b/doc/en/math/index.rst @@ -1,6 +1,9 @@ Math APIs ********* +Numeric helpers and color math. See also the :doc:`../filters/index` APIs for +signal-processing filters. + .. toctree:: :maxdepth: 1 @@ -10,3 +13,4 @@ Math APIs gaussian range_mapper vector2d + color diff --git a/doc/en/adrc.rst b/doc/en/motor_control/adrc.rst similarity index 100% rename from doc/en/adrc.rst rename to doc/en/motor_control/adrc.rst diff --git a/doc/en/adrc_example.md b/doc/en/motor_control/adrc_example.md similarity index 100% rename from doc/en/adrc_example.md rename to doc/en/motor_control/adrc_example.md diff --git a/doc/en/motor_control/index.rst b/doc/en/motor_control/index.rst new file mode 100644 index 000000000..dd6cfb190 --- /dev/null +++ b/doc/en/motor_control/index.rst @@ -0,0 +1,13 @@ +Motor Control APIs +****************** + +Motor-control algorithms and controller interfaces. See also the +:doc:`../bldc/index` APIs for BLDC drivers and motors, and the +:doc:`../filters/index` APIs commonly used in control loops. + +.. toctree:: + :maxdepth: 1 + + pid + adrc + odrive_ascii diff --git a/doc/en/odrive_ascii.rst b/doc/en/motor_control/odrive_ascii.rst similarity index 100% rename from doc/en/odrive_ascii.rst rename to doc/en/motor_control/odrive_ascii.rst diff --git a/doc/en/odrive_ascii_example.md b/doc/en/motor_control/odrive_ascii_example.md similarity index 100% rename from doc/en/odrive_ascii_example.md rename to doc/en/motor_control/odrive_ascii_example.md diff --git a/doc/en/pid.rst b/doc/en/motor_control/pid.rst similarity index 100% rename from doc/en/pid.rst rename to doc/en/motor_control/pid.rst diff --git a/doc/en/pid_example.md b/doc/en/motor_control/pid_example.md similarity index 100% rename from doc/en/pid_example.md rename to doc/en/motor_control/pid_example.md diff --git a/doc/en/protocols/index.rst b/doc/en/protocols/index.rst new file mode 100644 index 000000000..4bc483fa9 --- /dev/null +++ b/doc/en/protocols/index.rst @@ -0,0 +1,13 @@ +Protocols & Network Tools APIs +****************************** + +Higher-level network protocols and networking tools built on top of the +:doc:`../network/index` APIs. + +.. toctree:: + :maxdepth: 1 + + rtps + rtsp + remote_debug + iperf_menu diff --git a/doc/en/iperf_menu.rst b/doc/en/protocols/iperf_menu.rst similarity index 100% rename from doc/en/iperf_menu.rst rename to doc/en/protocols/iperf_menu.rst diff --git a/doc/en/iperf_menu_example.md b/doc/en/protocols/iperf_menu_example.md similarity index 100% rename from doc/en/iperf_menu_example.md rename to doc/en/protocols/iperf_menu_example.md diff --git a/doc/en/remote_debug.rst b/doc/en/protocols/remote_debug.rst similarity index 100% rename from doc/en/remote_debug.rst rename to doc/en/protocols/remote_debug.rst diff --git a/doc/en/remote_debug_example.md b/doc/en/protocols/remote_debug_example.md similarity index 100% rename from doc/en/remote_debug_example.md rename to doc/en/protocols/remote_debug_example.md diff --git a/doc/en/rtps.rst b/doc/en/protocols/rtps.rst similarity index 100% rename from doc/en/rtps.rst rename to doc/en/protocols/rtps.rst diff --git a/doc/en/rtps_example.md b/doc/en/protocols/rtps_example.md similarity index 100% rename from doc/en/rtps_example.md rename to doc/en/protocols/rtps_example.md diff --git a/doc/en/rtsp.rst b/doc/en/protocols/rtsp.rst similarity index 100% rename from doc/en/rtsp.rst rename to doc/en/protocols/rtsp.rst diff --git a/doc/en/rtsp_example.md b/doc/en/protocols/rtsp_example.md similarity index 100% rename from doc/en/rtsp_example.md rename to doc/en/protocols/rtsp_example.md diff --git a/doc/en/file_system.rst b/doc/en/storage/file_system.rst similarity index 100% rename from doc/en/file_system.rst rename to doc/en/storage/file_system.rst diff --git a/doc/en/file_system_example.md b/doc/en/storage/file_system_example.md similarity index 100% rename from doc/en/file_system_example.md rename to doc/en/storage/file_system_example.md diff --git a/doc/en/storage/index.rst b/doc/en/storage/index.rst new file mode 100644 index 000000000..5e186758b --- /dev/null +++ b/doc/en/storage/index.rst @@ -0,0 +1,11 @@ +Storage & Configuration APIs +**************************** + +Persisting data and configuration on the device: filesystems and non-volatile +storage. + +.. toctree:: + :maxdepth: 1 + + file_system + nvs diff --git a/doc/en/nvs.rst b/doc/en/storage/nvs.rst similarity index 100% rename from doc/en/nvs.rst rename to doc/en/storage/nvs.rst diff --git a/doc/en/nvs_example.md b/doc/en/storage/nvs_example.md similarity index 100% rename from doc/en/nvs_example.md rename to doc/en/storage/nvs_example.md