VppConfig Struct Reference

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

#include <vgenerator.hpp>

Inheritance diagram for VppConfig:

Public Member Functions
	VppConfig ()
	Constructor. More...
VppConfig &	operator= (const VppConfig &src)
	Assign Operator. More...

Public Attributes
uint	ctrlPin
	Pin number of the Control Voltage. More...
uint	vcSinPin
	Pin number of the VControl Shift Register SIN signal. More...
uint	vcClkPin
	Pin number of the VControl Shift Register CLK signal. More...
uint	vcClrPin
	Pin number of the VControl Shift Register CLR signal. More...
uint	vcRckPin
	Pin number of the VControl Shift Register RCK signal. More...
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 VppConfig &a, const VppConfig &b)
	Equality Operator. More...

Detailed Description

Defines the configuration fields for a VppGenerator class.

Constructor & Destructor Documentation

VppConfig()

VppConfig

(

)

Constructor.

Assumes defaults for all fields.

Member Function Documentation

operator=()

VppConfig & operator=

(

const VppConfig &

src

)

Assign Operator.

Parameters

src	VppConfig source object.

Returns

Reference for this.

Friends And Related Function Documentation

operator==

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

friend

Equality Operator.

Parameters

a	One object.
b	Another object.

Returns

True if the objects contain equal values, false otherwise.

Member Data Documentation

ctrlPin

uint ctrlPin

Pin number of the Control Voltage.

Default: 0xFF (not assigned).

vcSinPin

uint vcSinPin

Pin number of the VControl Shift Register SIN signal.

Default: 0xFF (not assigned).

vcClkPin

uint vcClkPin

Pin number of the VControl Shift Register CLK signal.

Default: 0xFF (not assigned).

vcClrPin

uint vcClrPin

Pin number of the VControl Shift Register CLR signal.

Default: 0xFF (not assigned).

vcRckPin

uint vcRckPin

Pin number of the VControl Shift Register RCK signal.

Default: 0xFF (not assigned).

pwmPin

uint pwmPin

inherited

Pin number of the PWM.

Default: 0xFF (not assigned).

pwmFreq

uint32_t pwmFreq

inherited

Frequency of the PWM, in Hertz.

Default: Pwm::kPwmDefaultFreq.

adcVref

float adcVref

inherited

Reference voltage of the ADC, in Volts.

Default: Adc::kAdcDefaultVRef.

adcChannel

uint adcChannel

inherited

Number of the ADC channel (0 to 3).

Default: 0xFF (not assigned).

divider

float divider

inherited

Feedback divider in output of DC2DC converter.

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

pwmMinDuty

float pwmMinDuty

inherited

Minimal duty cycle value for the PWM, in %.

Default: kPwmMinDutyCycleDefault.

pwmMaxDuty

float pwmMaxDuty

inherited

Maximum duty cycle value for the PWM, in %.

Default: kPwmMaxDutyCycleDefault.

pwmSlowStepDuty

float pwmSlowStepDuty

inherited

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

inherited

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

inherited

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

inherited

Tolerance voltage for DC2DC output.

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

kPwmMinDutyCycleDefault

constexpr float kPwmMinDutyCycleDefault = 0.0f

staticconstexprinherited

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

kPwmMaxDutyCycleDefault

constexpr float kPwmMaxDutyCycleDefault = 95.0f

staticconstexprinherited

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

kPwmSlowStepDutyCycleDefault

constexpr float kPwmSlowStepDutyCycleDefault = 0.1f

staticconstexprinherited

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

kPwmFastStepDutyCycleDefault

constexpr float kPwmFastStepDutyCycleDefault = 1.0f

staticconstexprinherited

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

kPwmToleranceToFastDefault

constexpr float kPwmToleranceToFastDefault = 0.1f

staticconstexprinherited

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

kDc2DcVoutToleranceDefault

constexpr float kDc2DcVoutToleranceDefault = 0.05f

staticconstexprinherited

Default value for tolerance voltage for DC2DC output.

---

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

• vgenerator.hpp
• vgenerator.cpp