Persistent user-defined ethernet settings which is mostly relevant only during startup as the information is subsequently hold by the QNEthernet library objects. More...

#include <ethernet.h>

Inheritance diagram for net::StartupConfig:

[legend]

Collaboration diagram for net::StartupConfig:

[legend]

Public Member Functions
void	reset_defaults ()

std::string	name () const

	StartupConfig ()
	Initializes with default values which are always valid and serve as a fallback if invalid options are given.

int	begin_ip ()
	Calls net::Ethernet.begin, sets IP address.

void	begin_mdns ()
	Calls net::MDNS.begin.

void	fromJson (JsonObjectConst src, nvmconfig::Context c=nvmconfig::Context::Flash) override

void	toJson (JsonObject target, nvmconfig::Context c=nvmconfig::Context::Flash) const override

Public Member Functions inherited from nvmconfig::PersistentSettings
virtual void	clear ()
	Clear local memory in order to save RAM if an object is not needed during runtime but only at startup.

Public Attributes
bool	enable_ethernet
	Turn on/off networking completely.

bool	enable_dhcp
	DHCP client vs static IP configuration.

bool	enable_jsonl
	Enable the JSONL TCP/IP server.

bool	enable_webserver
	Enable embedded webserver for REST access.

bool	enable_websockets
	Enable websocket server ontop of webserver.

bool	enable_mdns
	Enable mDNS/zeroconf multicast service discovery.

int	jsonl_port
	TCP port for jsonl server.

int	webserver_port
	TCP port for webserver.

MacAddress	mac
	Custom MAC address. Defaults to original permanent system Mac.

std::string	hostname
	used only for DHCP client. Maximum 250 characters.

IPAddress	static_ipaddr
	own ip address, used only when use_dhcp=false

IPAddress	static_netmask
	netmask; used only when use_dhcp=false

IPAddress	static_gw
	gateway address; used only when use_dhcp=false

IPAddress	static_dns
	DNS server address; used only when use_dhcp=false.

uint32_t	connection_timeout_ms
	(Runtime-changable) Time after idling connections time out.

uint8_t	max_connections
	(Runtime-changable) Maximum number of parallel connections accepted

Additional Inherited Members
Static Public Member Functions inherited from utils::HeapSingleton< StartupConfig >
static StartupConfig &	get ()

Detailed Description

Persistent user-defined ethernet settings which is mostly relevant only during startup as the information is subsequently hold by the QNEthernet library objects.

Definition at line 40 of file ethernet.h.

Constructor & Destructor Documentation

◆ StartupConfig()

net::StartupConfig::StartupConfig ( )

inline

Initializes with default values which are always valid and serve as a fallback if invalid options are given.

Default values are defined at build time in the code.

Definition at line 48 of file ethernet.h.

References reset_defaults().

Member Function Documentation

◆ begin_ip()

FLASHMEM int net::StartupConfig::begin_ip ( )

Calls net::Ethernet.begin, sets IP address.

Definition at line 100 of file ethernet.cpp.

References LOG, LOG2, LOG4, LOG_ALWAYS, LOG_ERROR, utils::toString(), and utils::valid().

◆ begin_mdns()

FLASHMEM void net::StartupConfig::begin_mdns ( )

Calls net::MDNS.begin.

Definition at line 156 of file ethernet.cpp.

◆ fromJson()

FLASHMEM void net::StartupConfig::fromJson	(	JsonObjectConst	src,
		nvmconfig::Context	c = nvmconfig::Context::Flash )

overridevirtual

Implements nvmconfig::PersistentSettings.

Definition at line 61 of file ethernet.cpp.

References JSON_GET, JSON_GET_AS, and src.

◆ name()

std::string net::StartupConfig::name ( ) const

inlinevirtual

Implements nvmconfig::PersistentSettings.

Definition at line 44 of file ethernet.h.

◆ reset_defaults()

FLASHMEM void net::StartupConfig::reset_defaults ( )

virtual

< In Firmware version 1.0, this feature is by default deactivated

@TODO test timeout.

Implements nvmconfig::PersistentSettings.

Definition at line 19 of file ethernet.cpp.

References connection_timeout_ms, enable_dhcp, enable_ethernet, enable_jsonl, enable_mdns, enable_webserver, enable_websockets, hostname, jsonl_port, LOG_ALWAYS, mac, max_connections, utils::MacAddress::reset(), static_dns, static_gw, static_ipaddr, static_netmask, and webserver_port.

Referenced by StartupConfig().

◆ toJson()

FLASHMEM void net::StartupConfig::toJson	(	JsonObject	target,
		nvmconfig::Context	c = nvmconfig::Context::Flash ) const

overridevirtual

Implements nvmconfig::PersistentSettings.

Definition at line 83 of file ethernet.cpp.

References JSON_SET.

Member Data Documentation

◆ connection_timeout_ms

uint32_t net::StartupConfig::connection_timeout_ms

(Runtime-changable) Time after idling connections time out.

Definition at line 70 of file ethernet.h.

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StartupConfig()

Member Function Documentation

◆ begin_ip()

◆ begin_mdns()

◆ fromJson()

◆ name()

◆ reset_defaults()

◆ toJson()

Member Data Documentation

◆ connection_timeout_ms

◆ enable_dhcp

◆ enable_ethernet

◆ enable_jsonl

◆ enable_mdns

◆ enable_webserver

◆ enable_websockets

◆ hostname

◆ jsonl_port

◆ mac

◆ max_connections

◆ static_dns

◆ static_gw

◆ static_ipaddr

◆ static_netmask

◆ webserver_port