Files
MeshCore/examples/companion_radio/CompanionWiFi.h
T

105 lines
4.1 KiB
C

#pragma once
#include <stddef.h>
#include <stdint.h>
#ifndef UI_WIFI_SETUP_HOME_PAGE
#define UI_WIFI_SETUP_HOME_PAGE 0
#endif
#if UI_WIFI_SETUP_HOME_PAGE == 1 \
&& !(defined(ESP32) && defined(WIFI_SSID))
#error "UI_WIFI_SETUP_HOME_PAGE requires ESP32 infrastructure WiFi"
#endif
#if defined(COMPANION_EXCLUSIVE_WIFI_BLE) \
&& !(defined(ESP32) && defined(WIFI_SSID) && defined(BLE_PIN_CODE))
#error "COMPANION_EXCLUSIVE_WIFI_BLE requires ESP32, WIFI_SSID, and BLE_PIN_CODE"
#endif
#if defined(ESP32) && defined(WIFI_SSID)
#if defined(COMPANION_EXCLUSIVE_WIFI_BLE)
enum class CompanionTransportMode : uint8_t {
Bluetooth,
WiFi,
};
// The selected transport is persisted immediately but is deliberately applied
// only on the next boot. This keeps Bluetooth memory release irreversible only
// within the boot that selected exclusive WiFi.
CompanionTransportMode getCompanionTransportMode();
bool selectCompanionTransportMode(CompanionTransportMode mode);
#endif
enum class CompanionWiFiPowerSaveResult : uint8_t {
Applied,
SavedForNextConnection,
SavedForNextBoot,
InvalidMode,
BluetoothConflict,
PrimaryEspNowConflict,
StorageError,
};
// The requested state is persisted immediately. Network services transition
// from the main loop so a button callback never tears down an active server.
bool toggleCompanionWiFi();
bool setCompanionWiFiEnabled(bool enabled);
bool isCompanionWiFiEnabled();
bool hasCompanionWiFiCredentials();
// Display-facing station state. Arduino's cached WL status can briefly lag the
// ESP-IDF association record, so accept either source while the AP link is
// live. Unlike localIP(), the driver record is cleared on a real disconnect.
bool isCompanionWiFiConnected();
enum class CompanionWiFiDisplayState : uint8_t {
NotRendered,
Setup,
Off,
Ready,
NotConfigured,
Connecting,
};
// Record the branch that was actually drawn. This is exposed through the
// read-only `get display.wifi` terminal diagnostic so a headless test host can
// distinguish network state from a stale or incorrect LCD frame.
void noteCompanionWiFiDisplayState(CompanionWiFiDisplayState state);
void formatCompanionWiFiDisplayStatus(char* reply, size_t reply_size);
// Inspect the actual Companion TCP listener and completed protocol traffic;
// reading this diagnostic never opens a client or restarts a live session.
void formatCompanionWiFiTcpStatus(char* reply, size_t reply_size);
// Compatibility changes are saved for the next boot; never tear down the
// transport carrying the command or disable modem sleep under a live BLE stack.
bool handleCompanionWiFiCompatibilityCommand(const char* command, char* reply,
size_t reply_size);
// Use Companion ownership state when formatting an otherwise ambiguous idle or
// disconnected station; WebConfig being stopped does not mean WiFi is off.
void formatCompanionWiFiStatus(char* reply, size_t reply_size);
// Display callbacks only queue these requests. The main loop owns the actual
// WebConfig/WiFi transitions so input handling never tears down network
// services from the UI task. Neither request changes the saved WebUI or WiFi
// preference; the setup AP is controlled only for the current boot session.
void requestCompanionWiFiSetup();
void requestCompanionWiFiSetupStop();
// Reload saved credentials after a text-terminal update. The reconnect is
// deferred so the command reply can leave USB/TCP before WiFi is restarted.
void scheduleCompanionWiFiCredentialReload();
// Companion WiFi power save is stored in the shared mesh-wifi NVS namespace.
// The returned mode is always the effective mode. WiFi+BLE builds map a stale
// or default "none" value to "min" because modem sleep is required for radio
// coexistence. Primary ESP-NOW builds also map stale "max" to "min" so the
// receiver does not sleep through unbuffered ESP-NOW broadcasts.
uint8_t getCompanionWiFiPowerSave();
const char* getCompanionWiFiPowerSaveName();
const char* companionWiFiPowerSaveName(uint8_t mode);
CompanionWiFiPowerSaveResult setCompanionWiFiPowerSave(uint8_t mode);
void reloadCompanionWiFiPowerSave();
bool applyCompanionWiFiPowerSave();
#endif