utils.h File Reference

Some utility functions. More...

#include "calibration.h"
#include "constants.h"
#include "dualtariff.h"
#include "processing.h"
#include "utils_rf.h"
#include "utils_temp.h"

Include dependency graph for utils.h:

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

Go to the source code of this file.

Macros
#define	BRANCH_NAME   ("N/A")
#define	COMMIT_HASH   ("N/A")
#define	PROJECT_PATH   (__FILE__)

Functions
int	freeRam ()
	Get the available RAM during setup.
void	logLoadPriorities ()
	Prints the load priorities to the Serial output.
void	printConfiguration ()
	Print the configuration during start.
void	printForEmonESP (const bool bOffPeak)
	Write on Serial in EmonESP format.
void	printForSerialJson ()
	Prints data logs to the Serial output in Json format.
void	printForSerialText ()
	Prints data logs to the Serial output in text format.
void	sendResults (bool bOffPeak)
	Prints data logs to the Serial output in text or json format.

Detailed Description

Some utility functions.

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

2023-02-09

Copyright

Copyright (c) 2023

Definition in file utils.h.

Macro Definition Documentation

BRANCH_NAME

#define BRANCH_NAME   ("N/A")

COMMIT_HASH

#define COMMIT_HASH   ("N/A")

PROJECT_PATH

#define PROJECT_PATH   (__FILE__)

Function Documentation

freeRam()

int freeRam ( )

inline

Get the available RAM during setup.

Returns

int The amount of free RAM

Definition at line 372 of file utils.h.

Here is the caller graph for this function:

logLoadPriorities()

void logLoadPriorities ( )

inline

Prints the load priorities to the Serial output.

Definition at line 353 of file utils.h.

Here is the caller graph for this function:

printConfiguration()

void printConfiguration ( )

inline

Print the configuration during start.

Definition at line 27 of file utils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

printForEmonESP()

void printForEmonESP ( const bool  bOffPeak )

inline

Write on Serial in EmonESP format.

Parameters

bOffPeak

state of on/off-peak period

Definition at line 154 of file utils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

printForSerialJson()

void printForSerialJson ( )

inline

Prints data logs to the Serial output in Json format.

Definition at line 209 of file utils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

printForSerialText()

void printForSerialText ( )

inline

Prints data logs to the Serial output in text format.

Definition at line 256 of file utils.h.

Here is the call graph for this function:

Here is the caller graph for this function:

sendResults()

void sendResults ( bool  bOffPeak )

inline

Prints data logs to the Serial output in text or json format.

Parameters

bOffPeak

true if off-peak tariff is active

Definition at line 321 of file utils.h.

Here is the call graph for this function:

Here is the caller graph for this function: