Controls a pressure valve. More...

#include <pressure_valve.h>

Public Member Functions
	PressureValve ()
	Default constructor. More...

	PressureValve (HardwareTimer *p_hardwareTimer, uint16_t p_timerChannel, uint16_t p_valvePin, uint16_t p_openApertureAngle, uint16_t p_closeApertureAngle)
	Parameterized constructor. More...

void	setup ()
	Initialize this valve. More...

void	open ()
	Request opening of the Pressure Valve. More...

void	open (uint16_t p_command)
	Request opening of the Pressure Valve with a given angle. More...

uint16_t	openLinear (uint16_t p_command)
	Request opening of the Pressure Valve with a given angle with linearization. More...

int32_t	getSectionBigHoseX100 ()

void	openSection (int32_t p_sectionMultiplyBy100)
	Request opening of the Pressure Valve with a given section (in mm^2) More...

void	close ()
	Request closing of the Pressure Valve. More...

void	execute ()
	Command the valve to go to the requested aperture. More...

uint16_t	minAperture () const
	Minimum valve aperture angle in degrees. More...

uint16_t	maxAperture () const
	Maximum valve aperture angle in degrees. More...

Public Attributes
uint16_t	command
	Value of the requested aperture. More...

uint16_t	position
	Current aperture. More...

uint16_t	positionLinear
	Current aperture linear. More...

Private Attributes
uint16_t	minApertureAngle
	Minimum valve aperture angle in degrees. More...

uint16_t	maxApertureAngle
	Maximum valve aperture angle in degrees. More...

uint16_t	openApertureAngle
	Open aperture angle in degrees. More...

uint16_t	closeApertureAngle
	Close aperture angle in degrees. More...

HardwareTimer *	actuator
	Hardware time for this valve. More...

uint16_t	timerChannel
	TIM channel for this valve. More...

uint16_t	valvePin
	Data pin for this valve. More...

Detailed Description

Controls a pressure valve.

Definition at line 29 of file pressure_valve.h.

Constructor & Destructor Documentation

◆ PressureValve() [1/2]

PressureValve::PressureValve ( )

Default constructor.

Definition at line 28 of file pressure_valve.cpp.

28 {}

◆ PressureValve() [2/2]

PressureValve::PressureValve	(	HardwareTimer *	p_hardwareTimer,
		uint16_t	p_timerChannel,
		uint16_t	p_valvePin,
		uint16_t	p_openApertureAngle,
		uint16_t	p_closeApertureAngle
	)

Parameterized constructor.

Parameters

p_hardwareTimer	Hardware time for this valve
p_timerChannel	TIM channel for this valve
p_valvePin	Data pin for this valve
p_openApertureAngle	Open aperture angle in degrees
p_closeApertureAngle	Close aperture angle in degrees

Definition at line 30 of file pressure_valve.cpp.

                                                             {
     actuator = p_hardwareTimer;
     timerChannel = p_timerChannel;
     valvePin = p_valvePin;
     openApertureAngle = p_openApertureAngle;
     closeApertureAngle = p_closeApertureAngle;
     minApertureAngle = min(p_closeApertureAngle, p_openApertureAngle);
     maxApertureAngle = max(p_closeApertureAngle, p_openApertureAngle);
     command = p_closeApertureAngle;
     position = -1;
     positionLinear = 0;
 }

Member Function Documentation

◆ close()

void PressureValve::close ( )

Request closing of the Pressure Valve.

Definition at line 54 of file pressure_valve.cpp.

54 { command = closeApertureAngle; }

◆ execute()

void PressureValve::execute ( )

inline

Command the valve to go to the requested aperture.

Note: Nothing will happen if this function is not called after requesting a new aperture

Definition at line 90 of file pressure_valve.h.

                           {
         // On évite d'aller plus loin que les limites de la valve
         if (command < minApertureAngle) {
             command = minApertureAngle;
         } else if (command > maxApertureAngle) {
             command = maxApertureAngle;
         } else {
         }
  
         if (command != position) {
             actuator->setCaptureCompare(timerChannel, valveAngle2MicroSeconds(command),
                                         MICROSEC_COMPARE_FORMAT);
             position = command;
         }
     }

