drivers/hardware_api.h File Reference

#include "../common/foc_utils.h"
#include "../common/time_utils.h"

Go to the source code of this file.

Functions
void	_configure2PWM (long pwm_frequency, const int pinA, const int pinB)
void	_configure3PWM (long pwm_frequency, const int pinA, const int pinB, const int pinC)
void	_configure4PWM (long pwm_frequency, const int pin1A, const int pin1B, const int pin2A, const int pin2B)
int	_configure6PWM (long pwm_frequency, float dead_zone, const int pinA_h, const int pinA_l, const int pinB_h, const int pinB_l, const int pinC_h, const int pinC_l)
void	_writeDutyCycle2PWM (float dc_a, float dc_b, int pinA, int pinB)
void	_writeDutyCycle3PWM (float dc_a, float dc_b, float dc_c, int pinA, int pinB, int pinC)
void	_writeDutyCycle4PWM (float dc_1a, float dc_1b, float dc_2a, float dc_2b, int pin1A, int pin1B, int pin2A, int pin2B)
void	_writeDutyCycle6PWM (float dc_a, float dc_b, float dc_c, float dead_zone, int pinA_h, int pinA_l, int pinB_h, int pinB_l, int pinC_h, int pinC_l)

Function Documentation

_configure2PWM()

void _configure2PWM	(	long	pwm_frequency,
		const int	pinA,
		const int	pinB
	)

Configuring PWM frequency, resolution and alignment

• Stepper driver - 2PWM setting
• hardware specific

Parameters

pwm_frequency	- frequency in hertz - if applicable
pinA	pinA bldc driver
pinB	pinB bldc driver

Definition at line 23 of file drivers/hardware_specific/generic_mcu.cpp.

_configure3PWM()

void _configure3PWM	(	long	pwm_frequency,
		const int	pinA,
		const int	pinB,
		const int	pinC
	)

Configuring PWM frequency, resolution and alignment

• BLDC driver - 3PWM setting
• hardware specific

Parameters

pwm_frequency	- frequency in hertz - if applicable
pinA	pinA bldc driver
pinB	pinB bldc driver
pinC	pinC bldc driver

Definition at line 31 of file drivers/hardware_specific/generic_mcu.cpp.

_configure4PWM()

void _configure4PWM	(	long	pwm_frequency,
		const int	pin1A,
		const int	pin1B,
		const int	pin2A,
		const int	pin2B
	)

Configuring PWM frequency, resolution and alignment

• Stepper driver - 4PWM setting
• hardware specific

Parameters

pwm_frequency	- frequency in hertz - if applicable
pin1A	pin1A stepper driver
pin1B	pin1B stepper driver
pin2A	pin2A stepper driver
pin2B	pin2B stepper driver

Definition at line 40 of file drivers/hardware_specific/generic_mcu.cpp.

_configure6PWM()

int _configure6PWM	(	long	pwm_frequency,
		float	dead_zone,
		const int	pinA_h,
		const int	pinA_l,
		const int	pinB_h,
		const int	pinB_l,
		const int	pinC_h,
		const int	pinC_l
	)

Configuring PWM frequency, resolution and alignment

• BLDC driver - 6PWM setting
• hardware specific

Parameters

pwm_frequency	- frequency in hertz - if applicable
dead_zone	duty cycle protection zone [0, 1] - both low and high side low - if applicable
pinA_h	pinA high-side bldc driver
pinA_l	pinA low-side bldc driver
pinB_h	pinA high-side bldc driver
pinB_l	pinA low-side bldc driver
pinC_h	pinA high-side bldc driver
pinC_l	pinA low-side bldc driver

Returns

0 if config good, -1 if failed

Definition at line 47 of file drivers/hardware_specific/generic_mcu.cpp.

_writeDutyCycle2PWM()

void _writeDutyCycle2PWM	(	float	dc_a,
		float	dc_b,
		int	pinA,
		int	pinB
	)

Function setting the duty cycle to the pwm pin (ex. analogWrite())

• Stepper driver - 2PWM setting
• hardware specific

Parameters

dc_a	duty cycle phase A [0, 1]
dc_b	duty cycle phase B [0, 1]
pinA	phase A hardware pin number
pinB	phase B hardware pin number

Definition at line 55 of file drivers/hardware_specific/generic_mcu.cpp.

_writeDutyCycle3PWM()

void _writeDutyCycle3PWM	(	float	dc_a,
		float	dc_b,
		float	dc_c,
		int	pinA,
		int	pinB,
		int	pinC
	)

Function setting the duty cycle to the pwm pin (ex. analogWrite())

• BLDC driver - 3PWM setting
• hardware specific

Parameters

dc_a	duty cycle phase A [0, 1]
dc_b	duty cycle phase B [0, 1]
dc_c	duty cycle phase C [0, 1]
pinA	phase A hardware pin number
pinB	phase B hardware pin number
pinC	phase C hardware pin number

Definition at line 64 of file drivers/hardware_specific/generic_mcu.cpp.

_writeDutyCycle4PWM()

void _writeDutyCycle4PWM	(	float	dc_1a,
		float	dc_1b,
		float	dc_2a,
		float	dc_2b,
		int	pin1A,
		int	pin1B,
		int	pin2A,
		int	pin2B
	)

Function setting the duty cycle to the pwm pin (ex. analogWrite())

• Stepper driver - 4PWM setting
• hardware specific

Parameters

dc_1a	duty cycle phase 1A [0, 1]
dc_1b	duty cycle phase 1B [0, 1]
dc_2a	duty cycle phase 2A [0, 1]
dc_2b	duty cycle phase 2B [0, 1]
pin1A	phase 1A hardware pin number
pin1B	phase 1B hardware pin number
pin2A	phase 2A hardware pin number
pin2B	phase 2B hardware pin number

Definition at line 74 of file drivers/hardware_specific/generic_mcu.cpp.

_writeDutyCycle6PWM()

void _writeDutyCycle6PWM	(	float	dc_a,
		float	dc_b,
		float	dc_c,
		float	dead_zone,
		int	pinA_h,
		int	pinA_l,
		int	pinB_h,
		int	pinB_l,
		int	pinC_h,
		int	pinC_l
	)

Function setting the duty cycle to the pwm pin (ex. analogWrite())

• BLDC driver - 6PWM setting
• hardware specific

Parameters

dc_a	duty cycle phase A [0, 1]
dc_b	duty cycle phase B [0, 1]
dc_c	duty cycle phase C [0, 1]
dead_zone	duty cycle protection zone [0, 1] - both low and high side low
pinA_h	phase A high-side hardware pin number
pinA_l	phase A low-side hardware pin number
pinB_h	phase B high-side hardware pin number
pinB_l	phase B low-side hardware pin number
pinC_h	phase C high-side hardware pin number
pinC_l	phase C low-side hardware pin number

Definition at line 86 of file drivers/hardware_specific/generic_mcu.cpp.