Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
// SPDX-License-Identifier: GPL-3.0-or-later
// Copyright (C) 2025 Jibril Sharafi
#pragma once
// Note: all the durations hereafter are in milliseconds unless specified otherwise
// Firmware info
#define FIRMWARE_BUILD_VERSION_MAJOR "2"
#define FIRMWARE_BUILD_VERSION_MINOR "5"
#define FIRMWARE_BUILD_VERSION_PATCH "0"
#define FIRMWARE_BUILD_VERSION FIRMWARE_BUILD_VERSION_MAJOR "." FIRMWARE_BUILD_VERSION_MINOR "." FIRMWARE_BUILD_VERSION_PATCH
#define FIRMWARE_BUILD_DATE __DATE__
#define FIRMWARE_BUILD_TIME __TIME__
// Product info
#define COMPANY_NAME "EnergyMe"
// Compile-time on purpose: every Pro env pins PRODUCT_FALLBACK=1 and the image descriptor keeps a
// Pro binary off Home hardware (and vice versa), so the build's product is the running product.
// PRODUCT_SLUG names things the user sees on their own network/servers (DHCP hostname, InfluxDB
// defaults). Cloud-facing identifiers (MQTT topics, rule names) are NOT derived from it.
#if defined(PRODUCT_FALLBACK) && PRODUCT_FALLBACK == 1
#define PRODUCT_NAME "Home Pro"
#define FULL_PRODUCT_NAME "EnergyMe - Home Pro"
#define PRODUCT_SLUG "energyme-homepro"
#define PRODUCT_DESCRIPTION "An open-source energy monitoring system with Ethernet, capable of monitoring up to 12 circuits."
#else
#define PRODUCT_NAME "Home"
#define FULL_PRODUCT_NAME "EnergyMe - Home"
#define PRODUCT_SLUG "energyme-home"
#define PRODUCT_DESCRIPTION "An open-source energy monitoring system for home use, capable of monitoring up to 16 circuits."
#endif
#define GITHUB_URL "https://github.com/jibrilsharafi/EnergyMe-Home"
#define GITHUB_API_LATEST_RELEASE_URL "https://api.github.com/repos/jibrilsharafi/EnergyMe-Home/releases/latest"
#define AUTHOR "Jibril Sharafi"
#define AUTHOR_EMAIL "jibril.sharafi@gmail.com"
// Serial
#define SERIAL_BAUDRATE 115200 // Most common baudrate for ESP32
// HWCDC blocks up to this long per write (per CHAR on the core-log path) when a USB host is attached
// but not draining the port. Core default is 100 ms: in dev builds the core's pre-setup chip report
// alone then takes ~280 s (measured: 292 s to first Ethernet reachability after a USB reset with the
// COM port left closed, vs 7 s with a reader). Applied from getArduinoSetupWaitTime_ms() in main.cpp.
// Must be >= 2: at 0 or 1 the core retry counter marks the port disconnected on healthy multi-chunk writes.
#define SERIAL_TX_TIMEOUT_MS 3
// While loops
#define MAX_LOOP_ITERATIONS 1000 // The maximum number of iterations for any while loop to avoid infinite loops
// Preferences namespaces are here to enable a full wipe from utils when factory resetting
#define PREFERENCES_NAMESPACE_GENERAL "general_ns"
#define PREFERENCES_NAMESPACE_ADE7953 "ade7953_ns"
#define PREFERENCES_NAMESPACE_ENERGY "energy_ns"
#define PREFERENCES_NAMESPACE_CALIBRATION "calibration_ns"
#define PREFERENCES_NAMESPACE_CHANNELS "channels_ns"
#define PREFERENCES_NAMESPACE_MQTT "mqtt_ns"
#define PREFERENCES_NAMESPACE_CUSTOM_MQTT "custom_mqtt_ns"
#define PREFERENCES_NAMESPACE_INFLUXDB "influxdb_ns"
#define PREFERENCES_NAMESPACE_BUTTON "button_ns"
#define PREFERENCES_NAMESPACE_WIFI "wifi_ns"
#define PREFERENCES_NAMESPACE_TIME "time_ns"
#define PREFERENCES_NAMESPACE_CRASHMONITOR "crashmonitor_ns"
#define PREFERENCES_NAMESPACE_FACTORY "factory_ns"
#define PREFERENCES_NAMESPACE_LED "led_ns"
#define PREFERENCES_NAMESPACE_AUTH "auth_ns"
#define PREFERENCES_NAMESPACE_UDP_LOG "udp_log_ns"
// Default ESP32 NVS spaces (only for reference - should never be touched)
#define PREFERENCES_DEFAULT_NAMESPACE_PHY "phy"
#define PREFERENCES_DEFAULT_NAMESPACE_WIFI "nvs.net80211"
// NVS namespaces excluded from backup/restore (sensitive or device-specific data)
// These must be skipped during export and rejected during import
#define EXCLUDED_NVS_NAMESPACES_LIST \
PREFERENCES_NAMESPACE_AUTH, \
PREFERENCES_DEFAULT_NAMESPACE_WIFI, \
PREFERENCES_DEFAULT_NAMESPACE_PHY, \
PREFERENCES_NAMESPACE_FACTORY
#define TO_INITIALIZE_NVS_NAMESPACES_LIST \
PREFERENCES_NAMESPACE_GENERAL, \
PREFERENCES_NAMESPACE_ADE7953, \
PREFERENCES_NAMESPACE_ENERGY, \
PREFERENCES_NAMESPACE_CALIBRATION, \
PREFERENCES_NAMESPACE_CHANNELS, \
PREFERENCES_NAMESPACE_MQTT, \
PREFERENCES_NAMESPACE_CUSTOM_MQTT, \
PREFERENCES_NAMESPACE_INFLUXDB, \
PREFERENCES_NAMESPACE_BUTTON, \
PREFERENCES_NAMESPACE_WIFI, \
PREFERENCES_NAMESPACE_TIME, \
PREFERENCES_NAMESPACE_CRASHMONITOR, \
PREFERENCES_NAMESPACE_LED, \
PREFERENCES_NAMESPACE_AUTH, \
PREFERENCES_NAMESPACE_UDP_LOG, \
// Logger
#define LOG_PATH "/log.txt"
// UDP Log configuration
#define PREFERENCES_KEY_UDP_DESTINATION "udp_dest"
// Buffer Sizes for String Operations
// =================================
// Only constants which are used in multiple files are defined here
#define PREFERENCES_KEY_BUFFER_SIZE 15 // Maximum allowed by Preferences API
#define VERSION_BUFFER_SIZE 16 // For version strings (e.g., 1.0.0)
#define DEVICE_ID_BUFFER_SIZE 16 // For device ID (increased slightly for safety)
#define IP_ADDRESS_BUFFER_SIZE 16 // For IPv4 addresses (e.g., "192.168.1.1")
#define MAC_ADDRESS_BUFFER_SIZE 18 // For MAC addresses (e.g., "00:1A:2B:3C:4D:5E")
#define TIMESTAMP_ISO_BUFFER_SIZE 25 // For ISO UTC timestamps (formatted as "YYYY-MM-DDTHH:MM:SS.sssZ")
#define SHORT_NAME_BUFFER_SIZE 32 // For short names (e.g., channel names, labels)
#define MD5_BUFFER_SIZE 33 // 32 characters + null terminator
#define SHA256_HEX_BUFFER_SIZE 65 // 64 hex characters + null terminator (app_elf_sha256)
#define WIFI_SSID_BUFFER_SIZE 32 // For WiFi SSID (maximum SSID length is 31)
#define WIFI_PASSWORD_BUFFER_SIZE 64 // For WiFi password (maximum WPA2 password length is 63)
#define USERNAME_BUFFER_SIZE 64 // For usernames (e.g., MQTT username)
#define PASSWORD_BUFFER_SIZE 64 // For passwords (e.g., MQTT password)
#define SHORT_STATUS_BUFFER_SIZE 64 // Generic short status messages. Smaller than status so we can use %s of SHORT_STATUS in STATUS
#define NAME_BUFFER_SIZE 64 // For generic names (device, user, etc.)
#define MQTT_TOPIC_BUFFER_SIZE 128 // For MQTT topics
#define URL_BUFFER_SIZE 256 // For URLs
#define FULL_URL_BUFFER_SIZE 512 // For URLs with query parameters and similars
#define STATUS_BUFFER_SIZE 128 // Generic status messages (e.g., connection status, error messages)
#define STREAM_UTILS_MQTT_PACKET_SIZE 256 // Buffering stream packets instead of sending byte per byte is way more efficient
// Timeouts and intervals
#define TASK_STOPPING_TIMEOUT (3 * 1000)
#define TASK_STOPPING_CHECK_INTERVAL 100
// stopTaskGracefully() signals shutdown via this bit (xTaskNotify, eSetBits);
// any nonzero value still satisfies plain ulTaskNotifyTake(pdTRUE, ...), so
// existing tasks are unaffected. MQTT distinguishes it from MQTT_NOTIFY_WAKE_BIT
// (mqtt.h) via xTaskNotifyWait so an alarm wake isn't treated as shutdown.
#define TASK_NOTIFY_SHUTDOWN_BIT (1 << 0)
#define CONFIG_MUTEX_TIMEOUT_MS (1 * 1000) // Generic timeout for configuration mutexes. Long timeouts cause wdt crash (like in async tcp)
// Server used ports (here to ensure no conflicts)
#define MODBUS_TCP_PORT 502
#define WEBSERVER_PORT 80
#define WEBSERVER_ROUTE_ALLOC_PSRAM_THRESHOLD 16 // malloc() PSRAM threshold (bytes) while the routes are registered - see CustomServer::begin()
// Useful constants
#define MAGIC_WORD_RTC 0xDEADBEEF // This is crucial to ensure that the RTC variables used have sensible values or it is just some garbage after reboot
f4329a85eThis file is pinned to the selected release. Download the original to open it in your design tool.