diff --git a/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md b/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md index b362b0f..ba5ff2f 100644 --- a/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md +++ b/docs_src/docs/api_guide/device/am243x/release_notes_09_00_00.md @@ -369,10 +369,21 @@ earlier SDKs. Additional Remarks + Position Sense EnDat + \ref endat_init + Added api parameter + void* pruss_iep + + + Position Sense EnDat + Structure: endat_priv + Added variables: pruss_iep, cmp3, cmp5 and cmp6 - - + + + Position Sense EnDat + Structure: cmd_supplement + Added variables: cmp3, cmp5 and cmp6 - diff --git a/docs_src/docs/api_guide/examples/endat_example.md b/docs_src/docs/api_guide/examples/endat_example.md index a75b8f7..42829c9 100644 --- a/docs_src/docs/api_guide/examples/endat_example.md +++ b/docs_src/docs/api_guide/examples/endat_example.md @@ -62,7 +62,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F). Folder/Files Description - ${SDK_INSTALL_PATH}/examples/motor_control/endat_diagnostic + ${SDK_INSTALL_PATH}/examples/position_sense/endat_diagnostic endat_diagnostic.c EnDAT diagnostic application @@ -86,7 +86,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F). ---------------|----------- CPU + OS | r5fss0-0 freertos ICSSG | ICSSG0 - PRU | PRU1 + PRU | PRU1, TXPRU1 and RTUPRU1 Toolchain | ti-arm-clang Board | @VAR_BOARD_NAME_LOWER Example folder | examples/motorcontrol/endat_example @@ -99,7 +99,7 @@ Following section describes the Example implementation of EnDat on ARM(R5F). ---------------|----------- CPU + OS | r5fss0-0 freertos ICSSG | ICSSG0 - PRU | PRU1 + PRU | PRU1, TXPRU1 and RTUPRU1 Toolchain | ti-arm-clang Board | @VAR_BOARD_NAME_LOWER, @VAR_LP_BOARD_NAME_LOWER Example folder | examples/motorcontrol/endat_example @@ -120,8 +120,8 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM ### Hardware Prerequisities for Booster Pack - EnDat encoder -- AM243x-LP board -- BP-AM2BLDCSERVO +- AM243x-LP board +- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO \endcond ## Hardware Setup @@ -222,389 +222,571 @@ Shown below is a sample output when the application is run: + - + + - + - + + - - + - - - - + + - + + - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - + - - - - + - + + - + - - - + + - + + + + - - + + + + + + + - - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + - - - + - + + - - - + - - - + + + + - + + + + + + + + + + + + + + + + + - + - - - + + - - + - - - + + - + + + + + + + + + + + + + + - - - + + - - + - - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + - - + - - - - + + - + - + - - + - - + - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + - + + - - + - + + - - + + + - - + - + + - - - + + - - - + + - - + - - - + + - + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + +
S.No Test detail Steps Pass/fail crieteria
To check position value1.To check position value 1. Enter 1 to select "Encoder send position values"Crc success CRC success
To receive encoder's operating parameters(error messege)2.To receive encoder's operating parameters (Error Message) 1. Enter 2 to select "Selection of memory area"
2. Enter "B9" in MRS code to select "Operating parameters"Crc success CRC success
3. Enter 4 to select "Encoder to send parameter"
4. Enter 0 in "parameter address" for selecting "Error message"Crc success 4. Enter 00 in "parameter address" for selecting "Error message"CRC success
To receive encoder's manufacture parameters for Endat 2.23.To receive encoder's operating parameters (Warning message) 1. Enter 2 to select "Selection of memory area"
2. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"Crc success 2. Enter "B9" in MRS code to select "Operating parameters"CRC success
3. Enter 4 to select "Encoder to send parameter"Crc success
4. Enter 0 in "parameter address" for selecting "Status of additional info"Crc success
To set values to encoder's operating parameters (error message)4. Enter 01 in "parameter address" for selecting "Error message"CRC success
4.To receive encoder's manufacture parameters for Endat 2.21. Enter 2 to select "Selection of memory area"
2. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"CRC success
3. Enter 4 to select "Encoder to send parameter"CRC success
4. Enter 0 in "parameter address" for selecting "Status of additional info 1"CRC success
5.To set values to encoder's operating parameters (Clear error message) 1. Enter 2 to select "Selection of memory area"
2. Enter "B9" in MRS code to select "Operating parameters"Crc success CRC success
3. Enter 3 to select "Encoder to receive parameter"
4. Enter 0 in "parameter address" for selecting "Error message"
5. Enter 0 in "parameter value" for seting value in " Error message"Crc success CRC success
To set values to encoder's manufacturing parameters for Endat 2.2(Status of additional info)6.To set values to encoder's operating parameters (Clear warning message) 1. Enter 2 to select "Selection of memory area"
2. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"Crc success 2. Enter "B9" in MRS code to select "Operating parameters"CRC success
3. Enter 3 to select "Encoder to receive parameter"
4. Enter 01 in "parameter address" for selecting "Error message"
4. Enter 0 in "parameter address" for selecting "Status of additional info"5. Enter 0 in "parameter value" for seting value in " Error message"CRC success
7.To set values to encoder's manufacturing parameters for Endat 2.2(Status of additional info)1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
5. Enter 0 in "parameter value" for seting value in " Status of additional info"Crc success 2. Enter "45" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"CRC success
To reset encoder3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"CRC success
4. Enter "BD" in MRS code to select "Memory parameter (LSB)" of Additional Information 1CRC success
5. Enter 10 to select "Encoder send position values + Additional Information(s) and receive parameter"
6. Enter 0 in "parameter address" for selecting "Status of additional info"
7. Enter 1235 (or any 2 byte value) in "parameter value" for seting value in " Status of additional info"CRC success
8. Enter 8 to select "Encoder send position values + Additional Information(s)"
  Note: Write is not permenant. When read again using Command 11, encoder will return the default value		Values followed by 0x45 represents last byte of the data received by encoder
Crc success
8.To reset encoder 1. Enter 5 to select "Encoder receive reset"Crc success CRC success
To receive test values from encoder with port address "0"9.To receive test values from encoder with port address "0" 1. Enter 7 to select "Encoder receive test command"
2. Enter 0 in "enter port address"
3. Enter 6 to select "Encoder send test values"Crc success CRC success
To receive test values from encoder with port address "E" 10.To receive test values from encoder with port address "E" 1. Enter 7 to select "Encoder receive test command"
2. Enter "E" in "enter port address"
3. Enter 6 to select "Encoder send test values"Crc success CRC success
To check position value with aditional info.1. Enter 8 to select "Encoder send position values + AI(s)"Crc success 11.To check position value with aditional info.1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"CRC success
To receive encoder's operating parameters(error messege) + 2. Enter "47" in MRS code to select "Acknowledge MRS code" of Additional Information 1CRC success
3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
4. Enter "56" in MRS code to select "Asynchronous Position value word 1 LSB" of Additional Information 2CRC success
5. Enter 8 to select "Encoder send position values + Additional Information(s)"CRC success
12.To receive encoder's operating parameters(error messege) +receive position value with additional info 1. Enter 9 to select "Encoder send position values + AI(s) and Selection of memory area"1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "B9" in MRS code to select "Operating parameters"Crc success 2. Enter "45" in MRS code to select "Memory parameter (LSB)" of Additional Information 1CRC success
3. Enter 11 to select "Encoder send position values + AI(s) and send parameter"3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
4. Enter 0 in "parameter address" for selecting "Error message"Crc success4. Enter "B9" in MRS code to select "Operating parameters"CRC success
To receive encoder's manufacture parameters + 5. Enter 11 to select "Encoder send position values + Additional Information(s) and send parameter"
6. Enter 0 in "parameter address" for selecting "Error message"CRC success
7. Enter 8 to select "Encoder send position values + Additional Information(s)"CRC success
13.To receive encoder's manufacture parameters for Endat 2.2 +receive position value with additional info - 1. Enter 9 to select "Encoder send position values + AI(s) and Selection of memory area"1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"Crc success 2. Enter "45" in MRS code to select "Memory parameter (LSB)" of Additional Information 1CRC success
3. Enter 11 to select "Encoder send position values + AI(s) and send parameter"3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
4. Enter 0 in "parameter address" for selecting "Status of additional info"Crc success4. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"CRC success
To set values to encoder's operating parameters (error message) + 5. Enter 11 to select "Encoder send position values + Additional Information(s) and send parameter"
6. Enter 0 in "parameter address" for selecting "Status of additional info 1"
7. Enter 8 to select "Encoder send position values + Additional Information(s)"CRC success
14.To acknowledge MRS code for Endat 2.2 + 1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "47" in MRS code to select "Acknowledge MRS code" of Additional Information 1CRC success
3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area
4. Enter "BD" or any other valid MRS code CRC success
5. Enter 8 to select "Encoder send position values + Additional Information(s)"Additional Information 1:0x47bd00
    (for MRS code = BD)
15.To set values to encoder's operating parameters (error message) +receive position value with additional info - 1. Enter 9 to select "Encoder send position values + AI(s) and Selection of memory area"1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "B9" in MRS code to select "Operating parameters"Crc success CRC success
3. Enter 10 to select "Encoder send position values + AI(s) and receive parameter"3. Enter 10 to select "Encoder send position values + Additional Information(s) and receive parameter"
4. Enter 0 in "parameter address" for selecting "Error message"
5. Enter 0 in "parameter value" for seting value in " Error message"Crc success5. Enter 0 in "parameter value" for seting value in "Error message"CRC success
To set values to encoder's manufacturing parameters for Endat 2.2(Status of additional info) + 16.To set values to encoder's manufacturing parameters for Endat 2.2(Status of additional info) +receive position value with additional info 1. Enter 9 to select "Encoder send position values + AI(s) and Selection of memory area"1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "BD" in MRS code to select "Parameters of encoder manufacturer for Endat 2.2"Crc success CRC success
3. Enter 10 to select "Encoder send position values + AI(s) and receive parameter"3. Enter 10 to select "Encoder send position values + Additional Information(s) and receive parameter"
4. Enter 0 in "parameter address" for selecting "Status of additional info"
5. Enter 0 in "parameter value" for seting value in " Status of additional info"Crc successCRC success
To reset encoder +receive position value with additional info1. Enter 12 to select "Encoder send position values + AI(s) and receive error reset"Crc success
1. Enter 14 to select "Encoder receive communication command"Crc success
2. Enter ______in "enter encoder address" Crc success
3. Enter _____ in "instruction hex value"Crc success
1. Enter 14 to select "Encoder receive communication command"Crc success
2. Enter ______in "enter encoder address" Crc success
3. Enter _____ in "instruction hex value"Crc success
Configure Clock 1. Enter 100 to select "configure clock"Crc success(Tested up to 8MHz)
2. Enter ___ for clock frequency(in Hz)17.To receive encoder's OEM (Original Equipment Manufacturer) data 1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
Simulate motor control 2.1 position loop2. Enter "45" in MRS code to select "Memory parameter (LSB)" of Additional Information 1CRC success
3. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
4. Enter A9 (or AB or AD) in MRS code to select the OEM memoryCRC success
5. Enter 11 to select "Encoder send position values + Additional Information(s) and send parameter"
6. Enter 40 in "parameter address"
7. Enter 8 to select "Encoder send position values + Additional Information(s)"CRC success
18.To set values in OEM memory area 1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "A9" in MRS code to select "Operating parameters"CRC success
3. Enter 10 to select "Encoder send position values + Additional Information(s) and receive parameter"
4. Enter 40 in "parameter address"
5. Enter E9 in "parameter value"CRC success
19.To reset encoder +receive position value with additional info1. Enter 12 to select "Encoder send position values + Additional Information(s) and receive error reset"CRC success
1. Enter 14 to select "Encoder receive communication command"CRC success
2. Enter ______in "enter encoder address" CRC success
3. Enter _____ in "instruction hex value"CRC success
1. Enter 14 to select "Encoder receive communication command"CRC success
2. Enter ______in "enter encoder address" CRC success
3. Enter _____ in "instruction hex value"CRC success
20.Configure Clock 1. Enter 100 to select "configure clock"
2. Enter ___ for clock frequency(in Hz)CRC success(Tested up to 8MHz)
21.Simulate motor control 2.1 position loop 1. Enter 101 to select "Simulate motor control 2.1 position loop"
2. Enter 10000 to select "clock frequency"
3. Rotate the rotor of motor and see the changes in Position value on UARTPosition Values are changing when rotor moves Position Values are changing when rotor moves
Toggle raw data display22.Toggle raw data display 1. Enter 102 to select "Toggle raw data display"
2. Enter 1 to select "Encoder send position value"raw data can be displayed raw data can be displayed
Configure TST delay23.Configure TST delay
Start continous mode1. Enter 104 to select "Start continous mode"24.Start continuous mode1. Enter 104 to select "Start continuous mode"
2. Rotate the rotor of motor and see the changes in Position value on UARTPosition Values are changing when rotor moves Position Values are changing when rotor moves
Configure rx arm counter25.Configure rx arm counter 1. Enter 105 to select "Configure rx arm counter"
2. Enter 0 to select channel 0(only for multi channel configuration)
3. Enter ___ to "select time in ns"
configure rx clock disable time26.configure rx clock disable time 1. Enter 106 to select "configure rx clock disable time"
2. Enter 0 to select channel 0(only for multi channel configuration)
3. Enter ___ to "select time in ns"
Simulate motor control 2.2 position loop(safety)27.Simulate motor control 2.2 position loop(safety) 1. Enter 107 to select "Simulate motor control 2.2 position loop"
3. Enter 10000 to select "clock frequency"2. Enter 10000 to select "clock frequency"
4. Rotate the rotor of motor and see the changes in Position value on UARTPosition Values are changing when rotor moves 3. Rotate the rotor of motor and see the changes in Position value on UARTPosition Values are changing when rotor moves
Configure propogation delay(td)28.Configure propogation delay(td) 1. Enter 108 to select configure propagation delay
2. Enter 0 to select channel 0(only for multi channel configuration)
To read Recovery Time1. Enter 8 to select "Encoder send position values + AI(s)" Crc Success 29.Configure Recovery time (tr) using EnDat 2.2 mode transmission1. Enter 9 to select "Encoder send position values + Additional Information(s) and Selection of memory area"
2. Enter "B9" in MRS code to select "Operating parameters"
3. Enter 10 to select "Encoder send position values + Additional Information(s) and receive parameter"
4. Enter 03 in "parameter address" for selecting "Initializing the functions"
5. Enter 01 in "parameter value" for selecting low recovery time
               or
   Enter 02 in "parameter value" for selecting high recovery time		CRC success
30.To read Recovery Time1. Enter 8 to select "Encoder send position values + Additional Information(s)" CRC Success
2. Enter 110 for read recovery time from DMEM Recovery Time is set to 1.25 us <= RT <= 3.75us or 10 us <= RT <= 30 usRecovery Time is set to 1.25 us <= RT <= 3.75us or 10 us <= RT <= 30 us
31.To test periodic continuous mode1. Enter 200 to enable periodic mode
2. Enter 5000 (in ns) for position read time Position Values are changing when rotor moves
32.Long term test1. Enter 111 to enable Long time continuous mode
2. press enter to stop the long term testThe result shows the number of position command sent and the number of CRC failures received
\ No newline at end of file diff --git a/docs_src/docs/api_guide/examples/hdsl_example.md b/docs_src/docs/api_guide/examples/hdsl_example.md index b570a9e..43b1c01 100644 --- a/docs_src/docs/api_guide/examples/hdsl_example.md +++ b/docs_src/docs/api_guide/examples/hdsl_example.md @@ -93,7 +93,7 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM - HDSL encoder - AM243x-LP board -- BP-AM2BLDCSERVO +- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO \endcond diff --git a/docs_src/docs/api_guide/examples/tamagawa_example.md b/docs_src/docs/api_guide/examples/tamagawa_example.md index 764a774..32d31fd 100644 --- a/docs_src/docs/api_guide/examples/tamagawa_example.md +++ b/docs_src/docs/api_guide/examples/tamagawa_example.md @@ -95,7 +95,7 @@ Other than the basic EVM setup mentioned in \htmllink{@VAR_MCU_SDK_DOCS_PATH/EVM - Tamagawa encoder - AM243x-LP board -- BP-AM2BLDCSERVO +- BP-AM2BLDCSERVO, https://www.ti.com/tool/BP-AM2BLDCSERVO \endcond diff --git a/docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png b/docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png index cd5a43d..25a0063 100644 Binary files a/docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png and b/docs_src/docs/api_guide/images/position_sense/EnDAT_Initialization_UART_PRINT.png differ