◆ getSectionBigHoseX100()

int32_t PressureValve::getSectionBigHoseX100 ( )

Definition at line 139 of file pressure_valve.cpp.

                                              {
     int32_t section;
     if (command > 105u) {
         section = 0;
     } else if (command >= 50u) {
         section = 5760u - (558u * command / 10u);
     } else {
         section = 4390u - (5u * command) - (47u * command * command / 100u);
     }
  
     return max(int32_t(0), section);
 }

◆ maxAperture()

uint16_t PressureValve::maxAperture ( ) const

inline

Maximum valve aperture angle in degrees.

Definition at line 110 of file pressure_valve.h.

110 { return maxApertureAngle; }

◆ minAperture()

uint16_t PressureValve::minAperture ( ) const

inline

Minimum valve aperture angle in degrees.

Definition at line 107 of file pressure_valve.h.

107 { return minApertureAngle; }

◆ open() [1/2]

void PressureValve::open ( )

Request opening of the Pressure Valve.

Definition at line 52 of file pressure_valve.cpp.

52 { command = openApertureAngle; }

◆ open() [2/2]

void PressureValve::open ( uint16_t p_command )

Request opening of the Pressure Valve with a given angle.

Parameters

p_command The angle in degree

Definition at line 56 of file pressure_valve.cpp.

56 { command = p_command; }

◆ openLinear()

uint16_t PressureValve::openLinear ( uint16_t p_command )

Request opening of the Pressure Valve with a given angle with linearization.

Parameters

p_command The angle in degree

Returns: The linearized angle calculated by this function

Definition at line 81 of file pressure_valve.cpp.

                                                      {
     uint16_t cappedCommand =
         // cppcheck-suppress misra-c2012-12.3 ; cppcheck error
         min(max(uint16_t(minApertureAngle), p_command), uint16_t(maxApertureAngle));
  
     positionLinear = cappedCommand;
     // The cappedCommand is in [ 0 ; 125 ], but the valve is only effective in [30; 100]
     // So lets make it between 30 and 100
     // A x10 multiplier is used here for better precision with integer calculations
     // The value of intermediateValue will consequently be in [300 ; 1000]
     uint32_t intermediateValue =
         (((static_cast<uint32_t>(cappedCommand) * 75u) / 125u) + 30u) * 10u;
  
     /* An order 3 polynom is used to correct the non linearity of the valve.
     To find this polynom, the following experimental protocol was used:
         - Run the blower max speed during the full experience
         - Plug inspiratory output on expiratory input
         - For each openning value of the valve, wait 5s for stabilisation and measure Flow
  
     This gives a csv with:
         openningValue[0;125], flow (mL/min)
         0, 48137
         10, 47780
         ...
         125, 127
  
     Then we calculated for each openning value the "linear target flow" with a basic linear
     equation:
         openningValue[0;125], flow (mL/min), targetFlow (mL/min)
         0, 48137,48137
         10, 47780, 44296
         ...
         125, 127, 0
  
     Then we manually found for each openning value, the openning value that should have been
     used to reach the targetFlow: openningValue[0;125], flow (mL/min), targetFlow (mL/min),
         correctedOpenningValue[0;125] 0, 48137,48137, 30 10, 47780, 44296, 55.2
         ...
         125, 127, 0, 100
  
     Then when made an order 3 regression between correctedOpenningValue and openningValue. This
     is the relation below:
     */
     command = (uint16_t)(
         (((76u * intermediateValue) / 10u)
          - (((985u * intermediateValue) * intermediateValue) / 100000u)
          + (((((44u * intermediateValue) * intermediateValue) / 1000u) * intermediateValue)
             / 10000u)
          - 1140u)
         / 10u);
  
     // cppcheck-suppress misra-c2012-12.3 ; cppcheck error
     command = min(max(uint16_t(minApertureAngle), command), uint16_t(maxApertureAngle));
  
     return command;
 }

