Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
openmrn_arduino::Esp32WiFiConfigurationParams Class Reference

Names and Descriptions for all ESP32 exposed WiFi configuration options. More...

#include <Esp32WiFiConfiguration.hxx>

Static Public Attributes

static constexpr const char * BOOLEAN_MAP
 <map> of possible keys and descriptive values to show to the user for the wifi_sleep and hub_mode fields.
 
static constexpr const char * WIFI_POWER_SAVE_NAME
 Visible name for the WiFi Power Savings mode.
 
static constexpr const char * WIFI_POWER_SAVE_DESC
 Visible description for the WiFi Power Savings mode.
 
static constexpr const char * HUB_NAME = "Hub Configuration"
 Visible name for the Hub Configuration group.
 
static constexpr const char * HUB_DESC
 Visible description for the Hub Configuration group.
 
static constexpr const char * CONN_MODE_NAME = "Connection Mode"
 Visible name for the hub/uplink enable field.
 
static constexpr const char * CONN_MODE_DESC
 Visible description for the hub/uplink enable field.
 
static constexpr const char * CONN_MODE_MAP
 <map> of possible keys and descriptive values to show to the user for the connection_mode fields.
 
static constexpr const char * HUB_LISTENER_PORT_NAME = "Hub Listener Port"
 Visible name for the hub_listener_port field.
 
static constexpr const char * HUB_LISTENER_PORT_DESC
 Visible name for the hub_listener_port field.
 
static constexpr const char * UPLINK_NAME = "Node Uplink Configuration"
 Visible name for the link_config group.
 
static constexpr const char * UPLINK_DESC
 Visible name for the link_config group.
 

Detailed Description

Names and Descriptions for all ESP32 exposed WiFi configuration options.

Definition at line 45 of file Esp32WiFiConfiguration.hxx.

Member Data Documentation

◆ BOOLEAN_MAP

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::BOOLEAN_MAP
staticconstexpr
Initial value:
=
"<relation><property>0</property><value>No</value></relation>"
"<relation><property>1</property><value>Yes</value></relation>"

<map> of possible keys and descriptive values to show to the user for the wifi_sleep and hub_mode fields.

Definition at line 50 of file Esp32WiFiConfiguration.hxx.

◆ CONN_MODE_DESC

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::CONN_MODE_DESC
staticconstexpr
Initial value:
=
"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."

Visible description for the hub/uplink enable field.

Definition at line 76 of file Esp32WiFiConfiguration.hxx.

◆ CONN_MODE_MAP

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::CONN_MODE_MAP
staticconstexpr
Initial value:
=
"<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>"

<map> of possible keys and descriptive values to show to the user for the connection_mode fields.

Definition at line 86 of file Esp32WiFiConfiguration.hxx.

◆ CONN_MODE_NAME

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::CONN_MODE_NAME = "Connection Mode"
staticconstexpr

Visible name for the hub/uplink enable field.

Definition at line 73 of file Esp32WiFiConfiguration.hxx.

◆ HUB_DESC

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::HUB_DESC
staticconstexpr
Initial value:
=
"Configuration settings for an OpenLCB Hub"

Visible description for the Hub Configuration group.

Definition at line 69 of file Esp32WiFiConfiguration.hxx.

◆ HUB_LISTENER_PORT_DESC

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::HUB_LISTENER_PORT_DESC
staticconstexpr
Initial value:
=
"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."

Visible name for the hub_listener_port field.

Definition at line 96 of file Esp32WiFiConfiguration.hxx.

◆ HUB_LISTENER_PORT_NAME

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::HUB_LISTENER_PORT_NAME = "Hub Listener Port"
staticconstexpr

Visible name for the hub_listener_port field.

Definition at line 93 of file Esp32WiFiConfiguration.hxx.

◆ HUB_NAME

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::HUB_NAME = "Hub Configuration"
staticconstexpr

Visible name for the Hub Configuration group.

Definition at line 66 of file Esp32WiFiConfiguration.hxx.

◆ UPLINK_DESC

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::UPLINK_DESC
staticconstexpr
Initial value:
=
"Configures how this node will connect to other nodes."

Visible name for the link_config group.

Definition at line 104 of file Esp32WiFiConfiguration.hxx.

◆ UPLINK_NAME

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::UPLINK_NAME = "Node Uplink Configuration"
staticconstexpr

Visible name for the link_config group.

Definition at line 101 of file Esp32WiFiConfiguration.hxx.

◆ WIFI_POWER_SAVE_DESC

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_DESC
staticconstexpr
Initial value:
=
"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."

Visible description for the WiFi Power Savings mode.

Definition at line 59 of file Esp32WiFiConfiguration.hxx.

◆ WIFI_POWER_SAVE_NAME

constexpr const char* openmrn_arduino::Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_NAME
staticconstexpr
Initial value:
=
"WiFi Power Savings Mode"

Visible name for the WiFi Power Savings mode.

Definition at line 55 of file Esp32WiFiConfiguration.hxx.

The documentation for this class was generated from the following file: