quadro::pwm::pwmDevice Class Reference

#include <pwmDevice.h>

Inheritance diagram for quadro::pwm::pwmDevice:

Public Types
enum	valType {   Run, Duty, Period, Polarity,   Power_Control, Power_RunTime_Active, Power_RunTime_Suspended }

Public Member Functions
	pwmDevice ()
	pwmDevice (pinBlocks _block, PWMPins _pin) throw ( pwmSetupException& )
long	get (valType _vt)
void	set (valType _vt, long _val)
void	setPinNum (PWMPins _pin)
void	setBlockNum (pinBlocks _block)
Public Member Functions inherited from quadro::IDevice
virtual	~IDevice ()

Public Attributes
pinBlocks	blockNum
	stores the PWM device block num More...
PWMPins	pinNum
	stores the PWM device pin num More...
string	powerControlStr
	stores the current power setting string More...

Detailed Description

Base class for PWM devices IDevice, pwmOverlay

Member Enumeration Documentation

enum quadro::pwm::pwmDevice::valType

This is a list of types allowed when accessing PWM Values.

Enumerator
Run	Run Value Type.
Duty	Duty Value Type.
Period	Period Value Type.
Polarity	Polarity Value Type.
Power_Control	Power_Control Value Type.
Power_RunTime_Active	Power_RunTime_Active Value Type.
Power_RunTime_Suspended	Power_RunTime_Suspended Value Type.

                         {
                Run, 
                Duty, 
                Period, 
                Polarity, 
                Power_Control, 
                Power_RunTime_Active, 
                Power_RunTime_Suspended 
            };

Constructor & Destructor Documentation

quadro::pwm::pwmDevice::pwmDevice ( )

inline

Base class for PWM devices IDevice, pwmOverlay

{ };

pwmDevice::pwmDevice	(	pinBlocks	_block,
		PWMPins	_pin
	)
throw	(	pwmSetupException &
	)

Alternative constructor, setting the pins on setup.

Exceptions

pwmSetupException

Parameters

pinBlocks	_block
PWNPins	_pin

{

    this->setBlockNum( _block );
    this->setPinNum( _pin );

    if ( this->settings.overlayLoaded ) {
        this->_pinOverlay = new pinOverlay( this->blockNum, this->pinNum );

        if ( this->_pinOverlay->settings.overlayLoaded )
            this->setFilePaths();
    }

}

Member Function Documentation

long pwmDevice::get

(

valType

_vt

)

Use this method to get a pwm value as specified from valType

Parameters

_vt

Returns

{ return this->getCurrentReading( _vt ); }

void pwmDevice::set	(	valType	_vt,
		long	_val
	)

Use this method to set a pwm value as specified by valType

Parameters

_vt
_val

{ this->writeToDevice( _vt, _val ); }

void pwmDevice::setBlockNum

(

pinBlocks

_block

)

Sets the pwm block number - on the beaglebone black this will be 8 or 9 only

Parameters

pinBlocks

_block

{ this->blockNum = _block; }

void pwmDevice::setPinNum

(

PWMPins

_pin

)

Set PWM Pin num from available PWMPins

Parameters

_pin

{ this->pinNum = _pin; }

Member Data Documentation

pinBlocks quadro::pwm::pwmDevice::blockNum

stores the PWM device block num

PWMPins quadro::pwm::pwmDevice::pinNum

stores the PWM device pin num

string quadro::pwm::pwmDevice::powerControlStr

stores the current power setting string

---

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

• /Users/michaelbrookes/ClionProjects/Quadro/lib/pwm/pwmDevice.h
• /Users/michaelbrookes/ClionProjects/Quadro/lib/pwm/pwmDevice.cpp