Automatic Curtain  MVP
Software repository for an automatic curtain using stepper motor, TMC2209 and ESP32
Logging Class Reference

#include <logging.h>

Public Member Functions

 Logging (bool logging_status)
 Construct a new Logging object, initializes the serial connection. More...
 
 ~Logging ()
 Destroy the Logging object. More...
 
bool Log (CONFIG_SET::LOG_TYPE log_type, CONFIG_SET::LOG_CLASS log_class, const char *message)
 For now, the function will just print a message on serial, it can be over wifi or just hardware serial. More...
 
bool Log (CONFIG_SET::LOG_TYPE log_type, CONFIG_SET::LOG_CLASS log_class, String message)
 For now, the function will just print a message on serial, it can be over wifi or just hardware serial. More...
 
void SetLoggingStatus (bool status)
 This function enables or disables logging true: logging enabled false: logging disabled. More...
 
bool GetLoggingStatus ()
 Get the Logging Status object. More...
 

Private Attributes

bool logging_status_
 
std::mutex status_mutex
 

Constructor & Destructor Documentation

◆ Logging()

Logging::Logging ( bool  logging_status)

Construct a new Logging object, initializes the serial connection.

◆ ~Logging()

Logging::~Logging ( )

Destroy the Logging object.

Member Function Documentation

◆ GetLoggingStatus()

bool Logging::GetLoggingStatus ( )

Get the Logging Status object.

Returns
bool: logging_status_

◆ Log() [1/2]

bool Logging::Log ( CONFIG_SET::LOG_TYPE  log_type,
CONFIG_SET::LOG_CLASS  log_class,
const char *  message 
)

For now, the function will just print a message on serial, it can be over wifi or just hardware serial.

Parameters
message
Returns
true : if the print is successful
false : otherwise
Here is the caller graph for this function:

◆ Log() [2/2]

bool Logging::Log ( CONFIG_SET::LOG_TYPE  log_type,
CONFIG_SET::LOG_CLASS  log_class,
String  message 
)

For now, the function will just print a message on serial, it can be over wifi or just hardware serial.

Parameters
message
Returns
true : if the print is successful
false : otherwise
Here is the call graph for this function:

◆ SetLoggingStatus()

void Logging::SetLoggingStatus ( bool  status)

This function enables or disables logging true: logging enabled false: logging disabled.

Member Data Documentation

◆ logging_status_

bool Logging::logging_status_
private

◆ status_mutex

std::mutex Logging::status_mutex
private

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