Referencia del archivo msg.cpp

#include "system/msg/msg.h"

Gráfico de dependencias incluidas en msg.cpp:

Ir al código fuente de este archivo.

Funciones
void	standardMessage (const char *message, const char *file, const char *function, const char *date, const char *time)
	Imprime un mensaje estandarizado y formateado en el monitor serie.
void	standardHeader (const char *message, uint16_t width, char deco)
	Imprime un encabezado decorativo con el mensaje centrado.
void	standardHeaderFull (const char *message, const char *file, const char *function, const char *date, const char *time, uint16_t width, char deco)
	Imprime un encabezado decorado con texto centrado y metadatos.
void	standardErrorMessage (const char *message, const char *file, const char *function, const char *date, const char *time, int line)
	Imprime un mensaje de error enriquecido con información contextual.
void	showConfigurationMessage (const configuracionMain &configuration)
	Muestra la configuración actual del sistema.
void	showMsgPrinLine (char c, int length)
	Imprime una línea compuesta por un carácter repetido.
void	printVersion (const char *fwVersion, const char *fwName, const char *fwDate, const char *fwAuthor, const char *appVersion, const char *appName, const char *appDate)
	Imprime la información de versión del firmware.

Documentación de funciones

printVersion()

void printVersion	(	const char *	fwVersion,
		const char *	fwName,
		const char *	fwDate,
		const char *	fwAuthor,
		const char *	appVersion,
		const char *	appName,
		const char *	appDate )

Imprime la información de versión del firmware.

Prints firmware version details to the serial monitor.

Muestra:

• versión del firmware
• nombre
• fecha
• autor
• versión de la aplicación
• nombre de la aplicación
• fecha de la aplicación

Definición en la línea 248 del archivo msg.cpp.

                                       {
    standardMessage("Firmware Version Information",
                     __FILE__,
                     __FUNCTION__,
                     __DATE__,
                     __TIME__);
    Serial.print("Firmware Version: "); Serial.println(fwVersion);
    Serial.print("Firmware Name: ");    Serial.println(fwName);
    Serial.print("Firmware Date: ");    Serial.println(fwDate);
    Serial.print("Firmware Author: ");  Serial.println(fwAuthor);
    Serial.print("App Version: ");      Serial.println(appVersion);
    Serial.print("App Name: ");         Serial.println(appName);
    Serial.print("App Date: ");         Serial.println(appDate);
}

Gráfico de llamadas de esta función:

Gráfico de llamadas a esta función:

showConfigurationMessage()

void showConfigurationMessage

(

const configuracionMain &

configuration

)

Muestra la configuración actual del sistema.

Displays the current system configuration status on the serial monitor.

Presenta los valores de la estructura configuracionMain con un formato visual claro y amigable.

Parámetros

configuration

Estructura de configuración del sistema.

Definición en la línea 203 del archivo msg.cpp.

                                                                      {
  standardMessage("Current System Configuration",
                     __FILE__,
                     __FUNCTION__,
                     __DATE__,
                     __TIME__);
  Serial.print("🔧 Debug mode: ");
  Serial.println(configuration.debugMode ? "Enabled" : "Disabled");
 
  standardHeaderFull("End of Configuration",
                     __FILE__,
                     __FUNCTION__,
                     __DATE__,
                     __TIME__,
                     120,
                     '-');
}

Gráfico de llamadas de esta función:

showMsgPrinLine()

void showMsgPrinLine	(	char	c,
		int	length )

Imprime una línea compuesta por un carácter repetido.

Parámetros

c	Carácter a imprimir.
length	Número de repeticiones.

Definición en la línea 228 del archivo msg.cpp.

                                         {
   for (int i = 0; i < length; i++) {
        Serial.print(c);
    }
    Serial.println();
}

standardErrorMessage()

void standardErrorMessage	(	const char *	message,
		const char *	file,
		const char *	function,
		const char *	date,
		const char *	time,
		int	line )

Imprime un mensaje de error enriquecido con información contextual.

Prints an enriched error message to the serial monitor, including contextual information.

Incluye:

• fecha y hora
• archivo
• función
• número de línea
• mensaje de error

Parámetros

message	Mensaje de error.
file	Archivo origen.
function	Función origen.
date	Fecha de compilación.
time	Hora de compilación.
line	Número de línea donde se invoca.

Definición en la línea 177 del archivo msg.cpp.

                                                                                                                                     {
  Serial.println();
  Serial.print("[");
  Serial.print(date);
  Serial.print(" ");
  Serial.print(time);
  Serial.print("] ");
  Serial.print(file);
  Serial.print("::");
  Serial.print(function);
  Serial.print(" (Line ");
  Serial.print(line);
  Serial.print(") ❌ ERROR ➤ ");
  Serial.println(message);
  Serial.println();
}

standardHeader()

void standardHeader	(	const char *	message,
		uint16_t	width,
		char	deco )

