Esp32WiFiConfiguration.hxx File Reference

#include "openlcb/ConfigRepresentation.hxx"
#include "openlcb/ConfiguredTcpConnection.hxx"

Go to the source code of this file.

Classes
class	openmrn_arduino::Esp32WiFiConfigurationParams
	Names and Descriptions for all ESP32 exposed WiFi configuration options. More...

Functions
	openmrn_arduino::CDI_GROUP (HubConfiguration)
	CDI Configuration for an Esp32WiFiManager managed hub.
	openmrn_arduino::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
	Specifies the port which should be used by the hub.
	openmrn_arduino::Name (openlcb::TcpClientDefaultParams::SERVICE_NAME)
	openmrn_arduino::Description (openlcb::TcpClientDefaultParams::SERVICE_DESCR))
	openmrn_arduino::CDI_GROUP_ENTRY (reserved, openlcb::BytesConfigEntry< 6 >, Hidden(true))
	Reserved space for future expansion.
	openmrn_arduino::CDI_GROUP_END ()
	openmrn_arduino::CDI_GROUP (WiFiConfiguration)
	CDI Configuration for an Esp32WiFiManager managed node.
	openmrn_arduino::CDI_GROUP_ENTRY (sleep, openlcb::Uint8ConfigEntry, Name(Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_NAME), Description(Esp32WiFiConfigurationParams::WIFI_POWER_SAVE_DESC), Min(0), Max(1), Default(0), MapValues(Esp32WiFiConfigurationParams::BOOLEAN_MAP))
	Allows the WiFi system to use power-saving techniques to conserve power when the node is powered via battery, this often can be left disabled.
	openmrn_arduino::CDI_GROUP_ENTRY (connection_mode, openlcb::Uint8ConfigEntry, Name(Esp32WiFiConfigurationParams::CONN_MODE_NAME), Description(Esp32WiFiConfigurationParams::CONN_MODE_DESC), Min(0), Max(3), Default(1), MapValues(Esp32WiFiConfigurationParams::CONN_MODE_MAP))
	Configures the connection mode as uplink, hub or both.
	openmrn_arduino::CDI_GROUP_ENTRY (hub, HubConfiguration, Name(Esp32WiFiConfigurationParams::HUB_NAME), Description(Esp32WiFiConfigurationParams::HUB_DESC))
	Configuration for the Esp32WiFiManager managed hub.
	openmrn_arduino::CDI_GROUP_ENTRY (uplink, openlcb::TcpClientConfig< openlcb::TcpClientDefaultParams >, Name(Esp32WiFiConfigurationParams::UPLINK_NAME), Description(Esp32WiFiConfigurationParams::UPLINK_DESC))
	Configuration for this node's uplink connection.

Detailed Description

Copyright

Copyright (c) 2019, Mike Dunston All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ESP32 WiFiConfiguration CDI declarations

Author

Mike Dunston

Date

11 February 2019

Definition in file Esp32WiFiConfiguration.hxx.

Function Documentation

CDI_GROUP_ENTRY()

openmrn_arduino::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)
	)

Specifies the port which should be used by the hub.

Specifies the mDNS service name to advertise for the hub.