ctbk/dmx-interface
1
0
Fork 0
mirror of https://github.com/HendrikRauh/dmx-interface.git synced 2025-05-18 21:55:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

implement logging system: create Log class to replace Logger calls for improved structure and maintainability

Browse source 
BUT does not compile!
This commit is contained in:
RaffaelW 2025-05-09 20:32:23 +02:00
parent 2e0431357a
commit 628f78cddb
3 changed files with 142 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
src/log.cpp Normal file
View file

@ -0,0 +1,58 @@
#include "log.h"
#include <Elog.h>
void Log::setup()
{
Logger.registerSerial(SYSTEM, 10, "SYSTEM");
Logger.registerSerial(DMX, 10, "DMX");
Logger.registerSerial(ARTNET, 10, "ARTNET");
Logger.registerSerial(WIFI, 10, "WIFI");
Logger.registerSerial(ETHERNET, 10, "ETHERNET");
Logger.registerSerial(SERVER, 10, "SERVER");
Logger.registerSerial(CONFIG, 10, "CONFIG");
};
void Log::info(int tag, String format, ...)
{
Logger.info(tag, format, va_list());
}
void Log::debug(int tag, String format, ...)
{
Logger.debug(tag, format, va_list());
}
void Log::verbose(int tag, String format, ...)
{
Logger.verbose(tag, format, va_list());
}
void Log::error(int tag, String format, ...)
{
Logger.error(tag, format, va_list());
}
void Log::critical(int tag, String format, ...)
{
Logger.critical(tag, format, va_list());
}
void Log::warning(int tag, String format, ...)
{
Logger.warning(tag, format, va_list());
}
void Log::notice(int tag, String format, ...)
{
Logger.notice(tag, format, va_list());
}
void Log::alert(int tag, String format, ...)
{
Logger.alert(tag, format, va_list());
}
void Log::emergency(int tag, String format, ...)
{
Logger.emergency(tag, format, va_list());
}

24
src/log.h Normal file
View file

@ -0,0 +1,24 @@
#include <Arduino.h>
#define SYSTEM 0
#define DMX 1
#define ARTNET 2
#define SERVER 3
#define WIFI 4
#define ETHERNET 5
#define CONFIG 6
class Log
{
public:
void setup();
void info(int tag, String format, ...);
void debug(int tag, String format, ...);
void verbose(int tag, String format, ...);
void error(int tag, String format, ...);
void critical(int tag, String format, ...);
void warning(int tag, String format, ...);
void notice(int tag, String format, ...);
void alert(int tag, String format, ...);
void emergency(int tag, String format, ...);
};

123
src/main.cpp
View file

