From ad4152f354f778956ac96c44c578f9503cf87a9b Mon Sep 17 00:00:00 2001 From: Dhaval Khandla Date: Tue, 26 Sep 2023 18:20:38 +0530 Subject: [PATCH] am263x: docs: Update main page Fixes: PINDSW-6551 Signed-off-by: Dhaval Khandla --- .../components/position_sense/position_sense.md | 12 ++++++------ docs_src/docs/api_guide/main_page/main_page.md | 16 ++++++++++++++++ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs_src/docs/api_guide/components/position_sense/position_sense.md b/docs_src/docs/api_guide/components/position_sense/position_sense.md index 063155e..2193ace 100644 --- a/docs_src/docs/api_guide/components/position_sense/position_sense.md +++ b/docs_src/docs/api_guide/components/position_sense/position_sense.md @@ -8,16 +8,16 @@ Real-time communication with encoders and current sensing is typically handled b Applications and PRU-ICSS firmwares for following position sense encoders are provided in the SDK. -- \subpage ENDAT -- \subpage HDSL -- \subpage TAMAGAWA +- \subpage ENDAT +- \subpage HDSL +- \subpage TAMAGAWA \endcond -\cond SOC_AM263X +\cond SOC_AM263X -Applications and PRU-ICSS firmwares for following position sense encoder is provided in the SDK. +Application for following position sense encoder is provided in the SDK. -\subpage TAMAGAWA_OVER_UART +- \subpage TAMAGAWA_OVER_UART \endcond \ No newline at end of file diff --git a/docs_src/docs/api_guide/main_page/main_page.md b/docs_src/docs/api_guide/main_page/main_page.md index 506c7dd..473da99 100644 --- a/docs_src/docs/api_guide/main_page/main_page.md +++ b/docs_src/docs/api_guide/main_page/main_page.md @@ -2,6 +2,8 @@ [TOC] +\cond SOC_AM64X || SOC_AM243X + Welcome to **@VAR_SDK_NAME for @VAR_SOC_NAME**. This SDK contains examples, libraries and tools to develop **RTOS and no-RTOS** based applications enabling real-time communication for position and current sense from motors, and real-time control libraries for **ARM R5F CPU** and related peripherals. @@ -9,6 +11,14 @@ Real-time communication with encoders and current sensing is typically handled b Applications and PRU-ICSS firmwares for position sense and current sense are provided in the SDK. +\endcond + +\cond SOC_AM263X + +Welcome to **@VAR_SDK_NAME for @VAR_SOC_NAME**. This SDK contains examples, libraries and tools to develop **RTOS and no-RTOS** based applications enabling real-time communication for position sense from motors, and real-time control libraries for **ARM R5F CPU** and related peripherals. + +\endcond + \attention This SDK also includes @VAR_SOC_NAME Industrial Communications SDK and @VAR_SOC_NAME MCU+ SDK. ## Getting Started @@ -124,6 +134,12 @@ The main software components in the block diagram specific to motor control are \ref TAMAGAWA_OVER_UART Driver for Tamagawa encoder interface +**Real Time Libraries** + + Digital Control Library (DCL) + \ref DCL + Header-only library for digital control applications + **Examples and Demos** Examples and Demos