Imprime un encabezado decorativo con el mensaje centrado.

Genera una línea con caracteres decorativos a ambos lados del texto, manteniendo un ancho total definido por el usuario.

Parámetros

message	Texto a centrar.
width	Ancho total de la línea.
deco	Carácter decorativo.

Definición en la línea 72 del archivo msg.cpp.

                               {
    int msgLen = strlen(message);
    int totalDeco = width - msgLen - 2; // Subtract 2 for spacing around the message
    if (totalDeco < 0) totalDeco = 0;
 
    int leftDeco = totalDeco / 2;
    int rightDeco = totalDeco - leftDeco;
 
    // 🔹 Blank line before the header
    Serial.println();
 
    // 🔹 Left decorative padding
    for (int i = 0; i < leftDeco; i++) Serial.write(deco);
 
    // 🔹 Centered message with spacing
    Serial.print(' ');
    Serial.print(message);
    Serial.print(' ');
 
    // 🔹 Right decorative padding
    for (int i = 0; i < rightDeco; i++) Serial.write(deco);
 
    // 🔹 Blank line after the header
    Serial.println();
    Serial.println();
}

standardHeaderFull()

void standardHeaderFull	(	const char *	message,
		const char *	file,
		const char *	function,
		const char *	date,
		const char *	time,
		uint16_t	width,
		char	deco )

Imprime un encabezado decorado con texto centrado y metadatos.

Prints a decorated header with centered text and padding on both sides.

Construye una línea única que incluye:

• mensaje principal
• archivo
• función
• fecha y hora

Todo ello centrado y rodeado de caracteres decorativos.

Parámetros

message	Mensaje principal.
file	Archivo origen.
function	Función origen.
date	Fecha de compilación.
time	Hora de compilación.
width	Ancho total de la línea.
deco	Carácter decorativo.

Definición en la línea 121 del archivo msg.cpp.

                                   {
    char buffer[256];
    // Build the full message with metadata
    snprintf(buffer, sizeof(buffer), "%s | %s | %s | %s %s",
             message, file, function, date, time);
 
    int msgLen = strlen(buffer);
    int totalDeco = width - msgLen - 2; // Subtract 2 for spacing around the message
    if (totalDeco < 0) totalDeco = 0;   // Prevent negative padding
 
    int leftDeco = totalDeco / 2;
    int rightDeco = totalDeco - leftDeco;
 
    // 🔹 Blank line before the header
    Serial.println();
 
    // 🔹 Left decorative padding
    for (int i = 0; i < leftDeco; i++) Serial.write(deco);
 
    // 🔹 Centered message with spacing
    Serial.print(' ');
    Serial.print(buffer);
    Serial.print(' ');
 
    // 🔹 Right decorative padding
    for (int i = 0; i < rightDeco; i++) Serial.write(deco);
 
    // 🔹 Blank lines after the header
    Serial.println();
    Serial.println();
}

Gráfico de llamadas a esta función:

standardMessage()

void standardMessage	(	const char *	message,
		const char *	file,
		const char *	function,
		const char *	date,
		const char *	time )

Imprime un mensaje estandarizado y formateado en el monitor serie.

Prints an enriched log message to the serial monitor.

El mensaje aparece centrado entre dos líneas decorativas y acompañado de información contextual como archivo, función, fecha y hora.

Parámetros

message	Mensaje principal a mostrar.
file	Nombre del archivo origen.
function	Nombre de la función desde donde se llama.
date	Fecha de compilación o personalizada.
time	Hora de compilación o personalizada.

Definición en la línea 15 del archivo msg.cpp.

                                       {
    const uint8_t totalWidth = 200; // Total width of the decorative line
    int msgLen = strlen(message);   // Length of the message text
    int padding = (totalWidth - msgLen) / 2; // Spaces to add on the left to center the text
 
    Serial.println();
 
    // ─────────────────────────────
    // Top decorative line
    // ─────────────────────────────
    for (uint8_t i = 0; i < totalWidth; i++) Serial.write('-');
    Serial.println();
 
    // ─────────────────────────────
    // Centered message text
    // ─────────────────────────────
    for (int i = 0; i < padding; i++) Serial.write(' '); // Left padding
    Serial.println(message); // Main message
 
    // ─────────────────────────────
    // Bottom decorative line
    // ─────────────────────────────
    for (uint8_t i = 0; i < totalWidth; i++) Serial.write('-');
    Serial.println();
 
    // ─────────────────────────────
    // Detailed information below the main message
    // ─────────────────────────────
    Serial.print("[");
    Serial.print(date);
    Serial.print(" ");
    Serial.print(time);
    Serial.print("] ");
    Serial.print(file);
    Serial.print("::");
    Serial.print(function);
    Serial.print(" ➤ ");
    Serial.println(message);
 
    Serial.println();
}

Gráfico de llamadas a esta función: