DcHardware Class Reference

#include <dc_motors.h>

Collaboration diagram for DcHardware:

Public Member Functions
	DcHardware ()
void	start (bool useTwoWires, brain_pin_e pinEnable, brain_pin_e pinDir1, brain_pin_e pinDir2, const char *disPinMsg, brain_pin_e pinDisable, bool isInverted, Scheduler *executor, int frequency)
void	setFrequency (int frequency)
const char *	msg ()
void	stop ()

Data Fields
TwoPinDcMotor	dcMotor

Private Attributes
OutputPin	m_pinEnable
OutputPin	m_pinDir1
OutputPin	m_pinDir2
OutputPin	m_disablePin
PwmWrapper	wrappedEnable {m_pinEnable}
PwmWrapper	wrappedDir1 {m_pinDir1}
PwmWrapper	wrappedDir2 {m_pinDir2}
SimplePwm	m_pwm1
SimplePwm	m_pwm2
bool	isStarted = false

Detailed Description

Definition at line 34 of file dc_motors.h.

Constructor & Destructor Documentation

DcHardware()

DcHardware::DcHardware ( )

inline

Definition at line 51 of file dc_motors.h.

: dcMotor(m_disablePin) {}

Member Function Documentation

msg()

const char * DcHardware::msg ( )

inline

Definition at line 70 of file dc_motors.h.

                      {
        return dcMotor.msg();
    }

Referenced by showDcMotorInfo(), and updateTunerStudioState().

Here is the call graph for this function:

Here is the caller graph for this function:

setFrequency()

void DcHardware::setFrequency ( int  frequency )

inline

Definition at line 65 of file dc_motors.h.

                                     {
        m_pwm1.setFrequency(frequency);
        m_pwm2.setFrequency(frequency);
    }

Referenced by setDcMotorFrequency().

Here is the call graph for this function:

Here is the caller graph for this function:

start()

void DcHardware::start	(	bool	useTwoWires,
		brain_pin_e	pinEnable,
		brain_pin_e	pinDir1,
		brain_pin_e	pinDir2,
		const char *	disPinMsg,
		brain_pin_e	pinDisable,
		bool	isInverted,
		Scheduler *	executor,
		int	frequency
	)

Definition at line 12 of file dc_motors.cpp.

                           {
 
        if (isStarted) {
            // actually implement stop()
            return;
        }
        isStarted = true;
 
        dcMotor.setType(useTwoWires ? TwoPinDcMotor::ControlType::PwmDirectionPins : TwoPinDcMotor::ControlType::PwmEnablePin);
 
        // Configure the disable pin first - ensure things are in a safe state
        m_disablePin.initPin(disPinMsg, pinDisable);
        m_disablePin.setValue(0);
 
        // Clamp to >100hz
        int clampedFrequency = maxI(100, frequency);
 
        if (clampedFrequency > ETB_HW_MAX_FREQUENCY) {
            criticalError("Electronic throttle frequency too high, maximum %d hz", ETB_HW_MAX_FREQUENCY);
            return;
        }
 
        if (useTwoWires) {
            m_pinEnable.initPin("ETB Enable", pinEnable);
 
// no need to complicate event queue with ETB PWM in unit tests
#if ! EFI_UNIT_TEST
            startSimplePwmHard(&m_pwm1, "ETB Dir 1",
                executor,
                pinDir1,
                &m_pinDir1,
                clampedFrequency,
                /*dutyCycle*/0
            );
 
            startSimplePwmHard(&m_pwm2, "ETB Dir 2",
                executor,
                pinDir2,
                &m_pinDir2,
                clampedFrequency,
                /*dutyCycle*/0
            );
#endif // EFI_UNIT_TEST
 
            dcMotor.configure(wrappedEnable, m_pwm1, m_pwm2, isInverted);
        } else {
            m_pinDir1.initPin("ETB Dir 1", pinDir1);
            m_pinDir2.initPin("ETB Dir 2", pinDir2);
 
// no need to complicate event queue with ETB PWM in unit tests
#if ! EFI_UNIT_TEST
            startSimplePwmHard(&m_pwm1, "ETB Enable",
                executor,
                pinEnable,
                &m_pinEnable,
                clampedFrequency,
                /*dutyCycle*/0
            );
#endif // EFI_UNIT_TEST
 
            dcMotor.configure(m_pwm1, wrappedDir1, wrappedDir2, isInverted);
        }
    }

Referenced by initDcMotor(), and initDcMotor().

Here is the call graph for this function:

Here is the caller graph for this function:

stop()

void DcHardware::stop ( )

inline

Definition at line 74 of file dc_motors.h.

                {
        // todo: replace 'isStarted' with 'stop'
    }

Field Documentation

dcMotor

TwoPinDcMotor DcHardware::dcMotor

Definition at line 63 of file dc_motors.h.

Referenced by msg(), setDcMotorDuty(), showDcMotorInfo(), start(), and updateTunerStudioState().

isStarted

bool DcHardware::isStarted = false

private

Definition at line 48 of file dc_motors.h.

Referenced by start().

m_disablePin

OutputPin DcHardware::m_disablePin

private

Definition at line 39 of file dc_motors.h.

Referenced by start().

m_pinDir1

OutputPin DcHardware::m_pinDir1

private

Definition at line 37 of file dc_motors.h.

Referenced by start().

m_pinDir2

OutputPin DcHardware::m_pinDir2

private

Definition at line 38 of file dc_motors.h.

Referenced by start().

m_pinEnable

OutputPin DcHardware::m_pinEnable

private

Definition at line 36 of file dc_motors.h.

Referenced by start().

m_pwm1

SimplePwm DcHardware::m_pwm1

private

Definition at line 45 of file dc_motors.h.

Referenced by setFrequency(), and start().

m_pwm2

SimplePwm DcHardware::m_pwm2

private

Definition at line 46 of file dc_motors.h.

Referenced by setFrequency(), and start().

wrappedDir1

PwmWrapper DcHardware::wrappedDir1 {m_pinDir1}

private

Definition at line 42 of file dc_motors.h.

{m_pinDir1};

Referenced by start().

wrappedDir2

PwmWrapper DcHardware::wrappedDir2 {m_pinDir2}

private

Definition at line 43 of file dc_motors.h.

{m_pinDir2};

Referenced by start().

wrappedEnable

PwmWrapper DcHardware::wrappedEnable {m_pinEnable}

private

Definition at line 41 of file dc_motors.h.

{m_pinEnable};

Referenced by start().

---

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

• controllers/actuators/dc_motors.h
• controllers/actuators/dc_motors.cpp