ST / X_NUCLEO_IHM02A1

Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the L6470 component.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   HelloWorld_IHM02A1 ConcorsoFinal HelloWorld_IHM02A1_mbedOS HelloWorld_IHM02A1-Serialinterpreter ... more

Fork of X_NUCLEO_IHM02A1 by ST Expansion SW Team

Embed: (wiki syntax)

« Back to documentation index

L6470_Private_Functions
Modules | Functions

L6470_Private_Functions
[L6470_Private_Variables]

Modules

 L6470_Exported_Functions

Functions

void L6470_ResetAppCmdPkg (sL6470_AppCmdPkg_t *pL6470_AppCmdPkg)
 Reset the structure used to store the identifier of the L6470 application command and its the needed parameters.
void L6470_FillAppCmdPkg (sL6470_AppCmdPkg_t *pL6470_AppCmdPkg, eL6470_AppCmdId_t L6470_AppCmdId, uint32_t p1, uint32_t p2, uint32_t p3)
 Fill the structure used to store the identifier of the L6470 application command and its the needed parameters.
void L6470_PrepareAppCmdPkg (sL6470_AppCmdPkg_t *pL6470_AppCmdPkg, eL6470_AppCmdId_t L6470_AppCmdId, uint32_t p1, uint32_t p2, uint32_t p3)
 This function will fill the column of the L6470_AppCmdPkg related the L6470 to be addressed inside the daisy chain.
void L6470_PrepareDaisyChainCommand (sL6470_AppCmdPkg_t *pL6470_AppCmdPkg, uint8_t *pL6470_DaisyChainSpiTxStruct)
 This function will translate the data inside the L6470_AppCmdPkg into the right data to be sent via SPI to the L6470 daisy chain.

Function Documentation

void L6470_FillAppCmdPkg ( sL6470_AppCmdPkg_t *  pL6470_AppCmdPkg,
eL6470_AppCmdId_t  L6470_AppCmdId,
uint32_t  p1,
uint32_t  p2,
uint32_t  p3 
) [protected, inherited]

Fill the structure used to store the identifier of the L6470 application command and its the needed parameters.

Parameters:
L6470_IdThe identifier of the L6470 target inside the daisy chain.
pL6470_AppCmdPkgThe structure to be filled.
L6470_AppCmdIdThe identifier of the L6470 application command to be sent.
p1The 1st parameter (if it is not needed it will be not considered).
p2The 2nd parameter (if it is not needed it will be not considered).
p3The 3rd parameter (if it is not needed it will be not considered).

Definition at line 188 of file L6470.cpp.

void L6470_PrepareAppCmdPkg ( sL6470_AppCmdPkg_t *  pL6470_AppCmdPkg,
eL6470_AppCmdId_t  L6470_AppCmdId,
uint32_t  p1,
uint32_t  p2,
uint32_t  p3 
) [protected, inherited]

This function will fill the column of the L6470_AppCmdPkg related the L6470 to be addressed inside the daisy chain.

Parameters:
L6470_IdThe identifier of the L6470 target inside the daisy chain.
pL6470_AppCmdPkgPointer to the sL6470_AppCmdPkg_t to be filled.
L6470_AppCmdIdThe identifier of the L6470 application command to be sent.
p1The 1st parameter (if it is not needed it will be not considered).
p2The 2nd parameter (if it is not needed it will be not considered).
p3The 3rd parameter (if it is not needed it will be not considered).

Definition at line 207 of file L6470.cpp.

void L6470_PrepareDaisyChainCommand ( sL6470_AppCmdPkg_t *  pL6470_AppCmdPkg,
uint8_t *  pL6470_DaisyChainSpiTxStruct 
) [protected, inherited]

This function will translate the data inside the L6470_AppCmdPkg into the right data to be sent via SPI to the L6470 daisy chain.

Parameters:
pL6470_AppCmdPkgPointer to the sL6470_AppCmdPkg_t to be filled.
pL6470_DaisyChainSpiTxStructPointer to the structure used by SPI to send the commands.

Definition at line 225 of file L6470.cpp.

void L6470_ResetAppCmdPkg ( sL6470_AppCmdPkg_t *  pL6470_AppCmdPkg ) [protected, inherited]

Reset the structure used to store the identifier of the L6470 application command and its the needed parameters.

Parameters:
pL6470_AppCmdPkgThe structure to be reset.

Definition at line 165 of file L6470.cpp.

Generated on Tue Jul 12 2022 22:48:07 by  doxygen 1.7.2