processing.h File Reference

Public functions/variables of processing engine. More...

#include "config.h"

Include dependency graph for processing.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	confirmPolarity (uint8_t phase)
	Confirms the polarity of the current voltage sample for a specific phase.
void	initializeProcessing ()
	Initializes the processing engine, including ports, load states, and ADC setup.
uint8_t	nextLogicalLoadToBeAdded ()
	Retrieve the next logical load that could be added.
uint8_t	nextLogicalLoadToBeRemoved ()
	Retrieve the next logical load that could be removed (in reverse order).
void	printParamsForSelectedOutputMode ()
	Print the settings used for the selected output mode.
void	proceedHighEnergyLevel ()
	Handles the case when the energy level is high, potentially adding a load.
void	proceedLowEnergyLevel ()
	Handles the case when the energy level is low, potentially removing a load.
void	processCurrentRawSample (const uint8_t phase, const int16_t rawSample)
	Processes the current raw sample for the specified phase.
void	processDataLogging ()
	Process data logging at the end of each logging period.
void	processLatestContribution (uint8_t phase)
	Process the latest contribution after each phase-specific new cycle.
void	processMinusHalfCycle (uint8_t phase)
	Processes the start of a new negative half cycle for the specified phase.
void	processPlusHalfCycle (uint8_t phase)
	Process the start of a new positive half cycle for the specified phase.
void	processPolarity (uint8_t phase, int16_t rawSample)
	Processes the polarity of the current voltage sample for a specific phase.
void	processRawSamples (const uint8_t phase)
	Processes raw voltage and current samples for the specified phase.
void	processStartNewCycle ()
	Processes the start of a new mains cycle on phase 0.
void	processStartUp (uint8_t phase)
	Processes the startup period for the router.
void	processVoltage (uint8_t phase)
	Processes the current voltage sample for the specified phase.
void	processVoltageRawSample (const uint8_t phase, const int16_t rawSample)
	Processes the current voltage raw sample for the specified phase.
void	updatePhysicalLoadStates ()
	Updates the physical load states based on logical load priorities and states.
void	updatePortsStates ()
	Updates the control ports for each of the physical loads.

Variables
constexpr uint16_t	initialDelay { 3000 }
uint8_t	loadPrioritiesAndState [NO_OF_DUMPLOADS]
constexpr uint8_t	PERSISTENCE_FOR_POLARITY_CHANGE { 1 }
constexpr uint8_t	sensorI [NO_OF_PHASES] { 1, 3, 5 }
constexpr uint8_t	sensorV [NO_OF_PHASES] { 0, 2, 4 }
constexpr uint16_t	startUpPeriod { 3000 }
PayloadTx_struct< NO_OF_PHASES >	tx_data

Detailed Description

Public functions/variables of processing engine.

Author

Frédéric Metrich (frede.nosp@m.ric..nosp@m.metri.nosp@m.ch@l.nosp@m.ive.f.nosp@m.r)

Version

0.1

Date

2021-10-04

Copyright

Copyright (c) 2021

Definition in file processing.h.

Function Documentation

printParamsForSelectedOutputMode()

void printParamsForSelectedOutputMode

(

)

Print the settings used for the selected output mode.

This function displays the relevant configuration parameters for the currently selected output mode. It provides details about the energy bucket capacity, thresholds, and mode-specific settings.

• For the "normal" mode, it displays the energy bucket capacity and thresholds.
• For the "anti-flicker" mode, it also displays the offset of energy thresholds.

Definition at line 1062 of file processing.cpp.

Here is the caller graph for this function:

Variable Documentation

initialDelay

uint16_t initialDelay { 3000 }

inlineconstexpr

in milli-seconds, to allow time to open the Serial monitor

Definition at line 26 of file processing.h.

loadPrioritiesAndState

uint8_t loadPrioritiesAndState[NO_OF_DUMPLOADS]

inline

load priorities

Definition at line 22 of file processing.h.

PERSISTENCE_FOR_POLARITY_CHANGE

uint8_t PERSISTENCE_FOR_POLARITY_CHANGE { 1 }

inlineconstexpr

allows polarity changes to be confirmed

Definition at line 24 of file processing.h.

sensorI

uint8_t sensorI[NO_OF_PHASES] { 1, 3, 5 }

inlineconstexpr

for 3-phase PCB, current measurement for each phase

Definition at line 19 of file processing.h.

sensorV

uint8_t sensorV[NO_OF_PHASES] { 0, 2, 4 }

inlineconstexpr

for 3-phase PCB, voltage measurement for each phase

Definition at line 18 of file processing.h.

startUpPeriod

uint16_t startUpPeriod { 3000 }

inlineconstexpr

in milli-seconds, to allow LP filter to settle

Definition at line 27 of file processing.h.

tx_data

PayloadTx_struct< NO_OF_PHASES > tx_data

inline

logging data

Definition at line 32 of file processing.h.