Introduction

Here is the list of FWC function APIs

Files
file	mtpa.h
	Contains Maximum torque per ampere (MTPA) functions implementation.

Data Structures
struct	MTPA_Handle
	Defines the MTPA object. More...

Functions
void	MTPA_computeParameters (MTPA_Handle handle, const float32_t Ls_d_H, const float32_t Ls_q_H, const float32_t flux_Wb)
	Computes the motor constant for MTPA module. More...

MTPA_Handle	MTPA_init (void *pMemory, const size_t numBytes)
	Initializes the maximum torque per ampere (MTPA) module. More...

static void	MTPA_disable (MTPA_Handle handle)
	Disables the MTPA. More...

static void	MTPA_enable (MTPA_Handle handle)
	Enables the MTPA. More...

static float32_t *	MTPA_getCurrentAnglePhase_rad_addr (MTPA_Handle handle)
	Gets the stator current phase angle memory address. More...

static float32_t	MTPA_getCurrentAngle_rad (MTPA_Handle handle)
	Gets the stator current phase angle value (angleCurrent_rad) More...

static float32_t	MTPA_getKconst (MTPA_Handle handle)
	Gets the motor constant of MTPA. More...

static float32_t *	MTPA_getIs_ref_A_addr (MTPA_Handle handle)
	Gets the stator current reference memory address. More...

static bool	MTPA_getFlagEnable (MTPA_Handle handle)
	Gets the enable controller flag value from the controller. More...

static float32_t	MTPA_getId_ref_A (MTPA_Handle handle)
	Gets the direct current reference value (Id_ref_A) More...

static float32_t	MTPA_getIq_ref_A (MTPA_Handle handle)
	Gets the quadrature current reference value (Iq_ref_A) More...

static float32_t	MTPA_getIs_ref_A (MTPA_Handle handle)
	Gets the stator current reference value (Is_ref_A) More...

static void	MTPA_setFlagEnable (MTPA_Handle handle, const bool flagEnable)
	Sets the enable flag. More...

static void	MTPA_setCurrentAngle_rad (MTPA_Handle handle, const float32_t angleCurrent_rad)
	Sets the stator current phase angle value. More...

static void	MTPA_setId_ref_A (MTPA_Handle handle, const float32_t Id_ref_A)
	Sets the direct current (Id_ref) reference vector value. More...

static void	MTPA_setIq_ref_A (MTPA_Handle handle, const float32_t Iq_ref_A)
	Sets the quadrature current (Iq_ref) reference value. More...

static void	MTPA_setIs_ref_A (MTPA_Handle handle, const float32_t Is_ref_A)
	Sets the stator current reference value (Is_ref) More...

static float32_t	MTPA_updateLs_d_withLUT (MTPA_Handle handle, const float32_t Is_A)
	Update the motor inductances. More...

static float32_t	MTPA_updateLs_q_withLUT (MTPA_Handle handle, const float32_t Is_A)
	Update the motor inductances. More...

static void	MTPA_computeCurrentReference (MTPA_Handle handle, const float32_t Is_ref_A)
	Compute the current reference of MTPA. More...

static float32_t	MTPA_computeCurrentAngle (MTPA_Handle handle, const float32_t Is_ref_A)
	Compute the current angle of MTPA. More...

Macros
#define	MTPA_LUT_INDEX_LD_MAX 20
	Defines the maximum length of LUT for Ld. More...

#define	MTPA_LUT_INDEX_LQ_MAX 20
	Defines the maximum length of LUT for Lq. More...

#define	MTPA_LUT_DELTA_CURRENT_LD_A 0.5
	Defines the current delta of LUT for Ld, A. More...

#define	MTPA_LUT_DELTA_CURRENT_LD_A 0.5
	Defines the current delta of LUT for Ld, A. More...

Macro Definition Documentation

◆ MTPA_LUT_INDEX_LD_MAX

#define MTPA_LUT_INDEX_LD_MAX 20

Defines the maximum length of LUT for Ld.

◆ MTPA_LUT_INDEX_LQ_MAX

