Esp32WiFiConfiguration.hxx

Go to the documentation of this file.

 
#ifndef _FREERTOS_DRIVERS_ESP32_ESP32WIFICONFIG_HXX_
#define _FREERTOS_DRIVERS_ESP32_ESP32WIFICONFIG_HXX_
 
#include "openlcb/ConfigRepresentation.hxx"
#include "openlcb/ConfiguredTcpConnection.hxx"
 
namespace openmrn_arduino
{
 
class Esp32WiFiConfigurationParams
{
public:
    static constexpr const char *BOOLEAN_MAP =
        "<relation><property>0</property><value>No</value></relation>"
        "<relation><property>1</property><value>Yes</value></relation>";
 
    static constexpr const char *WIFI_POWER_SAVE_NAME =
        "WiFi Power Savings Mode";
 
    static constexpr const char *WIFI_POWER_SAVE_DESC =
        "When enabled this allows the ESP32 WiFi radio to use power savings "
        "mode which puts the radio to sleep except to receive beacon updates "
        "from the connected SSID. This should generally not need to be "
        "enabled unless you are powering the ESP32 from a battery.";
 
    static constexpr const char *HUB_NAME = "Hub Configuration";
 
    static constexpr const char *HUB_DESC =
        "Configuration settings for an OpenLCB Hub";
 
    static constexpr const char *CONN_MODE_NAME = "Connection Mode";
 
    static constexpr const char *CONN_MODE_DESC =
        "Defines whether to allow accepting connections (according to the Hub "
        "configuration), making a connection (according to the Uplink "
        "configuration), or both.\nThis setting can be set to Disabled if the "
        "ESP32 will be using the TWAI (CAN) driver instead for the connection "
        "to other nodes.\nNote: it is not recommended to enable the Hub "
        "functionality on single-core ESP32 models.";
 
    static constexpr const char *CONN_MODE_MAP =
        "<relation><property>0</property><value>Disabled</value></relation>"
        "<relation><property>1</property><value>Uplink Only</value></relation>"
        "<relation><property>2</property><value>Hub Only</value></relation>"
        "<relation><property>3</property><value>Hub+Uplink</value></relation>";
  
    static constexpr const char *HUB_LISTENER_PORT_NAME = "Hub Listener Port";
 
    static constexpr const char *HUB_LISTENER_PORT_DESC =
        "Defines the TCP/IP listener port this node will use when operating "
        "as a hub. Most of the time this does not need to be changed.";
 
    static constexpr const char *UPLINK_NAME = "Node Uplink Configuration";
 
    static constexpr const char *UPLINK_DESC =
        "Configures how this node will connect to other nodes.";
};
 
CDI_GROUP(HubConfiguration);
CDI_GROUP_ENTRY(port, openlcb::Uint16ConfigEntry,
    Name(Esp32WiFiConfigurationParams::HUB_LISTENER_PORT_NAME),
    Description(Esp32WiFiConfigurationParams::HUB_LISTENER_PORT_DESC), Min(1),
    Max(65535), Default(openlcb::TcpClientDefaultParams::DEFAULT_PORT))
CDI_GROUP_ENTRY(service_name, openlcb::StringConfigEntry<48>,
    Name(openlcb::TcpClientDefaultParams::SERVICE_NAME),
    Description(openlcb::TcpClientDefaultParams::SERVICE_DESCR));
CDI_GROUP_ENTRY(reserved, openlcb::BytesConfigEntry<6>, Hidden(true));
CDI_GROUP_END();
 
CDI_GROUP(WiFiConfiguration);
CDI_GROUP_ENTRY(sleep, openlcb::Uint8ConfigEntry,
    Name(Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_NAME),
    Description(Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_DESC),
    Min(0), Max(1), Default(0), /* Off */
    MapValues(Esp32WiFiConfigurationParams::BOOLEAN_MAP));
CDI_GROUP_ENTRY(connection_mode, openlcb::Uint8ConfigEntry,
    Name(Esp32WiFiConfigurationParams::CONN_MODE_NAME),
    Description(Esp32WiFiConfigurationParams::CONN_MODE_DESC),
    Min(0), Max(3), Default(1), /* Uplink only */
    MapValues(Esp32WiFiConfigurationParams::CONN_MODE_MAP));
CDI_GROUP_ENTRY(hub, HubConfiguration,
    Name(Esp32WiFiConfigurationParams::HUB_NAME),
    Description(Esp32WiFiConfigurationParams::HUB_DESC));
CDI_GROUP_ENTRY(uplink,
    openlcb::TcpClientConfig<openlcb::TcpClientDefaultParams>,
    Name(Esp32WiFiConfigurationParams::UPLINK_NAME),
    Description(Esp32WiFiConfigurationParams::UPLINK_DESC));
CDI_GROUP_ENTRY(reserved, openlcb::BytesConfigEntry<6>, Hidden(true));
CDI_GROUP_END();
 
} // namespace openmrn_arduino
 
using openmrn_arduino::WiFiConfiguration;
 
#endif // _FREERTOS_DRIVERS_ESP32_ESP32WIFICONFIG_HXX_