@ -21,20 +21,13 @@
#include <esp_dmx.h> #include <esp_dmx.h>
#include <LittleFS.h> #include <LittleFS.h>
#include "log.h"
#include "websocket.h" #include "websocket.h"
#include "routes/config.h" #include "routes/config.h"
#include "routes/networks.h" #include "routes/networks.h"
#include "routes/status.h" #include "routes/status.h"
#include <Elog.h> Log log;
#define SYSTEM 0
#define DMX 1
#define ARTNET 2
#define SERVER 3
#define WIFI 4
#define ETHERNET 5
#define CONFIG 6
dmx_port_t dmx1 = DMX_NUM_0; // for esp32s2 dmx_port_t dmx1 = DMX_NUM_0; // for esp32s2
dmx_port_t dmx2 = DMX_NUM_1; dmx_port_t dmx2 = DMX_NUM_1;
@ -174,16 +167,8 @@ void setup()
updateLed(); updateLed();
Serial.begin(9600); Serial.begin(9600);
log.setup();
Logger.registerSerial(SYSTEM, 10, "SYSTEM"); log.info(SYSTEM, "Interface starting...");
Logger.registerSerial(DMX, 10, "DMX");
Logger.registerSerial(ARTNET, 10, "ARTNET");
Logger.registerSerial(WIFI, 10, "WIFI");
Logger.registerSerial(ETHERNET, 10, "ETHERNET");
Logger.registerSerial(SERVER, 10, "SERVER");
Logger.registerSerial(CONFIG, 10, "CONFIG");
Logger.info(SYSTEM, "Interface starting...");
// Get ETH mac // Get ETH mac
delay(1000); delay(1000);
@ -191,17 +176,17 @@ void setup()
esp_efuse_mac_get_default(mac); esp_efuse_mac_get_default(mac);
esp_read_mac(mac, ESP_MAC_ETH); esp_read_mac(mac, ESP_MAC_ETH);
Logger.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC ETH\n", log.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC ETH\n",
mac[0], mac[1], mac[2], mac[0], mac[1], mac[2],
mac[3], mac[4], mac[5]); mac[3], mac[4], mac[5]);
esp_read_mac(mac, ESP_MAC_WIFI_SOFTAP); esp_read_mac(mac, ESP_MAC_WIFI_SOFTAP);
Logger.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC SOFTAP\n", log.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC SOFTAP\n",
mac[0], mac[1], mac[2], mac[0], mac[1], mac[2],
mac[3], mac[4], mac[5]); mac[3], mac[4], mac[5]);
esp_read_mac(mac, ESP_MAC_WIFI_STA); // ESP_MAC_BASE esp_read_mac(mac, ESP_MAC_WIFI_STA); // ESP_MAC_BASE
Logger.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC BASE\n", log.debug(CONFIG, "%02x:%02x:%02x:%02x:%02x:%02x ESP MAC BASE\n",
mac[0], mac[1], mac[2], mac[0], mac[1], mac[2],
mac[3], mac[4], mac[5]); mac[3], mac[4], mac[5]);
@ -224,7 +209,7 @@ void setup()
} }
if (digitalRead(PIN_BUTTON) == LOW) if (digitalRead(PIN_BUTTON) == LOW)
{ {
Logger.notice(CONFIG, "Resetting config"); log.notice(CONFIG, "Resetting config");
config.begin("dmx", false); config.begin("dmx", false);
config.clear(); config.clear();
config.end(); config.end();
@ -260,8 +245,8 @@ void setup()
direction1 = static_cast<Direction>(config.getUInt("direction-1", DEFAULT_DIRECTION1)); direction1 = static_cast<Direction>(config.getUInt("direction-1", DEFAULT_DIRECTION1));
direction2 = static_cast<Direction>(config.getUInt("direction-2", DEFAULT_DIRECTION2)); direction2 = static_cast<Direction>(config.getUInt("direction-2", DEFAULT_DIRECTION2));
Logger.info(CONFIG, "Port A: Universe %d %s", universe1, (direction1 == Input) ? "DMX -> Art-Net" : "Art-Net -> DMX"); log.info(CONFIG, "Port A: Universe %d %s", universe1, (direction1 == Input) ? "DMX -> Art-Net" : "Art-Net -> DMX");
Logger.info(CONFIG, "Port B: Universe %d %s", universe2, (direction2 == Input) ? "DMX -> Art-Net" : "Art-Net -> DMX"); log.info(CONFIG, "Port B: Universe %d %s", universe2, (direction2 == Input) ? "DMX -> Art-Net" : "Art-Net -> DMX");
Connection connection = static_cast<Connection>(config.getUInt("connection", DEFAULT_CONNECTION)); Connection connection = static_cast<Connection>(config.getUInt("connection", DEFAULT_CONNECTION));
IpMethod ipMethod = static_cast<IpMethod>(config.getUInt("ip-method"), DEFAULT_IP_METHOD); IpMethod ipMethod = static_cast<IpMethod>(config.getUInt("ip-method"), DEFAULT_IP_METHOD);
@ -269,7 +254,7 @@ void setup()
char hostname[30]; char hostname[30];
snprintf(hostname, sizeof(hostname), "ChaosDMX-%02X%02X", mac[4], mac[5]); snprintf(hostname, sizeof(hostname), "ChaosDMX-%02X%02X", mac[4], mac[5]);
DEFAULT_SSID = hostname; DEFAULT_SSID = hostname;
Logger.info(CONFIG, "Hostname: %s", hostname); log.info(CONFIG, "Hostname: %s", hostname);
String ssid = config.getString("ssid", DEFAULT_SSID); String ssid = config.getString("ssid", DEFAULT_SSID);
String pwd = config.getString("password", DEFAULT_PASSWORD); String pwd = config.getString("password", DEFAULT_PASSWORD);
@ -284,32 +269,32 @@ void setup()
switch (connection) switch (connection)
{ {
case WiFiSta: case WiFiSta:
Logger.debug(SYSTEM, "Initialize as WiFi Station"); log.debug(SYSTEM, "Initialize as WiFi Station");
WiFi.setHostname(hostname); WiFi.setHostname(hostname);
WiFi.begin(ssid, pwd); WiFi.begin(ssid, pwd);
Logger.info(CONFIG, "SSID: %s; PWD: %s", ssid, pwd); log.info(CONFIG, "SSID: %s; PWD: %s", ssid, pwd);
if (ipMethod == Static) if (ipMethod == Static)
{ {
WiFi.config(ip, gateway, subnet); WiFi.config(ip, gateway, subnet);
Logger.info(CONFIG, "IP: %s; gateway: %s; subnet: %s", ip.toString(), gateway, subnet); log.info(CONFIG, "IP: %s; gateway: %s; subnet: %s", ip.toString(), gateway, subnet);
} }
Logger.debug(WIFI, "Connecting..."); log.debug(WIFI, "Connecting...");
while (WiFi.status() != WL_CONNECTED) while (WiFi.status() != WL_CONNECTED)
{ {
delay(50); delay(50);
updateLed(); updateLed();
} }
Logger.info(WIFI, "Connected!"); log.info(WIFI, "Connected!");
broadcastIp = String(WiFi.broadcastIP().toString().c_str()); broadcastIp = String(WiFi.broadcastIP().toString().c_str());
Logger.info(WIFI, "IP: %s", WiFi.localIP().toString()); log.info(WIFI, "IP: %s", WiFi.localIP().toString());
Logger.info(WIFI, "MAC: %X", WiFi.macAddress()); log.info(WIFI, "MAC: %X", WiFi.macAddress());
Logger.info(WIFI, "Broadcast IP: %s", broadcastIp); log.info(WIFI, "Broadcast IP: %s", broadcastIp);
break; break;
case Ethernet: case Ethernet:
{ {
Logger.debug(SYSTEM, "Initialize as ETH"); log.debug(SYSTEM, "Initialize as ETH");
ESP32_W5500_onEvent(); ESP32_W5500_onEvent();
if (ETH.begin(ETH_MISO, ETH_MOSI, ETH_SCK, ETH_SS, ETH_INT, ETH_SPI_CLOCK_MHZ, SPI2_HOST, mac)) if (ETH.begin(ETH_MISO, ETH_MOSI, ETH_SCK, ETH_SS, ETH_INT, ETH_SPI_CLOCK_MHZ, SPI2_HOST, mac))
@ -317,13 +302,13 @@ void setup()
} }
else else
{ {
Logger.critical(ETHERNET, "Failed to configure Ethernet"); log.critical(ETHERNET, "Failed to configure Ethernet");
} }
ETH.setHostname(hostname); ETH.setHostname(hostname);
// ESP32_W5500_waitForConnect(); // ESP32_W5500_waitForConnect();
uint8_t timeout = 5; // in s uint8_t timeout = 5; // in s
Logger.debug(ETHERNET, "Wait for connect"); log.debug(ETHERNET, "Wait for connect");
// TODO: use millis // TODO: use millis
while (!ESP32_W5500_eth_connected && timeout > 0) while (!ESP32_W5500_eth_connected && timeout > 0)
{ {
@ -332,41 +317,41 @@ void setup()
} }
if (ESP32_W5500_eth_connected) if (ESP32_W5500_eth_connected)
{ {
Logger.debug(ETHERNET, "DHCP OK!"); log.debug(ETHERNET, "DHCP OK!");
} }
else else
{ {
Logger.debug(ETHERNET, "Set static IP"); log.debug(ETHERNET, "Set static IP");
ETH.config(ip, gateway, subnet); ETH.config(ip, gateway, subnet);
} }
Logger.debug(ETHERNET, "Ethernet Successfully Initialized"); log.debug(ETHERNET, "Ethernet Successfully Initialized");
broadcastIp = ETH.broadcastIP().toString(); broadcastIp = ETH.broadcastIP().toString();
Logger.info(ETHERNET, "Local IP: %s", ETH.localIP().toString()); log.info(ETHERNET, "Local IP: %s", ETH.localIP().toString());
Logger.info(ETHERNET, "Subnet Mask: %s", ETH.subnetMask().toString()); log.info(ETHERNET, "Subnet Mask: %s", ETH.subnetMask().toString());
Logger.info(ETHERNET, "Gateway IP: %s", ETH.gatewayIP().toString()); log.info(ETHERNET, "Gateway IP: %s", ETH.gatewayIP().toString());
Logger.debug(ETHERNET, "DNS Server: %s", ETH.dnsIP().toString()); log.debug(ETHERNET, "DNS Server: %s", ETH.dnsIP().toString());
Logger.debug(ETHERNET, "MAC address: %X", ETH.macAddress()); log.debug(ETHERNET, "MAC address: %X", ETH.macAddress());
Logger.debug(ETHERNET, "Broadcast IP: %s", broadcastIp); log.debug(ETHERNET, "Broadcast IP: %s", broadcastIp);
break; break;
} }
default: default:
Logger.debug(SYSTEM, "Initialize as WiFi AccessPoint"); log.debug(SYSTEM, "Initialize as WiFi AccessPoint");
WiFi.softAPsetHostname(hostname); WiFi.softAPsetHostname(hostname);
WiFi.softAP(ssid, pwd); WiFi.softAP(ssid, pwd);
// AP always with DHCP // AP always with DHCP
// WiFi.softAPConfig(ip, gateway, subnet); // WiFi.softAPConfig(ip, gateway, subnet);
broadcastIp = WiFi.softAPBroadcastIP().toString(); broadcastIp = WiFi.softAPBroadcastIP().toString();
Logger.debug(WIFI, "WiFi AP enabled"); log.debug(WIFI, "WiFi AP enabled");
Logger.info(CONFIG, "IP: %s", WiFi.softAPIP().toString()); log.info(CONFIG, "IP: %s", WiFi.softAPIP().toString());
Logger.debug(CONFIG, "MAC address: %X", WiFi.softAPmacAddress()); log.debug(CONFIG, "MAC address: %X", WiFi.softAPmacAddress());
Logger.debug(CONFIG, "Broadcast IP: %s", broadcastIp); log.debug(CONFIG, "Broadcast IP: %s", broadcastIp);
break; break;
} }
// Initialize DMX ports // Initialize DMX ports
Logger.debug(DMX, "Initialize DMX..."); log.debug(DMX, "Initialize DMX...");
#ifdef CONFIG_IDF_TARGET_ESP32S2 #ifdef CONFIG_IDF_TARGET_ESP32S2
@ -379,20 +364,20 @@ void setup()
dmx_driver_install(dmx2, &dmx_config, personalities, personality_count); dmx_driver_install(dmx2, &dmx_config, personalities, personality_count);
dmx_set_pin(dmx2, 17, 18, -1); dmx_set_pin(dmx2, 17, 18, -1);
Logger.verbose(DMX, "DMX driver 1 installed: %d", dmx_driver_is_installed(dmx1)); log.verbose(DMX, "DMX driver 1 installed: %d", dmx_driver_is_installed(dmx1));
Logger.verbose(DMX, "DMX driver 2 installed: %d", dmx_driver_is_installed(dmx2)); log.verbose(DMX, "DMX driver 2 installed: %d", dmx_driver_is_installed(dmx2));
Logger.verbose(DMX, "DMX driver 1 enabled: %d", dmx_driver_is_enabled(dmx1)); log.verbose(DMX, "DMX driver 1 enabled: %d", dmx_driver_is_enabled(dmx1));
Logger.verbose(DMX, "DMX driver 2 enabled: %d", dmx_driver_is_enabled(dmx2)); log.verbose(DMX, "DMX driver 2 enabled: %d", dmx_driver_is_enabled(dmx2));
#else #else
dmx1.init(21, 33, Serial1); dmx1.init(21, 33, Serial1);
dmx2.init(17, 18, Serial2); dmx2.init(17, 18, Serial2);
#endif #endif
Logger.debug(DMX, "DMX initialized"); log.debug(DMX, "DMX initialized");
// Initialize Art-Net // Initialize Art-Net
Logger.debug(ARTNET, "Initialize Art-Net..."); log.debug(ARTNET, "Initialize Art-Net...");
artnet.begin(); artnet.begin();
// if Artnet packet comes to this universe, this function is called // if Artnet packet comes to this universe, this function is called
@ -413,12 +398,12 @@ void setup()
dmx_send(dmx2); dmx_send(dmx2);
dmx_wait_sent(dmx2, DMX_TIMEOUT_TICK); }); dmx_wait_sent(dmx2, DMX_TIMEOUT_TICK); });
} }
Logger.debug(ARTNET, "Initialized Art-Net"); log.debug(ARTNET, "Initialized Art-Net");
if (!LittleFS.begin(true)) if (!LittleFS.begin(true))
{ {
setStatus(Status::Critical); setStatus(Status::Critical);
Logger.critical(SYSTEM, "An Error has occurred while mounting LittleFS"); log.critical(SYSTEM, "An Error has occurred while mounting LittleFS");
return; return;
} }
@ -444,14 +429,14 @@ void setup()
{ {
if (request->url() == "/config" && request->method() == HTTP_PUT) { if (request->url() == "/config" && request->method() == HTTP_PUT) {
onPutConfig(request, data, len, index, total); onPutConfig(request, data, len, index, total);
Logger.info(SYSTEM, "Restarting ESP..."); log.info(SYSTEM, "Restarting ESP...");
ESP.restart(); ESP.restart();
} }); } });
initWebSocket(&server); initWebSocket(&server);
server.begin(); server.begin();
Logger.debug(SERVER, "Webserver started!"); log.debug(SERVER, "Webserver started!");
// scan networks and cache them // scan networks and cache them
WiFi.scanNetworks(true); WiFi.scanNetworks(true);
@ -460,16 +445,16 @@ void setup()
// Internal temperature RP2040 // Internal temperature RP2040
// float tempC = analogReadTemp(); // Get internal temperature // float tempC = analogReadTemp(); // Get internal temperature
// Logger.verbose(SYSTEM, "Temperature Celsius: %d °C", tempC); // log.verbose(SYSTEM, "Temperature Celsius: %d °C", tempC);
// Internal temperature ESP32 https://www.espboards.dev/blog/esp32-inbuilt-temperature-sensor/ // Internal temperature ESP32 https://www.espboards.dev/blog/esp32-inbuilt-temperature-sensor/
float result = 0; float result = 0;
temp_sensor_read_celsius(&result); temp_sensor_read_celsius(&result);
Logger.verbose(SYSTEM, "Temperature: %.2f °C", result); log.verbose(SYSTEM, "Temperature: %.2f °C", result);
Logger.verbose(SYSTEM, "Internal Total heap: %d; internal Free Heap: %d", ESP.getHeapSize(), ESP.getFreeHeap()); log.verbose(SYSTEM, "Internal Total heap: %d; internal Free Heap: %d", ESP.getHeapSize(), ESP.getFreeHeap());
Logger.verbose(SYSTEM, "SPIRam Total heap: %d; SPIRam Free Heap: %d", ESP.getPsramSize(), ESP.getFreePsram()); log.verbose(SYSTEM, "SPIRam Total heap: %d; SPIRam Free Heap: %d", ESP.getPsramSize(), ESP.getFreePsram());
Logger.verbose(SYSTEM, "ChipRevision: %d; Cpu Freq: %d; SDK Version: %s", ESP.getChipRevision(), ESP.getCpuFreqMHz(), ESP.getSdkVersion()); log.verbose(SYSTEM, "ChipRevision: %d; Cpu Freq: %d; SDK Version: %s", ESP.getChipRevision(), ESP.getCpuFreqMHz(), ESP.getSdkVersion());
Logger.verbose(SYSTEM, "Flash Size: %d; Flash Speed: %d", ESP.getFlashChipSize(), ESP.getFlashChipSpeed()); log.verbose(SYSTEM, "Flash Size: %d; Flash Speed: %d", ESP.getFlashChipSize(), ESP.getFlashChipSpeed());
} }
void transmitDmxToArtnet(dmx_port_t dmxPort, byte *dmx_data, uint8_t artnetUniverse) void transmitDmxToArtnet(dmx_port_t dmxPort, byte *dmx_data, uint8_t artnetUniverse)
@ -495,7 +480,7 @@ void transmitDmxToArtnet(dmx_port_t dmxPort, byte *dmx_data, uint8_t artnetUnive
connect or disconnect your DMX devices. If you are consistently getting connect or disconnect your DMX devices. If you are consistently getting
DMX errors, then something may have gone wrong with your code or DMX errors, then something may have gone wrong with your code or
something is seriously wrong with your DMX transmitter. */ something is seriously wrong with your DMX transmitter. */
Logger.error(DMX, "A DMX error occurred on port %d", dmxPort); log.error(DMX, "A DMX error occurred on port %d", dmxPort);
} }
} }
} }