FOCDriver Class Reference

#include <FOCDriver.h>

Inheritance diagram for FOCDriver:

Public Member Functions
virtual int	init ()=0
virtual void	enable ()=0
virtual void	disable ()=0
virtual DriverType	type ()=0

Public Attributes
long	pwm_frequency
	pwm frequency value in hertz
float	voltage_power_supply
	power supply voltage
float	voltage_limit
	limiting voltage set to the motor
bool	initialized = false
	true if driver was successfully initialized
void *	params = 0
	pointer to hardware specific parameters of driver
bool	enable_active_high = true
	enable pin should be set to high to enable the driver (default is HIGH)

Detailed Description

FOC driver class

Definition at line 25 of file FOCDriver.h.

Member Function Documentation

disable()

virtual void FOCDriver::disable ( )

pure virtual

Disable hardware

Implemented in BLDCDriver3PWM, BLDCDriver6PWM, StepperDriver2PWM, and StepperDriver4PWM.

Here is the caller graph for this function:

enable()

virtual void FOCDriver::enable ( )

pure virtual

Enable hardware

Implemented in BLDCDriver3PWM, BLDCDriver6PWM, StepperDriver2PWM, and StepperDriver4PWM.

Here is the caller graph for this function:

init()

virtual int FOCDriver::init ( )

pure virtual

Initialise hardware

Implemented in BLDCDriver3PWM, BLDCDriver6PWM, StepperDriver2PWM, and StepperDriver4PWM.

type()

virtual DriverType FOCDriver::type ( )

pure virtual

get the driver type

Implemented in BLDCDriver, and StepperDriver.

Here is the caller graph for this function:

Member Data Documentation

enable_active_high

bool FOCDriver::enable_active_high = true

enable pin should be set to high to enable the driver (default is HIGH)

Definition at line 42 of file FOCDriver.h.

initialized

bool FOCDriver::initialized = false

true if driver was successfully initialized

Definition at line 39 of file FOCDriver.h.

params

void* FOCDriver::params = 0

pointer to hardware specific parameters of driver

Definition at line 40 of file FOCDriver.h.

pwm_frequency

long FOCDriver::pwm_frequency

pwm frequency value in hertz

Definition at line 35 of file FOCDriver.h.

voltage_limit

float FOCDriver::voltage_limit

limiting voltage set to the motor

Definition at line 37 of file FOCDriver.h.

voltage_power_supply

float FOCDriver::voltage_power_supply

power supply voltage

Definition at line 36 of file FOCDriver.h.

---

The documentation for this class was generated from the following file:

• FOCDriver.h