A class for quickly configuring a SensESP application object before wiring up your sensors. More...

#include <sensesp_app_builder.h>

Inheritance diagram for sensesp::SensESPAppBuilder:

Public Member Functions
	SensESPAppBuilder ()
	Construct a new SensESPApp Builder object.

SensESPAppBuilder *	set_wifi_client (String ssid, String password)
	Set the Wi-Fi network SSID and password.

SensESPAppBuilder *	set_wifi (String ssid, String password)

SensESPAppBuilder *	set_wifi_clients (const std::vector< ClientSSIDConfig > &wifi_client_configs)
	Set multiple Wi-Fi client (STA) networks for failover.

SensESPAppBuilder *	set_wifi_access_point (const String &ssid, const String &password)
	Set the wifi access point object SSID and password.

SensESPAppBuilder *	disable_wifi ()
	Clear the default WiFi STA/AP settings.

template<typename ProvisionerConfigT >
SensESPAppBuilder *	set_ethernet (ProvisionerConfigT config)
	Configure the app to use a non-WiFi NetworkProvisioner.

SensESPAppBuilder *	set_sk_server (String address, uint16_t port)
	Set the Signal K server address and port.

SensESPAppBuilder *	set_hostname (String hostname) override final
	Set the device hostname.

SensESPAppBuilder *	set_admin_user (const char username, const char password)
	Set admin username and password for the web interface.

SensESPAppBuilder *	set_system_status_led (std::shared_ptr< SystemStatusLed > system_status_led)
	Set the system status led object.

SensESPAppBuilder *	enable_system_hz_sensor (String prefix=kDefaultSystemInfoSensorPrefix)
	Enable the System Hz sensor.

SensESPAppBuilder *	enable_free_mem_sensor (String prefix=kDefaultSystemInfoSensorPrefix)
	Enable the free memory sensor.

SensESPAppBuilder *	enable_uptime_sensor (String prefix=kDefaultSystemInfoSensorPrefix)
	Report the system uptime in seconds since the last reboot.

SensESPAppBuilder *	enable_ip_address_sensor (String prefix=kDefaultSystemInfoSensorPrefix)
	Report the IP address of the device.

SensESPAppBuilder *	enable_wifi_signal_sensor (String prefix=kDefaultSystemInfoSensorPrefix)
	Report the Wi-Fi signal strength.

SensESPAppBuilder *	set_button_pin (int pin)
	Set the button GPIO pin.

SensESPAppBuilder *	enable_system_info_sensors (String prefix=kDefaultSystemInfoSensorPrefix)
	Enable all built-in system info sensors.

SensESPAppBuilder *	enable_ota (const char *password)
	Enable over-the-air updates for the device.

SensESPAppBuilder *	set_wifi_manager_password (const char *password)
	Set the wifi manager password.

SensESPAppBuilder *	enable_wifi_watchdog (int timeout_s=180)
	Restart the device after a prolonged network outage.

std::shared_ptr< SensESPApp >	get_app ()
	Get the SensESPApp object.

Protected Attributes
std::shared_ptr< SensESPApp >	app_

Protected Attributes inherited from sensesp::SensESPBaseAppBuilder
String	hostname_ = "SensESP"

Detailed Description

A class for quickly configuring a SensESP application object before wiring up your sensors.

Definition at line 22 of file sensesp_app_builder.h.

Constructor & Destructor Documentation

◆ SensESPAppBuilder()

sensesp::SensESPAppBuilder::SensESPAppBuilder ( )

inline

Construct a new SensESPApp Builder object.

SensESPAppBuilder is used to instantiate a SensESPApp object with non-trivial configuration.

Definition at line 40 of file sensesp_app_builder.h.

Member Function Documentation

◆ disable_wifi()

SensESPAppBuilder * sensesp::SensESPAppBuilder::disable_wifi ( )

inline

Clear the default WiFi STA/AP settings.

Intended for use by non-WiFi provisioners (Ethernet, future PPP/cellular, …) that supply a factory via SensESPApp::set_network_provisioner_factory(). Without this call, the default WiFi-construction path in SensESPApp::setup() would still produce a WiFiProvisioner alongside the non-WiFi one.

set_ethernet() calls this implicitly, so most users do not have to invoke disable_wifi() directly.

Definition at line 116 of file sensesp_app_builder.h.

Here is the caller graph for this function:

◆ enable_free_mem_sensor()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_free_mem_sensor ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Enable the free memory sensor.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 235 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_ip_address_sensor()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_ip_address_sensor ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Report the IP address of the device.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 267 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_ota()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_ota ( const char * password )

inline

Enable over-the-air updates for the device.

Parameters

password OTA authentication password.

Returns: SensESPAppBuilder*

Definition at line 326 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_system_hz_sensor()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_system_hz_sensor ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Enable the System Hz sensor.

The System Hz sensor is a built-in sensor that measures how many times the system loop is executed per second.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 219 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_system_info_sensors()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_system_info_sensors ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Enable all built-in system info sensors.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 310 of file sensesp_app_builder.h.

Here is the call graph for this function:

◆ enable_uptime_sensor()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_uptime_sensor ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Report the system uptime in seconds since the last reboot.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 251 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_wifi_signal_sensor()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_wifi_signal_sensor ( String prefix = kDefaultSystemInfoSensorPrefix )

inline

Report the Wi-Fi signal strength.

Parameters

prefix

Returns: SensESPAppBuilder*

Definition at line 283 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable_wifi_watchdog()

SensESPAppBuilder * sensesp::SensESPAppBuilder::enable_wifi_watchdog ( int timeout_s = 180 )

inline

Restart the device after a prolonged network outage.

The watchdog arms on the first station or Ethernet connection after boot, so a device that starts without a reachable access point keeps running. The soft-AP and the captive portal neither arm it nor count as an outage. Once armed, a continuous outage of at least timeout_s restarts the device. The timeout is exposed on the web UI Configuration page as the "WiFi Watchdog" card; a value saved there takes precedence over timeout_s on later boots. Call this before get_app().

Pick a timeout that outlasts an access point reboot; a too-short value costs an unnecessary restart during every AP outage.

Parameters

timeout_s Initial outage duration in seconds before restarting, between 1 and WiFiWatchdog::kMaxTimeoutS.

Definition at line 364 of file sensesp_app_builder.h.

Here is the call graph for this function:

◆ get_app()

std::shared_ptr< SensESPApp > sensesp::SensESPAppBuilder::get_app ( )

inline

Get the SensESPApp object.

Return a SensESPApp object that has been setup.

Returns: SensESPApp*

Definition at line 389 of file sensesp_app_builder.h.

Here is the call graph for this function:

◆ set_admin_user()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_admin_user	(	const char *	username,
		const char *	password
	)

inline

Set admin username and password for the web interface.

Definition at line 191 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_button_pin()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_button_pin ( int pin )

inline

Set the button GPIO pin.

Returns: SensESPAppBuilder*

Definition at line 299 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_ethernet()

template<typename ProvisionerConfigT >

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_ethernet ( ProvisionerConfigT config )

inline

Configure the app to use a non-WiFi NetworkProvisioner.

Today only Ethernet on ESP32-P4 is supported. Use as:

#include "sensesp/net/ethernet_provisioner.h"
...
builder.set_ethernet(EthernetConfig::waveshare_esp32p4_poe())
       ->get_app();

Template Parameters

ProvisionerConfigT a configuration struct that exposes a nested using ProvisionerType = …; typedef pointing at the concrete NetworkProvisioner implementation. EthernetConfig from sensesp/net/ethernet_provisioner.h is the only such type today. Templated so this header does not need to pull in any provisioner implementation files — users who call set_ethernet() must include the relevant provisioner header in their own translation unit.

Calling set_ethernet() on a target whose provisioner header is empty (e.g. classic ESP32, where EthernetConfig is not declared) produces a clean compile error at the use site rather than a silent runtime failure. Implicitly calls disable_wifi() so the WiFi-specific HTTP handlers and soft-AP fall-back are not registered.

