|
SensESP 3.5.1-alpha
Universal Signal K sensor toolkit ESP32
|
#include <sensesp_app.h>
Public Member Functions | |
| SensESPApp (SensESPApp &other)=delete | |
| void | operator= (const SensESPApp &)=delete |
| virtual bool | destroy () override |
| Destroy the SensESPBaseApp instance. | |
| std::shared_ptr< SKDeltaQueue > | get_sk_delta () |
| std::shared_ptr< SystemStatusController > | get_system_status_controller () |
| std::shared_ptr< NetworkProvisioner > & | get_network_provisioner () |
| Active network provisioner (transport-agnostic). | |
| std::shared_ptr< WiFiProvisioner > & | get_wifi_provisioner () |
| Active WiFi provisioner, or nullptr if a non-WiFi transport is in use. | |
| std::shared_ptr< NetworkStateProducer > | get_network_state_producer () |
| Unified producer that emits NetworkState transitions for any active interface (WiFi STA, WiFi AP, Ethernet, …). | |
| std::shared_ptr< WiFiProvisioner > & | get_networking () |
| std::shared_ptr< SKWSClient > | get_ws_client () |
| void | set_network_provisioner_factory (std::function< std::shared_ptr< NetworkProvisioner >()> factory) |
| Install a custom factory that setup() will use to construct the NetworkProvisioner instead of the default WiFiProvisioner. | |
Public Member Functions inherited from sensesp::SensESPBaseApp | |
| virtual void | start () |
| Start the app (activate all the subcomponents) | |
| virtual void | reset () |
| Reset the device to factory defaults. | |
| std::shared_ptr< ObservableValue< String > > | get_hostname_observable () |
| Get the hostname observable object. | |
Static Public Member Functions | |
| static std::shared_ptr< SensESPApp > | get () |
| Get the singleton instance of the SensESPApp. | |
Static Public Member Functions inherited from sensesp::SensESPBaseApp | |
| static const std::shared_ptr< SensESPBaseApp > & | get () |
| Get the singleton instance of the SensESPBaseApp. | |
| static void | clear_registries () |
| Clear all static object registries. | |
| static String | get_hostname () |
| Get the current hostname. | |
| static std::shared_ptr< reactesp::EventLoop > | get_event_loop () |
| Get the event loop object from the singleton SensESPBaseApp instance. | |
Protected Member Functions | |
| SensESPApp () | |
| SensESPApp constructor. | |
| const SensESPApp * | set_hostname (String hostname) |
| const SensESPApp * | set_ssid (String ssid) |
| const SensESPApp * | set_wifi_password (String wifi_password) |
| const SensESPApp * | set_wifi_clients (const std::vector< ClientSSIDConfig > &wifi_client_configs) |
| const SensESPApp * | set_ap_ssid (const String &ssid) |
| const SensESPApp * | set_ap_password (const String &password) |
| const SensESPApp * | set_sk_server_address (String sk_server_address) |
| const SensESPApp * | set_sk_server_port (uint16_t sk_server_port) |
| const SensESPApp * | set_system_status_led (std::shared_ptr< SystemStatusLed > &system_status_led) |
| const SensESPApp * | set_admin_user (const char *username, const char *password) |
| const SensESPApp * | enable_ota (const char *password) |
| const SensESPApp * | set_button_pin (int pin) |
| void | setup () |
| Perform initialization of SensESPApp once builder configuration is done. | |
| void | connect_status_page_items () |
Protected Member Functions inherited from sensesp::SensESPBaseApp | |
| SensESPBaseApp () | |
| Construct a new SensESP Base App object. | |
| ~SensESPBaseApp () | |
| void | init_hostname (const String &default_hostname=kDefaultHostname) |
| void | set_instance (const std::shared_ptr< SensESPBaseApp > &instance) |
| const SensESPBaseApp * | set_hostname (String hostname) |
Friends | |
| class | WebServer |
| class | SensESPAppBuilder |
Additional Inherited Members | |
Static Protected Attributes inherited from sensesp::SensESPBaseApp | |
| static std::shared_ptr< SensESPBaseApp > | instance_ = nullptr |
The default SensESP application object with networking and Signal K communication.
Definition at line 41 of file sensesp_app.h.
|
delete |
Singletons should not be cloneable
|
inlineprotected |
SensESPApp constructor.
Note that the constructor is protected, so SensESPApp should only be instantiated using SensESPAppBuilder.
Definition at line 149 of file sensesp_app.h.
|
inlineprotected |
Definition at line 366 of file sensesp_app.h.
|
inlineoverridevirtual |
Destroy the SensESPBaseApp instance.
Reimplemented from sensesp::SensESPBaseApp.
Definition at line 63 of file sensesp_app.h.
|
inlineprotected |
Definition at line 196 of file sensesp_app.h.
|
inlinestatic |
Get the singleton instance of the SensESPApp.
Definition at line 56 of file sensesp_app.h.
|
inline |
Active network provisioner (transport-agnostic).
Always non-null after setup() has run. Holds whichever provisioner the builder selected (WiFi by default, Ethernet via set_ethernet(), future PPP/cellular via set_ppp(), …).
Definition at line 84 of file sensesp_app.h.
|
inline |
Unified producer that emits NetworkState transitions for any active interface (WiFi STA, WiFi AP, Ethernet, …).
Always non-null after setup() has run. The SystemStatusController subscribes to it during setup(); user code can attach additional consumers via connect_to().
Definition at line 108 of file sensesp_app.h.
|
inline |
Definition at line 116 of file sensesp_app.h.
|
inline |
Definition at line 72 of file sensesp_app.h.
|
inline |
Definition at line 73 of file sensesp_app.h.
|
inline |
Active WiFi provisioner, or nullptr if a non-WiFi transport is in use.
Use this when WiFi-specific functionality is needed (scanning, captive portal, soft-AP IP). For transport-agnostic queries (local_ip(), mac_address(), …) prefer get_network_provisioner().
Definition at line 96 of file sensesp_app.h.
|
inline |
Definition at line 120 of file sensesp_app.h.
|
delete |
Singletons should not be assignable
|
inlineprotected |
Definition at line 191 of file sensesp_app.h.
|
inlineprotected |
Definition at line 174 of file sensesp_app.h.
|
inlineprotected |
Definition at line 170 of file sensesp_app.h.
|
inlineprotected |
Definition at line 200 of file sensesp_app.h.
|
inlineprotected |
|
inline |
Install a custom factory that setup() will use to construct the NetworkProvisioner instead of the default WiFiProvisioner.
This is the extension point for non-WiFi transports (Ethernet, PPP/cellular, mock provisioners for tests, …). If never called, setup() falls back to constructing a WiFiProvisioner using the existing ssid_ / wifi_client_password_ / ap_ssid_ / ap_password_ setters — preserving the legacy default for existing WiFi users.
A follow-up PR referencing RFC #849 will ship an Ethernet provisioner plus a SensESPAppBuilder::set_ethernet() convenience method that wraps this setter.
Definition at line 136 of file sensesp_app.h.
|
inlineprotected |
Definition at line 178 of file sensesp_app.h.
|
inlineprotected |
Definition at line 182 of file sensesp_app.h.
|
inlineprotected |
Definition at line 157 of file sensesp_app.h.
|
inlineprotected |
Definition at line 186 of file sensesp_app.h.
|
inlineprotected |
Definition at line 165 of file sensesp_app.h.
|
inlineprotected |
Definition at line 161 of file sensesp_app.h.
|
inlineprotectedvirtual |
Perform initialization of SensESPApp once builder configuration is done.
This should be only called from the builder!
Reimplemented from sensesp::SensESPBaseApp.
Definition at line 212 of file sensesp_app.h.
|
friend |
Definition at line 565 of file sensesp_app.h.
|
friend |
Definition at line 564 of file sensesp_app.h.
|
protected |
Definition at line 471 of file sensesp_app.h.
|
protected |
Definition at line 470 of file sensesp_app.h.
|
protected |
Definition at line 554 of file sensesp_app.h.
|
protected |
Definition at line 484 of file sensesp_app.h.
|
protected |
Definition at line 485 of file sensesp_app.h.
|
protected |
Definition at line 523 of file sensesp_app.h.
|
protected |
Definition at line 521 of file sensesp_app.h.
|
protected |
Definition at line 537 of file sensesp_app.h.
|
protected |
Definition at line 532 of file sensesp_app.h.
|
protected |
Definition at line 526 of file sensesp_app.h.
|
protected |
Definition at line 528 of file sensesp_app.h.
|
protected |
Definition at line 530 of file sensesp_app.h.
|
protected |
Definition at line 545 of file sensesp_app.h.
|
protected |
Definition at line 559 of file sensesp_app.h.
|
protected |
Definition at line 496 of file sensesp_app.h.
|
protected |
Definition at line 507 of file sensesp_app.h.
|
protected |
Definition at line 477 of file sensesp_app.h.
|
protected |
Definition at line 561 of file sensesp_app.h.
|
protected |
Definition at line 479 of file sensesp_app.h.
|
protected |
Definition at line 508 of file sensesp_app.h.
|
protected |
Definition at line 476 of file sensesp_app.h.
|
protected |
Definition at line 502 of file sensesp_app.h.
|
protected |
Definition at line 500 of file sensesp_app.h.
|
protected |
Definition at line 488 of file sensesp_app.h.
|
protected |
Definition at line 487 of file sensesp_app.h.
|
protected |
Definition at line 492 of file sensesp_app.h.
|
protected |
Definition at line 472 of file sensesp_app.h.
|
protected |
Definition at line 474 of file sensesp_app.h.
|
protected |
Definition at line 473 of file sensesp_app.h.
|
protected |
Definition at line 490 of file sensesp_app.h.
|
protected |
Definition at line 504 of file sensesp_app.h.
|
protected |
Definition at line 552 of file sensesp_app.h.
|
protected |
Definition at line 493 of file sensesp_app.h.
|
protected |
Definition at line 468 of file sensesp_app.h.
|
protected |
Definition at line 515 of file sensesp_app.h.
|
protected |
Definition at line 519 of file sensesp_app.h.
|
protected |
Definition at line 469 of file sensesp_app.h.
|
protected |
Definition at line 517 of file sensesp_app.h.
|
protected |
Definition at line 462 of file sensesp_app.h.
|
protected |
Definition at line 558 of file sensesp_app.h.
|
protected |
Definition at line 482 of file sensesp_app.h.
|
protected |
Definition at line 481 of file sensesp_app.h.
|
protected |
Definition at line 543 of file sensesp_app.h.
|
protected |
Definition at line 539 of file sensesp_app.h.
|
protected |
Definition at line 547 of file sensesp_app.h.
|
protected |
Definition at line 535 of file sensesp_app.h.
|
protected |
Definition at line 541 of file sensesp_app.h.
|
protected |
Definition at line 549 of file sensesp_app.h.
|
protected |
Definition at line 560 of file sensesp_app.h.
|
protected |
Definition at line 498 of file sensesp_app.h.
|
protected |
Definition at line 467 of file sensesp_app.h.
|
protected |
Definition at line 463 of file sensesp_app.h.
|
protected |
Definition at line 489 of file sensesp_app.h.
|
protected |
Definition at line 512 of file sensesp_app.h.
|
protected |
Definition at line 562 of file sensesp_app.h.
|
protected |
Definition at line 510 of file sensesp_app.h.
|
protected |
Definition at line 494 of file sensesp_app.h.