Dc2Dc Class Reference

DC To DC Converter Class. More...

#include <dc2dc.hpp>

Public Member Functions
	Dc2Dc ()
	Constructor. More...
	Dc2Dc (const Dc2DcConfig &config)
	Constructor. More...
	~Dc2Dc ()
	Destructor. More...
void	configure (const Dc2DcConfig &config)
	Configures the DC to DC converter. More...
Dc2DcConfig	getConfig () const
	Gets the current configuration data. More...
void	setCalibration (float value)
	Sets the calibration value (offset) of the output of DC2DC converter. More...
float	getCalibration () const
	Returns the calibration value of the output of DC2DC converter. More...
bool	start ()
	Starts the DC to DC converter. More...
bool	stop ()
	Stops the DC to DC converter. More...
bool	isRunning () const
	Returns if the converter is running. More...
void	adjust ()
	Adjusts the PWM duty cycle value to the output reaches the target voltage. More...
void	setV (float v)
	Sets the target output voltage of the converter. More...
float	getV () const
	Gets the current output voltage of the converter. More...
float	getVTarget () const
	Gets the target output voltage of the converter. More...
float	getDuty () const
	Gets the current duty cycle of the PWM. More...

Detailed Description

DC To DC Converter Class.

The purpose of this class is to provide the methods to manipulate a DC To DC converter via software (using the CPU's PWM and ADC modules).

Constructor & Destructor Documentation

Dc2Dc() [1/2]

Dc2Dc

(

)

Constructor.

Assumes a default value for the configuration.

Dc2Dc() [2/2]

Dc2Dc ( const Dc2DcConfig &  config )

explicit

Constructor.

Parameters

config

Configuration data.

~Dc2Dc()

~Dc2Dc

(

)

Destructor.

Member Function Documentation

configure()

void configure

(

const Dc2DcConfig &

config

)

Configures the DC to DC converter.

If the converter is running, then it's stopped before.

Parameters

config

Configuration data.

getConfig()

Dc2DcConfig getConfig

(

)

const

Gets the current configuration data.

Returns

Copy of the current configuration data.

setCalibration()

void setCalibration

(

float

value

)

Sets the calibration value (offset) of the output of DC2DC converter.

Parameters

value

Calibration value.

getCalibration()

float getCalibration

(

)

const

Returns the calibration value of the output of DC2DC converter.

Returns

Calibration value.

start()

bool start

(

)

Starts the DC to DC converter.

If the configuration is invalid, then fails.

Returns

True if success, false otherwise.

stop()

bool stop

(

)

Stops the DC to DC converter.

If the configuration is invalid, then fails.

Returns

True if success, false otherwise.

isRunning()

bool isRunning

(

)

const

Returns if the converter is running.

Returns

True if converter is running, false otherwise.

adjust()

void adjust

(

)

Adjusts the PWM duty cycle value to the output reaches the target voltage.

This method must be called periodically in a loop, so that the DC to DC converter works properly.

setV()

void setV

(

float

v

)

Sets the target output voltage of the converter.

Parameters

v	Target output voltage, in Volts.

getV()

float getV

(

)

const

Gets the current output voltage of the converter.

Returns

Current output voltage, in Volts.

getVTarget()

float getVTarget

(

)

const

Gets the target output voltage of the converter.

Returns

Target output voltage, in Volts.

getDuty()

float getDuty

(

)

const

Gets the current duty cycle of the PWM.

Returns

Current duty cycle value, in percent.

---

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

• dc2dc.hpp
• dc2dc.cpp