◆ openSection()

void PressureValve::openSection ( int32_t p_sectionMultiplyBy100 )

Request opening of the Pressure Valve with a given section (in mm^2)

Parameters

p_sectionMultiplyBy100 The section to open tha valve (in mm^2 multiplied by 100)

Definition at line 58 of file pressure_valve.cpp.

                                                               {
     // Min-max to prevent overflow
     int32_t cappedSectionMultiplyBy100 =
         // cppcheck-suppress misra-c2012-12.3 ; cppcheck error
         min(max(int32_t(0), p_sectionMultiplyBy100), int32_t(3318));
  
     int32_t tempCommand;
     if (cappedSectionMultiplyBy100 < 1960) {
         tempCommand = 98 - (318 * cappedSectionMultiplyBy100 / 10000);
     } else {
         tempCommand =
             2626 - (36 * cappedSectionMultiplyBy100) / 10
             + 168 * ((cappedSectionMultiplyBy100 * cappedSectionMultiplyBy100) / 100) / 1000
             - 264
                   * (((cappedSectionMultiplyBy100 * cappedSectionMultiplyBy100) / 100)
                      * (cappedSectionMultiplyBy100) / 100)
                   / 100000;
     }
     // cppcheck-suppress misra-c2012-12.3
     command = min(max(int32_t(minApertureAngle), tempCommand), int32_t(maxApertureAngle));
 }

◆ setup()

void PressureValve::setup ( )

Initialize this valve.

This must be called once to be able to use this Pressure Valve

Definition at line 47 of file pressure_valve.cpp.

                           {
     actuator->setMode(timerChannel, TIMER_OUTPUT_COMPARE_PWM1, valvePin);
     actuator->setCaptureCompare(timerChannel, 0, MICROSEC_COMPARE_FORMAT);
 }

Member Data Documentation

◆ actuator

HardwareTimer* PressureValve::actuator

private

Hardware time for this valve.

Definition at line 135 of file pressure_valve.h.

◆ closeApertureAngle

uint16_t PressureValve::closeApertureAngle

private

Close aperture angle in degrees.

Definition at line 132 of file pressure_valve.h.

◆ command

uint16_t PressureValve::command

Value of the requested aperture.

Definition at line 113 of file pressure_valve.h.

◆ maxApertureAngle

uint16_t PressureValve::maxApertureAngle

private

Maximum valve aperture angle in degrees.

Definition at line 126 of file pressure_valve.h.

◆ minApertureAngle

uint16_t PressureValve::minApertureAngle

private

Minimum valve aperture angle in degrees.

Definition at line 123 of file pressure_valve.h.

◆ openApertureAngle

uint16_t PressureValve::openApertureAngle

private

Open aperture angle in degrees.

Definition at line 129 of file pressure_valve.h.

◆ position

uint16_t PressureValve::position

Current aperture.

Definition at line 116 of file pressure_valve.h.

◆ positionLinear

uint16_t PressureValve::positionLinear

Current aperture linear.

Definition at line 119 of file pressure_valve.h.

◆ timerChannel

uint16_t PressureValve::timerChannel

private

TIM channel for this valve.

Definition at line 138 of file pressure_valve.h.

◆ valvePin

uint16_t PressureValve::valvePin

private

Data pin for this valve.

Definition at line 141 of file pressure_valve.h.

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

includes/pressure_valve.h
srcs/pressure_valve.cpp

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PressureValve() [1/2]

◆ PressureValve() [2/2]

Member Function Documentation

◆ close()

◆ execute()

◆ getSectionBigHoseX100()

◆ maxAperture()

◆ minAperture()

◆ open() [1/2]

◆ open() [2/2]

◆ openLinear()

◆ openSection()

◆ setup()

Member Data Documentation

◆ actuator

◆ closeApertureAngle

◆ command

◆ maxApertureAngle

◆ minApertureAngle

◆ openApertureAngle

◆ position

◆ positionLinear

◆ timerChannel

◆ valvePin