From 95839eb1c61b264f9f09c9d1d02c877d19e42704 Mon Sep 17 00:00:00 2001 From: laokaiyao Date: Wed, 9 Aug 2023 12:15:28 +0800 Subject: [PATCH] docs(parlio_rx): add programming guide --- docs/doxygen/Doxyfile | 1 + docs/en/api-reference/peripherals/parlio.rst | 9 ++++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index d92b07e169..1d1830e547 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -75,6 +75,7 @@ INPUT = \ $(PROJECT_PATH)/components/console/esp_console.h \ $(PROJECT_PATH)/components/driver/ledc/include/driver/ledc.h \ $(PROJECT_PATH)/components/driver/parlio/include/driver/parlio_tx.h \ + $(PROJECT_PATH)/components/driver/parlio/include/driver/parlio_rx.h \ $(PROJECT_PATH)/components/driver/parlio/include/driver/parlio_types.h \ $(PROJECT_PATH)/components/driver/touch_sensor/include/driver/touch_sensor_common.h \ $(PROJECT_PATH)/components/driver/twai/include/driver/twai.h \ diff --git a/docs/en/api-reference/peripherals/parlio.rst b/docs/en/api-reference/peripherals/parlio.rst index cd8318e682..b2c96cbf87 100644 --- a/docs/en/api-reference/peripherals/parlio.rst +++ b/docs/en/api-reference/peripherals/parlio.rst @@ -6,21 +6,24 @@ Introduction The Parallel IO peripheral is a general purpose parallel interface that can be used to connect to external devices such as LED matrix, LCD display, Printer and Camera. The peripheral has independent TX and RX units. Each unit can have up to 8 or 16 data signals plus 1 or 2 clock signals. [1]_ -.. warning:: +The TX and RX driver of Parallel IO peripheral are designed separately, you can include ``driver/parlio_tx.h`` or ``driver/parlio_rx.h`` to use any of them. - At the moment, the Parallel IO driver only supports TX mode. The RX feature is still working in progress. +Parlio RX Driver +---------------- Application Examples -------------------- -* Simple REG LED Matrix with HUB75 interface: :example:`peripherals/parlio/simple_rgb_led_matrix`. +* Simple REG LED Matrix with HUB75 interface: :example:`peripherals/parlio/parlio_tx/simple_rgb_led_matrix`. +* Logic Analyzer: :example:`peripherals/parlio/parlio_rx/logic_analyzer`. API Reference ------------- .. include-build-file:: inc/parlio_tx.inc +.. include-build-file:: inc/parlio_rx.inc .. include-build-file:: inc/components/driver/parlio/include/driver/parlio_types.inc .. include-build-file:: inc/components/hal/include/hal/parlio_types.inc