Defines the configuration fields for a Dc2Dc class. More...

#include <dc2dc.hpp>

Inheritance diagram for Dc2DcConfig:

Public Member Functions
	Dc2DcConfig ()
	Constructor. More...

	Dc2DcConfig (uint pwmPin, uint adcChannel, float divider=1.0f, uint32_t pwmFreq=Pwm::kPwmDefaultFreq, float adcVref=Adc::kAdcDefaultVRef, float pwmMinDuty=kPwmMinDutyCycleDefault, float pwmMaxDuty=kPwmMaxDutyCycleDefault, float pwmSlowStepDuty=kPwmSlowStepDutyCycleDefault, float pwmFastStepDuty=kPwmFastStepDutyCycleDefault, float pwmToleranceToFast=kPwmToleranceToFastDefault, float vTolerance=kDc2DcVoutToleranceDefault)
	Constructor. More...

Dc2DcConfig &	operator= (const Dc2DcConfig &src)
	Assign Operator. More...

Public Attributes
uint	pwmPin
	Pin number of the PWM. More...

uint32_t	pwmFreq
	Frequency of the PWM, in Hertz. More...

float	adcVref
	Reference voltage of the ADC, in Volts. More...

uint	adcChannel
	Number of the ADC channel (0 to 3). More...

float	divider
	Feedback divider in output of DC2DC converter. More...

float	pwmMinDuty
	Minimal duty cycle value for the PWM, in %. More...

float	pwmMaxDuty
	Maximum duty cycle value for the PWM, in %. More...

float	pwmSlowStepDuty
	Step of slow increment/decrement for the PWM duty cycle. More...

float	pwmFastStepDuty
	Step of fast increment/decrement for the PWM duty cycle. More...

float	pwmToleranceToFast
	Tolerance between actual and target voltages to consider them far. More...

float	vTolerance
	Tolerance voltage for DC2DC output. More...

Static Public Attributes
static constexpr float	kPwmMinDutyCycleDefault = 0.0f
	Default value for minimal duty cycle value for the PWM, in %. More...

static constexpr float	kPwmMaxDutyCycleDefault = 95.0f
	Default value for maximum duty cycle value for the PWM, in %. More...

static constexpr float	kPwmSlowStepDutyCycleDefault = 0.1f
	Default value for step of slow increment/decrement for the PWM duty cycle. More...

static constexpr float	kPwmFastStepDutyCycleDefault = 1.0f
	Default value for step of fast increment/decrement for the PWM duty cycle. More...

static constexpr float	kPwmToleranceToFastDefault = 0.1f
	Default value for Tolerance between actual and target voltages to consider them far. More...

static constexpr float	kDc2DcVoutToleranceDefault = 0.05f
	Default value for tolerance voltage for DC2DC output. More...

Friends
bool	operator== (const Dc2DcConfig &a, const Dc2DcConfig &b)
	Equality Operator. More...

bool	operator!= (const Dc2DcConfig &a, const Dc2DcConfig &b)
	Unequality Operator. More...

Detailed Description

Defines the configuration fields for a Dc2Dc class.

Constructor & Destructor Documentation

◆ Dc2DcConfig() [1/2]

Dc2DcConfig ( )

Constructor.

Assumes defaults for all fields.

◆ Dc2DcConfig() [2/2]

Dc2DcConfig	(	uint	pwmPin,
		uint	adcChannel,
		float	divider = `1.0f`,
		uint32_t	pwmFreq = `Pwm::kPwmDefaultFreq`,
		float	adcVref = `Adc::kAdcDefaultVRef`,
		float	pwmMinDuty = `kPwmMinDutyCycleDefault`,
		float	pwmMaxDuty = `kPwmMaxDutyCycleDefault`,
		float	pwmSlowStepDuty = `kPwmSlowStepDutyCycleDefault`,
		float	pwmFastStepDuty = `kPwmFastStepDutyCycleDefault`,
		float	pwmToleranceToFast = `kPwmToleranceToFastDefault`,
		float	vTolerance = `kDc2DcVoutToleranceDefault`
	)

explicit

Constructor.

Parameters

pwmPin	Pin number of the PWM.
adcChannel	Number of the ADC channel (0 to 3).
divider	Feedback divider in output of DC2DC converter.
pwmFreq	Frequency of the PWM, in Hertz.
adcVref	Reference voltage of the ADC, in Volts.
pwmMinDuty	Minimal duty cycle value for the PWM, in %.
pwmMaxDuty	Maximum duty cycle value for the PWM, in %.
pwmSlowStepDuty	Step of slow increment/decrement for the PWM duty cycle.
pwmFastStepDuty	Step of fast increment/decrement for the PWM duty cycle.
pwmToleranceToFast	Tolerance between actual and target voltages to consider them far.
vTolerance	Tolerance voltage for DC2DC output.