#define MTPA_LUT_INDEX_LQ_MAX 20

Defines the maximum length of LUT for Lq.

◆ MTPA_LUT_DELTA_CURRENT_LD_A [1/2]

#define MTPA_LUT_DELTA_CURRENT_LD_A 0.5

Defines the current delta of LUT for Ld, A.

Defines the current delta of LUT for Lq, A.

◆ MTPA_LUT_DELTA_CURRENT_LD_A [2/2]

#define MTPA_LUT_DELTA_CURRENT_LD_A 0.5

Defines the current delta of LUT for Ld, A.

Defines the current delta of LUT for Lq, A.

Function Documentation

◆ MTPA_computeParameters()

void MTPA_computeParameters	(	MTPA_Handle	handle,
		const float32_t	Ls_d_H,
		const float32_t	Ls_q_H,
		const float32_t	flux_Wb
	)

Computes the motor constant for MTPA module.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Ls_d_H	The direct stator inductance, Henry
[in]	Ls_q_H	The quadrature stator inductance, Henry
[in]	flux_Wb	The rated flux value, Wb

◆ MTPA_init()

MTPA_Handle MTPA_init	(	void *	pMemory,
		const size_t	numBytes
	)

Initializes the maximum torque per ampere (MTPA) module.

Parameters

[in]	pMemory	A pointer to the memory for the MTPA object
[in]	numBytes	The number of bytes allocated for the MTPA object

Returns: The Maximum torque per ampere (MTPA) object handle

◆ MTPA_disable()

static void MTPA_disable ( MTPA_Handle handle )

inlinestatic

Disables the MTPA.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

◆ MTPA_enable()

static void MTPA_enable ( MTPA_Handle handle )

inlinestatic

Enables the MTPA.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

◆ MTPA_getCurrentAnglePhase_rad_addr()

static float32_t* MTPA_getCurrentAnglePhase_rad_addr ( MTPA_Handle handle )

inlinestatic

Gets the stator current phase angle memory address.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The stator current phase angle memory address

◆ MTPA_getCurrentAngle_rad()

static float32_t MTPA_getCurrentAngle_rad ( MTPA_Handle handle )

inlinestatic

Gets the stator current phase angle value (angleCurrent_rad)

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The stator current phase angle value, rad

◆ MTPA_getKconst()

static float32_t MTPA_getKconst ( MTPA_Handle handle )

inlinestatic

Gets the motor constant of MTPA.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The motor constant of MTPA

◆ MTPA_getIs_ref_A_addr()

static float32_t* MTPA_getIs_ref_A_addr ( MTPA_Handle handle )

inlinestatic

Gets the stator current reference memory address.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The stator current reference memory address

◆ MTPA_getFlagEnable()

static bool MTPA_getFlagEnable ( MTPA_Handle handle )

inlinestatic

Gets the enable controller flag value from the controller.

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The enable MTPA flag value

◆ MTPA_getId_ref_A()

static float32_t MTPA_getId_ref_A ( MTPA_Handle handle )

inlinestatic

Gets the direct current reference value (Id_ref_A)

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The direct reference reference current, A

◆ MTPA_getIq_ref_A()

static float32_t MTPA_getIq_ref_A ( MTPA_Handle handle )

inlinestatic

Gets the quadrature current reference value (Iq_ref_A)

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The quadrature current reference value, A

◆ MTPA_getIs_ref_A()

static float32_t MTPA_getIs_ref_A ( MTPA_Handle handle )

inlinestatic

Gets the stator current reference value (Is_ref_A)

Parameters

[in] handle The maximum torque per ampere (MTPA) handle

Returns: The stator current reference value, A

◆ MTPA_setFlagEnable()

static void MTPA_setFlagEnable	(	MTPA_Handle	handle,
		const bool	flagEnable
	)

inlinestatic

Sets the enable flag.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	flagEnable	The enable flag

◆ MTPA_setCurrentAngle_rad()

static void MTPA_setCurrentAngle_rad	(	MTPA_Handle	handle,
		const float32_t	angleCurrent_rad
	)

