External/motor-control-sdk
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pull request #47: am263x: docs: Update main page

Browse Source 
Merge in PINDSW/motor_control_sdk from PINDSW-6551_update_release_notes_am263x to next

* commit 'ad4152f354f778956ac96c44c578f9503cf87a9b':
  am263x: docs: Update main page
This commit is contained in:
Dhaval Khandla 2023-09-27 00:01:24 -05:00 committed by Naresh A
commit dc2d7819dc
2 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs_src/docs/api_guide/components/position_sense/position_sense.md
View File

@ -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. Applications and PRU-ICSS firmwares for following position sense encoders are provided in the SDK.
- \subpage ENDAT - \subpage ENDAT
- \subpage HDSL - \subpage HDSL
- \subpage TAMAGAWA - \subpage TAMAGAWA
\endcond \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 \endcond

16
docs_src/docs/api_guide/main_page/main_page.md
View File

@ -2,6 +2,8 @@
[TOC] [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. 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. 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 <a href="@VAR_IC_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME Industrial Communications SDK</a> and <a href="@VAR_MCU_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME MCU+ SDK</a>. \attention This SDK also includes <a href="@VAR_IC_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME Industrial Communications SDK</a> and <a href="@VAR_MCU_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME MCU+ SDK</a>.
## Getting Started ## Getting Started
@ -124,6 +134,12 @@ The main software components in the block diagram specific to motor control are
<td>\ref TAMAGAWA_OVER_UART <td>\ref TAMAGAWA_OVER_UART
<td> Driver for Tamagawa encoder interface <td> Driver for Tamagawa encoder interface
</tr> </tr>
<tr><td colspan="3" bgcolor=#F0F0F0>**Real Time Libraries**</td></tr>
<tr>
<td> Digital Control Library (DCL)
<td>\ref DCL
<td> Header-only library for digital control applications
</tr>
<tr><td colspan="3" bgcolor=#F0F0F0>**Examples and Demos**</td></tr> <tr><td colspan="3" bgcolor=#F0F0F0>**Examples and Demos**</td></tr>
<tr> <tr>
<td>Examples and Demos <td>Examples and Demos