Member Function Documentation

◆ operator=()

Dc2DcConfig & operator= ( const Dc2DcConfig & src )

Assign Operator.

Parameters

src	Dc2DcConfig source object.

Returns: Reference for this.

Friends And Related Function Documentation

◆ operator==

bool operator==	(	const Dc2DcConfig &	a,
		const Dc2DcConfig &	b
	)

friend

Equality Operator.

Parameters

a	One object.
b	Another object.

Returns: True if the objects contain equal values, false otherwise.

◆ operator!=

bool operator!=	(	const Dc2DcConfig &	a,
		const Dc2DcConfig &	b
	)

friend

Unequality Operator.

Parameters

a	One object.
b	Another object.

Returns: True if the objects contain different values, false otherwise.

Member Data Documentation

◆ pwmPin

uint pwmPin

Pin number of the PWM.

Default: 0xFF (not assigned).

◆ pwmFreq

uint32_t pwmFreq

Frequency of the PWM, in Hertz.

Default: Pwm::kPwmDefaultFreq.

◆ adcVref

float adcVref

Reference voltage of the ADC, in Volts.

Default: Adc::kAdcDefaultVRef.

◆ adcChannel

uint adcChannel

Number of the ADC channel (0 to 3).

Default: 0xFF (not assigned).

◆ divider

float divider

Feedback divider in output of DC2DC converter.

Typical formula: Divider = (R1 + R2) / R2.
Default: 1.0.

◆ pwmMinDuty

float pwmMinDuty

Minimal duty cycle value for the PWM, in %.

Default: kPwmMinDutyCycleDefault.

◆ pwmMaxDuty

float pwmMaxDuty

Maximum duty cycle value for the PWM, in %.

Default: kPwmMaxDutyCycleDefault.

◆ pwmSlowStepDuty

float pwmSlowStepDuty

Step of slow increment/decrement for the PWM duty cycle.

Used when actual voltage is near to the target voltage.
Default: kPwmSlowStepDutyCycleDefault.

◆ pwmFastStepDuty

float pwmFastStepDuty

Step of fast increment/decrement for the PWM duty cycle.

Used when actual voltage is far to the target voltage.
Default: kPwmFastStepDutyCycleDefault.

◆ pwmToleranceToFast

float pwmToleranceToFast

Tolerance between actual and target voltages to consider them far.

Used formula: distance = |actual - targetV * (1.0 +- vTolerance) * (1.0 +- pwmToleranceToFast)|
Default: kPwmToleranceToFastDefault.

◆ vTolerance

float vTolerance

Tolerance voltage for DC2DC output.

The output voltage will vary within tolerance limits.
Default: kDc2DcVoutToleranceDefault.

◆ kPwmMinDutyCycleDefault

constexpr float kPwmMinDutyCycleDefault = 0.0f

staticconstexpr

Default value for minimal duty cycle value for the PWM, in %.

◆ kPwmMaxDutyCycleDefault

constexpr float kPwmMaxDutyCycleDefault = 95.0f

staticconstexpr

Default value for maximum duty cycle value for the PWM, in %.

◆ kPwmSlowStepDutyCycleDefault

constexpr float kPwmSlowStepDutyCycleDefault = 0.1f

staticconstexpr

Default value for step of slow increment/decrement for the PWM duty cycle.

◆ kPwmFastStepDutyCycleDefault

constexpr float kPwmFastStepDutyCycleDefault = 1.0f

staticconstexpr

Default value for step of fast increment/decrement for the PWM duty cycle.

◆ kPwmToleranceToFastDefault

constexpr float kPwmToleranceToFastDefault = 0.1f

staticconstexpr

Default value for Tolerance between actual and target voltages to consider them far.

◆ kDc2DcVoutToleranceDefault

constexpr float kDc2DcVoutToleranceDefault = 0.05f

staticconstexpr

Default value for tolerance voltage for DC2DC output.

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

Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Dc2DcConfig() [1/2]

◆ Dc2DcConfig() [2/2]

Member Function Documentation

◆ operator=()

Friends And Related Function Documentation

◆ operator==

◆ operator!=

Member Data Documentation

◆ pwmPin

◆ pwmFreq

◆ adcVref

◆ adcChannel

◆ divider

◆ pwmMinDuty

◆ pwmMaxDuty

◆ pwmSlowStepDuty

◆ pwmFastStepDuty

◆ pwmToleranceToFast

◆ vTolerance

◆ kPwmMinDutyCycleDefault

◆ kPwmMaxDutyCycleDefault

◆ kPwmSlowStepDutyCycleDefault

◆ kPwmFastStepDutyCycleDefault

◆ kPwmToleranceToFastDefault

◆ kDc2DcVoutToleranceDefault