inlinestatic

Sets the stator current phase angle value.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	angleCurrent_rad	The stator current phase angle value, rad

◆ MTPA_setId_ref_A()

static void MTPA_setId_ref_A	(	MTPA_Handle	handle,
		const float32_t	Id_ref_A
	)

inlinestatic

Sets the direct current (Id_ref) reference vector value.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Id_ref_A	The direct current reference value, A

◆ MTPA_setIq_ref_A()

static void MTPA_setIq_ref_A	(	MTPA_Handle	handle,
		const float32_t	Iq_ref_A
	)

inlinestatic

Sets the quadrature current (Iq_ref) reference value.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Iq_ref_A	The quadrature current reference value, A

◆ MTPA_setIs_ref_A()

static void MTPA_setIs_ref_A	(	MTPA_Handle	handle,
		const float32_t	Is_ref_A
	)

inlinestatic

Sets the stator current reference value (Is_ref)

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Is_ref_A	The stator current reference value, A

◆ MTPA_updateLs_d_withLUT()

static float32_t MTPA_updateLs_d_withLUT	(	MTPA_Handle	handle,
		const float32_t	Is_A
	)

inlinestatic

Update the motor inductances.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Is_A	The stator current value, A

Returns: The d-axis inductance

◆ MTPA_updateLs_q_withLUT()

static float32_t MTPA_updateLs_q_withLUT	(	MTPA_Handle	handle,
		const float32_t	Is_A
	)

inlinestatic

Update the motor inductances.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Is_A	The stator current value, A

Returns: The q-axis inductance

◆ MTPA_computeCurrentReference()

static void MTPA_computeCurrentReference	(	MTPA_Handle	handle,
		const float32_t	Is_ref_A
	)

static

Compute the current reference of MTPA.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Is_ref_A	The stator current reference value, A

◆ MTPA_computeCurrentAngle()

static float32_t MTPA_computeCurrentAngle	(	MTPA_Handle	handle,
		const float32_t	Is_ref_A
	)

static

Compute the current angle of MTPA.

Parameters

[in]	handle	The maximum torque per ampere (MTPA) handle
[in]	Is_ref_A	The stator current reference value, A

Returns: The vector stator current reference

Variable Documentation

◆ MTPA_Ld_tableData_H

const float32_t MTPA_Ld_tableData_H[MTPA_LUT_INDEX_LD_MAX+1]

extern

Defines the Ld array.

◆ MTPA_Lq_tableData_H

const float32_t MTPA_Lq_tableData_H[MTPA_LUT_INDEX_LQ_MAX+1]

extern

Defines the Lq array.

Introduction

Files

Data Structures

Functions

Macros

Macro Definition Documentation

◆ MTPA_LUT_INDEX_LD_MAX

◆ MTPA_LUT_INDEX_LQ_MAX

◆ MTPA_LUT_DELTA_CURRENT_LD_A [1/2]

◆ MTPA_LUT_DELTA_CURRENT_LD_A [2/2]

Function Documentation

◆ MTPA_computeParameters()

◆ MTPA_init()

◆ MTPA_disable()

◆ MTPA_enable()

◆ MTPA_getCurrentAnglePhase_rad_addr()

◆ MTPA_getCurrentAngle_rad()

◆ MTPA_getKconst()

◆ MTPA_getIs_ref_A_addr()

◆ MTPA_getFlagEnable()

◆ MTPA_getId_ref_A()

◆ MTPA_getIq_ref_A()

◆ MTPA_getIs_ref_A()

◆ MTPA_setFlagEnable()

◆ MTPA_setCurrentAngle_rad()

◆ MTPA_setId_ref_A()

◆ MTPA_setIq_ref_A()

◆ MTPA_setIs_ref_A()

◆ MTPA_updateLs_d_withLUT()

◆ MTPA_updateLs_q_withLUT()

◆ MTPA_computeCurrentReference()

◆ MTPA_computeCurrentAngle()

Variable Documentation

◆ MTPA_Ld_tableData_H

◆ MTPA_Lq_tableData_H