AppConfig.hpp

Go to the documentation of this file.

#pragma once
 
#include <config.hpp>
#include <tuple>
 
namespace lacte::config {
template <typename T>
using ConfigField = insitech::config::FieldSpec<T>;
 
// =============================================================================
// Обязательные поля - в точности список REQUIRED FIELDS из собственного
// doc-комментария AppContext.h (см. doc-комментарий этого файла).
// static_assert'ы AppConfig<kAllFields> проверяют, что каждое из них
// существует, под этим точным ключом/типом - собраны вместе, первыми,
// чтобы этот контракт был виден как единое целое, а не разбросан по
// тематическим секциям ниже.
// =============================================================================
 
// (см. App.cpp::main()'s AppContext, AppContext::app_name/app_description)
inline constexpr ConfigField<const char*> K_APP_NAME{
    "app_name",
    "This app's own name - its Logger label, its bus identity's name, and "
    "ConsoleApp's own CLI --help header/single-instance lock file name "
    "(read straight off AppContext::app_name, not a separate copy)",
    "lacte_app"};
inline constexpr ConfigField<const char*> K_APP_DESCRIPTION{
    "app_description", "Human-readable one-line app description (CLI --help)",
    "some description"};
// Базовая директория для собственных операционных данных этого приложения
// - см. собственный doc-комментарий этого файла о том, что именно здесь
// живёт (поиск прошивки, база данных, кэш платы) и почему используется
// НАПРЯМУЮ, без добавленного app_name - заменяет/поглощает bin_path И
// cache_path (их старые значения по умолчанию уже были идентичны).
inline constexpr ConfigField<const char*> K_APP_DIR{
    "app_dir",
    "Base directory for this app's own data (firmware-file search "
    "directory, database, board cache - see this file's own doc comment) "
    "- used as-is, deliberately kept at its historical value",
    "/usr/local/daemon/lacte"};
inline constexpr ConfigField<const char*> K_BUS_MULTICAST_GROUP{
    "bus_multicast_group", "Multicast group every bus participant joins",
    "239.255.19.31"};
inline constexpr ConfigField<int64_t> K_BUS_MULTICAST_PORT{
    "bus_multicast_port", "Multicast port every bus participant joins", 47761};
inline constexpr ConfigField<int64_t> K_SHARED_BUS_ADDRESS{
    "shared_bus_address",
    "This process's ONE shared insitech::bus::Hub<RX,TX> node's own "
    "address (see AppContext::bus) - distinct from every "
    "participant's own client address below (kModelBusAddress/kUiBusAddress/"
    "kDbBusAddress), which each builds its own client onto this same node.",
    100};
// Читается напрямую AppContext (см. Libraries/app_control/AppContext.h -
// REQUIRED FIELDS) для построения собственного файла диагностического
// логгера - роль и значение НЕ ИЗМЕНИЛИСЬ (см. собственный doc-комментарий
// этого файла): всё тот же большой, выгружаемый вовне лог, сознательно
// отделённый от операционных данных app_dir. Также дублирует роль
// вторичной директории поиска прошивки (см. LacteApp::TryToUpdate()),
// заменяя старое отдельное поле nand_lacte_path (всегда хранившее то же
// самое значение, что и это).
inline constexpr ConfigField<const char*> K_LOG_DIR{
    "log_dir",
    "Directory the diagnostic logger's own (large) file lives under, in "
    "an app_name subdirectory - also the secondary firmware-search "
    "directory (used as-is) - NOT this app's own operational data "
    "(database, cache), see app_dir for that",
    "/mnt/nand_disk_ext/lacte/"};
// Читается напрямую AppContext (см. Libraries/app_control/AppContext.h -
// REQUIRED FIELDS) сразу после построения `logger`, чтобы применяться с
// самой первой записанной строки - собственная опция CLI --log-level
// LacteApp (см. LacteApp.cpp) переопределяет это заново, позже, как только
// CLI11 разберёт argv.
inline constexpr ConfigField<int64_t> K_LOG_MIN_LEVEL{
    "log_min_level",
    "Minimum severity level written to the log (0=TRACE, 1=INFO, "
    "2=WARNING, 3=ERROR)",
    1};
 
// =============================================================================
// Имена - строки идентичности/подписи, ещё не перечисленные выше.
// =============================================================================
 
// -- Имена идентичности узлов Hub (см. собственное анонсируемое имя
// AppContext::bus, производное от kAppName - эти же поля для СОБСТВЕННЫХ
// узлов клиентов ДРУГИХ участников, см. секцию "Network / bus transport"
// ниже про их адреса) --
inline constexpr ConfigField<const char*> K_MODEL_BUS_NODE_NAME{
    "model_bus_node_name", "Identity name for the Model's bus node",
    "lacte-model"};
inline constexpr ConfigField<const char*> K_DB_BUS_NODE_NAME{
    "db_bus_node_name", "Identity name for AppDb's own bus node", "lacte-db"};
// Здесь нет kLogBusAddress/kLogBusNodeName: каждое приложение, унаследованное
// от ConsoleApp, уже получает собственный insitech::Logger, бесплатно
// подключённый слушать шину (см. собственный конструктор AppContext) по
// адресу insitech::Logger::kDefaultAddress - это ЕДИНСТВЕННЫЙ источник
// истины для адреса слушателя логов, а не поле конфига для каждого
// приложения отдельно.
// Здесь также нет kSharedBusNodeName: собственное анонсируемое имя
// идентичности узла общей шины выводится напрямую из ЗНАЧЕНИЯ kAppName во
// время сборки контекста (см. собственный конструктор AppContext в
// Libraries/app_control/AppContext.h) - не второе, отдельно
// конфигурируемое имя для того же самого, по сути, вопроса "кто это",
// на который kAppName уже отвечает.
 
// =============================================================================
// Пути - пути файловой системы и устройств, ещё не перечисленные выше.
// =============================================================================
 
// Голый КОРЕНЬ точки монтирования NAND (на один уровень выше log_dir) -
// см. собственный doc-комментарий этого файла о том, почему это остаётся
// отдельным полем от log_dir (проверке IsMounted() в App.cpp::Bootstrap()
// нужно именно это значение, а не собственное, на уровень глубже, значение
// log_dir).
inline constexpr ConfigField<const char*> K_NAND_DISK_PATH{
    "nand_disk_path",
    "Mount point checked before using the NAND firmware directory "
    "(log_dir) - the bare mount root, one level up from log_dir itself",
    "/mnt/nand_disk_ext"};
inline constexpr ConfigField<const char*> K_PL2303_SYSFS_PATH{
    "pl2303_sysfs_path",
    "sysfs new_id file used to bind the pl2303 UART driver to the board's "
    "VID:PID",
    "/sys/bus/usb-serial/drivers/pl2303/new_id"};
 
// -- Пути устройств (см. LacteApp.cpp::RunImpl(), ui/framebuffer/
// FramebufferUi.cpp) - device_name, несмотря на своё имя ключа,
// идентифицирует, как ОТКРЫТЬ устройство платы (путь либо VID:PID) точно
// так же, как пути framebuffer/touch/HMI ниже идентифицируют свои
// устройства; см. kUsbVidPid (в "Всё остальное" ниже) для ДРУГОЙ цели -
// регистрации в драйвере ядра, которой служит именно то поле --
inline constexpr ConfigField<const char*> K_DEVICE_NAME{
    "device_name", "Board UART device path or VID:PID", "067b:23a3"};
// Читается только когда ui_mode равен "fb" - та же категория, что и
// device_name выше (путь узла устройства, который реальному
// развёртыванию может понадобиться изменить без пересборки), только для
// аппаратуры дисплея/тачскрина/HMI вместо платы.
inline constexpr ConfigField<const char*> K_FRAMEBUFFER_PATH{
    "framebuffer_path", "Framebuffer device node the 'fb' UI renders to",
    "/dev/fb0"};
inline constexpr ConfigField<const char*> K_TOUCH_PATH{
    "touch_path", "Touchscreen input device node the 'fb' UI reads",
    "/dev/input/event1"};
inline constexpr ConfigField<const char*> K_HMI_UART_PATH{
    "hmi_uart_path",
    "UART device node the 'fb' UI's HMI/back-board protocol uses",
    "/dev/ptyhmi-sniff"};
 
// =============================================================================
// Всё остальное - адреса/порты, настройки протокола устройства, интервалы.
// =============================================================================
 
// Только ИМЯ ФАЙЛА базы данных - живёт напрямую под app_dir (см. собственный
// doc-комментарий этого файла) - раньше было db_path (голое "./lacte.db",
// относительно CWD - фактически оказывалось в директории app_dir только
// потому, что она исторически И БЫЛА рабочей директорией этого процесса в
// production; теперь явное, а не случайное, то же самое итоговое место).
inline constexpr ConfigField<const char*> K_DB_NAME{
    "db_name", "SQLite database file name (lives directly under app_dir)",
    "lacte.db"};
inline constexpr ConfigField<const char*> K_FIRMWARE_GLOB{
    "firmware_glob", "Glob TryToUpdate() scans app_dir/log_dir with", "*.bin"};
inline constexpr ConfigField<const char*> K_USB_VID_PID{
    "usb_vid_pid",
    "Board's USB VID:PID, space-separated (sysfs new_id's own format) — "
    "written to pl2303_sysfs_path so the board's UART shows up as a device "
    "node at all. Distinct from device_name: that one names how to *open* "
    "the device (a path, or the same VID:PID colon-separated), this one is "
    "only ever used to register it with the kernel driver",
    "067b 23a3"};
 
// -- Сеть / транспорт шины (см. App.cpp::main(), ModelBusClient.hpp/
// UiBusClient.hpp) - bus_multicast_group/_port/shared_bus_address -
// обязательные поля, см. секцию выше; это - собственные адреса клиентов
// ДРУГИХ участников на том же общем узле --
inline constexpr ConfigField<int64_t> K_MODEL_BUS_ADDRESS{
    "model_bus_address",
    "This process's bus node address for the Model "
    "(bus::kModelBusAddress)",
    1};
inline constexpr ConfigField<int64_t> K_UI_BUS_ADDRESS{
    "ui_bus_address",
    "Hub node address a UI process/thread uses (bus::kUiBusAddress)", 2};
inline constexpr ConfigField<int64_t> K_DB_BUS_ADDRESS{
    "db_bus_address",
    "Hub node address AppDb's own internal bus node uses (kDbBusAddress "
    "in LacteApp.cpp)",
    3};
inline constexpr ConfigField<int64_t> K_MODEL_UI_NOTIFIER_ADDRESS{
    "model_ui_notifier_address",
    "Hub node address the Model's second client (a UiBusClient - see "
    "Model::ConnectBus()) uses purely to push UiCommand/BoardSnapshotEvent "
    "to the UI - distinct from kModelBusAddress since one client can't be "
    "registered at two addresses.",
    4};
// -- Настройки устройства платы / протокола (см. LacteApp.cpp::RunImpl()) --
inline constexpr ConfigField<int64_t> K_UART_BAUD_RATE{
    "uart_baud_rate", "Board UART baud rate", 115200};
inline constexpr ConfigField<const char*> K_UI_MODE{
    "ui_mode", "'fb' (framebuffer), 'console', or 'no' (headless)", "fb"};
inline constexpr ConfigField<int64_t> K_CHECK_UPDATE_INTERVAL_MS{
    "check_update_interval_ms",
    "How often to poll app_dir/log_dir for a new firmware file", 30000};
inline constexpr ConfigField<int64_t> K_BOARD_ONLINE_TIMEOUT_MS{
    "board_online_timeout_ms",
    "How long without an info packet before Model reports the board "
    "offline",
    3000};
 
// -- Тайминги Framebuffer UI (см. ui/framebuffer/FramebufferUi.cpp) --
inline constexpr ConfigField<int64_t> K_HMI_UART_BAUD_RATE{
    "hmi_uart_baud_rate", "Baud rate for hmi_uart_path", 115200};
inline constexpr ConfigField<int64_t> K_FRAME_TIME_MS{
    "frame_time_ms", "Target frame time in ms the 'fb' UI's GUI loop runs at",
    30};
 
// -- VNC (RFB) mirror server (см. ui/framebuffer/vnc/RfbServer.hpp) --
inline constexpr ConfigField<int64_t> K_VNC_PORT{
    "vnc_port", "TCP port the 'fb' UI's VNC (RFB) mirror server listens on",
    5900};
inline constexpr ConfigField<const char*> K_VNC_PASSWORD{
    "vnc_password",
    "Classic VNC (RFB DES challenge-response) password, up to 8 characters "
    "(a real protocol limit, not a bug) - typed manually into the VNC "
    "viewer at connect time, same as any other VNC server. Empty "
    "(default) disables the VNC server entirely - there is no "
    "unauthenticated fallback.",
    ""};
 
// Все поля выше, собранные воедино один раз — единственный аргумент,
// который нужен `Config`/`ConfigStore` для построения всей схемы lacteApp
// (см. App.cpp::main()).
inline constexpr auto K_ALL_FIELDS = std::tie(
    // Обязательные поля
    K_APP_NAME, K_APP_DESCRIPTION, K_APP_DIR, K_BUS_MULTICAST_GROUP,
    K_BUS_MULTICAST_PORT, K_SHARED_BUS_ADDRESS, K_LOG_DIR, K_LOG_MIN_LEVEL,
    // Имена
    K_MODEL_BUS_NODE_NAME, K_DB_BUS_NODE_NAME,
    // Пути
    K_NAND_DISK_PATH, K_PL2303_SYSFS_PATH, K_DEVICE_NAME, K_FRAMEBUFFER_PATH,
    K_TOUCH_PATH, K_HMI_UART_PATH,
    // Всё остальное
    K_DB_NAME, K_FIRMWARE_GLOB, K_USB_VID_PID, K_MODEL_BUS_ADDRESS,
    K_UI_BUS_ADDRESS, K_DB_BUS_ADDRESS, K_MODEL_UI_NOTIFIER_ADDRESS,
    K_UART_BAUD_RATE, K_UI_MODE, K_CHECK_UPDATE_INTERVAL_MS,
    K_BOARD_ONLINE_TIMEOUT_MS, K_HMI_UART_BAUD_RATE, K_FRAME_TIME_MS,
    K_VNC_PORT, K_VNC_PASSWORD);
}  // namespace lacte::config