Definition at line 151 of file sensesp_app_builder.h.

Here is the call graph for this function:

◆ set_hostname()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_hostname ( String hostname )

inlinefinaloverridevirtual

Set the device hostname.

If not set, the device hostname is set to "SensESP".

Parameters

hostname

Returns: SensESPAppBuilder*

Implements sensesp::SensESPBaseAppBuilder.

Definition at line 183 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_sk_server()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_sk_server	(	String	address,
		uint16_t	port
	)

inline

Set the Signal K server address and port.

If not set, mDNS is used to discover the Signal K server.

Parameters

address
port

Returns: SensESPAppBuilder*

Definition at line 170 of file sensesp_app_builder.h.

◆ set_system_status_led()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_system_status_led ( std::shared_ptr< SystemStatusLed > system_status_led )

inline

Set the system status led object.

This allows custom status LED patterns to be used.

Parameters

system_status_led

Returns: SensESPAppBuilder*

Definition at line 205 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_wifi()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_wifi	(	String	ssid,
		String	password
	)

inline

Definition at line 61 of file sensesp_app_builder.h.

Here is the call graph for this function:

◆ set_wifi_access_point()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_wifi_access_point	(	const String &	ssid,
		const String &	password
	)

inline

Set the wifi access point object SSID and password.

To disable the SSID, set both to empty strings.

Parameters

ssid
password

Returns: SensESPAppBuilder*

Definition at line 97 of file sensesp_app_builder.h.

◆ set_wifi_client()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_wifi_client	(	String	ssid,
		String	password
	)

inline

Set the Wi-Fi network SSID and password.

If not set, WiFiManager is used to create an access point for configuring the settings.

Parameters

ssid
password

Returns: SensESPAppBuilder*

Definition at line 54 of file sensesp_app_builder.h.

Here is the caller graph for this function:

◆ set_wifi_clients()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_wifi_clients ( const std::vector< ClientSSIDConfig > & wifi_client_configs )

inline

Set multiple Wi-Fi client (STA) networks for failover.

The device tries the networks in order, failing over to the next when one is unreachable (up to WiFiProvisioner::kMaxNumClientConfigs entries; extras are dropped, and entries with an empty SSID or password are ignored). This is the in-code equivalent of the multi-network list the web UI manages.

Like set_wifi_client(), these values only seed a device with no saved WiFi configuration; a configuration saved via the web UI always wins. Use this instead of set_wifi_client() when you need more than one network defined in code.

Parameters

wifi_client_configs ordered list of client networks

Returns: SensESPAppBuilder*

Definition at line 82 of file sensesp_app_builder.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_wifi_manager_password()

SensESPAppBuilder * sensesp::SensESPAppBuilder::set_wifi_manager_password ( const char * password )

inline

Set the wifi manager password.

Set the password for the WiFi configuration access point that is enabled after device reset if no wifi configuration is provided in the application code.

Parameters

password

Returns: SensESPAppBuilder*

Definition at line 342 of file sensesp_app_builder.h.

Member Data Documentation

◆ app_

std::shared_ptr<SensESPApp> sensesp::SensESPAppBuilder::app_

protected

Definition at line 31 of file sensesp_app_builder.h.

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

src/sensesp_app_builder.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SensESPAppBuilder()

Member Function Documentation

◆ disable_wifi()

◆ enable_free_mem_sensor()

◆ enable_ip_address_sensor()

◆ enable_ota()

◆ enable_system_hz_sensor()

◆ enable_system_info_sensors()

◆ enable_uptime_sensor()

◆ enable_wifi_signal_sensor()

◆ enable_wifi_watchdog()

◆ get_app()

◆ set_admin_user()

◆ set_button_pin()

◆ set_ethernet()

◆ set_hostname()

◆ set_sk_server()

◆ set_system_status_led()

◆ set_wifi()

◆ set_wifi_access_point()

◆ set_wifi_client()

◆ set_wifi_clients()

◆ set_wifi_manager_password()

Member Data Documentation

◆ app_