From 347d9094a230696ab7e66bb3a12480d7d26cf566 Mon Sep 17 00:00:00 2001 From: cziter15 Date: Mon, 1 Apr 2024 20:10:14 +0000 Subject: [PATCH] deploy: 23bb494c5669ae98e4892f2dde476a9c99893d51 --- annotated.html | 22 +- classksf_1_1comps_1_1ks_config_provider.html | 40 +-- ..._1_1ks_dev_stat_mqtt_reporter-members.html | 2 +- ...1_1comps_1_1ks_dev_stat_mqtt_reporter.html | 69 ++++-- ..._1_1comps_1_1ks_device_portal-members.html | 2 +- classksf_1_1comps_1_1ks_device_portal.html | 228 ++++++++++++------ classksf_1_1comps_1_1ks_led.html | 26 +- ...f_1_1comps_1_1ks_mqtt_config_provider.html | 34 +-- ...1_1comps_1_1ks_mqtt_connector-members.html | 4 +- classksf_1_1comps_1_1ks_mqtt_connector.html | 48 ++-- classksf_1_1comps_1_1ks_reset_button.html | 28 +-- ...comps_1_1ks_wifi_configurator-members.html | 30 +-- ...sksf_1_1comps_1_1ks_wifi_configurator.html | 89 ++++--- classksf_1_1comps_1_1ks_wifi_connector.html | 66 +++-- classksf_1_1ks_app_rotator.html | 20 +- classksf_1_1ks_application.html | 67 +++-- classksf_1_1ks_cert_fingerprint.html | 10 +- classksf_1_1ks_component.html | 58 +++-- classksf_1_1ks_config.html | 67 ++--- classksf_1_1ks_rtti.html | 51 ++-- classksf_1_1ks_simple_timer.html | 24 +- classksf_1_1misc_1_1ks_w_s_server.html | 33 +-- doxygen_crawl.html | 9 + functions.html | 2 +- functions_func.html | 7 +- functions_i.html | 2 +- functions_k.html | 1 + functions_o.html | 3 +- functions_p.html | 2 +- functions_vars.html | 3 +- hierarchy.html | 22 +- ks_app_rotator_8h_source.html | 96 ++++---- ks_application_8h_source.html | 143 +++++------ ks_cert_utils_8h_source.html | 78 +++--- ks_component_8h_source.html | 44 ++-- ks_config_8h_source.html | 56 ++--- ks_config_provider_8h_source.html | 91 +++---- ks_constants_8h_source.html | 120 ++++----- ks_dev_stat_mqtt_reporter_8h_source.html | 23 +- ks_device_portal_8h_source.html | 199 +++++++-------- ks_led_8h_source.html | 4 +- ks_mqtt_config_provider_8h_source.html | 2 +- ks_mqtt_connector_8h_source.html | 178 +++++++------- ks_reset_button_8h_source.html | 4 +- ks_rtti_8h_source.html | 114 ++++----- ks_simple_timer_8h_source.html | 48 ++-- ks_w_s_server_8h_source.html | 42 ++-- ks_wifi_configurator_8h_source.html | 68 +++--- ks_wifi_connector_8h_source.html | 96 ++++---- menudata.js | 6 + namespaceksf_1_1_e_o_t_a_type.html | 129 ++++++++++ ...eksf_1_1comps_1_1_e_config_param_type.html | 104 ++++++++ namespacemembers.html | 86 +++++++ namespacemembers_enum.html | 83 +++++++ namespacemembers_eval.html | 85 +++++++ namespaces.html | 85 +++++++ search/all_0.js | 2 +- search/all_10.js | 22 +- search/all_11.js | 10 +- search/all_12.js | 7 +- search/all_13.js | 15 +- search/all_14.js | 23 +- search/all_15.js | 12 + search/all_8.js | 2 +- search/all_9.js | 24 +- search/all_c.js | 16 +- search/all_d.js | 25 +- search/all_e.js | 22 +- search/all_f.js | 32 +-- search/enums_0.js | 4 + search/enumvalues_0.js | 4 + search/enumvalues_1.js | 5 + search/functions_6.js | 2 +- search/functions_7.js | 17 +- search/functions_a.js | 2 +- search/functions_b.js | 2 +- search/namespaces_0.js | 5 + search/searchdata.js | 29 ++- search/variables_0.js | 2 +- search/variables_9.js | 3 +- ...ctksf_1_1comps_1_1ks_config_parameter.html | 2 +- 81 files changed, 2098 insertions(+), 1244 deletions(-) create mode 100644 namespaceksf_1_1_e_o_t_a_type.html create mode 100644 namespaceksf_1_1comps_1_1_e_config_param_type.html create mode 100644 namespacemembers.html create mode 100644 namespacemembers_enum.html create mode 100644 namespacemembers_eval.html create mode 100644 namespaces.html create mode 100644 search/all_15.js create mode 100644 search/enums_0.js create mode 100644 search/enumvalues_0.js create mode 100644 search/enumvalues_1.js create mode 100644 search/namespaces_0.js diff --git a/annotated.html b/annotated.html index c4b32f7..9a77df6 100644 --- a/annotated.html +++ b/annotated.html @@ -79,28 +79,28 @@  ▼Nksf  ▼Ncomps  CksConfigParameterA structure that defines configuration parameter - CksConfigProviderA component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage - CksDevicePortal + CksConfigProviderA component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage + CksDevicePortalA component thet implements web-based configuration portal accessible from local network  CksDevStatMqttReporterA component that periodocally reports device state to the broker  CksLedA component that simplifies driving the LED  CksMqttConfigProviderA component that manages MQTT-related configuration  CksMqttConnectorA component which is responsible for MQTT connection management  CksResetButtonA component that implements reset button functionality - CksWifiConfigurator - CksWifiConnector + CksWifiConfiguratorKsWifiConfigurator component class + CksWifiConnectorA component that manages WiFi connection  ▼Nevt  CksEvent  CksEventHandle  CksEventInterface  ▼Nmisc  CksWSServer - CksApplication - CksAppRotator - CksCertFingerprint - CksComponent - CksConfig - CksRtti - CksSimpleTimer + CksApplicationA class that is a base for user-defined application + CksAppRotatorApplication rotator component + CksCertFingerprintInterface for certificate fingerprint verification + CksComponentBase component class + CksConfigImplements low-level configuration file handling + CksRttiImplements RTTI (run-time type information) for objects + CksSimpleTimerSimple timer class, without using component architecture  ▼Nlogger  CColors diff --git a/classksf_1_1comps_1_1ks_config_provider.html b/classksf_1_1comps_1_1ks_config_provider.html index b0e163b..ba2f654 100644 --- a/classksf_1_1comps_1_1ks_config_provider.html +++ b/classksf_1_1comps_1_1ks_config_provider.html @@ -85,7 +85,7 @@
-

A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage. +

A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage. More...

#include <ksConfigProvider.h>

@@ -97,8 +97,8 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti ksf::comps::ksMqttConfigProvider
@@ -106,10 +106,10 @@

Public Member Functions

virtual const size_t getInstanceType () const - This function is used to get type ID of object.
+ Retrieves type ID of the object.
  virtual bool isA (const size_t id) const - This function is used to check if object is of given type.
+ Checks whether object is of given type.
  std::list< ksConfigParameter > & getParameters () @@ -126,19 +126,19 @@  Initializes component.
  virtual bool loop (ksApplication *app) - Called from application loop.
+ Handles component loop logic, called from application loop.
  virtual bool postInit (ksApplication *app) - Method called after component initialization.
+ Method called after component initialization, used to setup references to other components.
  - Public Member Functions inherited from ksf::ksRtti template<typename TType > TType * as () - This function is used to cast object to given type.
+ Tries to cast object to the type provided as a template parameter.
  template<typename TType > const TType * as () const - This function is used to const cast object to given type.
+ Tries to cast object to the type provided as a template parameter (const version).
 

@@ -153,10 +153,10 @@

- + - +

Protected Member Functions

void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
 Defines new configutation parameter.
 
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
 Defines new configuation parameter (with default value).
 
@@ -170,8 +170,8 @@
 

Detailed Description

-

A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage.

-

In the configurator application, it should be instantiated like a typical component, and ksWifiConfigurator must be added to the component stack. In this case, it will manage the correct flow of data reading and saving.

+

A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage.

+

In the configurator application, it should be instantiated like a typical component, and ksWifiConfigurator must be added to the component stack. In this case, it will manage the correct flow of data reading and saving.

In contrast, in a normal application, it can be created for a short period of time, usually inside the application's init method, to read the data and return the required value. Refer to the EnergySensor init method for an example. Note that the component will be destroyed upon reaching the function return. Also, note that the setupRotations method can return false in case of a problem with the value retrieval (for example, no config present yet), thus causing the application to break and triggering the app rotator to move to the next defined application, usually AP-based configurator.

Member Function Documentation

@@ -201,7 +201,7 @@

- EConfigParamType::Type type = {} ) + EConfigParamType::Type type = {} ) @@ -253,7 +253,7 @@

- EConfigParamType::Type type = {} ) + EConfigParamType::Type type = {} ) @@ -266,7 +266,7 @@

Parameters
- + @@ -305,8 +305,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -337,10 +337,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters

configksConfig reference.
configksConfig reference.
idUnique identificator that will be also used as property label by Device Portal.
valueDefault parameter value.
maxLengthMaximum length of the value.
- +
idType ID.
idType ID to check against.
diff --git a/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html b/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html index 0df64e5..f9aee79 100644 --- a/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html +++ b/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html @@ -89,7 +89,7 @@ getInstanceType() constksf::comps::ksDevStatMqttReporterinlinevirtual init(ksApplication *app)ksf::ksComponentvirtual isA(const size_t id) constksf::comps::ksDevStatMqttReporterinlinevirtual - ksDevStatMqttReporter(uint8_t intervalInSeconds=60) (defined in ksf::comps::ksDevStatMqttReporter)ksf::comps::ksDevStatMqttReporter + ksDevStatMqttReporter(uint8_t intervalInSeconds=60)ksf::comps::ksDevStatMqttReporter loop(ksApplication *app) overrideksf::comps::ksDevStatMqttReportervirtual mqttConnWpksf::comps::ksDevStatMqttReporterprotected onConnected()ksf::comps::ksDevStatMqttReporterprotected diff --git a/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html b/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html index 93e7ed3..1f1ccb1 100644 --- a/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html +++ b/classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html @@ -97,21 +97,21 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti

- + - + - + + @@ -126,11 +126,11 @@ - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
- ksDevStatMqttReporter (uint8_t intervalInSeconds=60)
 ksDevStatMqttReporter (uint8_t intervalInSeconds=60)
 Constructs device statistics reporter component.
 
bool postInit (ksApplication *app) override
 Handles component post-initialization.
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- +

@@ -150,7 +150,7 @@

 
void reportDevStats () const
 Reports device statistics to the broker.
 Reports device statistics to the MQTT broker.
 
- + diff --git a/classksf_1_1comps_1_1ks_device_portal.html b/classksf_1_1comps_1_1ks_device_portal.html index 18f0af0..50ae95b 100644 --- a/classksf_1_1comps_1_1ks_device_portal.html +++ b/classksf_1_1comps_1_1ks_device_portal.html @@ -85,6 +85,11 @@
ksf::comps::ksDevicePortal Class Reference
+ +

A component thet implements web-based configuration portal accessible from local network. + More...

+ +

#include <ksDevicePortal.h>

+ Inheritance diagram for ksf::comps::ksDevicePortal:
@@ -93,46 +98,46 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti

@@ -175,7 +175,33 @@

A component that periodocally reports device state to the broker.

Upon instantiated, the component will look for ksMqttConnector component. The interval between each update is defined by the construction parameter.

Each update contain values like RSSI, device uptime, connection time and IP address. The subtopic used is "dstat", so for example RSSI will be sent to the topic named "deviceprefix/dstat/rssi".

-

Member Function Documentation

+

Constructor & Destructor Documentation

+ +

◆ ksDevStatMqttReporter()

+ +
+
+ + + + + + + +
ksf::comps::ksDevStatMqttReporter::ksDevStatMqttReporter (uint8_t intervalInSeconds = 60)
+
+ +

Constructs device statistics reporter component.

+
Parameters
+ + +
intervalInSecondsInterval in seconds between each report.
+
+
+ +
+
+

Member Function Documentation

◆ getInstanceType()

@@ -199,8 +225,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -229,10 +255,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -268,7 +294,7 @@

Parameters
- +
appPointer to the parent, which is ksApplication.
appPointer to the parent ksApplication.
@@ -276,6 +302,8 @@

ksf::ksComponent.

+

References reportDevStats(), reporterTimer, and ksf::ksSimpleTimer::triggered().

+ @@ -302,8 +330,11 @@

Calback executed on MQTT connection.

-
This callback is used to restart reporter timer to match
-

the intervals between individual reports. The timer will be processed even if the MQTT is not connected, but reportDevStats will quickly return.

+

This callback is used to restart reporter timer to match the intervals between individual reports. The timer will be processed even if the MQTT is not connected, but reportDevStats will quickly return.

+ +

References reporterTimer, and ksf::ksSimpleTimer::restart().

+ +

Referenced by postInit().

@@ -334,7 +365,7 @@

Parameters
- +
appPointer to the parent, which is ksApplication object.
appPointer to the paren ksApplication.
@@ -342,7 +373,7 @@

ksf::ksComponent.

-

References ksf::ksApplication::findComponent(), ksf::comps::ksMqttConnector::onConnected, and ksf::evt::ksEvent< Params >::registerEvent().

+

References connEventHandle, ksf::ksApplication::findComponent(), mqttConnWp, onConnected(), ksf::comps::ksMqttConnector::onConnected, and ksf::evt::ksEvent< Params >::registerEvent().

diff --git a/classksf_1_1comps_1_1ks_device_portal-members.html b/classksf_1_1comps_1_1ks_device_portal-members.html index bb1beac..2d5530f 100644 --- a/classksf_1_1comps_1_1ks_device_portal-members.html +++ b/classksf_1_1comps_1_1ks_device_portal-members.html @@ -104,7 +104,7 @@

loop(ksApplication *app) overrideksf::comps::ksDevicePortalvirtual
loopExecutionTimeksf::comps::ksDevicePortalprotected
mqttConnectorWpksf::comps::ksDevicePortalprotected
onAppLog(std::string &msgRef)ksf::comps::ksDevicePortalprotected
onAppLog(std::string &&message)ksf::comps::ksDevicePortalprotected
onHandlePortalCommandksf::comps::ksDevicePortal
onRequest_index()ksf::comps::ksDevicePortalprotected
onRequest_notFound() constksf::comps::ksDevicePortalprotected
- + - + - + - + - + - + - + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksDevicePortal ()
 Constructor, used to construct Device Portal component.
 Constructs the Device Portal component.
 
 ksDevicePortal (std::string portalPassword)
 Constructor, used to construct Device Portal component.
 Constructs the Device Portal component with custom password.
 
bool init (ksApplication *app) override
 Initializes device portal component.
 Initializes the device portal component.
 
bool postInit (ksApplication *app) override
 Post initialization method for device portal with integrated OTA.
 Post-initializes the device portal component.
 
bool loop (ksApplication *app) override
 Handles device portal component loop logic.
 Handles core logic of the device portal component.
 
virtual ~ksDevicePortal ()
 Destructor used to cleanup resources.
 Destructs the Device Portal component.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- + - + - + - + - + - + - - + + - - + + - + - + - + - + - + - + - + - - - + + +

@@ -158,60 +163,58 @@ Protected Member Functions

void requestAppBreak ()
 Causes the app to break from loop with false status.
 Causes the application exit (and ksAppRotator to spawn and process next defined application).
 
void setupHttpServer ()
 This function starts OTA update server.
 Starts device portal HTTP server.
 
void setupWsServer ()
 This function starts WebSocket server.
 Starts device portal WebSocket server.
 
void updateFinished (bool fromPortal)
 This function is called when OTA update is finished.
 Implements post-OTA update actions.
 
void rebootDevice ()
 This function handles device reboot.
 Reboots the device.
 
bool inRequest_NeedAuthentication ()
 This function handles authentication error.
 Checks if current HTTP request requires authentication.
 
-void onRequest_notFound () const
 This function handles "not found" error.
void onRequest_notFound () const
 HTTP handler for 404 "not found" endpoint.
 
-void onRequest_index ()
 This function serves main page to the client.
void onRequest_index ()
 HTTP handler for index endpoint.
 
void onRequest_otaChunk ()
 This function is called for each OTA chunk.
 HTTP handler for OTA chunk endpoint.
 
void onRequest_otaFinish ()
 This function is called when OTA update is finished.
 HTTP handler for OTA finish endpoint.
 
void onWebsocketTextMessage (uint8_t clientNum, const std::string_view &message)
 This function handles incomming websocket messages.
 Handles websocket text message.
 
void handle_scanNetworks (std::string &response)
 This function handles scanning networks.
 Websocket handler for network scan endpoint.
 
void handle_getIdentity (std::string &response)
 This function handles identity request.
 Websocket handler for identity endpoint (device details).
 
void handle_getDeviceParams (std::string &response)
 This function handles device params request.
 Websocket handler for device parameters endpoint.
 
std::string handle_executeCommand (const std::string_view &body)
 This function handles command execution.
 Websocket handler for user commands endpoint.
 
void onAppLog (std::string &msgRef)
 This function handles logging.
 
void onAppLog (std::string &&message)
 Broadcasts application log message to all connected Websocket clients.
 
@@ -267,7 +270,11 @@

Protected Attributes

ksComponentState::TYPE componentState { ksComponentState::NotInitialized }
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

A component thet implements web-based configuration portal accessible from local network.

+

The portal can be used to upload OTA update, both in access point and station mode. There's also web-based terminal which can be used to debug the device and examine realitme application logs.

+

In case of confiugrator application, please don't add this component directly and use ksWifiConfigurator instead. In case of "normal application", you have to add the component manually if you want to use it.

+

Constructor & Destructor Documentation

◆ ksDevicePortal() [1/2]

@@ -283,7 +290,7 @@

-

Constructor, used to construct Device Portal component.

+

Constructs the Device Portal component.

Uses the default password "ota_ksiotframework"

@@ -303,7 +310,7 @@

-

Constructor, used to construct Device Portal component.

+

Constructs the Device Portal component with custom password.

Parameters
@@ -339,8 +346,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -369,14 +376,14 @@

-

This function handles command execution.

+

Websocket handler for user commands endpoint.

Parameters

passwordPassword used to authenticate the user.
- +
bodyCommand body
bodyCommand string from the browser.
-
Returns
Command response.
+
Returns
String with commadn execution result.

References ksf::evt::ksEvent< Params >::broadcast(), onHandlePortalCommand, and rebootDevice().

@@ -407,10 +414,10 @@

-

This function handles device params request.

+

Websocket handler for device parameters endpoint.

Parameters
- +
responseResponse reference, where the response should be appended
responseResponse reference . This method will output device configuration parameters into this string.
@@ -444,10 +451,10 @@

-

This function handles identity request.

+

Websocket handler for identity endpoint (device details).

Parameters
- +
responseResponse reference, where the response should be appended
responseResponse reference. This method will output device details in JSON format into this string.
@@ -481,10 +488,10 @@

-

This function handles scanning networks.

+

Websocket handler for network scan endpoint.

Parameters
- +
responseResponse reference, where the response should be appended
responseResponse reference. This method will output network scan results in JSON format into this string.
@@ -518,14 +525,14 @@

-

Initializes device portal component.

+

Initializes the device portal component.

Parameters
- +
appPointer to ksApplication
appPointer to the parent ksApplication.
-
Returns
True on success, false on fail.
+
Returns
True on success, false otherwise.

Reimplemented from ksf::ksComponent.

@@ -556,10 +563,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -592,14 +599,14 @@

-

Handles device portal component loop logic.

+

Handles core logic of the device portal component.

Parameters
- +
appPointer to ksApplication.
appPointer to the parent ksApplication.
-
Returns
True on success, false on fail.
+
Returns
True on success, false otherwise.

Reimplemented from ksf::ksComponent.

@@ -607,8 +614,8 @@

-

◆ onAppLog()

+ +

◆ onAppLog()

@@ -619,7 +626,7 @@

void ksf::comps::ksDevicePortal::onAppLog ( - std::string & msgRef) + std::string && message) @@ -630,10 +637,10 @@

-

This function handles logging.

+

Broadcasts application log message to all connected Websocket clients.

Parameters
- +
msgRefLog message
messageR-value reference of the message to broadcast.
@@ -642,6 +649,70 @@

Referenced by onWebsocketTextMessage().

+

+
+ +

◆ onRequest_index()

+ +
+
+ + + + + +
+ + + + + + + +
void ksf::comps::ksDevicePortal::onRequest_index ()
+ 		+protected
+
+ +

HTTP handler for index endpoint.

+

Called when the browser requests "/" endpoint. This is the default endpoint.

+ +

References inRequest_NeedAuthentication(), webServer, and webSocket.

+ +

Referenced by setupHttpServer().

+ +
+
+ +

◆ onRequest_notFound()

+ +
+
+ + + + + +
+ + + + + + + +
void ksf::comps::ksDevicePortal::onRequest_notFound () const
+ 		+protected
+
+ +

HTTP handler for 404 "not found" endpoint.

+

Called when the browser requests an endpoint that doesn't exist.

+ +

References webServer.

+ +

Referenced by setupHttpServer().

+
@@ -667,8 +738,8 @@

-

This function is called for each OTA chunk.

-

Handles endpoint "/api/flash".

+

HTTP handler for OTA chunk endpoint.

+

Called when the browser requests "/api/flash" endpoint with next firmware upload part. Used also to notify the browser about firmware uplaod progress.

References ksf::evt::ksEvent< Params >::broadcast(), inRequest_NeedAuthentication(), onUpdateStart, and webServer.

@@ -699,8 +770,8 @@

-

This function is called when OTA update is finished.

-

Handles endpoint "/api/flash".

+

HTTP handler for OTA finish endpoint.

+

Called when the browser requests "/api/flash" endpoint and the upload is complete. Used also to tell the browser that the upload is complete (or failed).

References inRequest_NeedAuthentication(), rebootDevice(), updateFinished(), and webServer.

@@ -735,16 +806,16 @@

-

This function handles incomming websocket messages.

+

Handles websocket text message.

Parameters
- - + +
clientNumClient number
messageMessage string view
clientNumNumber of Websocket client (used as ID to know who's the sender).
messageString view of the message content.
-

References app, ksf::ksApplication::findComponents(), handle_executeCommand(), handle_getDeviceParams(), handle_getIdentity(), handle_scanNetworks(), logKeepAliveTimestamp, onAppLog(), requestAppBreak(), and webSocket.

+

References app, ksf::ksApplication::findComponents(), handle_executeCommand(), handle_getDeviceParams(), handle_getIdentity(), handle_scanNetworks(), logKeepAliveTimestamp, onAppLog(), requestAppBreak(), and webSocket.

Referenced by setupWsServer().

@@ -773,14 +844,14 @@

-

Post initialization method for device portal with integrated OTA.

+

Post-initializes the device portal component.

Parameters
- +
appPointer to ksApplication
appPointer to the parent ksApplication.
-
Returns
True on success, false on fail.
+
Returns
True on success, false otherwise.

Reimplemented from ksf::ksComponent.

@@ -800,7 +871,14 @@

-

Evnet for portal console commands.

+

Custom command handler event.

Parameters
+ + + + +
param_1String view of the command coming from the browser.
param_2Reference of boolean value indicating if the command was handled. Set to true to stop further processing and return response.
param_3Reference of the string containing the command response. Append results here.
+
+

Referenced by handle_executeCommand().

@@ -817,7 +895,7 @@

-

Update end (OTA) event.

+

Update end (OTA) event. No parameters.

Referenced by updateFinished().

@@ -834,7 +912,7 @@

-

Update start (OTA) event.

+

Update start (OTA) event. No parameters.

Referenced by ksDevicePortal(), and onRequest_otaChunk().

diff --git a/classksf_1_1comps_1_1ks_led.html b/classksf_1_1comps_1_1ks_led.html index af76c08..71ebf9b 100644 --- a/classksf_1_1comps_1_1ks_led.html +++ b/classksf_1_1comps_1_1ks_led.html @@ -96,18 +96,18 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti
- + - + @@ -142,16 +142,16 @@ - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksLed (uint8_t pin, bool activeLow=false, bool driveAsPushPull=false)
 Constructs the LED object.
 
- Public Member Functions inherited from ksf::ksComponent
virtual bool postInit (ksApplication *app)
 Method called after component initialization.
 Method called after component initialization, used to setup references to other components.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- + @@ -105,7 +105,7 @@ - + diff --git a/classksf_1_1comps_1_1ks_mqtt_connector.html b/classksf_1_1comps_1_1ks_mqtt_connector.html index c229aad..394244a 100644 --- a/classksf_1_1comps_1_1ks_mqtt_connector.html +++ b/classksf_1_1comps_1_1ks_mqtt_connector.html @@ -99,8 +99,8 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti

@@ -258,8 +258,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -321,7 +321,7 @@

Parameters
- +
ownerPointer to parent ksApplication object.
ownerPointer to parent ksApplication object.
@@ -356,10 +356,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -533,7 +533,7 @@

References driveAsActiveLow, driveAsPushPull, and pin.

-

Referenced by init(), loop(), ksf::comps::ksWifiConfigurator::postInit(), setBlinking(), setDriveAsPushPull(), and ~ksLed().

+

Referenced by init(), loop(), ksf::comps::ksWifiConfigurator::postInit(), setBlinking(), setDriveAsPushPull(), and ~ksLed().

diff --git a/classksf_1_1comps_1_1ks_mqtt_config_provider.html b/classksf_1_1comps_1_1ks_mqtt_config_provider.html index ec88721..7822552 100644 --- a/classksf_1_1comps_1_1ks_mqtt_config_provider.html +++ b/classksf_1_1comps_1_1ks_mqtt_config_provider.html @@ -96,18 +96,18 @@ ksf::comps::ksConfigProvider -ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti - + - + @@ -128,19 +128,19 @@ - + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
void readParams () override
 Retrieves MQTT parameters.
 Initializes component.
 
virtual bool loop (ksApplication *app)
 Called from application loop.
 Handles component loop logic, called from application loop.
 
virtual bool postInit (ksApplication *app)
 Method called after component initialization.
 Method called after component initialization, used to setup references to other components.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- + - + @@ -201,8 +201,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::comps::ksConfigProvider.

@@ -231,10 +231,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters

@@ -160,10 +160,10 @@

Additional Inherited Members

- Protected Member Functions inherited from ksf::comps::ksConfigProvider
void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
 Defines new configutation parameter.
 
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
 Defines new configuation parameter (with default value).
 
- Protected Attributes inherited from ksf::comps::ksConfigProvider
- +
idType ID.
idType ID to check against.
@@ -301,8 +301,8 @@

Saves MQTT aprameters into the configuration file.

-
This method saves current (in-memory) MQTT properties into the configuration file.
-
+

This method saves current (in-memory) MQTT properties into the configuration file.

+

Implements ksf::comps::ksConfigProvider.

@@ -332,7 +332,7 @@

References ksf::comps::ksMqttConnector::setupConnection().

-

Referenced by ksf::comps::ksMqttConnector::init().

+

Referenced by ksf::comps::ksMqttConnector::init().

diff --git a/classksf_1_1comps_1_1ks_mqtt_connector-members.html b/classksf_1_1comps_1_1ks_mqtt_connector-members.html index 959926f..c74882f 100644 --- a/classksf_1_1comps_1_1ks_mqtt_connector-members.html +++ b/classksf_1_1comps_1_1ks_mqtt_connector-members.html @@ -90,7 +90,7 @@

getConnectionTimeSeconds() constksf::comps::ksMqttConnector
getInstanceType() constksf::comps::ksMqttConnectorinlinevirtual
getReconnectCounter() constksf::comps::ksMqttConnectorinline
init(ksApplication *owner) overrideksf::comps::ksMqttConnectorvirtual
init(ksApplication *app) overrideksf::comps::ksMqttConnectorvirtual
isA(const size_t id) constksf::comps::ksMqttConnectorinlinevirtual
isConnected() constksf::comps::ksMqttConnector
ksMqttConnector(bool sendConnectionStatus=true, bool usePersistentSession=false)ksf::comps::ksMqttConnector
onDeviceMessageksf::comps::ksMqttConnector
onDisconnectedksf::comps::ksMqttConnector
passwordksf::comps::ksMqttConnectorprotected
postInit(ksApplication *owner) overrideksf::comps::ksMqttConnectorvirtual
postInit(ksApplication *app) overrideksf::comps::ksMqttConnectorvirtual
prefixksf::comps::ksMqttConnectorprotected
publish(const std::string &topic, const std::string &payload, bool retain=false, bool skipDevicePrefix=false)ksf::comps::ksMqttConnector
QosLevel enum name (defined in ksf::comps::ksMqttConnector)ksf::comps::ksMqttConnector
@@ -114,20 +114,20 @@ - + - + - - - - - - + + + + + + @@ -159,11 +159,11 @@ - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksMqttConnector (bool sendConnectionStatus=true, bool usePersistentSession=false)
 Constructs ksMqttConnector object.
 
bool init (ksApplication *owner) override
 Instantiates the MQTT connector component.
 
bool postInit (ksApplication *owner) override
 Method that handles component post-initialization.
 
bool init (ksApplication *app) override
 Instantiates the MQTT connector component.
 
bool postInit (ksApplication *app) override
 Method that handles component post-initialization.
 
bool loop (ksApplication *app) override
 Executes MQTT connection logic.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- +

@@ -378,8 +378,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -415,8 +415,8 @@

-

◆ init()

+ +

◆ init()

@@ -427,7 +427,7 @@

bool ksf::comps::ksMqttConnector::init

(ksApplication * owner)ksApplication * app)
@@ -441,7 +441,7 @@

Parameters
- +
ownerPointer to the ksApplication object (parent).
appPointer to the parent ksApplication.
@@ -476,10 +476,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -625,8 +625,8 @@

-

◆ postInit()

+ +

◆ postInit()

@@ -637,7 +637,7 @@

bool ksf::comps::ksMqttConnector::postInit ( - ksApplication * owner) + ksApplication * app) @@ -652,7 +652,7 @@

Parameters
- +
ownerPointer to the parent ksApplication.
appPointer to the parent ksApplication.
diff --git a/classksf_1_1comps_1_1ks_reset_button.html b/classksf_1_1comps_1_1ks_reset_button.html index c1457b9..733cbf2 100644 --- a/classksf_1_1comps_1_1ks_reset_button.html +++ b/classksf_1_1comps_1_1ks_reset_button.html @@ -96,18 +96,18 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti

- + - + @@ -127,16 +127,16 @@ - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksResetButton (uint8_t pin, uint8_t triggerState, uint8_t mode=INPUT)
 Constructs the reset button component.
 
- Public Member Functions inherited from ksf::ksComponent
virtual bool postInit (ksApplication *app)
 Method called after component initialization.
 Method called after component initialization, used to setup references to other components.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 

@@ -181,7 +181,7 @@

Detailed Description

A component that implements reset button functionality.

-

On short press, it will cause component loop to return false, then ksAppRotator will move to the next application. On long press, it will erase user data (factory reset).

+

On short press, it will cause component loop to return false, then ksAppRotator will move to the next application. On long press, it will erase user data (factory reset).

The component has also built-in debounce handling logic.

Constructor & Destructor Documentation

@@ -244,8 +244,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -307,7 +307,7 @@

Parameters
- +
appPointer to the parent ksApplication.
appPointer to the parent ksApplication.
@@ -342,10 +342,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -381,7 +381,7 @@

Parameters
- +
appPointer to the parent ksApplication.
appPointer to the parent ksApplication.
diff --git a/classksf_1_1comps_1_1ks_wifi_configurator-members.html b/classksf_1_1comps_1_1ks_wifi_configurator-members.html index 39bef19..7e96ecc 100644 --- a/classksf_1_1comps_1_1ks_wifi_configurator-members.html +++ b/classksf_1_1comps_1_1ks_wifi_configurator-members.html @@ -81,22 +81,22 @@

This is the complete list of members for ksf::comps::ksWifiConfigurator, including all inherited members.

- - - - - - - - - - - - - - + + + + + + + + + + + + + + - +
as()ksf::ksRttiinline
as() constksf::ksRttiinline
componentStateksf::ksComponentprotected
configTimeoutksf::comps::ksWifiConfiguratorprotected
deviceNameksf::comps::ksWifiConfiguratorprotected
getClassType() (defined in ksf::comps::ksWifiConfigurator)ksf::comps::ksWifiConfiguratorinlinestatic
getInstanceType() constksf::comps::ksWifiConfiguratorinlinevirtual
handlePeriodicTasks()ksf::comps::ksWifiConfiguratorprotected
init(ksApplication *owner) overrideksf::comps::ksWifiConfiguratorvirtual
isA(const size_t id) constksf::comps::ksWifiConfiguratorinlinevirtual
ksWifiConfigurator()ksf::comps::ksWifiConfigurator
ksWifiConfigurator(std::string devicePrefixName)ksf::comps::ksWifiConfigurator
loop(ksApplication *app) overrideksf::comps::ksWifiConfiguratorvirtual
ownerksf::comps::ksWifiConfiguratorprotected
appksf::comps::ksWifiConfiguratorprotected
as()ksf::ksRttiinline
as() constksf::ksRttiinline
componentStateksf::ksComponentprotected
configTimeoutksf::comps::ksWifiConfiguratorprotected
deviceNameksf::comps::ksWifiConfiguratorprotected
getClassType() (defined in ksf::comps::ksWifiConfigurator)ksf::comps::ksWifiConfiguratorinlinestatic
getInstanceType() constksf::comps::ksWifiConfiguratorinlinevirtual
handlePeriodicTasks()ksf::comps::ksWifiConfiguratorprotected
init(ksApplication *app) overrideksf::comps::ksWifiConfiguratorvirtual
isA(const size_t id) constksf::comps::ksWifiConfiguratorinlinevirtual
ksWifiConfigurator()ksf::comps::ksWifiConfigurator
ksWifiConfigurator(std::string devicePrefixName)ksf::comps::ksWifiConfigurator
loop(ksApplication *app) overrideksf::comps::ksWifiConfiguratorvirtual
periodicTasksTimeoutksf::comps::ksWifiConfiguratorprotected
postInit(ksApplication *owner) overrideksf::comps::ksWifiConfiguratorvirtual
postInit(ksApplication *app) overrideksf::comps::ksWifiConfiguratorvirtual
~ksWifiConfigurator()ksf::comps::ksWifiConfiguratorvirtual

diff --git a/classksf_1_1comps_1_1ks_wifi_configurator.html b/classksf_1_1comps_1_1ks_wifi_configurator.html index d8e4515..f59e369 100644 --- a/classksf_1_1comps_1_1ks_wifi_configurator.html +++ b/classksf_1_1comps_1_1ks_wifi_configurator.html @@ -84,6 +84,11 @@
ksf::comps::ksWifiConfigurator Class Reference
+ +

ksWifiConfigurator component class. + More...

+ +

#include <ksWifiConfigurator.h>

+ Inheritance diagram for ksf::comps::ksWifiConfigurator:
@@ -92,18 +97,18 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti
- + - + @@ -112,27 +117,27 @@ - - + + - - - - - - + + + + + + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksWifiConfigurator ()
 ksWifiConfigurator (std::string devicePrefixName)
 Constructs WiFi configurator object.
 
bool loop (ksApplication *app) override
 Handles ksWifiConfigurator logic.
bool loop (ksApplication *app) override
 Handles ksWifiConfigurator logic.
 
bool init (ksApplication *owner) override
 ksWifiConfigurator init function.
 
bool postInit (ksApplication *owner) override
 ksWifiConfigurator postInit function.
 
bool init (ksApplication *app) override
 Implements ksWifiConfigurator initialization logic.
 
bool postInit (ksApplication *app) override
 Implements ksWifiConfigurator post-initialization logic.
 
virtual ~ksWifiConfigurator ()
 Destructor for WiFi configurator component.
 Destructs WiFi configurator component.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 

@@ -154,10 +159,10 @@

- - - + + + @@ -174,7 +179,10 @@

Protected Attributes

-ksApplication * owner {nullptr}
 Pointer to ksApplication object that owns this component.
 
+ksApplication * app {nullptr}
 Pointer to ksApplication object that owns this component.
 
std::string deviceName
 Device name (prefix).
ksComponentState::TYPE componentState { ksComponentState::NotInitialized }
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

ksWifiConfigurator component class.

+

Handles Device Portal, where the user can configure the device like WiFi or MQTT credentials as well as custom, application-defined parameters implemented using ksConfigProvider interface.

+

Constructor & Destructor Documentation

◆ ksWifiConfigurator()

@@ -226,15 +234,15 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

- -

◆ init()

+ +

◆ init()

@@ -245,7 +253,7 @@

bool ksf::comps::ksWifiConfigurator::init ( - ksApplication * owner) + ksApplication * app) @@ -256,10 +264,10 @@

-

ksWifiConfigurator init function.

+

Implements ksWifiConfigurator initialization logic.

Parameters
- +
ownerPointer to the application object
appPointer to ksApplication object that owns this component
@@ -267,7 +275,7 @@

ksf::ksComponent.

-

References ksf::ksApplication::addComponent(), and deviceName.

+

References ksf::ksApplication::addComponent(), app, and deviceName.

@@ -294,10 +302,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -330,8 +338,14 @@

-

Handles ksWifiConfigurator logic.

+

Handles ksWifiConfigurator logic.

It starts and handles Device Portal, where the user can configure the device (that means WiFi or MQTT credential as well as custom defined device parameters).

+
Parameters
+ + +
appPointer to ksApplication object that owns this component.
+
+
Returns
True if loop succedeed, otherwise false.

Reimplemented from ksf::ksComponent.

@@ -340,8 +354,8 @@

-

◆ postInit()

+ +

◆ postInit()

@@ -352,7 +366,7 @@

bool ksf::comps::ksWifiConfigurator::postInit ( - ksApplication * owner) + ksApplication * app) @@ -363,11 +377,10 @@

-

ksWifiConfigurator postInit function.

-

Turns on all registered LEDs in config mode.

+

Implements ksWifiConfigurator post-initialization logic.

Parameters
- +
ownerPointer to ksApplication object that owns this component
appPointer to ksApplication object that owns this component
@@ -375,7 +388,7 @@

ksf::ksComponent.

-

References ksf::ksApplication::findComponents(), and ksf::comps::ksLed::setEnabled().

+

References app, ksf::ksApplication::findComponents(), and ksf::comps::ksLed::setEnabled().

diff --git a/classksf_1_1comps_1_1ks_wifi_connector.html b/classksf_1_1comps_1_1ks_wifi_connector.html index 015fe52..be5a2ca 100644 --- a/classksf_1_1comps_1_1ks_wifi_connector.html +++ b/classksf_1_1comps_1_1ks_wifi_connector.html @@ -85,6 +85,11 @@
ksf::comps::ksWifiConnector Class Reference
+ +

A component that manages WiFi connection. + More...

+ +

#include <ksWifiConnector.h>

+ Inheritance diagram for ksf::comps::ksWifiConnector:
@@ -93,21 +98,21 @@
-ksf::ksComponent -ksf::ksRtti +ksf::ksComponent +ksf::ksRtti
- + - + - + @@ -120,20 +125,20 @@ - + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
 ksWifiConnector (const char *hostname, bool savePower=true)
 Constructor for WiFi connector component.
 Constructs WiFi connector component.
 
bool init (ksApplication *app) override
 Initializes WiFi connector component.
 
virtual ~ksWifiConnector ()
 Destructor for WiFi connector component.
 Destructos WiFi connector component.
 
- Public Member Functions inherited from ksf::ksComponent
virtual bool postInit (ksApplication *app)
 Method called after component initialization.
 Method called after component initialization, used to setup references to other components.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
- + @@ -173,15 +178,15 @@ Protected Attributes - + - + - + @@ -199,7 +204,16 @@

@@ -158,7 +163,7 @@

Protected Member Functions

void setupMacAddress ()
 Internal method to setup MAC address.
 Internal method that generates MAC address for the device.
 
void wifiConnectedInternal ()
ksSimpleTimer wifiTimeoutTimer { 120000UL }
 Wifi timer - timeout.
 Wifi timer - long timeout in case of issues.
 
ksSimpleTimer wifiReconnectTimer { 5000UL }
 Wifi timer - reconnect.
 Wifi timer - reconnection timeout.
 
ksSimpleTimer wifiIpCheckTimer { 1000UL }
 Wifi timer - IP check.
 Wifi timer - IP check interval.
 
bool wasConnected: 1 {false}
ksComponentState::TYPE componentState { ksComponentState::NotInitialized }
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

A component that manages WiFi connection.

+

This component handles WiFi connection, reconnecting automatically in case of disconnection.

+

There are many things that this component manages:

    +
  • MAC address generation (to easily identify ksIotFrameworkLib based devices)
    • +
  • Simple power management (DTIM low-power mode)
    • +
  • IP address validation, used to determine if WiFi connection was successful (not only using WiFi PHY state)
    • +
  • Timeout management, used to break in case of longer WiFi connection issues (causing application to exit and swittch to configuration mode)
    • +
+

Constructor & Destructor Documentation

◆ ksWifiConnector()

@@ -219,11 +233,11 @@

-

Constructor for WiFi connector component.

+

Constructs WiFi connector component.

Parameters
- - + +
hostnameHostname to be used by WiFi class
savePowerTrue to save power
hostnameHostname of the device, used also by mDNS service.
savePowerIf set, will put the device in modem sleep mode. This is useful to reduce power consumption, but increases reaction time.
@@ -256,8 +270,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Reimplemented from ksf::ksComponent.

@@ -289,7 +303,7 @@

Parameters
- +
ownerPointer to ksApplication object that owns this component
appPointer to the parent ksApplication.
@@ -324,10 +338,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -385,6 +399,12 @@

Handles WiFi connector component loop logic.

+
Parameters
+ + +
appPointer to the parent ksApplication.
+
+
Returns
True on success, false on fail.

Reimplemented from ksf::ksComponent.

@@ -416,7 +436,7 @@

-

Internal method to setup MAC address.

+

Internal method that generates MAC address for the device.

This MAC is generated by using original ChipID / MAC, but starts with 0xFA 0xF1 and then there are four Chip ID bytes. 0xFA 0xF1 works like prefix / signature to help identyfying devices in router properties / Wireshark (debugging) etc.

Referenced by ksWifiConnector().

diff --git a/classksf_1_1ks_app_rotator.html b/classksf_1_1ks_app_rotator.html index a721cc0..a113b63 100644 --- a/classksf_1_1ks_app_rotator.html +++ b/classksf_1_1ks_app_rotator.html @@ -81,6 +81,11 @@
ksf::ksAppRotator< AppTypes > Class Template Reference

+ +

Application rotator component. + More...

+ +

#include <ksAppRotator.h>

@@ -89,10 +94,19 @@ - +

Public Member Functions

 Runs the application loop.
 
void loop (unsigned long milliseconds)
 Runs the application loop with a delay.
 Runs application loop with a delay between loops.
 
-

Member Function Documentation

+

Detailed Description

+
template<class... AppTypes>
+class ksf::ksAppRotator< AppTypes >

Application rotator component.

+
Template Parameters
+ + +
...List of application classes to be used.
+
+
+

Member Function Documentation

◆ loop()

@@ -118,7 +132,7 @@

-

Runs the application loop with a delay.

+

Runs application loop with a delay between loops.

Parameters
diff --git a/classksf_1_1ks_application.html b/classksf_1_1ks_application.html index cb9f08e..3f76948 100644 --- a/classksf_1_1ks_application.html +++ b/classksf_1_1ks_application.html @@ -82,26 +82,31 @@
ksf::ksApplication Class Referenceabstract
+ +

A class that is a base for user-defined application. + More...

+ +

#include <ksApplication.h>

millisecondsDelay time in milliseconds.
- + - + - + - +

Public Member Functions

template<class TComponentType , class... TParams>
std::weak_ptr< TComponentType > addComponent (TParams... arg)
 Instantiates a component of passed type.
 Instantiates a component of the type defined by the template instance. This function will pass all template-defined parameters to the component constructor.
 
template<class TComponentType >
void findComponents (std::vector< std::weak_ptr< TComponentType > > &outComponents)
 Looks for all components of passed type and puts them into passed vector.
 Iterates through all components and returns a vector of weak pointers with components that matches the type passed as a template parameter.
 
template<class TComponentType >
std::weak_ptr< TComponentType > findComponent ()
 Looks for a component of passed type and returns a weak pointer to it.
 Iterates through all components and returns a weak pointer to the first component that matches the type passed as a template parameter.
 
virtual bool init ()=0
 Initializes application.
 
virtual bool loop ()
 Executes application loop.
 Executes application logic loop.
 

@@ -111,7 +116,13 @@

 An array with shared_ptr of components (holding main reference).
 
-

Member Function Documentation

+

Detailed Description

+

A class that is a base for user-defined application.

+

ksApplication implements core application logic. It is responsible for initializing and running components.

+

You must override init method to build component stack. You can return false to stop the initialization. In this case, application will be stopped and ksAppRotator will move to the next application.

+

Do not override loop method until you have a good reason. If you do so, keep in mind that you should call base loop method and return the result properly. If any component returns false, application logic should be stopped. The best way is to add only small piece of code and return the reult of the base loop method. It is also safe to return false early, before calling base loop method.

+

When init or loop returns false, application will be stopped.

+

Member Function Documentation

◆ addComponent()

@@ -137,19 +148,25 @@

-

Instantiates a component of passed type.

-

This function will pass all template-defined parameters as constructor parameters to the component. Keep in mind that passed parameters must match target component constructor parameters.

+

Instantiates a component of the type defined by the template instance. This function will pass all template-defined parameters to the component constructor.

+
Template Parameters
+ + + +
TComponentTypeA type of the component.
TParams...A list of parameters to be passed to the component constructor.
+
+
Parameters
- +
...- user (template) defined parameters
arg...A list of parameters to be passed to the component constructor.
-
Returns
Weak pointer to the newly created component.
+
Returns
Weak pointer to the created component.

References components, and ksf::ksComponent::getInstanceType().

-

Referenced by ksf::comps::ksWifiConfigurator::init().

+

Referenced by ksf::comps::ksWifiConfigurator::init().

@@ -178,12 +195,18 @@

-

Looks for a component of passed type and returns a weak pointer to it.

-
Returns
Weak pointer to the component of passed type.
+

Iterates through all components and returns a weak pointer to the first component that matches the type passed as a template parameter.

+
Template Parameters
+ + +
TComponentTypeA type of the component to look for.
+
+
+
Returns
Weak pointer to the first component that matches the type passed as a template parameter.

References components, and ksf::ksComponent::getInstanceType().

-

Referenced by ksf::comps::ksDevicePortal::postInit(), ksf::comps::ksDevStatMqttReporter::postInit(), and ksf::comps::ksMqttConnector::postInit().

+

Referenced by ksf::comps::ksDevicePortal::postInit(), ksf::comps::ksDevStatMqttReporter::postInit(), and ksf::comps::ksMqttConnector::postInit().

@@ -212,17 +235,23 @@

-

Looks for all components of passed type and puts them into passed vector.

+

Iterates through all components and returns a vector of weak pointers with components that matches the type passed as a template parameter.

+
Template Parameters
+ + +
TComponentTypeA type of the component to look for.
+
+
Parameters
- +
outComponentsVector of weak pointers to components of passed type.
outComponentsA vector of weak pointers to components that match the type passed as a template parameter.

References components, and ksf::ksComponent::getInstanceType().

-

Referenced by ksf::comps::ksDevicePortal::handle_getDeviceParams(), ksf::comps::ksDevicePortal::onWebsocketTextMessage(), and ksf::comps::ksWifiConfigurator::postInit().

+

Referenced by ksf::comps::ksDevicePortal::handle_getDeviceParams(), ksf::comps::ksDevicePortal::onWebsocketTextMessage(), and ksf::comps::ksWifiConfigurator::postInit().

@@ -250,7 +279,7 @@

Initializes application.

-
Returns
True on success, false on fail (will break application execution).
+
Returns
True on success, false otherwise (will break application execution).
@@ -277,8 +306,8 @@

-

Executes application loop.

-
Returns
True on success, false on fail (will break application execution).
+

Executes application logic loop.

+
Returns
True on success, false otherwise (will break application execution).

References components.

diff --git a/classksf_1_1ks_cert_fingerprint.html b/classksf_1_1ks_cert_fingerprint.html index 7d80ad1..af3805a 100644 --- a/classksf_1_1ks_cert_fingerprint.html +++ b/classksf_1_1ks_cert_fingerprint.html @@ -82,6 +82,11 @@
ksf::ksCertFingerprint Class Reference
+ +

Interface for certificate fingerprint verification. + More...

+ +

#include <ksCertUtils.h>

@@ -98,7 +103,10 @@

Public Member Functions

 Converts fingerprint string into array of bytes.
 
-

Member Function Documentation

+

Detailed Description

+

Interface for certificate fingerprint verification.

+

Implements platform-dependent certificate fingerprint verification. Used to validate certificate fingerprints without the requirement of certificate-chain verification.

+

Member Function Documentation

◆ fingerprintToBytes()

diff --git a/classksf_1_1ks_component.html b/classksf_1_1ks_component.html index ce30f7c..8795a06 100644 --- a/classksf_1_1ks_component.html +++ b/classksf_1_1ks_component.html @@ -84,6 +84,11 @@
ksf::ksComponent Class Reference
+ +

Base component class. + More...

+ +

#include <ksComponent.h>

+ Inheritance diagram for ksf::ksComponent:
@@ -92,43 +97,43 @@
-ksf::ksRtti +ksf::ksRtti ksf::comps::ksConfigProvider ksf::comps::ksDevStatMqttReporter -ksf::comps::ksDevicePortal +ksf::comps::ksDevicePortal ksf::comps::ksLed ksf::comps::ksMqttConnector ksf::comps::ksResetButton -ksf::comps::ksWifiConfigurator -ksf::comps::ksWifiConnector +ksf::comps::ksWifiConfigurator +ksf::comps::ksWifiConnector
- + - + - + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
virtual bool init (ksApplication *app)
 Initializes component.
 
virtual bool loop (ksApplication *app)
 Called from application loop.
 Handles component loop logic, called from application loop.
 
virtual bool postInit (ksApplication *app)
 Method called after component initialization.
 Method called after component initialization, used to setup references to other components.
 
- Public Member Functions inherited from ksf::ksRtti
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 

@@ -148,7 +153,10 @@ class 

ksApplication
 
-

Member Function Documentation

+

Detailed Description

+

Base component class.

+

A component is a part of the application that can be configured and managed by the application. As it is using ksRtti, it must use KSF_RTTI_DECLARATIONS for proper initialization.

+

Member Function Documentation

◆ getInstanceType()

@@ -172,8 +180,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Implements ksf::ksRtti.

@@ -209,15 +217,15 @@

Parameters
- +
ownerPointer to the owning application.
appPointer to the parent ksApplication.
Returns
True on success, false on fail.
-

Reimplemented in ksf::comps::ksDevicePortal, ksf::comps::ksResetButton, ksf::comps::ksWifiConnector, ksf::comps::ksLed, ksf::comps::ksMqttConnector, and ksf::comps::ksWifiConfigurator.

+

Reimplemented in ksf::comps::ksDevicePortal, ksf::comps::ksMqttConnector, ksf::comps::ksResetButton, ksf::comps::ksWifiConfigurator, ksf::comps::ksWifiConnector, and ksf::comps::ksLed.

-

Referenced by ksf::comps::ksMqttConnector::init().

+

Referenced by ksf::comps::ksMqttConnector::init().

@@ -244,10 +252,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
@@ -282,7 +290,13 @@

-

Called from application loop.

+

Handles component loop logic, called from application loop.

+
Parameters
+ + +
appPointer to the parent ksApplication.
+
+
Returns
True on success, false on fail.

Reimplemented in ksf::comps::ksDevicePortal, ksf::comps::ksDevStatMqttReporter, ksf::comps::ksLed, ksf::comps::ksMqttConnector, ksf::comps::ksResetButton, ksf::comps::ksWifiConfigurator, and ksf::comps::ksWifiConnector.

@@ -312,16 +326,16 @@

-

Method called after component initialization.

+

Method called after component initialization, used to setup references to other components.

Parameters
- +
ownerPointer to the owning application.
appPointer to the parent ksApplication.
Returns
True on success, false on fail.
-

Reimplemented in ksf::comps::ksDevicePortal, ksf::comps::ksDevStatMqttReporter, ksf::comps::ksMqttConnector, and ksf::comps::ksWifiConfigurator.

+

Reimplemented in ksf::comps::ksDevicePortal, ksf::comps::ksDevStatMqttReporter, ksf::comps::ksMqttConnector, and ksf::comps::ksWifiConfigurator.

diff --git a/classksf_1_1ks_config.html b/classksf_1_1ks_config.html index 7b27bb7..1ad72a0 100644 --- a/classksf_1_1ks_config.html +++ b/classksf_1_1ks_config.html @@ -82,14 +82,19 @@
ksf::ksConfig Class Reference
+ +

Implements low-level configuration file handling. + More...

+ +

#include <ksConfig.h>

- + - + @@ -97,8 +102,9 @@ - - + +

Public Member Functions

 ksConfig (const std::string &fileName)
 Constructor that opens (or creates) specified config file and loads its contents into memory.
 Constructor tha opens or creates configuration file.
 
void setParam (const std::string &paramName, const std::string paramValue)
 Sets parameter value.
 Sets parameter value (creates new parameter if it does not exist).
 
const std::string & getParam (const std::string &paramName, const std::string &defaultValue=std::string()) const
 Retrieves parameter value.
 operator bool () const
 Operator bool override. Returns true if configFilename is not empty.
 
virtual ~ksConfig ()
 Saves config content to flash.
+virtual ~ksConfig ()
 Saves config content on the device filesystem. In case there is no modification, nothing should actually happen.
 

@@ -116,7 +122,10 @@

 Config filename.
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

Implements low-level configuration file handling.

+

Uses std::map to store configuration parameters. When any parameter is modified, the config file is marked as dirty. Then on destruction, the config file is saved if it has been modified (marked as dirty) into the filesystem.

+

Constructor & Destructor Documentation

◆ ksConfig()

@@ -132,46 +141,16 @@

-

Constructor that opens (or creates) specified config file and loads its contents into memory.

+

Constructor tha opens or creates configuration file.

Parameters
- +
configFileConfig file name
fileNameConfig filename.

References configPath, and setParam().

-

- - -

◆ ~ksConfig()

- -
-
- - - - - -
- - - - - - - -
ksf::ksConfig::~ksConfig ()
- 		-virtual
-
- -

Saves config content to flash.

-

If config contents has not been modified, nothing will be saved.

- -

References configParams, configPath, and isDirty.

-

Member Function Documentation

@@ -195,15 +174,14 @@

Retrieves parameter value.

-

If parameter does not exist, defaultValue will be returned.

Parameters
- - + +
paramNameParameter name
defaultValueDefault value to return if parameter does not exist
paramNameName of the parameter to retrieve.
defaultValueDefault value to return if parameter does not exist.
-
Returns
Parameter value or defaultValue if parameter does not exist.
+
Returns
Parameter value string (or defaultValue).

References configParams.

@@ -250,12 +228,11 @@

-

Sets parameter value.

-

If parameter does not exist, it will be created.

+

Sets parameter value (creates new parameter if it does not exist).

Parameters
- - + +
paramNameParameter name
paramValueParameter value (use std::move when possible)
paramNameParameter name.
paramValueParameter value (use std::move when possible).
diff --git a/classksf_1_1ks_rtti.html b/classksf_1_1ks_rtti.html index 0032629..d2ffe38 100644 --- a/classksf_1_1ks_rtti.html +++ b/classksf_1_1ks_rtti.html @@ -81,6 +81,11 @@
ksf::ksRtti Class Referenceabstract
+ +

Implements RTTI (run-time type information) for objects. + More...

+ +

#include <ksRtti.h>

+ Inheritance diagram for ksf::ksRtti:
@@ -89,36 +94,40 @@
-ksf::ksComponent +ksf::ksComponent ksf::comps::ksConfigProvider ksf::comps::ksDevStatMqttReporter -ksf::comps::ksDevicePortal +ksf::comps::ksDevicePortal ksf::comps::ksLed ksf::comps::ksMqttConnector ksf::comps::ksResetButton -ksf::comps::ksWifiConfigurator -ksf::comps::ksWifiConnector +ksf::comps::ksWifiConfigurator +ksf::comps::ksWifiConnector
- + - + - + - +

Public Member Functions

virtual const size_t getInstanceType () const =0
 This function is used to get type ID of object.
 Retrieves type ID of the object.
 
virtual bool isA (const size_t id) const
 This function is used to check if object is of given type.
 Checks whether object is of given type.
 
template<typename TType >
TType * as ()
 This function is used to cast object to given type.
 Tries to cast object to the type provided as a template parameter.
 
template<typename TType >
const TType * as () const
 This function is used to const cast object to given type.
 Tries to cast object to the type provided as a template parameter (const version).
 
-

Member Function Documentation

+

Detailed Description

+

Implements RTTI (run-time type information) for objects.

+

This is a simple, but fast and lightweight implementation of RTTI feature. Provides the ability to check whether object is of given type and cast it to the type provided as a template parameter.

+

Extensively used to implement components - ksComponent and easily manage components in the application (ksApplication).

+

Member Function Documentation

◆ as() [1/2]

@@ -144,7 +153,13 @@

-

This function is used to cast object to given type.

+

Tries to cast object to the type provided as a template parameter.

+
Template Parameters
+ + +
TTypeTarget type.
+
+
Returns
Pointer to object of given type or nullptr if object is not of given type.

@@ -174,7 +189,13 @@

-

This function is used to const cast object to given type.

+

Tries to cast object to the type provided as a template parameter (const version).

+
Template Parameters
+ + +
TTypeTarget type.
+
+
Returns
Const pointer to object of given type or nullptr if object is not of given type.
@@ -202,8 +223,8 @@

-

This function is used to get type ID of object.

-
Returns
Type ID.
+

Retrieves type ID of the object.

+
Returns
Object type ID.

Implemented in ksf::comps::ksConfigProvider, ksf::comps::ksDevicePortal, ksf::comps::ksDevStatMqttReporter, ksf::comps::ksLed, ksf::comps::ksMqttConfigProvider, ksf::comps::ksMqttConnector, ksf::comps::ksResetButton, ksf::comps::ksWifiConfigurator, ksf::comps::ksWifiConnector, and ksf::ksComponent.

@@ -232,10 +253,10 @@

-

This function is used to check if object is of given type.

+

Checks whether object is of given type.

Parameters
- +
idType ID.
idType ID to check against.
diff --git a/classksf_1_1ks_simple_timer.html b/classksf_1_1ks_simple_timer.html index 1d197d9..7bd6bfc 100644 --- a/classksf_1_1ks_simple_timer.html +++ b/classksf_1_1ks_simple_timer.html @@ -82,6 +82,11 @@
ksf::ksSimpleTimer Class Reference
+ +

Simple timer class, without using component architecture. + More...

+ +

#include <ksSimpleTimer.h>

@@ -96,10 +101,10 @@ - + - +

Public Member Functions

 Restarts timer. Will set last trigger time to current time w/o triggering the timer).
 
bool triggered ()
 Checks if timer interval just passed. Restarting timer is automatic. If interval is 0 then always returns false.
 Checks if timer interval just passed and resets the timer in this case. If timer interval is 0 then always returns false.
 
bool hasTimePassed () const
 Checks if timer interval just passed. Restarting timer relies on user. If interval is 0 then always returns false.
 Checks if timer interval just passed. Restarting timer relies on user. If timer interval is 0 then always returns false.
 

@@ -113,7 +118,14 @@

 Last trigger time (milliseconds).
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

Simple timer class, without using component architecture.

+

Used to trigger events periodically. Internally checks if timer interval just passed. When interval is 0, never triggers the timer.

+

There are two ways to use it:

+

Constructor & Destructor Documentation

◆ ksSimpleTimer()

@@ -157,7 +169,7 @@

-

Checks if timer interval just passed. Restarting timer relies on user. If interval is 0 then always returns false.

+

Checks if timer interval just passed. Restarting timer relies on user. If timer interval is 0 then always returns false.

Returns
True if timer interval just passed, otherwise false.

References intervalMs, and lastTriggerTimeMs.

@@ -210,12 +222,12 @@

-

Checks if timer interval just passed. Restarting timer is automatic. If interval is 0 then always returns false.

+

Checks if timer interval just passed and resets the timer in this case. If timer interval is 0 then always returns false.

Returns
True if timer just triggered, otherwise false.

References hasTimePassed(), and restart().

-

Referenced by ksf::comps::ksWifiConfigurator::loop(), and ksf::comps::ksWifiConnector::loop().

+

Referenced by ksf::comps::ksDevStatMqttReporter::loop(), ksf::comps::ksWifiConfigurator::loop(), and ksf::comps::ksWifiConnector::loop().

diff --git a/classksf_1_1misc_1_1ks_w_s_server.html b/classksf_1_1misc_1_1ks_w_s_server.html index 879cdc6..bd05928 100644 --- a/classksf_1_1misc_1_1ks_w_s_server.html +++ b/classksf_1_1misc_1_1ks_w_s_server.html @@ -95,34 +95,34 @@

Public Member Functions

 ksWSServer (uint16_t port) - Prepares ksWebServer on specified port but does not start it (call begin).
+ Prepares ksWebServer on specified port without actually starting it.
  uint64_t getRequiredAuthToken () const - Returns simple authtoken for WebSocket authentication.
+ Returns simple authentication token for WebSocket authentication process.
  void setRequiredAuthToken (uint64_t authToken)  Sets simple authtoken for WebSocket authentication.
  void begin () - Starts the server listening on the specified port.
+ Starts the server.
  void loop () - Handles server logic.
+ Handles WebSocket server logic.
  void setMessageHandler (ksWsServerMessageFunc_t func) - Installs a message handler callback to WebSocket text receive messages.
+ Installs a message handler to receive WebSocket text messages.
  virtual ~ksWSServer () - Releases server resources.
+ Destructs the server, releasing the resources.
  - +

Protected Member Functions

void handleNonWebsocketConnection (WSclient_t *client) override
 Handles a situation wher the socket is not authorized.
 Handler for non-WebSocket connections on websocket port.
 
- - - - + + + + - - - + + + - + - - - + + +

@@ -156,10 +156,10 @@

-

Prepares ksWebServer on specified port but does not start it (call begin).

+

Prepares ksWebServer on specified port without actually starting it.

Parameters
- +
portWebSocket listening port.
portPort to listen for incoming WebSocket connections.
@@ -184,8 +184,9 @@

-

Returns simple authtoken for WebSocket authentication.

-

The value 0 is considered to be invalid (no auth token). Auth token is set via setRequiredAuthToken(). Generally, this token should be generated earlier, then the WebServer should use Cookie to transmit it to the browser and then the browser should pass it with WebSocket requests (via HTTP Cookie header).

+

Returns simple authentication token for WebSocket authentication process.

+

The value 0 is considered to be empty token. Authentication token is set via setRequiredAuthToken().

+

Generally, this token should be generated earlier, then the WebServer should use Cookie to transmit it to the browser and then the browser should pass it with WebSocket requests (via HTTP Cookie header).

Returns
Auth token for WebSocket

References requriedAuthToken.

@@ -215,10 +216,10 @@

-

Handles a situation wher the socket is not authorized.

+

Handler for non-WebSocket connections on websocket port.

Parameters
- +
clientWSclient_t * ptr to the client struct
clientSPointer to the WSclient_t object.
@@ -240,10 +241,10 @@

-

Installs a message handler callback to WebSocket text receive messages.

+

Installs a message handler to receive WebSocket text messages.

Parameters
- +
funcCallback function to receive messages
funcThe message handler function.
@@ -271,7 +272,7 @@

setRequiredAuthToken(). Generally, this token should be generated earlier, then the WebServer should use Cookie to transmit it to the browser and then the browser should pass it with WebSocket requests (via HTTP Cookie header).

Parameters
- +
authTokenThe token to set
authTokenThe token to set.
diff --git a/doxygen_crawl.html b/doxygen_crawl.html index 64b9ebb..8df638b 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -65,6 +65,8 @@ + + @@ -84,6 +86,13 @@ + + + + + + + diff --git a/functions.html b/functions.html index 7e72fea..97639ad 100644 --- a/functions.html +++ b/functions.html @@ -77,7 +77,7 @@

- a -

diff --git a/functions_func.html b/functions_func.html index 732b761..5e6d4c0 100644 --- a/functions_func.html +++ b/functions_func.html @@ -122,7 +122,7 @@

- h -

 Cksf::evt::ksEvent< const std::string_view &, bool &, std::string & >
 Cksf::evt::ksEvent< const std::string_view &, const std::string_view & >
 Cksf::evt::ksEvent< Params >
 Cksf::ksApplication
 Cksf::ksAppRotator< AppTypes >
 Cksf::ksCertFingerprint
 Cksf::ksConfig
 Cksf::ksApplicationA class that is a base for user-defined application
 Cksf::ksAppRotator< AppTypes >Application rotator component
 Cksf::ksCertFingerprintInterface for certificate fingerprint verification
 Cksf::ksConfigImplements low-level configuration file handling
 Cksf::comps::ksConfigParameterA structure that defines configuration parameter
 Cksf::evt::ksEventHandle
 ▼Cksf::ksRtti
 ▼Cksf::ksComponent
 ▼Cksf::comps::ksConfigProviderA component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage
 ▼Cksf::ksRttiImplements RTTI (run-time type information) for objects
 ▼Cksf::ksComponentBase component class
 ▼Cksf::comps::ksConfigProviderA component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage
 Cksf::comps::ksMqttConfigProviderA component that manages MQTT-related configuration
 Cksf::comps::ksDevStatMqttReporterA component that periodocally reports device state to the broker
 Cksf::comps::ksDevicePortal
 Cksf::comps::ksDevicePortalA component thet implements web-based configuration portal accessible from local network
 Cksf::comps::ksLedA component that simplifies driving the LED
 Cksf::comps::ksMqttConnectorA component which is responsible for MQTT connection management
 Cksf::comps::ksResetButtonA component that implements reset button functionality
 Cksf::comps::ksWifiConfigurator
 Cksf::comps::ksWifiConnector
 Cksf::ksSimpleTimer
 Cksf::comps::ksWifiConfiguratorKsWifiConfigurator component class
 Cksf::comps::ksWifiConnectorA component that manages WiFi connection
 Cksf::ksSimpleTimerSimple timer class, without using component architecture
 ▼CWebSocketsServerCore
 Cksf::misc::ksWSServer
diff --git a/ks_app_rotator_8h_source.html b/ks_app_rotator_8h_source.html index 7101272..6c6c5dc 100644 --- a/ks_app_rotator_8h_source.html +++ b/ks_app_rotator_8h_source.html @@ -112,57 +112,57 @@
36
37namespace ksf
38{
-
39 template <class... AppTypes>
-
-
40 class ksAppRotator
-
41 {
-
42 private:
-
43 uint8_t appIndex{0};
-
44 std::unique_ptr<ksApplication> currentApplication{nullptr};
-
45 typedef std::unique_ptr<ksApplication> (*TSpawnerFunc)();
-
46
-
51 template <class T>
-
52 static std::unique_ptr<ksApplication> spawnApp()
-
53 {
-
54 return std::make_unique<T>();
-
55 }
-
56
-
57 static constexpr std::array<TSpawnerFunc, sizeof...(AppTypes)> appSpawners{spawnApp<AppTypes>...};
-
58
-
59 public:
-
-
63 void loopNoDelay()
-
64 {
-
65 /* If current application is valid and we looped, then we're done. */
-
66 if (currentApplication && currentApplication->loop())
-
67 return;
-
68
-
69 /* Spawn application. */
-
70 currentApplication = appSpawners[appIndex]();
-
71
-
72 /* If not initialized, then destroy and try to do our business next delay. */
-
73 if (!currentApplication->init())
-
74 currentApplication.reset(nullptr);
-
75
-
76 /* Set next app index. */
-
77 if (++appIndex >= appSpawners.size())
-
78 appIndex = 0;
-
79 }
-
+
43 template <class... AppTypes>
+
+
44 class ksAppRotator
+
45 {
+
46 private:
+
47 uint8_t appIndex{0};
+
48 std::unique_ptr<ksApplication> currentApplication{nullptr};
+
49 typedef std::unique_ptr<ksApplication> (*TSpawnerFunc)();
+
50
+
56 template <class TApplicationType>
+
57 static std::unique_ptr<ksApplication> spawnApp()
+
58 {
+
59 return std::make_unique<TApplicationType>();
+
60 }
+
61
+
62 static constexpr std::array<TSpawnerFunc, sizeof...(AppTypes)> appSpawners{spawnApp<AppTypes>...};
+
63
+
64 public:
+
+
68 void loopNoDelay()
+
69 {
+
70 /* If current application is valid and we looped, then we're done. */
+
71 if (currentApplication && currentApplication->loop())
+
72 return;
+
73
+
74 /* Spawn application. */
+
75 currentApplication = appSpawners[appIndex]();
+
76
+
77 /* If not initialized, then destroy and try to do our business next delay. */
+
78 if (!currentApplication->init())
+
79 currentApplication.reset(nullptr);
80
-
-
85 void loop(unsigned long milliseconds)
-
86 {
-
87 loopNoDelay();
-
88 delay(milliseconds);
-
89 }
+
81 /* Set next app index. */
+
82 if (++appIndex >= appSpawners.size())
+
83 appIndex = 0;
+
84 }
+
+
85
+
+
90 void loop(unsigned long milliseconds)
+
91 {
+
92 loopNoDelay();
+
93 delay(milliseconds);
+
94 }
-
90 };
+
95 };
-
91}
-
ksf::ksAppRotator
Definition ksAppRotator.h:41
-
ksf::ksAppRotator::loopNoDelay
void loopNoDelay()
Runs the application loop.
Definition ksAppRotator.h:63
-
ksf::ksAppRotator::loop
void loop(unsigned long milliseconds)
Runs the application loop with a delay.
Definition ksAppRotator.h:85
+
96}
+
ksf::ksAppRotator
Application rotator component.
Definition ksAppRotator.h:45
+
ksf::ksAppRotator::loopNoDelay
void loopNoDelay()
Runs the application loop.
Definition ksAppRotator.h:68
+
ksf::ksAppRotator::loop
void loop(unsigned long milliseconds)
Runs application loop with a delay between loops.
Definition ksAppRotator.h:90
diff --git a/ks_application_8h_source.html b/ks_application_8h_source.html index 7d1deac..a1e0cd3 100644 --- a/ks_application_8h_source.html +++ b/ks_application_8h_source.html @@ -102,95 +102,96 @@
17
18#if APP_LOG_ENABLED
19typedef std::function<void(std::string&)> AppLogProviderFunc_t;
-
20typedef std::function<void(std::string&)> AppLogCallbackFunc_t;
+
20typedef std::function<void(std::string&&)> AppLogCallbackFunc_t;
21#endif
22
23namespace ksf
24{
25 class ksComponent;
-
-
26 class ksApplication
-
27 {
-
28 protected:
-
29 std::list<std::shared_ptr<ksComponent>> components;
-
30
-
31#if APP_LOG_ENABLED
-
32 AppLogCallbackFunc_t appLogCallback;
-
33#endif
-
34 public:
-
45 template <class TComponentType, class... TParams>
-
-
46 std::weak_ptr<TComponentType> addComponent(TParams... arg)
-
47 {
-
48 static_assert(!std::is_same_v<decltype(&ksComponent::getInstanceType), decltype(&TComponentType::getInstanceType)>,
-
49 "You're calling addComponent, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
-
50 );
-
51
-
52 auto componentSp{std::make_shared<TComponentType>(arg...)};
-
53 auto componentWp{std::weak_ptr<TComponentType>(componentSp)};
-
54 components.push_front(std::move(componentSp));
-
55 return componentWp;
-
56 }
-
-
57
-
62 template <class TComponentType>
+
26
+
+
42 class ksApplication
+
43 {
+
44 protected:
+
45 std::list<std::shared_ptr<ksComponent>> components;
+
46
+
47#if APP_LOG_ENABLED
+
48 AppLogCallbackFunc_t appLogCallback;
+
49#endif
+
50 public:
+
62 template <class TComponentType, class... TParams>
-
63 void findComponents(std::vector<std::weak_ptr<TComponentType>>& outComponents)
+
63 std::weak_ptr<TComponentType> addComponent(TParams... arg)
64 {
65 static_assert(!std::is_same_v<decltype(&ksComponent::getInstanceType), decltype(&TComponentType::getInstanceType)>,
-
66 "You're calling findComponents, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
+
66 "You're calling addComponent, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
67 );
68
-
69 outComponents.clear();
-
70
-
71 for (const auto& comp : components)
-
72 {
-
73 if (comp->isA(TComponentType::getClassType()))
-
74 {
-
75 std::weak_ptr<TComponentType> castedCompWp{std::static_pointer_cast<TComponentType>(comp)};
-
76 if (!castedCompWp.expired())
-
77 outComponents.push_back(std::move(castedCompWp));
-
78 }
-
79 }
-
80 }
+
69 auto componentSp{std::make_shared<TComponentType>(arg...)};
+
70 auto componentWp{std::weak_ptr<TComponentType>(componentSp)};
+
71 components.push_front(std::move(componentSp));
+
72 return componentWp;
+
73 }
-
81
-
86 template <class TComponentType>
-
-
87 std::weak_ptr<TComponentType> findComponent()
-
88 {
-
89 static_assert(!std::is_same_v<decltype(&ksComponent::getInstanceType), decltype(&TComponentType::getInstanceType)>,
-
90 "You're calling findComponent, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
-
91 );
-
92
-
93 for (const auto& comp : components)
-
94 if (comp->isA(TComponentType::getClassType()))
-
95 return std::static_pointer_cast<TComponentType>(comp);
-
96
-
97 return std::weak_ptr<TComponentType>();
+
74
+
80 template <class TComponentType>
+
+
81 void findComponents(std::vector<std::weak_ptr<TComponentType>>& outComponents)
+
82 {
+
83 static_assert(!std::is_same_v<decltype(&ksComponent::getInstanceType), decltype(&TComponentType::getInstanceType)>,
+
84 "You're calling findComponents, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
+
85 );
+
86
+
87 outComponents.clear();
+
88
+
89 for (const auto& comp : components)
+
90 {
+
91 if (comp->isA(TComponentType::getClassType()))
+
92 {
+
93 std::weak_ptr<TComponentType> castedCompWp{std::static_pointer_cast<TComponentType>(comp)};
+
94 if (!castedCompWp.expired())
+
95 outComponents.push_back(std::move(castedCompWp));
+
96 }
+
97 }
98 }
99
-
104 virtual bool init() = 0;
-
105
-
110 virtual bool loop();
+
105 template <class TComponentType>
+
+
106 std::weak_ptr<TComponentType> findComponent()
+
107 {
+
108 static_assert(!std::is_same_v<decltype(&ksComponent::getInstanceType), decltype(&TComponentType::getInstanceType)>,
+
109 "You're calling findComponent, but provided type lacks RTTI implementation. Did you miss KSF_RTTI_DECLARATIONS?"
+
110 );
111
-
112#if APP_LOG_ENABLED
-
117 void log(AppLogProviderFunc_t provideLogFn) const;
+
112 for (const auto& comp : components)
+
113 if (comp->isA(TComponentType::getClassType()))
+
114 return std::static_pointer_cast<TComponentType>(comp);
+
115
+
116 return std::weak_ptr<TComponentType>();
+
117 }
+
118
-
123 void setLogCallback(AppLogCallbackFunc_t logCallback);
-
124#endif
-
125 };
+
123 virtual bool init() = 0;
+
124
+
129 virtual bool loop();
+
130
+
131#if APP_LOG_ENABLED
+
136 void log(AppLogProviderFunc_t provideLogFn) const;
+
137
+
142 void setLogCallback(AppLogCallbackFunc_t logCallback);
+
143#endif
+
144 };
-
126}
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksApplication::components
std::list< std::shared_ptr< ksComponent > > components
An array with shared_ptr of components (holding main reference).
Definition ksApplication.h:29
-
ksf::ksApplication::loop
virtual bool loop()
Executes application loop.
Definition ksApplication.cpp:15
-
ksf::ksApplication::findComponent
std::weak_ptr< TComponentType > findComponent()
Looks for a component of passed type and returns a weak pointer to it.
Definition ksApplication.h:87
-
ksf::ksApplication::findComponents
void findComponents(std::vector< std::weak_ptr< TComponentType > > &outComponents)
Looks for all components of passed type and puts them into passed vector.
Definition ksApplication.h:63
-
ksf::ksApplication::addComponent
std::weak_ptr< TComponentType > addComponent(TParams... arg)
Instantiates a component of passed type.
Definition ksApplication.h:46
+
145}
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksApplication::components
std::list< std::shared_ptr< ksComponent > > components
An array with shared_ptr of components (holding main reference).
Definition ksApplication.h:45
+
ksf::ksApplication::loop
virtual bool loop()
Executes application logic loop.
Definition ksApplication.cpp:15
+
ksf::ksApplication::findComponent
std::weak_ptr< TComponentType > findComponent()
Iterates through all components and returns a weak pointer to the first component that matches the ty...
Definition ksApplication.h:106
+
ksf::ksApplication::findComponents
void findComponents(std::vector< std::weak_ptr< TComponentType > > &outComponents)
Iterates through all components and returns a vector of weak pointers with components that matches th...
Definition ksApplication.h:81
+
ksf::ksApplication::addComponent
std::weak_ptr< TComponentType > addComponent(TParams... arg)
Instantiates a component of the type defined by the template instance. This function will pass all te...
Definition ksApplication.h:63
ksf::ksApplication::init
virtual bool init()=0
Initializes application.
-
ksf::ksComponent::getInstanceType
virtual const size_t getInstanceType() const
This function is used to get type ID of object.
Definition ksComponent.h:46
+
ksf::ksComponent::getInstanceType
virtual const size_t getInstanceType() const
Retrieves type ID of the object.
Definition ksComponent.h:52
diff --git a/ks_cert_utils_8h_source.html b/ks_cert_utils_8h_source.html index 232cecb..578f878 100644 --- a/ks_cert_utils_8h_source.html +++ b/ks_cert_utils_8h_source.html @@ -101,47 +101,47 @@
16
17namespace ksf
18{
-
-
19 class ksCertFingerprint
-
20 {
-
21 protected:
-
29 bool fingerprintToBytes(const std::string& fingerprint, uint8_t* bytes, uint8_t bytesLen) const;
-
30
-
31 public:
-
38 virtual bool setup(WiFiClientSecure* client, const std::string& fingerprint);
-
39
-
45 virtual bool verify(WiFiClientSecure* client) const;
-
46 };
+
+
25 class ksCertFingerprint
+
26 {
+
27 protected:
+
35 bool fingerprintToBytes(const std::string& fingerprint, uint8_t* bytes, uint8_t bytesLen) const;
+
36
+
37 public:
+
44 virtual bool setup(WiFiClientSecure* client, const std::string& fingerprint);
+
45
+
51 virtual bool verify(WiFiClientSecure* client) const;
+
52 };
-
47
-
48#ifdef ESP32
-
49 class ksCertFingerprintESP32 : public ksCertFingerprint
-
50 {
-
51 private:
-
52 uint8_t fingerprintBytes[32];
53
-
54 public:
-
64 bool setup(WiFiClientSecure* client, const std::string& fingerprint) override;
-
65
-
71 bool verify(WiFiClientSecure* client) const override;
-
72 };
-
73
-
74 using ksCertFingerprintHolder = ksCertFingerprintESP32;
-
75#endif
-
76
-
77#ifdef ESP8266
-
78 class ksCertFingerprintESP8266 : public ksCertFingerprint
-
79 {
-
80 public:
-
87 bool setup(WiFiClientSecure* client, const std::string& fingerprint) override;
-
88
-
97 bool verify(WiFiClientSecure* client) const override;
-
98 };
-
99
-
100 using ksCertFingerprintHolder = ksCertFingerprintESP8266;
-
101#endif
-
102}
-
ksf::ksCertFingerprint
Definition ksCertUtils.h:20
+
54#ifdef ESP32
+
55 class ksCertFingerprintESP32 : public ksCertFingerprint
+
56 {
+
57 private:
+
58 uint8_t fingerprintBytes[32];
+
59
+
60 public:
+
70 bool setup(WiFiClientSecure* client, const std::string& fingerprint) override;
+
71
+
77 bool verify(WiFiClientSecure* client) const override;
+
78 };
+
79
+
80 using ksCertFingerprintHolder = ksCertFingerprintESP32;
+
81#endif
+
82
+
83#ifdef ESP8266
+
84 class ksCertFingerprintESP8266 : public ksCertFingerprint
+
85 {
+
86 public:
+
93 bool setup(WiFiClientSecure* client, const std::string& fingerprint) override;
+
94
+
103 bool verify(WiFiClientSecure* client) const override;
+
104 };
+
105
+
106 using ksCertFingerprintHolder = ksCertFingerprintESP8266;
+
107#endif
+
108}
+
ksf::ksCertFingerprint
Interface for certificate fingerprint verification.
Definition ksCertUtils.h:26
ksf::ksCertFingerprint::fingerprintToBytes
bool fingerprintToBytes(const std::string &fingerprint, uint8_t *bytes, uint8_t bytesLen) const
Converts fingerprint string into array of bytes.
Definition ksCertUtils.cpp:33
ksf::ksCertFingerprint::verify
virtual bool verify(WiFiClientSecure *client) const
Performs certificate fingerprint validation (platform dependent).
ksf::ksCertFingerprint::setup
virtual bool setup(WiFiClientSecure *client, const std::string &fingerprint)
Performs certificate fingerprint setup (platform dependent).
diff --git a/ks_component_8h_source.html b/ks_component_8h_source.html index 0011ea2..60a30f5 100644 --- a/ks_component_8h_source.html +++ b/ks_component_8h_source.html @@ -112,32 +112,32 @@
41 };
42 }
43
-
-
44 class ksComponent : public ksRtti
-
45 {
-
46 KSF_RTTI_DECLARATIONS(ksComponent, ksRtti)
-
47
-
48 friend class ksApplication;
-
49
-
50 protected:
-
52 ksComponentState::TYPE componentState { ksComponentState::NotInitialized };
+
+
50 class ksComponent : public ksRtti
+
51 {
+
52 KSF_RTTI_DECLARATIONS(ksComponent, ksRtti)
53
-
54 public:
-
60 virtual bool init(ksApplication* app);
-
61
-
66 virtual bool loop(ksApplication* app);
+
54 friend class ksApplication;
+
55
+
56 protected:
+
58 ksComponentState::TYPE componentState { ksComponentState::NotInitialized };
+
59
+
60 public:
+
66 virtual bool init(ksApplication* app);
67
-
73 virtual bool postInit(ksApplication* app);
-
74 };
+
73 virtual bool loop(ksApplication* app);
+
74
+
80 virtual bool postInit(ksApplication* app);
+
81 };
-
75}
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
+
82}
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
ksf::ksComponent::init
virtual bool init(ksApplication *app)
Initializes component.
Definition ksComponent.cpp:14
-
ksf::ksComponent::componentState
ksComponentState::TYPE componentState
Definition ksComponent.h:52
-
ksf::ksComponent::postInit
virtual bool postInit(ksApplication *app)
Method called after component initialization.
Definition ksComponent.cpp:24
-
ksf::ksComponent::loop
virtual bool loop(ksApplication *app)
Called from application loop.
Definition ksComponent.cpp:19
-
ksf::ksRtti
Definition ksRtti.h:18
+
ksf::ksComponent::componentState
ksComponentState::TYPE componentState
Definition ksComponent.h:58
+
ksf::ksComponent::postInit
virtual bool postInit(ksApplication *app)
Method called after component initialization, used to setup references to other components.
Definition ksComponent.cpp:24
+
ksf::ksComponent::loop
virtual bool loop(ksApplication *app)
Handles component loop logic, called from application loop.
Definition ksComponent.cpp:19
+
ksf::ksRtti
Implements RTTI (run-time type information) for objects.
Definition ksRtti.h:26
diff --git a/ks_config_8h_source.html b/ks_config_8h_source.html index 4d7098e..7222966 100644 --- a/ks_config_8h_source.html +++ b/ks_config_8h_source.html @@ -97,41 +97,41 @@
12#include <string>
13#include <map>
14
-
18#define USING_CONFIG_FILE(fileName) \
-
19 if (ksf::ksConfig config_file{ksf::ksConfig(fileName)})
-
20
-
21namespace ksf
-
22{
-
-
23 class ksConfig
-
24 {
-
25 protected:
-
26 bool isDirty{false};
-
27 std::map<std::string, std::string> configParams;
-
28 std::string configPath;
-
29
-
30 public:
-
35 ksConfig(const std::string& fileName);
+
19#define USING_CONFIG_FILE(fileName) \
+
20 if (ksf::ksConfig config_file{ksf::ksConfig(fileName)})
+
21
+
22namespace ksf
+
23{
+
+
30 class ksConfig
+
31 {
+
32 protected:
+
33 bool isDirty{false};
+
34 std::map<std::string, std::string> configParams;
+
35 std::string configPath;
36
-
45 void setParam(const std::string& paramName, const std::string paramValue);
-
46
-
56 const std::string& getParam(const std::string& paramName, const std::string& defaultValue = std::string()) const;
-
57
-
62 operator bool() const;
-
63
+
37 public:
+
42 ksConfig(const std::string& fileName);
+
43
+
49 void setParam(const std::string& paramName, const std::string paramValue);
+
50
+
57 const std::string& getParam(const std::string& paramName, const std::string& defaultValue = std::string()) const;
+
58
+
63 operator bool() const;
+
64
69 virtual ~ksConfig();
70 };
71}
72
-
ksf::ksConfig
Definition ksConfig.h:24
-
ksf::ksConfig::configParams
std::map< std::string, std::string > configParams
Config parameters.
Definition ksConfig.h:27
-
ksf::ksConfig::~ksConfig
virtual ~ksConfig()
Saves config content to flash.
Definition ksConfig.cpp:73
+
ksf::ksConfig
Implements low-level configuration file handling.
Definition ksConfig.h:31
+
ksf::ksConfig::configParams
std::map< std::string, std::string > configParams
Config parameters.
Definition ksConfig.h:34
+
ksf::ksConfig::~ksConfig
virtual ~ksConfig()
Saves config content on the device filesystem. In case there is no modification, nothing should actua...
Definition ksConfig.cpp:73
ksf::ksConfig::getParam
const std::string & getParam(const std::string &paramName, const std::string &defaultValue=std::string()) const
Retrieves parameter value.
Definition ksConfig.cpp:62
-
ksf::ksConfig::configPath
std::string configPath
Config filename.
Definition ksConfig.h:28
-
ksf::ksConfig::setParam
void setParam(const std::string &paramName, const std::string paramValue)
Sets parameter value.
Definition ksConfig.cpp:56
-
ksf::ksConfig::ksConfig
ksConfig(const std::string &fileName)
Constructor that opens (or creates) specified config file and loads its contents into memory.
Definition ksConfig.cpp:16
-
ksf::ksConfig::isDirty
bool isDirty
True if config contents has been modified (and should be saved).
Definition ksConfig.h:26
+
ksf::ksConfig::configPath
std::string configPath
Config filename.
Definition ksConfig.h:35
+
ksf::ksConfig::setParam
void setParam(const std::string &paramName, const std::string paramValue)
Sets parameter value (creates new parameter if it does not exist).
Definition ksConfig.cpp:56
+
ksf::ksConfig::ksConfig
ksConfig(const std::string &fileName)
Constructor tha opens or creates configuration file.
Definition ksConfig.cpp:16
+
ksf::ksConfig::isDirty
bool isDirty
True if config contents has been modified (and should be saved).
Definition ksConfig.h:33
diff --git a/ks_config_provider_8h_source.html b/ks_config_provider_8h_source.html index a44515e..d4445b8 100644 --- a/ks_config_provider_8h_source.html +++ b/ks_config_provider_8h_source.html @@ -108,57 +108,62 @@
23
24namespace ksf::comps
25{
-
26 namespace EConfigParamType
-
27 {
-
28 enum Type
-
29 {
-
30 Text,
-
31 Password,
-
32 Number
-
33 };
-
34 };
-
35
-
-
39 struct ksConfigParameter
-
40 {
-
41 std::string id;
-
42 std::string defaultValue;
-
43 std::string value;
-
44 EConfigParamType::Type type{};
-
45 int maxLength{};
-
46 };
+
+
29 namespace EConfigParamType
+
30 {
+
+
34 enum Type
+
35 {
+
36 Text,
+
37 Password,
+
38 Number
+
39 };
-
47
-
-
60 class ksConfigProvider : public ksComponent
-
61 {
-
62 KSF_RTTI_DECLARATIONS(ksConfigProvider, ksComponent)
-
63
-
64 protected:
-
65 std::list<ksConfigParameter> params;
-
66
-
75 void addNewParam(std::string id, std::string value, int maxLength = 50, EConfigParamType::Type type = {});
-
76
-
86 void addNewParamWithConfigDefault(ksConfig& config, std::string id, int maxLength = 50, EConfigParamType::Type type = {});
-
87
-
88 public:
-
92 std::list<ksConfigParameter>& getParameters();
+
40 };
+
+
41
+
+
45 struct ksConfigParameter
+
46 {
+
47 std::string id;
+
48 std::string defaultValue;
+
49 std::string value;
+
50 EConfigParamType::Type type{};
+
51 int maxLength{};
+
52 };
+
+
53
+
+
66 class ksConfigProvider : public ksComponent
+
67 {
+
68 KSF_RTTI_DECLARATIONS(ksConfigProvider, ksComponent)
+
69
+
70 protected:
+
71 std::list<ksConfigParameter> params;
+
72
+
81 void addNewParam(std::string id, std::string value, int maxLength = 50, EConfigParamType::Type type = {});
+
82
+
92 void addNewParamWithConfigDefault(ksConfig& config, std::string id, int maxLength = 50, EConfigParamType::Type type = {});
93
-
97 virtual void readParams() = 0;
-
98
-
102 virtual void saveParams() = 0;
-
103 };
+
94 public:
+
98 std::list<ksConfigParameter>& getParameters();
+
99
+
103 virtual void readParams() = 0;
+
104
+
108 virtual void saveParams() = 0;
+
109 };
-
104}
-
ksf::comps::ksConfigProvider
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:61
+
110}
+
ksf::comps::ksConfigProvider
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:67
ksf::comps::ksConfigProvider::readParams
virtual void readParams()=0
Populates the parameter list by processing the configuration file.
ksf::comps::ksConfigProvider::saveParams
virtual void saveParams()=0
Outputs the parameter list to the configuration file.
ksf::comps::ksConfigProvider::getParameters
std::list< ksConfigParameter > & getParameters()
Provides const reference to the list of managed parameters.
Definition ksConfigProvider.cpp:34
ksf::comps::ksConfigProvider::addNewParam
void addNewParam(std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
Defines new configutation parameter.
Definition ksConfigProvider.cpp:15
ksf::comps::ksConfigProvider::addNewParamWithConfigDefault
void addNewParamWithConfigDefault(ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
Defines new configuation parameter (with default value).
Definition ksConfigProvider.cpp:28
-
ksf::ksComponent
Definition ksComponent.h:45
-
ksf::ksConfig
Definition ksConfig.h:24
-
ksf::comps::ksConfigParameter
A structure that defines configuration parameter.
Definition ksConfigProvider.h:40
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
+
ksf::ksConfig
Implements low-level configuration file handling.
Definition ksConfig.h:31
+
ksf::comps::EConfigParamType::Type
Type
Configuration parameter type enum.
Definition ksConfigProvider.h:35
+
ksf::comps::ksConfigParameter
A structure that defines configuration parameter.
Definition ksConfigProvider.h:46
diff --git a/ks_constants_8h_source.html b/ks_constants_8h_source.html index 5dd4daf..a4f42ad 100644 --- a/ks_constants_8h_source.html +++ b/ks_constants_8h_source.html @@ -130,65 +130,73 @@
57
58namespace ksf
59{
-
60 namespace EOTAType
-
61 {
-
62 enum Type
-
63 {
-
65 NO_OTA,
-
67 OTA_GENERIC,
-
69 OTA_PORTAL,
-
70 };
-
71 }
-
72
-
77 extern const char* getNvsDirectory();
+
+
63 namespace EOTAType
+
64 {
+
+
68 enum Type
+
69 {
+
71 NO_OTA,
+
73 OTA_GENERIC,
+
75 OTA_PORTAL,
+
76 };
+
+
77 }
+
78
-
82 extern void initializeFramework();
-
83
-
89 extern bool removeDirectory(const char* path);
-
90
-
95 extern bool eraseConfigData();
+
83 extern const char* getNvsDirectory();
+
84
+
88 extern void initializeFramework();
+
89
+
95 extern bool removeDirectory(const char* path);
96
-
100 extern void updateDeviceUptime();
-
101
-
106 extern uint64_t millis64();
+
101 extern bool eraseConfigData();
+
102
+
106 extern void updateDeviceUptime();
107
-
116 extern std::string to_string(double value, const int base);
-
117
-
127 extern std::string to_string(float value, const int base);
-
128
-
134 template <typename _Type>
-
135 inline std::string to_string(const _Type& input)
-
136 {
-
137 return std::to_string(input);
-
138 }
-
139
-
146 template <typename _In, typename _Out>
-
147 bool from_chars(const _In& input, _Out& out)
-
148 {
-
149 const auto& result{std::from_chars(input.data(), input.data() + input.size(), out)};
-
150 return result.ec == std::errc();
-
151 }
-
152
-
157 extern EOTAType::Type getOtaBootType();
-
158
-
166 extern void saveOtaBootIndicator(EOTAType::Type type = EOTAType::OTA_GENERIC);
-
167
-
173 template<class _Type1, class _Type2>
-
174 inline bool starts_with(const _Type1& input, const _Type2& match)
-
175 {
-
176 return input.size() >= match.size() && std::equal(match.begin(), match.end(), input.begin());
-
177 }
-
178
-
182 extern const std::string getResetReason();
-
183
-
189 extern const std::string getUptimeFromSeconds(uint32_t seconds);
-
190
-
195 extern const std::string getUptimeString();
-
196
-
202 extern void loadCredentials(std::string& ssid, std::string& password);
-
203
-
209 extern void saveCredentials(std::string ssid, std::string password);
-
210}
+
112 extern uint64_t millis64();
+
113
+
122 extern std::string to_string(double value, const int base);
+
123
+
133 extern std::string to_string(float value, const int base);
+
134
+
143 template <typename _Type>
+
144 inline std::string to_string(const _Type& input)
+
145 {
+
146 return std::to_string(input);
+
147 }
+
148
+
159 template <typename _In, typename _Out>
+
160 bool from_chars(const _In& input, _Out& out)
+
161 {
+
162 const auto& result{std::from_chars(input.data(), input.data() + input.size(), out)};
+
163 return result.ec == std::errc();
+
164 }
+
165
+
174 extern EOTAType::Type getOtaBootType();
+
175
+
183 extern void saveOtaBootIndicator(EOTAType::Type type = EOTAType::OTA_GENERIC);
+
184
+
196 template<class _Type1, class _Type2>
+
197 inline bool starts_with(const _Type1& input, const _Type2& match)
+
198 {
+
199 return input.size() >= match.size() && std::equal(match.begin(), match.end(), input.begin());
+
200 }
+
201
+
205 extern const std::string getResetReason();
+
206
+
212 extern const std::string getUptimeFromSeconds(uint32_t seconds);
+
213
+
218 extern const std::string getUptimeString();
+
219
+
225 extern void loadCredentials(std::string& ssid, std::string& password);
+
226
+
232 extern void saveCredentials(std::string ssid, std::string password);
+
233}
+
ksf::EOTAType::Type
Type
OTA boot type enum.
Definition ksConstants.h:69
+
ksf::EOTAType::NO_OTA
@ NO_OTA
Definition ksConstants.h:71
+
ksf::EOTAType::OTA_PORTAL
@ OTA_PORTAL
Definition ksConstants.h:75
+
ksf::EOTAType::OTA_GENERIC
@ OTA_GENERIC
Definition ksConstants.h:73
diff --git a/ks_dev_stat_mqtt_reporter_8h_source.html b/ks_dev_stat_mqtt_reporter_8h_source.html index 438f0b7..d43265f 100644 --- a/ks_dev_stat_mqtt_reporter_8h_source.html +++ b/ks_dev_stat_mqtt_reporter_8h_source.html @@ -117,25 +117,26 @@
50 void reportDevStats() const;
51
52 public:
-
53 ksDevStatMqttReporter(uint8_t intervalInSeconds = 60);
-
54
-
63 bool postInit(ksApplication* app) override;
-
64
-
70 bool loop(ksApplication* app) override;
-
71 };
+
57 ksDevStatMqttReporter(uint8_t intervalInSeconds = 60);
+
58
+
67 bool postInit(ksApplication* app) override;
+
68
+
74 bool loop(ksApplication* app) override;
+
75 };
-
72}
+
76}
ksf::comps::ksDevStatMqttReporter
A component that periodocally reports device state to the broker.
Definition ksDevStatMqttReporter.h:30
-
ksf::comps::ksDevStatMqttReporter::reportDevStats
void reportDevStats() const
Reports device statistics to the broker.
Definition ksDevStatMqttReporter.cpp:45
+
ksf::comps::ksDevStatMqttReporter::reportDevStats
void reportDevStats() const
Reports device statistics to the MQTT broker.
Definition ksDevStatMqttReporter.cpp:45
ksf::comps::ksDevStatMqttReporter::onConnected
void onConnected()
Calback executed on MQTT connection.
Definition ksDevStatMqttReporter.cpp:40
ksf::comps::ksDevStatMqttReporter::loop
bool loop(ksApplication *app) override
Handles MQTT debug connector component loop logic.
Definition ksDevStatMqttReporter.cpp:57
ksf::comps::ksDevStatMqttReporter::postInit
bool postInit(ksApplication *app) override
Handles component post-initialization.
Definition ksDevStatMqttReporter.cpp:30
ksf::comps::ksDevStatMqttReporter::reporterTimer
ksSimpleTimer reporterTimer
Timer to report device stats.
Definition ksDevStatMqttReporter.h:36
ksf::comps::ksDevStatMqttReporter::connEventHandle
std::unique_ptr< evt::ksEventHandle > connEventHandle
Event handle for connection delegate.
Definition ksDevStatMqttReporter.h:35
ksf::comps::ksDevStatMqttReporter::mqttConnWp
std::weak_ptr< ksMqttConnector > mqttConnWp
Weak pointer to MQTT connector.
Definition ksDevStatMqttReporter.h:34
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
-
ksf::ksSimpleTimer
Definition ksSimpleTimer.h:17
+
ksf::comps::ksDevStatMqttReporter::ksDevStatMqttReporter
ksDevStatMqttReporter(uint8_t intervalInSeconds=60)
Constructs device statistics reporter component.
Definition ksDevStatMqttReporter.cpp:26
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
+
ksf::ksSimpleTimer
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27
diff --git a/ks_device_portal_8h_source.html b/ks_device_portal_8h_source.html index 712e246..6d1696c 100644 --- a/ks_device_portal_8h_source.html +++ b/ks_device_portal_8h_source.html @@ -122,116 +122,117 @@
37namespace ksf::comps
38{
39 class ksMqttConnector;
-
-
40 class ksDevicePortal : public ksComponent
-
41 {
-
42 KSF_RTTI_DECLARATIONS(ksDevicePortal, ksComponent)
-
43
-
44 protected:
-
45 ksf::ksApplication* app{nullptr};
-
46
-
47 bool breakApp : 1 {false};
-
48 uint32_t logKeepAliveTimestamp{0};
-
49 uint32_t lastLoopExecutionTimestamp{0};
-
50 uint32_t loopExecutionTime{0};
-
51 uint32_t scanNetworkTimestamp{0};
-
52
-
53 std::string portalPassword;
-
54 std::weak_ptr<ksMqttConnector> mqttConnectorWp;
-
55
-
56 std::unique_ptr<WebServerClass> webServer;
-
57 std::unique_ptr<misc::ksWSServer> webSocket;
-
58 std::unique_ptr<DNSServer> dnsServer;
-
59 std::unique_ptr<ArduinoOTAClass> arduinoOTA;
-
60
-
64 void requestAppBreak() { breakApp = true; }
+
40
+
+
50 class ksDevicePortal : public ksComponent
+
51 {
+
52 KSF_RTTI_DECLARATIONS(ksDevicePortal, ksComponent)
+
53
+
54 protected:
+
55 ksf::ksApplication* app{nullptr};
+
56
+
57 bool breakApp : 1 {false};
+
58 uint32_t logKeepAliveTimestamp{0};
+
59 uint32_t lastLoopExecutionTimestamp{0};
+
60 uint32_t loopExecutionTime{0};
+
61 uint32_t scanNetworkTimestamp{0};
+
62
+
63 std::string portalPassword;
+
64 std::weak_ptr<ksMqttConnector> mqttConnectorWp;
65
-
69 void setupHttpServer();
+
66 std::unique_ptr<WebServerClass> webServer;
+
67 std::unique_ptr<misc::ksWSServer> webSocket;
+
68 std::unique_ptr<DNSServer> dnsServer;
+
69 std::unique_ptr<ArduinoOTAClass> arduinoOTA;
70
-
74 void setupWsServer();
+
74 void requestAppBreak() { breakApp = true; }
75
-
79 void updateFinished(bool fromPortal);
+
79 void setupHttpServer();
80
-
84 void rebootDevice();
+
84 void setupWsServer();
85
-
89 bool inRequest_NeedAuthentication();
+
89 void updateFinished(bool fromPortal);
90
-
94 void onRequest_notFound() const;
+
94 void rebootDevice();
95
-
99 void onRequest_index();
+
99 bool inRequest_NeedAuthentication();
100
-
106 void onRequest_otaChunk();
+
106 void onRequest_notFound() const;
107
-
113 void onRequest_otaFinish();
+
113 void onRequest_index();
114
-
120 void onWebsocketTextMessage(uint8_t clientNum, const std::string_view& message);
-
121
-
126 void handle_scanNetworks(std::string& response);
-
127
-
132 void handle_getIdentity(std::string& response);
-
133
-
138 void handle_getDeviceParams(std::string& response);
-
139
-
145 std::string handle_executeCommand(const std::string_view& body);
-
146
-
151 void onAppLog(std::string& msgRef);
-
152
-
153 public:
-
155 DECLARE_KS_EVENT(onUpdateStart)
-
157 DECLARE_KS_EVENT(onUpdateEnd)
-
159 DECLARE_KS_EVENT(onHandlePortalCommand, const std::string_view&, bool&, std::string&)
-
160
-
166 ksDevicePortal();
-
167
-
172 ksDevicePortal(std::string portalPassword);
-
173
-
179 bool init(ksApplication* app) override;
-
180
-
186 bool postInit(ksApplication* app) override;
-
187
-
193 bool loop(ksApplication* app) override;
-
194
-
198 virtual ~ksDevicePortal();
-
199 };
+
121 void onRequest_otaChunk();
+
122
+
129 void onRequest_otaFinish();
+
130
+
136 void onWebsocketTextMessage(uint8_t clientNum, const std::string_view& message);
+
137
+
142 void handle_scanNetworks(std::string& response);
+
143
+
148 void handle_getIdentity(std::string& response);
+
149
+
154 void handle_getDeviceParams(std::string& response);
+
155
+
161 std::string handle_executeCommand(const std::string_view& body);
+
162
+
167 void onAppLog(std::string&& message);
+
168
+
169 public:
+
173 DECLARE_KS_EVENT(onUpdateStart)
+
177 DECLARE_KS_EVENT(onUpdateEnd)
+
184 DECLARE_KS_EVENT(onHandlePortalCommand, const std::string_view&, bool&, std::string&)
+
185
+
191 ksDevicePortal();
+
192
+
198 ksDevicePortal(std::string portalPassword);
+
199
+
205 bool init(ksApplication* app) override;
+
206
+
212 bool postInit(ksApplication* app) override;
+
213
+
219 bool loop(ksApplication* app) override;
+
220
+
224 virtual ~ksDevicePortal();
+
225 };
-
200}
-
ksf::comps::ksDevicePortal
Definition ksDevicePortal.h:41
-
ksf::comps::ksDevicePortal::arduinoOTA
std::unique_ptr< ArduinoOTAClass > arduinoOTA
Arduino OTA object.
Definition ksDevicePortal.h:59
-
ksf::comps::ksDevicePortal::app
ksf::ksApplication * app
Application pointer.
Definition ksDevicePortal.h:45
-
ksf::comps::ksDevicePortal::onWebsocketTextMessage
void onWebsocketTextMessage(uint8_t clientNum, const std::string_view &message)
This function handles incomming websocket messages.
Definition ksDevicePortal.cpp:217
-
ksf::comps::ksDevicePortal::init
bool init(ksApplication *app) override
Initializes device portal component.
Definition ksDevicePortal.cpp:116
-
ksf::comps::ksDevicePortal::setupWsServer
void setupWsServer()
This function starts WebSocket server.
Definition ksDevicePortal.cpp:610
-
ksf::comps::ksDevicePortal::updateFinished
void updateFinished(bool fromPortal)
This function is called when OTA update is finished.
Definition ksDevicePortal.cpp:199
-
ksf::comps::ksDevicePortal::portalPassword
std::string portalPassword
Portal password.
Definition ksDevicePortal.h:53
-
ksf::comps::ksDevicePortal::postInit
bool postInit(ksApplication *app) override
Post initialization method for device portal with integrated OTA.
Definition ksDevicePortal.cpp:126
-
ksf::comps::ksDevicePortal::mqttConnectorWp
std::weak_ptr< ksMqttConnector > mqttConnectorWp
MQTT connector.
Definition ksDevicePortal.h:54
-
ksf::comps::ksDevicePortal::requestAppBreak
void requestAppBreak()
Causes the app to break from loop with false status.
Definition ksDevicePortal.h:64
-
ksf::comps::ksDevicePortal::scanNetworkTimestamp
uint32_t scanNetworkTimestamp
Timestamp of last scan.
Definition ksDevicePortal.h:51
-
ksf::comps::ksDevicePortal::breakApp
bool breakApp
Flag to restart chip.
Definition ksDevicePortal.h:47
-
ksf::comps::ksDevicePortal::handle_executeCommand
std::string handle_executeCommand(const std::string_view &body)
This function handles command execution.
Definition ksDevicePortal.cpp:158
-
ksf::comps::ksDevicePortal::onHandlePortalCommand
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, bool &, std::string & > > onHandlePortalCommand
Definition ksDevicePortal.h:159
-
ksf::comps::ksDevicePortal::webSocket
std::unique_ptr< misc::ksWSServer > webSocket
Web socket server.
Definition ksDevicePortal.h:57
-
ksf::comps::ksDevicePortal::onUpdateEnd
std::shared_ptr< ksf::evt::ksEvent<> > onUpdateEnd
Definition ksDevicePortal.h:157
-
ksf::comps::ksDevicePortal::onRequest_index
void onRequest_index()
This function serves main page to the client.
Definition ksDevicePortal.cpp:560
-
ksf::comps::ksDevicePortal::onRequest_otaChunk
void onRequest_otaChunk()
This function is called for each OTA chunk.
Definition ksDevicePortal.cpp:512
-
ksf::comps::ksDevicePortal::onRequest_notFound
void onRequest_notFound() const
This function handles "not found" error.
Definition ksDevicePortal.cpp:498
-
ksf::comps::ksDevicePortal::logKeepAliveTimestamp
uint32_t logKeepAliveTimestamp
Flag indicating whether logs are enabled.
Definition ksDevicePortal.h:48
-
ksf::comps::ksDevicePortal::onUpdateStart
std::shared_ptr< ksf::evt::ksEvent<> > onUpdateStart
Definition ksDevicePortal.h:155
-
ksf::comps::ksDevicePortal::dnsServer
std::unique_ptr< DNSServer > dnsServer
DNS server.
Definition ksDevicePortal.h:58
-
ksf::comps::ksDevicePortal::loop
bool loop(ksApplication *app) override
Handles device portal component loop logic.
Definition ksDevicePortal.cpp:619
-
ksf::comps::ksDevicePortal::handle_getIdentity
void handle_getIdentity(std::string &response)
This function handles identity request.
Definition ksDevicePortal.cpp:338
-
ksf::comps::ksDevicePortal::inRequest_NeedAuthentication
bool inRequest_NeedAuthentication()
This function handles authentication error.
Definition ksDevicePortal.cpp:205
-
ksf::comps::ksDevicePortal::onRequest_otaFinish
void onRequest_otaFinish()
This function is called when OTA update is finished.
Definition ksDevicePortal.cpp:543
-
ksf::comps::ksDevicePortal::onAppLog
void onAppLog(std::string &msgRef)
This function handles logging.
Definition ksDevicePortal.cpp:143
-
ksf::comps::ksDevicePortal::lastLoopExecutionTimestamp
uint32_t lastLoopExecutionTimestamp
Time of last loop execution (us)/.
Definition ksDevicePortal.h:49
-
ksf::comps::ksDevicePortal::rebootDevice
void rebootDevice()
This function handles device reboot.
Definition ksDevicePortal.cpp:152
-
ksf::comps::ksDevicePortal::setupHttpServer
void setupHttpServer()
This function starts OTA update server.
Definition ksDevicePortal.cpp:580
-
ksf::comps::ksDevicePortal::loopExecutionTime
uint32_t loopExecutionTime
Diff (loop exec time).
Definition ksDevicePortal.h:50
-
ksf::comps::ksDevicePortal::webServer
std::unique_ptr< WebServerClass > webServer
HTTP server.
Definition ksDevicePortal.h:56
-
ksf::comps::ksDevicePortal::handle_scanNetworks
void handle_scanNetworks(std::string &response)
This function handles scanning networks.
Definition ksDevicePortal.cpp:384
-
ksf::comps::ksDevicePortal::handle_getDeviceParams
void handle_getDeviceParams(std::string &response)
This function handles device params request.
Definition ksDevicePortal.cpp:431
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
+
226}
+
ksf::comps::ksDevicePortal
A component thet implements web-based configuration portal accessible from local network.
Definition ksDevicePortal.h:51
+
ksf::comps::ksDevicePortal::arduinoOTA
std::unique_ptr< ArduinoOTAClass > arduinoOTA
Arduino OTA object.
Definition ksDevicePortal.h:69
+
ksf::comps::ksDevicePortal::app
ksf::ksApplication * app
Application pointer.
Definition ksDevicePortal.h:55
+
ksf::comps::ksDevicePortal::onWebsocketTextMessage
void onWebsocketTextMessage(uint8_t clientNum, const std::string_view &message)
Handles websocket text message.
Definition ksDevicePortal.cpp:217
+
ksf::comps::ksDevicePortal::init
bool init(ksApplication *app) override
Initializes the device portal component.
Definition ksDevicePortal.cpp:116
+
ksf::comps::ksDevicePortal::setupWsServer
void setupWsServer()
Starts device portal WebSocket server.
Definition ksDevicePortal.cpp:610
+
ksf::comps::ksDevicePortal::updateFinished
void updateFinished(bool fromPortal)
Implements post-OTA update actions.
Definition ksDevicePortal.cpp:199
+
ksf::comps::ksDevicePortal::portalPassword
std::string portalPassword
Portal password.
Definition ksDevicePortal.h:63
+
ksf::comps::ksDevicePortal::postInit
bool postInit(ksApplication *app) override
Post-initializes the device portal component.
Definition ksDevicePortal.cpp:126
+
ksf::comps::ksDevicePortal::mqttConnectorWp
std::weak_ptr< ksMqttConnector > mqttConnectorWp
MQTT connector.
Definition ksDevicePortal.h:64
+
ksf::comps::ksDevicePortal::requestAppBreak
void requestAppBreak()
Causes the application exit (and ksAppRotator to spawn and process next defined application).
Definition ksDevicePortal.h:74
+
ksf::comps::ksDevicePortal::scanNetworkTimestamp
uint32_t scanNetworkTimestamp
Timestamp of last scan.
Definition ksDevicePortal.h:61
+
ksf::comps::ksDevicePortal::breakApp
bool breakApp
Flag to restart chip.
Definition ksDevicePortal.h:57
+
ksf::comps::ksDevicePortal::handle_executeCommand
std::string handle_executeCommand(const std::string_view &body)
Websocket handler for user commands endpoint.
Definition ksDevicePortal.cpp:158
+
ksf::comps::ksDevicePortal::onHandlePortalCommand
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, bool &, std::string & > > onHandlePortalCommand
Definition ksDevicePortal.h:184
+
ksf::comps::ksDevicePortal::webSocket
std::unique_ptr< misc::ksWSServer > webSocket
Web socket server.
Definition ksDevicePortal.h:67
+
ksf::comps::ksDevicePortal::onAppLog
void onAppLog(std::string &&message)
Broadcasts application log message to all connected Websocket clients.
Definition ksDevicePortal.cpp:143
+
ksf::comps::ksDevicePortal::onUpdateEnd
std::shared_ptr< ksf::evt::ksEvent<> > onUpdateEnd
Definition ksDevicePortal.h:177
+
ksf::comps::ksDevicePortal::onRequest_index
void onRequest_index()
HTTP handler for index endpoint.
Definition ksDevicePortal.cpp:560
+
ksf::comps::ksDevicePortal::onRequest_otaChunk
void onRequest_otaChunk()
HTTP handler for OTA chunk endpoint.
Definition ksDevicePortal.cpp:512
+
ksf::comps::ksDevicePortal::onRequest_notFound
void onRequest_notFound() const
HTTP handler for 404 "not found" endpoint.
Definition ksDevicePortal.cpp:498
+
ksf::comps::ksDevicePortal::logKeepAliveTimestamp
uint32_t logKeepAliveTimestamp
Flag indicating whether logs are enabled.
Definition ksDevicePortal.h:58
+
ksf::comps::ksDevicePortal::onUpdateStart
std::shared_ptr< ksf::evt::ksEvent<> > onUpdateStart
Definition ksDevicePortal.h:173
+
ksf::comps::ksDevicePortal::dnsServer
std::unique_ptr< DNSServer > dnsServer
DNS server.
Definition ksDevicePortal.h:68
+
ksf::comps::ksDevicePortal::loop
bool loop(ksApplication *app) override
Handles core logic of the device portal component.
Definition ksDevicePortal.cpp:619
+
ksf::comps::ksDevicePortal::handle_getIdentity
void handle_getIdentity(std::string &response)
Websocket handler for identity endpoint (device details).
Definition ksDevicePortal.cpp:338
+
ksf::comps::ksDevicePortal::inRequest_NeedAuthentication
bool inRequest_NeedAuthentication()
Checks if current HTTP request requires authentication.
Definition ksDevicePortal.cpp:205
+
ksf::comps::ksDevicePortal::onRequest_otaFinish
void onRequest_otaFinish()
HTTP handler for OTA finish endpoint.
Definition ksDevicePortal.cpp:543
+
ksf::comps::ksDevicePortal::lastLoopExecutionTimestamp
uint32_t lastLoopExecutionTimestamp
Time of last loop execution (us)/.
Definition ksDevicePortal.h:59
+
ksf::comps::ksDevicePortal::rebootDevice
void rebootDevice()
Reboots the device.
Definition ksDevicePortal.cpp:152
+
ksf::comps::ksDevicePortal::setupHttpServer
void setupHttpServer()
Starts device portal HTTP server.
Definition ksDevicePortal.cpp:580
+
ksf::comps::ksDevicePortal::loopExecutionTime
uint32_t loopExecutionTime
Diff (loop exec time).
Definition ksDevicePortal.h:60
+
ksf::comps::ksDevicePortal::webServer
std::unique_ptr< WebServerClass > webServer
HTTP server.
Definition ksDevicePortal.h:66
+
ksf::comps::ksDevicePortal::handle_scanNetworks
void handle_scanNetworks(std::string &response)
Websocket handler for network scan endpoint.
Definition ksDevicePortal.cpp:384
+
ksf::comps::ksDevicePortal::handle_getDeviceParams
void handle_getDeviceParams(std::string &response)
Websocket handler for device parameters endpoint.
Definition ksDevicePortal.cpp:431
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
diff --git a/ks_led_8h_source.html b/ks_led_8h_source.html index ba44b06..faf1dbf 100644 --- a/ks_led_8h_source.html +++ b/ks_led_8h_source.html @@ -153,8 +153,8 @@
ksf::comps::ksLed::loop
bool loop(ksApplication *app) override
Executes core of the LED component logic.
Definition ksLed.cpp:29
ksf::comps::ksLed::setBlinking
void setBlinking(uint32_t blinkIntervalMs, uint32_t blinkLoops=0)
Sets LED blinking pattern.
Definition ksLed.cpp:50
ksf::comps::ksLed::isEnabled
bool isEnabled() const
Returns whether the LED is actually enabled.
Definition ksLed.cpp:45
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
diff --git a/ks_mqtt_config_provider_8h_source.html b/ks_mqtt_config_provider_8h_source.html index 6e77c39..c5c2450 100644 --- a/ks_mqtt_config_provider_8h_source.html +++ b/ks_mqtt_config_provider_8h_source.html @@ -115,7 +115,7 @@
50 };
51}
-
ksf::comps::ksConfigProvider
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:61
+
ksf::comps::ksConfigProvider
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:67
ksf::comps::ksMqttConfigProvider
A component that manages MQTT-related configuration.
Definition ksMqttConfigProvider.h:26
ksf::comps::ksMqttConfigProvider::saveParams
void saveParams() override
Saves MQTT aprameters into the configuration file.
Definition ksMqttConfigProvider.cpp:75
ksf::comps::ksMqttConfigProvider::setupMqttConnector
void setupMqttConnector(ksMqttConnector &connector)
Setup MQTT connector with captured parameters.
Definition ksMqttConfigProvider.cpp:31
diff --git a/ks_mqtt_connector_8h_source.html b/ks_mqtt_connector_8h_source.html index ccb78db..5c167e4 100644 --- a/ks_mqtt_connector_8h_source.html +++ b/ks_mqtt_connector_8h_source.html @@ -116,112 +116,110 @@
38 KSF_RTTI_DECLARATIONS(ksMqttConnector, ksComponent)
39
40 protected:
-
41
-
42#if APP_LOG_ENABLED
-
43 ksApplication* app{nullptr};
-
44#endif
-
45
-
46 std::unique_ptr<WiFiClient> wifiClientSp;
-
47 std::unique_ptr<PubSubClient> mqttClientSp;
+
41#if APP_LOG_ENABLED
+
42 ksApplication* app{nullptr};
+
43#endif
+
44 std::unique_ptr<WiFiClient> wifiClientSp;
+
45 std::unique_ptr<PubSubClient> mqttClientSp;
+
46
+
47 std::weak_ptr<ksWifiConnector> wifiConnWp;
48
-
49 std::weak_ptr<ksWifiConnector> wifiConnWp;
-
50
-
51 uint64_t lastSuccessConnectionTime{0};
-
52 uint32_t reconnectCounter{0};
-
53
-
54 bool sendConnectionStatus : 1 {true};
-
55 bool usePersistentSession : 1 {false};
-
56 bool wasConnected : 1 {false};
+
49 uint64_t lastSuccessConnectionTime{0};
+
50 uint32_t reconnectCounter{0};
+
51
+
52 bool sendConnectionStatus : 1 {true};
+
53 bool usePersistentSession : 1 {false};
+
54 bool wasConnected : 1 {false};
+
55
+
56 ksSimpleTimer reconnectTimer{KSF_MQTT_RECONNECT_DELAY_MS};
57
-
58 ksSimpleTimer reconnectTimer{KSF_MQTT_RECONNECT_DELAY_MS};
-
59
-
60 std::string login;
-
61 std::string password;
-
62 std::string prefix;
+
58 std::string login;
+
59 std::string password;
+
60 std::string prefix;
+
61
+
62 std::unique_ptr<ksCertFingerprint> certFingerprint;
63
-
64 std::unique_ptr<ksCertFingerprint> certFingerprint;
-
65
-
71 bool connectToBroker();
-
72
-
78 void mqttConnectedInternal();
-
79
-
86 void mqttMessageInternal(const char* topic, const uint8_t* payload, uint32_t length);
-
87
-
88 public:
-
89 enum class QosLevel
-
90 {
-
91 QOS_AT_LEAST_ONCE,
-
92 QOS_EXACTLY_ONCE
-
93 };
-
94
-
95 DECLARE_KS_EVENT(onDeviceMessage, const std::string_view&, const std::string_view&)
-
96 DECLARE_KS_EVENT(onAnyMessage, const std::string_view&, const std::string_view&)
-
97
-
98 DECLARE_KS_EVENT(onConnected)
-
99 DECLARE_KS_EVENT(onDisconnected)
-
100
-
107 ksMqttConnector(bool sendConnectionStatus = true, bool usePersistentSession = false);
-
108
-
115 bool init(ksApplication* owner) override;
-
116
-
125 bool postInit(ksApplication* owner) override;
-
126
-
131 bool loop(ksApplication* app) override;
-
132
-
137 bool isConnected() const;
-
138
-
143 uint32_t getConnectionTimeSeconds() const;
-
144
-
149 uint32_t getReconnectCounter() const { return reconnectCounter; }
-
150
-
157 void subscribe(const std::string& topic, bool skipDevicePrefix = false, ksMqttConnector::QosLevel = ksMqttConnector::QosLevel::QOS_AT_LEAST_ONCE);
-
158
-
164 void unsubscribe(const std::string& topic, bool skipDevicePrefix = false);
-
165
-
173 void publish(const std::string& topic, const std::string& payload, bool retain = false, bool skipDevicePrefix = false);
-
174
-
183 void setupConnection(const std::string& broker, const std::string& port, std::string login, std::string password, std::string prefix, const std::string& fingerprint);
-
184
-
188 virtual ~ksMqttConnector();
-
189 };
+
69 bool connectToBroker();
+
70
+
76 void mqttConnectedInternal();
+
77
+
84 void mqttMessageInternal(const char* topic, const uint8_t* payload, uint32_t length);
+
85
+
86 public:
+
87 enum class QosLevel
+
88 {
+
89 QOS_AT_LEAST_ONCE,
+
90 QOS_EXACTLY_ONCE
+
91 };
+
92
+
93 DECLARE_KS_EVENT(onDeviceMessage, const std::string_view&, const std::string_view&)
+
94 DECLARE_KS_EVENT(onAnyMessage, const std::string_view&, const std::string_view&)
+
95
+
96 DECLARE_KS_EVENT(onConnected)
+
97 DECLARE_KS_EVENT(onDisconnected)
+
98
+
105 ksMqttConnector(bool sendConnectionStatus = true, bool usePersistentSession = false);
+
106
+
113 bool init(ksApplication* app) override;
+
114
+
123 bool postInit(ksApplication* app) override;
+
124
+
129 bool loop(ksApplication* app) override;
+
130
+
135 bool isConnected() const;
+
136
+
141 uint32_t getConnectionTimeSeconds() const;
+
142
+
147 uint32_t getReconnectCounter() const { return reconnectCounter; }
+
148
+
155 void subscribe(const std::string& topic, bool skipDevicePrefix = false, ksMqttConnector::QosLevel = ksMqttConnector::QosLevel::QOS_AT_LEAST_ONCE);
+
156
+
162 void unsubscribe(const std::string& topic, bool skipDevicePrefix = false);
+
163
+
171 void publish(const std::string& topic, const std::string& payload, bool retain = false, bool skipDevicePrefix = false);
+
172
+
181 void setupConnection(const std::string& broker, const std::string& port, std::string login, std::string password, std::string prefix, const std::string& fingerprint);
+
182
+
186 virtual ~ksMqttConnector();
+
187 };
-
190 }
-
191}
+
188 }
+
189}
ksf::comps::ksMqttConnector
A component which is responsible for MQTT connection management.
Definition ksMqttConnector.h:37
-
ksf::comps::ksMqttConnector::wifiConnWp
std::weak_ptr< ksWifiConnector > wifiConnWp
Weak pointer to WiFi connector.
Definition ksMqttConnector.h:49
-
ksf::comps::ksMqttConnector::onDeviceMessage
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, const std::string_view & > > onDeviceMessage
onDeviceMessage event that user can bind to.
Definition ksMqttConnector.h:95
-
ksf::comps::ksMqttConnector::postInit
bool postInit(ksApplication *owner) override
Method that handles component post-initialization.
Definition ksMqttConnector.cpp:58
-
ksf::comps::ksMqttConnector::prefix
std::string prefix
Saved MQTT prefix.
Definition ksMqttConnector.h:62
+
ksf::comps::ksMqttConnector::wifiConnWp
std::weak_ptr< ksWifiConnector > wifiConnWp
Weak pointer to WiFi connector.
Definition ksMqttConnector.h:47
+
ksf::comps::ksMqttConnector::onDeviceMessage
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, const std::string_view & > > onDeviceMessage
onDeviceMessage event that user can bind to.
Definition ksMqttConnector.h:93
+
ksf::comps::ksMqttConnector::prefix
std::string prefix
Saved MQTT prefix.
Definition ksMqttConnector.h:60
ksf::comps::ksMqttConnector::subscribe
void subscribe(const std::string &topic, bool skipDevicePrefix=false, ksMqttConnector::QosLevel=ksMqttConnector::QosLevel::QOS_AT_LEAST_ONCE)
Subscribes to MQTT topic.
Definition ksMqttConnector.cpp:156
-
ksf::comps::ksMqttConnector::getReconnectCounter
uint32_t getReconnectCounter() const
Retrieves MQTT reconnect counter.
Definition ksMqttConnector.h:149
-
ksf::comps::ksMqttConnector::wifiClientSp
std::unique_ptr< WiFiClient > wifiClientSp
Shared pointer to WiFiClient used to connect to MQTT.
Definition ksMqttConnector.h:46
-
ksf::comps::ksMqttConnector::lastSuccessConnectionTime
uint64_t lastSuccessConnectionTime
Time of connection to MQTT broker in seconds.
Definition ksMqttConnector.h:51
+
ksf::comps::ksMqttConnector::getReconnectCounter
uint32_t getReconnectCounter() const
Retrieves MQTT reconnect counter.
Definition ksMqttConnector.h:147
+
ksf::comps::ksMqttConnector::wifiClientSp
std::unique_ptr< WiFiClient > wifiClientSp
Shared pointer to WiFiClient used to connect to MQTT.
Definition ksMqttConnector.h:44
+
ksf::comps::ksMqttConnector::init
bool init(ksApplication *app) override
Instantiates the MQTT connector component.
Definition ksMqttConnector.cpp:40
+
ksf::comps::ksMqttConnector::lastSuccessConnectionTime
uint64_t lastSuccessConnectionTime
Time of connection to MQTT broker in seconds.
Definition ksMqttConnector.h:49
ksf::comps::ksMqttConnector::~ksMqttConnector
virtual ~ksMqttConnector()
Destructor (for uniqueptr purposes).
ksf::comps::ksMqttConnector::loop
bool loop(ksApplication *app) override
Executes MQTT connection logic.
Definition ksMqttConnector.cpp:222
-
ksf::comps::ksMqttConnector::certFingerprint
std::unique_ptr< ksCertFingerprint > certFingerprint
Shared pointer to fingerprint validator.
Definition ksMqttConnector.h:64
-
ksf::comps::ksMqttConnector::login
std::string login
Saved MQTT login.
Definition ksMqttConnector.h:60
-
ksf::comps::ksMqttConnector::usePersistentSession
bool usePersistentSession
Use persistent session or not.
Definition ksMqttConnector.h:55
+
ksf::comps::ksMqttConnector::certFingerprint
std::unique_ptr< ksCertFingerprint > certFingerprint
Shared pointer to fingerprint validator.
Definition ksMqttConnector.h:62
+
ksf::comps::ksMqttConnector::login
std::string login
Saved MQTT login.
Definition ksMqttConnector.h:58
+
ksf::comps::ksMqttConnector::usePersistentSession
bool usePersistentSession
Use persistent session or not.
Definition ksMqttConnector.h:53
ksf::comps::ksMqttConnector::getConnectionTimeSeconds
uint32_t getConnectionTimeSeconds() const
Retrieves connection time in seconds.
Definition ksMqttConnector.cpp:257
-
ksf::comps::ksMqttConnector::sendConnectionStatus
bool sendConnectionStatus
Send connection status to MQTT or not.
Definition ksMqttConnector.h:54
+
ksf::comps::ksMqttConnector::sendConnectionStatus
bool sendConnectionStatus
Send connection status to MQTT or not.
Definition ksMqttConnector.h:52
ksf::comps::ksMqttConnector::setupConnection
void setupConnection(const std::string &broker, const std::string &port, std::string login, std::string password, std::string prefix, const std::string &fingerprint)
Sets up MQTT connection.
Definition ksMqttConnector.cpp:64
ksf::comps::ksMqttConnector::unsubscribe
void unsubscribe(const std::string &topic, bool skipDevicePrefix=false)
Unsubscribes the MQTT topic.
Definition ksMqttConnector.cpp:162
ksf::comps::ksMqttConnector::isConnected
bool isConnected() const
Retrieves connection state.
Definition ksMqttConnector.cpp:252
-
ksf::comps::ksMqttConnector::onDisconnected
std::shared_ptr< ksf::evt::ksEvent<> > onDisconnected
onDisconnected event that user can bind to.
Definition ksMqttConnector.h:99
+
ksf::comps::ksMqttConnector::onDisconnected
std::shared_ptr< ksf::evt::ksEvent<> > onDisconnected
onDisconnected event that user can bind to.
Definition ksMqttConnector.h:97
ksf::comps::ksMqttConnector::publish
void publish(const std::string &topic, const std::string &payload, bool retain=false, bool skipDevicePrefix=false)
Publishes a message to the MQTT topic.
Definition ksMqttConnector.cpp:167
ksf::comps::ksMqttConnector::mqttConnectedInternal
void mqttConnectedInternal()
Connects to the MQTT broker (internal function).
Definition ksMqttConnector.cpp:119
ksf::comps::ksMqttConnector::connectToBroker
bool connectToBroker()
Connects to the MQTT broker.
Definition ksMqttConnector.cpp:184
-
ksf::comps::ksMqttConnector::onAnyMessage
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, const std::string_view & > > onAnyMessage
onAnyMessage event that user can bind to.
Definition ksMqttConnector.h:96
-
ksf::comps::ksMqttConnector::reconnectTimer
ksSimpleTimer reconnectTimer
Timer that counts time between reconnection attempts.
Definition ksMqttConnector.h:58
-
ksf::comps::ksMqttConnector::onConnected
std::shared_ptr< ksf::evt::ksEvent<> > onConnected
onConnected event that user can bind to.
Definition ksMqttConnector.h:98
+
ksf::comps::ksMqttConnector::onAnyMessage
std::shared_ptr< ksf::evt::ksEvent< const std::string_view &, const std::string_view & > > onAnyMessage
onAnyMessage event that user can bind to.
Definition ksMqttConnector.h:94
+
ksf::comps::ksMqttConnector::reconnectTimer
ksSimpleTimer reconnectTimer
Timer that counts time between reconnection attempts.
Definition ksMqttConnector.h:56
+
ksf::comps::ksMqttConnector::postInit
bool postInit(ksApplication *app) override
Method that handles component post-initialization.
Definition ksMqttConnector.cpp:58
+
ksf::comps::ksMqttConnector::onConnected
std::shared_ptr< ksf::evt::ksEvent<> > onConnected
onConnected event that user can bind to.
Definition ksMqttConnector.h:96
ksf::comps::ksMqttConnector::mqttMessageInternal
void mqttMessageInternal(const char *topic, const uint8_t *payload, uint32_t length)
Called when MQTT message arrives (internal function).
Definition ksMqttConnector.cpp:126
-
ksf::comps::ksMqttConnector::password
std::string password
Saved MQTT password.
Definition ksMqttConnector.h:61
-
ksf::comps::ksMqttConnector::mqttClientSp
std::unique_ptr< PubSubClient > mqttClientSp
Shared pointer to PubSubClient used to connect to MQTT.
Definition ksMqttConnector.h:47
-
ksf::comps::ksMqttConnector::reconnectCounter
uint32_t reconnectCounter
MQTT reconnection counter.
Definition ksMqttConnector.h:52
-
ksf::comps::ksMqttConnector::init
bool init(ksApplication *owner) override
Instantiates the MQTT connector component.
Definition ksMqttConnector.cpp:40
-
ksf::comps::ksMqttConnector::wasConnected
bool wasConnected
True if connected in previous loop.
Definition ksMqttConnector.h:56
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
-
ksf::ksSimpleTimer
Definition ksSimpleTimer.h:17
+
ksf::comps::ksMqttConnector::password
std::string password
Saved MQTT password.
Definition ksMqttConnector.h:59
+
ksf::comps::ksMqttConnector::mqttClientSp
std::unique_ptr< PubSubClient > mqttClientSp
Shared pointer to PubSubClient used to connect to MQTT.
Definition ksMqttConnector.h:45
+
ksf::comps::ksMqttConnector::reconnectCounter
uint32_t reconnectCounter
MQTT reconnection counter.
Definition ksMqttConnector.h:50
+
ksf::comps::ksMqttConnector::wasConnected
bool wasConnected
True if connected in previous loop.
Definition ksMqttConnector.h:54
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
+
ksf::ksSimpleTimer
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27
diff --git a/ks_reset_button_8h_source.html b/ks_reset_button_8h_source.html index 6d08e9b..2049b6e 100644 --- a/ks_reset_button_8h_source.html +++ b/ks_reset_button_8h_source.html @@ -137,8 +137,8 @@
ksf::comps::ksResetButton::lastState
uint8_t lastState
Previous state (for debouncing).
Definition ksResetButton.h:32
ksf::comps::ksResetButton::ksResetButton
ksResetButton(uint8_t pin, uint8_t triggerState, uint8_t mode=INPUT)
Constructs the reset button component.
Definition ksResetButton.cpp:30
ksf::comps::ksResetButton::init
bool init(ksApplication *app) override
Initializes the reset button component.
Definition ksResetButton.cpp:34
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
diff --git a/ks_rtti_8h_source.html b/ks_rtti_8h_source.html index 7858bef..f25f7f3 100644 --- a/ks_rtti_8h_source.html +++ b/ks_rtti_8h_source.html @@ -99,67 +99,67 @@
14
15namespace ksf
16{
-
-
17 class ksRtti
-
18 {
-
19 public:
-
24 virtual const size_t getInstanceType() const = 0;
-
25
-
-
31 virtual bool isA(const size_t id) const
-
32 {
-
33 return false;
-
34 }
+
+
25 class ksRtti
+
26 {
+
27 public:
+
32 virtual const size_t getInstanceType() const = 0;
+
33
+
+
39 virtual bool isA(const size_t id) const
+
40 {
+
41 return false;
+
42 }
-
35
-
40 template <typename TType>
-
-
41 TType* as()
-
42 {
-
43 if (is(TType::getClassType()))
-
44 return (TType*)this;
-
45
-
46 return nullptr;
-
47 }
+
43
+
49 template <typename TType>
+
+
50 TType* as()
+
51 {
+
52 if (is(TType::getClassType()))
+
53 return (TType*)this;
+
54
+
55 return nullptr;
+
56 }
-
48
-
53 template <typename TType>
-
-
54 const TType* as() const
-
55 {
-
56 if (is(TType::getClassType()))
-
57 return (TType*)this;
-
58
-
59 return nullptr;
-
60 }
+
57
+
63 template <typename TType>
+
+
64 const TType* as() const
+
65 {
+
66 if (is(TType::getClassType()))
+
67 return (TType*)this;
+
68
+
69 return nullptr;
+
70 }
-
61 };
+
71 };
-
62
-
63 #define KSF_RTTI_DECLARATIONS(_Type, _ParentType) \
-
64 public: \
-
65 virtual const size_t getInstanceType() const \
-
66 { \
-
67 return _Type::getClassType(); \
-
68 } \
-
69 static const size_t getClassType() \
-
70 { \
-
71 static int d{0}; return (size_t)&d; \
-
72 } \
-
73 virtual bool isA(const size_t id) const \
-
74 { \
-
75 if (id == getClassType()) \
-
76 return true; \
-
77 else \
-
78 return _ParentType::isA(id); \
-
79 } \
-
80 private:
-
81}
-
ksf::ksRtti
Definition ksRtti.h:18
-
ksf::ksRtti::as
const TType * as() const
This function is used to const cast object to given type.
Definition ksRtti.h:54
-
ksf::ksRtti::as
TType * as()
This function is used to cast object to given type.
Definition ksRtti.h:41
-
ksf::ksRtti::isA
virtual bool isA(const size_t id) const
This function is used to check if object is of given type.
Definition ksRtti.h:31
-
ksf::ksRtti::getInstanceType
virtual const size_t getInstanceType() const =0
This function is used to get type ID of object.
+
72
+
73 #define KSF_RTTI_DECLARATIONS(_Type, _ParentType) \
+
74 public: \
+
75 virtual const size_t getInstanceType() const \
+
76 { \
+
77 return _Type::getClassType(); \
+
78 } \
+
79 static const size_t getClassType() \
+
80 { \
+
81 static int d{0}; return (size_t)&d; \
+
82 } \
+
83 virtual bool isA(const size_t id) const \
+
84 { \
+
85 if (id == getClassType()) \
+
86 return true; \
+
87 else \
+
88 return _ParentType::isA(id); \
+
89 } \
+
90 private:
+
91}
+
ksf::ksRtti
Implements RTTI (run-time type information) for objects.
Definition ksRtti.h:26
+
ksf::ksRtti::as
const TType * as() const
Tries to cast object to the type provided as a template parameter (const version).
Definition ksRtti.h:64
+
ksf::ksRtti::as
TType * as()
Tries to cast object to the type provided as a template parameter.
Definition ksRtti.h:50
+
ksf::ksRtti::isA
virtual bool isA(const size_t id) const
Checks whether object is of given type.
Definition ksRtti.h:39
+
ksf::ksRtti::getInstanceType
virtual const size_t getInstanceType() const =0
Retrieves type ID of the object.
diff --git a/ks_simple_timer_8h_source.html b/ks_simple_timer_8h_source.html index 14450d0..8573792 100644 --- a/ks_simple_timer_8h_source.html +++ b/ks_simple_timer_8h_source.html @@ -98,34 +98,34 @@
13
14namespace ksf
15{
-
-
16 class ksSimpleTimer
-
17 {
-
18 protected:
-
19 uint32_t intervalMs{0};
-
20 uint32_t lastTriggerTimeMs{0};
-
21
-
22 public:
-
27 ksSimpleTimer(uint32_t intervalMs);
-
28
-
33 void setInterval(uint32_t intervalMs);
-
34
-
38 void restart();
-
39
-
45 bool triggered();
-
46
-
52 bool hasTimePassed() const;
-
53 };
+
+
26 class ksSimpleTimer
+
27 {
+
28 protected:
+
29 uint32_t intervalMs{0};
+
30 uint32_t lastTriggerTimeMs{0};
+
31
+
32 public:
+
37 ksSimpleTimer(uint32_t intervalMs);
+
38
+
43 void setInterval(uint32_t intervalMs);
+
44
+
48 void restart();
+
49
+
55 bool triggered();
+
56
+
62 bool hasTimePassed() const;
+
63 };
-
54}
-
ksf::ksSimpleTimer
Definition ksSimpleTimer.h:17
-
ksf::ksSimpleTimer::intervalMs
uint32_t intervalMs
Timer interval (milliseconds).
Definition ksSimpleTimer.h:19
+
64}
+
ksf::ksSimpleTimer
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27
+
ksf::ksSimpleTimer::intervalMs
uint32_t intervalMs
Timer interval (milliseconds).
Definition ksSimpleTimer.h:29
ksf::ksSimpleTimer::setInterval
void setInterval(uint32_t intervalMs)
Sets timer interval (milliseconds) and restarts the timer.
Definition ksSimpleTimer.cpp:21
-
ksf::ksSimpleTimer::triggered
bool triggered()
Checks if timer interval just passed. Restarting timer is automatic. If interval is 0 then always ret...
Definition ksSimpleTimer.cpp:32
+
ksf::ksSimpleTimer::triggered
bool triggered()
Checks if timer interval just passed and resets the timer in this case. If timer interval is 0 then a...
Definition ksSimpleTimer.cpp:32
ksf::ksSimpleTimer::restart
void restart()
Restarts timer. Will set last trigger time to current time w/o triggering the timer).
Definition ksSimpleTimer.cpp:43
ksf::ksSimpleTimer::ksSimpleTimer
ksSimpleTimer(uint32_t intervalMs)
Constructs timer with interval (milliseconds).
Definition ksSimpleTimer.cpp:16
-
ksf::ksSimpleTimer::hasTimePassed
bool hasTimePassed() const
Checks if timer interval just passed. Restarting timer relies on user. If interval is 0 then always r...
Definition ksSimpleTimer.cpp:27
-
ksf::ksSimpleTimer::lastTriggerTimeMs
uint32_t lastTriggerTimeMs
Last trigger time (milliseconds).
Definition ksSimpleTimer.h:20
+
ksf::ksSimpleTimer::hasTimePassed
bool hasTimePassed() const
Checks if timer interval just passed. Restarting timer relies on user. If timer interval is 0 then al...
Definition ksSimpleTimer.cpp:27
+
ksf::ksSimpleTimer::lastTriggerTimeMs
uint32_t lastTriggerTimeMs
Last trigger time (milliseconds).
Definition ksSimpleTimer.h:30
diff --git a/ks_w_s_server_8h_source.html b/ks_w_s_server_8h_source.html index 13d47f9..0649bc3 100644 --- a/ks_w_s_server_8h_source.html +++ b/ks_w_s_server_8h_source.html @@ -111,35 +111,35 @@
30 uint64_t requriedAuthToken{0};
31 ksWsServerMessageFunc_t onWebsocketTextMessage;
32
-
37 void handleNonWebsocketConnection(WSclient_t * client) override;
+
37 void handleNonWebsocketConnection(WSclient_t* client) override;
38
39 public:
44 ksWSServer(uint16_t port);
45
-
55 uint64_t getRequiredAuthToken() const;
-
56
-
66 void setRequiredAuthToken(uint64_t authToken);
-
67
-
71 void begin();
-
72
-
76 void loop();
-
77
-
82 void setMessageHandler(ksWsServerMessageFunc_t func);
-
83
-
87 virtual ~ksWSServer();
-
88 };
+
56 uint64_t getRequiredAuthToken() const;
+
57
+
67 void setRequiredAuthToken(uint64_t authToken);
+
68
+
72 void begin();
+
73
+
77 void loop();
+
78
+
83 void setMessageHandler(ksWsServerMessageFunc_t func);
+
84
+
88 virtual ~ksWSServer();
+
89 };
-
89}
+
90}
ksf::misc::ksWSServer
Definition ksWSServer.h:27
-
ksf::misc::ksWSServer::~ksWSServer
virtual ~ksWSServer()
Releases server resources.
Definition ksWSServer.cpp:21
-
ksf::misc::ksWSServer::begin
void begin()
Starts the server listening on the specified port.
Definition ksWSServer.cpp:26
-
ksf::misc::ksWSServer::loop
void loop()
Handles server logic.
Definition ksWSServer.cpp:59
-
ksf::misc::ksWSServer::ksWSServer
ksWSServer(uint16_t port)
Prepares ksWebServer on specified port but does not start it (call begin).
Definition ksWSServer.cpp:16
+
ksf::misc::ksWSServer::~ksWSServer
virtual ~ksWSServer()
Destructs the server, releasing the resources.
Definition ksWSServer.cpp:21
+
ksf::misc::ksWSServer::begin
void begin()
Starts the server.
Definition ksWSServer.cpp:26
+
ksf::misc::ksWSServer::loop
void loop()
Handles WebSocket server logic.
Definition ksWSServer.cpp:59
+
ksf::misc::ksWSServer::ksWSServer
ksWSServer(uint16_t port)
Prepares ksWebServer on specified port without actually starting it.
Definition ksWSServer.cpp:16
ksf::misc::ksWSServer::onWebsocketTextMessage
ksWsServerMessageFunc_t onWebsocketTextMessage
Callback function to receive messages.
Definition ksWSServer.h:31
-
ksf::misc::ksWSServer::getRequiredAuthToken
uint64_t getRequiredAuthToken() const
Returns simple authtoken for WebSocket authentication.
Definition ksWSServer.cpp:82
+
ksf::misc::ksWSServer::getRequiredAuthToken
uint64_t getRequiredAuthToken() const
Returns simple authentication token for WebSocket authentication process.
Definition ksWSServer.cpp:82
ksf::misc::ksWSServer::wsListener
std::unique_ptr< WiFiServer > wsListener
WS server (listener).
Definition ksWSServer.h:29
-
ksf::misc::ksWSServer::setMessageHandler
void setMessageHandler(ksWsServerMessageFunc_t func)
Installs a message handler callback to WebSocket text receive messages.
Definition ksWSServer.cpp:77
-
ksf::misc::ksWSServer::handleNonWebsocketConnection
void handleNonWebsocketConnection(WSclient_t *client) override
Handles a situation wher the socket is not authorized.
Definition ksWSServer.cpp:92
+
ksf::misc::ksWSServer::setMessageHandler
void setMessageHandler(ksWsServerMessageFunc_t func)
Installs a message handler to receive WebSocket text messages.
Definition ksWSServer.cpp:77
+
ksf::misc::ksWSServer::handleNonWebsocketConnection
void handleNonWebsocketConnection(WSclient_t *client) override
Handler for non-WebSocket connections on websocket port.
Definition ksWSServer.cpp:92
ksf::misc::ksWSServer::setRequiredAuthToken
void setRequiredAuthToken(uint64_t authToken)
Sets simple authtoken for WebSocket authentication.
Definition ksWSServer.cpp:87
ksf::misc::ksWSServer::requriedAuthToken
uint64_t requriedAuthToken
WS auth token.
Definition ksWSServer.h:30
diff --git a/ks_wifi_configurator_8h_source.html b/ks_wifi_configurator_8h_source.html index cd74292..3bb8f77 100644 --- a/ks_wifi_configurator_8h_source.html +++ b/ks_wifi_configurator_8h_source.html @@ -99,48 +99,48 @@
14#include "../ksSimpleTimer.h"
15namespace ksf::comps
16{
-
-
17 class ksWifiConfigurator : public ksComponent
-
18 {
-
19 KSF_RTTI_DECLARATIONS(ksWifiConfigurator, ksComponent)
-
20
-
21 protected:
-
22 ksApplication* owner{nullptr};
-
23 std::string deviceName;
-
24 ksf::ksSimpleTimer configTimeout{120 * 1000};
-
25 ksf::ksSimpleTimer periodicTasksTimeout{1000};
+
+
23 class ksWifiConfigurator : public ksComponent
+
24 {
+
25 KSF_RTTI_DECLARATIONS(ksWifiConfigurator, ksComponent)
26
-
30 void handlePeriodicTasks();
-
31
-
32 public:
-
36 ksWifiConfigurator();
+
27 protected:
+
28 ksApplication* app{nullptr};
+
29 std::string deviceName;
+
30 ksf::ksSimpleTimer configTimeout{120 * 1000};
+
31 ksf::ksSimpleTimer periodicTasksTimeout{1000};
+
32
+
36 void handlePeriodicTasks();
37
-
42 ksWifiConfigurator(std::string devicePrefixName);
+
38 public:
+
42 ksWifiConfigurator();
43
-
52 bool loop(ksApplication* app) override;
-
53
-
59 bool init(ksApplication* owner) override;
+
48 ksWifiConfigurator(std::string devicePrefixName);
+
49
+
59 bool loop(ksApplication* app) override;
60
-
69 bool postInit(ksApplication* owner) override;
-
70
-
74 virtual ~ksWifiConfigurator();
-
75 };
+
66 bool init(ksApplication* app) override;
+
67
+
73 bool postInit(ksApplication* app) override;
+
74
+
78 virtual ~ksWifiConfigurator();
+
79 };
-
76}
-
ksf::comps::ksWifiConfigurator
Definition ksWifiConfigurator.h:18
-
ksf::comps::ksWifiConfigurator::configTimeout
ksf::ksSimpleTimer configTimeout
Timeout for captive portal in ms.
Definition ksWifiConfigurator.h:24
-
ksf::comps::ksWifiConfigurator::postInit
bool postInit(ksApplication *owner) override
ksWifiConfigurator postInit function.
Definition ksWifiConfigurator.cpp:56
+
80}
+
ksf::comps::ksWifiConfigurator
ksWifiConfigurator component class.
Definition ksWifiConfigurator.h:24
+
ksf::comps::ksWifiConfigurator::configTimeout
ksf::ksSimpleTimer configTimeout
Timeout for captive portal in ms.
Definition ksWifiConfigurator.h:30
ksf::comps::ksWifiConfigurator::ksWifiConfigurator
ksWifiConfigurator()
Constructs WiFi configurator object.
Definition ksWifiConfigurator.cpp:29
ksf::comps::ksWifiConfigurator::handlePeriodicTasks
void handlePeriodicTasks()
Handles periodic tasks like WiFi management.
Definition ksWifiConfigurator.cpp:68
-
ksf::comps::ksWifiConfigurator::init
bool init(ksApplication *owner) override
ksWifiConfigurator init function.
Definition ksWifiConfigurator.cpp:48
-
ksf::comps::ksWifiConfigurator::~ksWifiConfigurator
virtual ~ksWifiConfigurator()
Destructor for WiFi configurator component.
Definition ksWifiConfigurator.cpp:82
+
ksf::comps::ksWifiConfigurator::app
ksApplication * app
Pointer to ksApplication object that owns this component.
Definition ksWifiConfigurator.h:28
+
ksf::comps::ksWifiConfigurator::~ksWifiConfigurator
virtual ~ksWifiConfigurator()
Destructs WiFi configurator component.
Definition ksWifiConfigurator.cpp:82
ksf::comps::ksWifiConfigurator::loop
bool loop(ksApplication *app) override
Handles ksWifiConfigurator logic.
Definition ksWifiConfigurator.cpp:74
-
ksf::comps::ksWifiConfigurator::periodicTasksTimeout
ksf::ksSimpleTimer periodicTasksTimeout
Timeout for loop in ms.
Definition ksWifiConfigurator.h:25
-
ksf::comps::ksWifiConfigurator::owner
ksApplication * owner
Pointer to ksApplication object that owns this component.
Definition ksWifiConfigurator.h:22
-
ksf::comps::ksWifiConfigurator::deviceName
std::string deviceName
Device name (prefix).
Definition ksWifiConfigurator.h:23
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
-
ksf::ksSimpleTimer
Definition ksSimpleTimer.h:17
+
ksf::comps::ksWifiConfigurator::periodicTasksTimeout
ksf::ksSimpleTimer periodicTasksTimeout
Timeout for loop in ms.
Definition ksWifiConfigurator.h:31
+
ksf::comps::ksWifiConfigurator::init
bool init(ksApplication *app) override
Implements ksWifiConfigurator initialization logic.
Definition ksWifiConfigurator.cpp:48
+
ksf::comps::ksWifiConfigurator::deviceName
std::string deviceName
Device name (prefix).
Definition ksWifiConfigurator.h:29
+
ksf::comps::ksWifiConfigurator::postInit
bool postInit(ksApplication *app) override
Implements ksWifiConfigurator post-initialization logic.
Definition ksWifiConfigurator.cpp:56
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
+
ksf::ksSimpleTimer
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27
diff --git a/ks_wifi_connector_8h_source.html b/ks_wifi_connector_8h_source.html index f71ee10..fe35f3b 100644 --- a/ks_wifi_connector_8h_source.html +++ b/ks_wifi_connector_8h_source.html @@ -100,61 +100,61 @@
15
16namespace ksf::comps
17{
-
-
18 class ksWifiConnector : public ksComponent
-
19 {
-
20 KSF_RTTI_DECLARATIONS(ksWifiConnector, ksComponent)
-
21
-
22 protected:
-
23 ksSimpleTimer wifiTimeoutTimer{KSF_WIFI_TIMEOUT_MS};
-
24 ksSimpleTimer wifiReconnectTimer{KSF_WIFI_RECONNECT_TIME_MS};
-
25 ksSimpleTimer wifiIpCheckTimer{KSF_ONE_SEC_MS};
-
26
-
27 bool wasConnected : 1 {false};
-
28 bool gotIpAddress : 1{false};
-
29 bool savePower : 1 {true};
-
30
-
37 void setupMacAddress();
-
38
-
42 void wifiConnectedInternal();
-
43
-
47 void wifiDisconnectedInternal();
-
48
-
49 public:
-
50 DECLARE_KS_EVENT(onConnected) // onConnected event that user can bind to.
-
51 DECLARE_KS_EVENT(onDisconnected) // onDisconnected event that user can bind to.
-
52
-
53
-
58 ksWifiConnector(const char* hostname, bool savePower = true);
+
+
29 class ksWifiConnector : public ksComponent
+
30 {
+
31 KSF_RTTI_DECLARATIONS(ksWifiConnector, ksComponent)
+
32
+
33 protected:
+
34 ksSimpleTimer wifiTimeoutTimer{KSF_WIFI_TIMEOUT_MS};
+
35 ksSimpleTimer wifiReconnectTimer{KSF_WIFI_RECONNECT_TIME_MS};
+
36 ksSimpleTimer wifiIpCheckTimer{KSF_ONE_SEC_MS};
+
37
+
38 bool wasConnected : 1 {false};
+
39 bool gotIpAddress : 1{false};
+
40 bool savePower : 1 {true};
+
41
+
48 void setupMacAddress();
+
49
+
53 void wifiConnectedInternal();
+
54
+
58 void wifiDisconnectedInternal();
59
-
65 bool init(ksApplication* app) override;
-
66
-
71 bool loop(ksApplication* app) override;
-
72
-
77 bool isConnected() const;
-
78
-
82 virtual ~ksWifiConnector();
-
83 };
+
60 public:
+
61 DECLARE_KS_EVENT(onConnected) // onConnected event that user can bind to.
+
62 DECLARE_KS_EVENT(onDisconnected) // onDisconnected event that user can bind to.
+
63
+
64
+
69 ksWifiConnector(const char* hostname, bool savePower = true);
+
70
+
76 bool init(ksApplication* app) override;
+
77
+
83 bool loop(ksApplication* app) override;
+
84
+
89 bool isConnected() const;
+
90
+
94 virtual ~ksWifiConnector();
+
95 };
-
84}
-
ksf::comps::ksWifiConnector
Definition ksWifiConnector.h:19
-
ksf::comps::ksWifiConnector::wifiReconnectTimer
ksSimpleTimer wifiReconnectTimer
Wifi timer - reconnect.
Definition ksWifiConnector.h:24
+
96}
+
ksf::comps::ksWifiConnector
A component that manages WiFi connection.
Definition ksWifiConnector.h:30
+
ksf::comps::ksWifiConnector::wifiReconnectTimer
ksSimpleTimer wifiReconnectTimer
Wifi timer - reconnection timeout.
Definition ksWifiConnector.h:35
ksf::comps::ksWifiConnector::isConnected
bool isConnected() const
Returns whether WiFi is connected or not.
Definition ksWifiConnector.cpp:133
-
ksf::comps::ksWifiConnector::wifiIpCheckTimer
ksSimpleTimer wifiIpCheckTimer
Wifi timer - IP check.
Definition ksWifiConnector.h:25
-
ksf::comps::ksWifiConnector::gotIpAddress
bool gotIpAddress
True if IP address is set.
Definition ksWifiConnector.h:28
-
ksf::comps::ksWifiConnector::wasConnected
bool wasConnected
True if connected in previous loop.
Definition ksWifiConnector.h:27
-
ksf::comps::ksWifiConnector::ksWifiConnector
ksWifiConnector(const char *hostname, bool savePower=true)
Constructor for WiFi connector component.
Definition ksWifiConnector.cpp:26
+
ksf::comps::ksWifiConnector::wifiIpCheckTimer
ksSimpleTimer wifiIpCheckTimer
Wifi timer - IP check interval.
Definition ksWifiConnector.h:36
+
ksf::comps::ksWifiConnector::gotIpAddress
bool gotIpAddress
True if IP address is set.
Definition ksWifiConnector.h:39
+
ksf::comps::ksWifiConnector::wasConnected
bool wasConnected
True if connected in previous loop.
Definition ksWifiConnector.h:38
+
ksf::comps::ksWifiConnector::ksWifiConnector
ksWifiConnector(const char *hostname, bool savePower=true)
Constructs WiFi connector component.
Definition ksWifiConnector.cpp:26
ksf::comps::ksWifiConnector::init
bool init(ksApplication *app) override
Initializes WiFi connector component.
Definition ksWifiConnector.cpp:68
ksf::comps::ksWifiConnector::loop
bool loop(ksApplication *app) override
Handles WiFi connector component loop logic.
Definition ksWifiConnector.cpp:94
-
ksf::comps::ksWifiConnector::wifiTimeoutTimer
ksSimpleTimer wifiTimeoutTimer
Wifi timer - timeout.
Definition ksWifiConnector.h:23
-
ksf::comps::ksWifiConnector::setupMacAddress
void setupMacAddress()
Internal method to setup MAC address.
Definition ksWifiConnector.cpp:43
+
ksf::comps::ksWifiConnector::wifiTimeoutTimer
ksSimpleTimer wifiTimeoutTimer
Wifi timer - long timeout in case of issues.
Definition ksWifiConnector.h:34
+
ksf::comps::ksWifiConnector::setupMacAddress
void setupMacAddress()
Internal method that generates MAC address for the device.
Definition ksWifiConnector.cpp:43
ksf::comps::ksWifiConnector::wifiDisconnectedInternal
void wifiDisconnectedInternal()
Internal method called on WiFi disconnection.
Definition ksWifiConnector.cpp:89
-
ksf::comps::ksWifiConnector::savePower
bool savePower
True to save power.
Definition ksWifiConnector.h:29
+
ksf::comps::ksWifiConnector::savePower
bool savePower
True to save power.
Definition ksWifiConnector.h:40
ksf::comps::ksWifiConnector::wifiConnectedInternal
void wifiConnectedInternal()
Internal method called on WiFi connection.
Definition ksWifiConnector.cpp:84
-
ksf::comps::ksWifiConnector::~ksWifiConnector
virtual ~ksWifiConnector()
Destructor for WiFi connector component.
Definition ksWifiConnector.cpp:138
-
ksf::ksApplication
Definition ksApplication.h:27
-
ksf::ksComponent
Definition ksComponent.h:45
-
ksf::ksSimpleTimer
Definition ksSimpleTimer.h:17
+
ksf::comps::ksWifiConnector::~ksWifiConnector
virtual ~ksWifiConnector()
Destructos WiFi connector component.
Definition ksWifiConnector.cpp:138
+
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
+
ksf::ksComponent
Base component class.
Definition ksComponent.h:51
+
ksf::ksSimpleTimer
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27
diff --git a/menudata.js b/menudata.js index 65c887a..938efa4 100644 --- a/menudata.js +++ b/menudata.js @@ -24,6 +24,12 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html"}, +{text:"Enumerations",url:"namespacemembers_enum.html"}, +{text:"Enumerator",url:"namespacemembers_eval.html"}]}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, diff --git a/namespaceksf_1_1_e_o_t_a_type.html b/namespaceksf_1_1_e_o_t_a_type.html new file mode 100644 index 0000000..c80d9d0 --- /dev/null +++ b/namespaceksf_1_1_e_o_t_a_type.html @@ -0,0 +1,129 @@ + + + + + + + +Doxygen with github: ksf::EOTAType Namespace Reference + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Enumerations
+
ksf::EOTAType Namespace Reference
+
+
+ +

OTA boot types. +More...

+ + + + + +

+Enumerations

enum  Type { NO_OTA +, OTA_GENERIC +, OTA_PORTAL + }
 OTA boot type enum. More...
 
+

Detailed Description

+

OTA boot types.

+

Enumeration Type Documentation

+ +

◆ Type

+ +
+
+ + + + +
enum ksf::EOTAType::Type
+
+ +

OTA boot type enum.

+ + + + +
Enumerator
NO_OTA 

No OTA happened.

+
OTA_GENERIC 

Generic OTA happened.

+
OTA_PORTAL 

OTA happened through captive portal.

+
+ +
+
+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/namespaceksf_1_1comps_1_1_e_config_param_type.html b/namespaceksf_1_1comps_1_1_e_config_param_type.html new file mode 100644 index 0000000..c70c96a --- /dev/null +++ b/namespaceksf_1_1comps_1_1_e_config_param_type.html @@ -0,0 +1,104 @@ + + + + + + + +Doxygen with github: ksf::comps::EConfigParamType Namespace Reference + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Enumerations
+
ksf::comps::EConfigParamType Namespace Reference
+
+
+ +

Configuration parameter types. +More...

+ + + + + +

+Enumerations

enum  Type { Text +, Password +, Number + }
 Configuration parameter type enum.
 
+

Detailed Description

+

Configuration parameter types.

+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/namespacemembers.html b/namespacemembers.html new file mode 100644 index 0000000..55cb152 --- /dev/null +++ b/namespacemembers.html @@ -0,0 +1,86 @@ + + + + + + + +Doxygen with github: Namespace Members + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented namespace members with links to the namespaces they belong to:
+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/namespacemembers_enum.html b/namespacemembers_enum.html new file mode 100644 index 0000000..3285af6 --- /dev/null +++ b/namespacemembers_enum.html @@ -0,0 +1,83 @@ + + + + + + + +Doxygen with github: Namespace Members + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented namespace enums with links to the namespaces they belong to:
+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/namespacemembers_eval.html b/namespacemembers_eval.html new file mode 100644 index 0000000..884de97 --- /dev/null +++ b/namespacemembers_eval.html @@ -0,0 +1,85 @@ + + + + + + + +Doxygen with github: Namespace Members + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented namespace enum values with links to the namespaces they belong to:
+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/namespaces.html b/namespaces.html new file mode 100644 index 0000000..6be893c --- /dev/null +++ b/namespaces.html @@ -0,0 +1,85 @@ + + + + + + + +Doxygen with github: Namespace List + + + + + + + + + + + +
+
+ + + + + + +
+
Doxygen with github +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Namespace List
+
+
+
Here is a list of all documented namespaces with brief descriptions:
+
+
+ +
+Generated by doxygen 1.10.0 +
+ + diff --git a/search/all_0.js b/search/all_0.js index 822da82..0a81268 100644 --- a/search/all_0.js +++ b/search/all_0.js @@ -4,7 +4,7 @@ var searchData= ['addnewparam_1',['addNewParam',['../classksf_1_1comps_1_1ks_config_provider.html#a6e72aedea03159b059f197ebf21a95ef',1,'ksf::comps::ksConfigProvider']]], ['addnewparamwithconfigdefault_2',['addNewParamWithConfigDefault',['../classksf_1_1comps_1_1ks_config_provider.html#af0c39ab3c54f26fd79d55b2c6ec86e92',1,'ksf::comps::ksConfigProvider']]], ['and_20why_3',['What and why?',['../index.html#autotoc_md1',1,'']]], - ['app_4',['app',['../classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1',1,'ksf::comps::ksDevicePortal']]], + ['app_4',['app',['../classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1',1,'ksf::comps::ksDevicePortal::app'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a88bfef0ffa77358a7b26ed066bd5fe29',1,'ksf::comps::ksWifiConfigurator::app']]], ['application_5',['Building application',['../index.html#autotoc_md6',1,'']]], ['architecture_6',['Architecture',['../index.html#autotoc_md2',1,'']]], ['arduinoota_7',['arduinoOTA',['../classksf_1_1comps_1_1ks_device_portal.html#a08bf056d0703b80eebf334e2e3830813',1,'ksf::comps::ksDevicePortal']]], diff --git a/search/all_10.js b/search/all_10.js index bbade1d..075f51e 100644 --- a/search/all_10.js +++ b/search/all_10.js @@ -1,6 +1,22 @@ var searchData= [ - ['the_20hood_0',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], - ['triggered_1',['triggered',['../classksf_1_1ks_simple_timer.html#a5d12020dc37e1836c9c98ec92eade407',1,'ksf::ksSimpleTimer']]], - ['triggerstate_2',['triggerState',['../classksf_1_1comps_1_1ks_reset_button.html#a19333b9f885a6e61c27e04f206b75cb7',1,'ksf::comps::ksResetButton']]] + ['saveparams_0',['saveParams',['../classksf_1_1comps_1_1ks_config_provider.html#a137995e9f92a86526a6feec85d7721b5',1,'ksf::comps::ksConfigProvider::saveParams()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#a4d316f6e72e43ee5d121b48d2aee50fc',1,'ksf::comps::ksMqttConfigProvider::saveParams()']]], + ['savepower_1',['savePower',['../classksf_1_1comps_1_1ks_wifi_connector.html#ad712e221c2bcc55d500b0365075cfee2',1,'ksf::comps::ksWifiConnector']]], + ['saving_20power_2',['Saving power',['../index.html#autotoc_md10',1,'']]], + ['scannetworktimestamp_3',['scanNetworkTimestamp',['../classksf_1_1comps_1_1ks_device_portal.html#a4fafe81b3100c79214a84bec4b093556',1,'ksf::comps::ksDevicePortal']]], + ['sendconnectionstatus_4',['sendConnectionStatus',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a95b20ca302d48003c755183b21d65215',1,'ksf::comps::ksMqttConnector']]], + ['setblinking_5',['setBlinking',['../classksf_1_1comps_1_1ks_led.html#ac4b5388865229bfb8b841df7b690900a',1,'ksf::comps::ksLed']]], + ['setdriveaspushpull_6',['setDriveAsPushPull',['../classksf_1_1comps_1_1ks_led.html#ab6948ea0404741b5bd8c8ed6e1c957b2',1,'ksf::comps::ksLed']]], + ['setenabled_7',['setEnabled',['../classksf_1_1comps_1_1ks_led.html#a07bd8f91be11f266ac3a31bfe8c1c79a',1,'ksf::comps::ksLed']]], + ['setinterval_8',['setInterval',['../classksf_1_1ks_simple_timer.html#a15d32e956c02488bea6a50eddcdecc6a',1,'ksf::ksSimpleTimer']]], + ['setmessagehandler_9',['setMessageHandler',['../classksf_1_1misc_1_1ks_w_s_server.html#ab6465499a17fef0e369e9f0f5802ef13',1,'ksf::misc::ksWSServer']]], + ['setparam_10',['setParam',['../classksf_1_1ks_config.html#a714a7fe8087ccc2bd386bbadb467ce3e',1,'ksf::ksConfig']]], + ['setrequiredauthtoken_11',['setRequiredAuthToken',['../classksf_1_1misc_1_1ks_w_s_server.html#ad7c5303434271a77957a113dad7a2c37',1,'ksf::misc::ksWSServer']]], + ['setup_12',['setup',['../classksf_1_1ks_cert_fingerprint.html#af4672963f80f351ab4cfd9ee9c5adcf7',1,'ksf::ksCertFingerprint']]], + ['setupconnection_13',['setupConnection',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a9a7833df0f4760e30c26b9c08ff6d922',1,'ksf::comps::ksMqttConnector']]], + ['setuphttpserver_14',['setupHttpServer',['../classksf_1_1comps_1_1ks_device_portal.html#ae6c76bee527e97fbd9a4e08d09306633',1,'ksf::comps::ksDevicePortal']]], + ['setupmacaddress_15',['setupMacAddress',['../classksf_1_1comps_1_1ks_wifi_connector.html#ac52bb4438c4024c91066caec2795f2dc',1,'ksf::comps::ksWifiConnector']]], + ['setupmqttconnector_16',['setupMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#ab7ed416913dd45cd2f2ef3dd3f85bb2e',1,'ksf::comps::ksMqttConfigProvider']]], + ['setupwsserver_17',['setupWsServer',['../classksf_1_1comps_1_1ks_device_portal.html#a2fc892e79d3813ab7b6135df5a475aee',1,'ksf::comps::ksDevicePortal']]], + ['subscribe_18',['subscribe',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a327f16a26deb354be7374bdb0e26cdbd',1,'ksf::comps::ksMqttConnector']]] ]; diff --git a/search/all_11.js b/search/all_11.js index d4aecbf..0d09efb 100644 --- a/search/all_11.js +++ b/search/all_11.js @@ -1,9 +1,7 @@ var searchData= [ - ['unbind_0',['unbind',['../classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc',1,'ksf::evt::ksEvent::unbind()'],['../classksf_1_1evt_1_1ks_event_interface.html#a9da6e0357176b359db6f5004f66caf7a',1,'ksf::evt::ksEventInterface::unbind()']]], - ['under_20the_20hood_1',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], - ['unsubscribe_2',['unsubscribe',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aa0371f700a74e710804fc4e7c99e75e4',1,'ksf::comps::ksMqttConnector']]], - ['updatefinished_3',['updateFinished',['../classksf_1_1comps_1_1ks_device_portal.html#a2febff831199e81498a8bbf8b91f0e4b',1,'ksf::comps::ksDevicePortal']]], - ['usepersistentsession_4',['usePersistentSession',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a8e80106d4063007faf9f1bc7eb1c889c',1,'ksf::comps::ksMqttConnector']]], - ['utilities_5',['Utilities',['../index.html#autotoc_md3',1,'']]] + ['the_20hood_0',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], + ['triggered_1',['triggered',['../classksf_1_1ks_simple_timer.html#a5d12020dc37e1836c9c98ec92eade407',1,'ksf::ksSimpleTimer']]], + ['triggerstate_2',['triggerState',['../classksf_1_1comps_1_1ks_reset_button.html#a19333b9f885a6e61c27e04f206b75cb7',1,'ksf::comps::ksResetButton']]], + ['type_3',['Type',['../namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1',1,'ksf::comps::EConfigParamType::Type'],['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7',1,'ksf::EOTAType::Type']]] ]; diff --git a/search/all_12.js b/search/all_12.js index ef6c585..d4aecbf 100644 --- a/search/all_12.js +++ b/search/all_12.js @@ -1,4 +1,9 @@ var searchData= [ - ['verify_0',['verify',['../classksf_1_1ks_cert_fingerprint.html#aaef4a1680808fd8212cb62ad757355e7',1,'ksf::ksCertFingerprint']]] + ['unbind_0',['unbind',['../classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc',1,'ksf::evt::ksEvent::unbind()'],['../classksf_1_1evt_1_1ks_event_interface.html#a9da6e0357176b359db6f5004f66caf7a',1,'ksf::evt::ksEventInterface::unbind()']]], + ['under_20the_20hood_1',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], + ['unsubscribe_2',['unsubscribe',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aa0371f700a74e710804fc4e7c99e75e4',1,'ksf::comps::ksMqttConnector']]], + ['updatefinished_3',['updateFinished',['../classksf_1_1comps_1_1ks_device_portal.html#a2febff831199e81498a8bbf8b91f0e4b',1,'ksf::comps::ksDevicePortal']]], + ['usepersistentsession_4',['usePersistentSession',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a8e80106d4063007faf9f1bc7eb1c889c',1,'ksf::comps::ksMqttConnector']]], + ['utilities_5',['Utilities',['../index.html#autotoc_md3',1,'']]] ]; diff --git a/search/all_13.js b/search/all_13.js index f3d4626..ef6c585 100644 --- a/search/all_13.js +++ b/search/all_13.js @@ -1,17 +1,4 @@ var searchData= [ - ['wasconnected_0',['wasConnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#afc9123d68f055d4709f9f455cfb655f9',1,'ksf::comps::ksMqttConnector::wasConnected'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a32228ab43c1d389d792f960e7e5b1aec',1,'ksf::comps::ksWifiConnector::wasConnected']]], - ['webserver_1',['webServer',['../classksf_1_1comps_1_1ks_device_portal.html#aed3161ec11cf98fc8afa61e0868596ad',1,'ksf::comps::ksDevicePortal']]], - ['websocket_2',['webSocket',['../classksf_1_1comps_1_1ks_device_portal.html#a70a982a1a01f3ae4011d6b78f2dcedbc',1,'ksf::comps::ksDevicePortal']]], - ['what_20and_20why_3',['What and why?',['../index.html#autotoc_md1',1,'']]], - ['why_4',['What and why?',['../index.html#autotoc_md1',1,'']]], - ['wificlientsp_5',['wifiClientSp',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a437a9bcc82d47c0bc27f25c155d35ff3',1,'ksf::comps::ksMqttConnector']]], - ['wificonnectedinternal_6',['wifiConnectedInternal',['../classksf_1_1comps_1_1ks_wifi_connector.html#ae2a0ac579cfc0b29ad0ade3de0b8cde4',1,'ksf::comps::ksWifiConnector']]], - ['wificonnwp_7',['wifiConnWp',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a00194e36edb73cbc7db830d42490fff4',1,'ksf::comps::ksMqttConnector']]], - ['wifidisconnectedinternal_8',['wifiDisconnectedInternal',['../classksf_1_1comps_1_1ks_wifi_connector.html#ad011586bdc807db81e5eb9b2766ed950',1,'ksf::comps::ksWifiConnector']]], - ['wifiipchecktimer_9',['wifiIpCheckTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#a20835a8e41863f79bd140f905d908bae',1,'ksf::comps::ksWifiConnector']]], - ['wifireconnecttimer_10',['wifiReconnectTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#a0564f0ed42827fbfc35bdf168b0490cb',1,'ksf::comps::ksWifiConnector']]], - ['wifitimeouttimer_11',['wifiTimeoutTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#aa4aefb3cbb2365f443d51fa8900930c9',1,'ksf::comps::ksWifiConnector']]], - ['work_20under_20the_20hood_12',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], - ['wslistener_13',['wsListener',['../classksf_1_1misc_1_1ks_w_s_server.html#aa70db8c4e6820c660c1654807276b9c6',1,'ksf::misc::ksWSServer']]] + ['verify_0',['verify',['../classksf_1_1ks_cert_fingerprint.html#aaef4a1680808fd8212cb62ad757355e7',1,'ksf::ksCertFingerprint']]] ]; diff --git a/search/all_14.js b/search/all_14.js index 84dd69b..f3d4626 100644 --- a/search/all_14.js +++ b/search/all_14.js @@ -1,12 +1,17 @@ var searchData= [ - ['_7eksconfig_0',['~ksConfig',['../classksf_1_1ks_config.html#a304947df2a72b5297cbca0bba3c8136f',1,'ksf::ksConfig']]], - ['_7eksdeviceportal_1',['~ksDevicePortal',['../classksf_1_1comps_1_1ks_device_portal.html#a341b68e99384e4ae0a7038227bff92f6',1,'ksf::comps::ksDevicePortal']]], - ['_7ekseventhandle_2',['~ksEventHandle',['../classksf_1_1evt_1_1ks_event_handle.html#ad296ef8c5a77a0404666fc93123267ce',1,'ksf::evt::ksEventHandle']]], - ['_7eksled_3',['~ksLed',['../classksf_1_1comps_1_1ks_led.html#a1c87003b2282ae75929235a58f7ced0c',1,'ksf::comps::ksLed']]], - ['_7eksmqttconnector_4',['~ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a6a2c69fad3a041cf706ff66b88afb663',1,'ksf::comps::ksMqttConnector']]], - ['_7eksresetbutton_5',['~ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html#ab85ae4de074ad0cb1f5e44528c109ecd',1,'ksf::comps::ksResetButton']]], - ['_7ekswificonfigurator_6',['~ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html#a98c0d0ea3e1f04d787b4acb6754ee995',1,'ksf::comps::ksWifiConfigurator']]], - ['_7ekswificonnector_7',['~ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html#ae4d6d1486214998fcb711c2e2f624d84',1,'ksf::comps::ksWifiConnector']]], - ['_7ekswsserver_8',['~ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html#a2224ec4f425cd7938cd89880cb5ce771',1,'ksf::misc::ksWSServer']]] + ['wasconnected_0',['wasConnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#afc9123d68f055d4709f9f455cfb655f9',1,'ksf::comps::ksMqttConnector::wasConnected'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a32228ab43c1d389d792f960e7e5b1aec',1,'ksf::comps::ksWifiConnector::wasConnected']]], + ['webserver_1',['webServer',['../classksf_1_1comps_1_1ks_device_portal.html#aed3161ec11cf98fc8afa61e0868596ad',1,'ksf::comps::ksDevicePortal']]], + ['websocket_2',['webSocket',['../classksf_1_1comps_1_1ks_device_portal.html#a70a982a1a01f3ae4011d6b78f2dcedbc',1,'ksf::comps::ksDevicePortal']]], + ['what_20and_20why_3',['What and why?',['../index.html#autotoc_md1',1,'']]], + ['why_4',['What and why?',['../index.html#autotoc_md1',1,'']]], + ['wificlientsp_5',['wifiClientSp',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a437a9bcc82d47c0bc27f25c155d35ff3',1,'ksf::comps::ksMqttConnector']]], + ['wificonnectedinternal_6',['wifiConnectedInternal',['../classksf_1_1comps_1_1ks_wifi_connector.html#ae2a0ac579cfc0b29ad0ade3de0b8cde4',1,'ksf::comps::ksWifiConnector']]], + ['wificonnwp_7',['wifiConnWp',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a00194e36edb73cbc7db830d42490fff4',1,'ksf::comps::ksMqttConnector']]], + ['wifidisconnectedinternal_8',['wifiDisconnectedInternal',['../classksf_1_1comps_1_1ks_wifi_connector.html#ad011586bdc807db81e5eb9b2766ed950',1,'ksf::comps::ksWifiConnector']]], + ['wifiipchecktimer_9',['wifiIpCheckTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#a20835a8e41863f79bd140f905d908bae',1,'ksf::comps::ksWifiConnector']]], + ['wifireconnecttimer_10',['wifiReconnectTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#a0564f0ed42827fbfc35bdf168b0490cb',1,'ksf::comps::ksWifiConnector']]], + ['wifitimeouttimer_11',['wifiTimeoutTimer',['../classksf_1_1comps_1_1ks_wifi_connector.html#aa4aefb3cbb2365f443d51fa8900930c9',1,'ksf::comps::ksWifiConnector']]], + ['work_20under_20the_20hood_12',['How does it work under the hood?',['../index.html#autotoc_md7',1,'']]], + ['wslistener_13',['wsListener',['../classksf_1_1misc_1_1ks_w_s_server.html#aa70db8c4e6820c660c1654807276b9c6',1,'ksf::misc::ksWSServer']]] ]; diff --git a/search/all_15.js b/search/all_15.js new file mode 100644 index 0000000..84dd69b --- /dev/null +++ b/search/all_15.js @@ -0,0 +1,12 @@ +var searchData= +[ + ['_7eksconfig_0',['~ksConfig',['../classksf_1_1ks_config.html#a304947df2a72b5297cbca0bba3c8136f',1,'ksf::ksConfig']]], + ['_7eksdeviceportal_1',['~ksDevicePortal',['../classksf_1_1comps_1_1ks_device_portal.html#a341b68e99384e4ae0a7038227bff92f6',1,'ksf::comps::ksDevicePortal']]], + ['_7ekseventhandle_2',['~ksEventHandle',['../classksf_1_1evt_1_1ks_event_handle.html#ad296ef8c5a77a0404666fc93123267ce',1,'ksf::evt::ksEventHandle']]], + ['_7eksled_3',['~ksLed',['../classksf_1_1comps_1_1ks_led.html#a1c87003b2282ae75929235a58f7ced0c',1,'ksf::comps::ksLed']]], + ['_7eksmqttconnector_4',['~ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a6a2c69fad3a041cf706ff66b88afb663',1,'ksf::comps::ksMqttConnector']]], + ['_7eksresetbutton_5',['~ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html#ab85ae4de074ad0cb1f5e44528c109ecd',1,'ksf::comps::ksResetButton']]], + ['_7ekswificonfigurator_6',['~ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html#a98c0d0ea3e1f04d787b4acb6754ee995',1,'ksf::comps::ksWifiConfigurator']]], + ['_7ekswificonnector_7',['~ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html#ae4d6d1486214998fcb711c2e2f624d84',1,'ksf::comps::ksWifiConnector']]], + ['_7ekswsserver_8',['~ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html#a2224ec4f425cd7938cd89880cb5ce771',1,'ksf::misc::ksWSServer']]] +]; diff --git a/search/all_8.js b/search/all_8.js index a90212d..c3817d8 100644 --- a/search/all_8.js +++ b/search/all_8.js @@ -1,6 +1,6 @@ var searchData= [ - ['init_0',['init',['../classksf_1_1comps_1_1ks_device_portal.html#a2b75ab8090a6ac95008c3f6f417d821e',1,'ksf::comps::ksDevicePortal::init()'],['../classksf_1_1comps_1_1ks_led.html#a54708ddd80553023003ce7bba9f7430e',1,'ksf::comps::ksLed::init()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#afc908554cc4966eefa989baac31d6d02',1,'ksf::comps::ksMqttConnector::init()'],['../classksf_1_1comps_1_1ks_reset_button.html#aff554ea730fa9b9e830c4abb2d44d17f',1,'ksf::comps::ksResetButton::init()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a95ce665dfb9817352fb6d4aafc172cb0',1,'ksf::comps::ksWifiConfigurator::init()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a893fbb2fdb3c2b6a126e478ff92e325c',1,'ksf::comps::ksWifiConnector::init()'],['../classksf_1_1ks_application.html#ae0df7f797abc4f477f17448aa89613ce',1,'ksf::ksApplication::init()'],['../classksf_1_1ks_component.html#a684f870e77ac3795b3cf789a8a81cdde',1,'ksf::ksComponent::init()']]], + ['init_0',['init',['../classksf_1_1comps_1_1ks_device_portal.html#a2b75ab8090a6ac95008c3f6f417d821e',1,'ksf::comps::ksDevicePortal::init()'],['../classksf_1_1comps_1_1ks_led.html#a54708ddd80553023003ce7bba9f7430e',1,'ksf::comps::ksLed::init()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a5218003f79bceb2207178361fc124aeb',1,'ksf::comps::ksMqttConnector::init()'],['../classksf_1_1comps_1_1ks_reset_button.html#aff554ea730fa9b9e830c4abb2d44d17f',1,'ksf::comps::ksResetButton::init()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#aaf10ed3c6fa2336fc4d5b7e71bb89195',1,'ksf::comps::ksWifiConfigurator::init()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a893fbb2fdb3c2b6a126e478ff92e325c',1,'ksf::comps::ksWifiConnector::init()'],['../classksf_1_1ks_application.html#ae0df7f797abc4f477f17448aa89613ce',1,'ksf::ksApplication::init()'],['../classksf_1_1ks_component.html#a684f870e77ac3795b3cf789a8a81cdde',1,'ksf::ksComponent::init()']]], ['inrequest_5fneedauthentication_1',['inRequest_NeedAuthentication',['../classksf_1_1comps_1_1ks_device_portal.html#aadf8b151247f2364ac2da012acb51738',1,'ksf::comps::ksDevicePortal']]], ['intervalms_2',['intervalMs',['../classksf_1_1ks_simple_timer.html#a0e71a98ffe9b0bef207203f950da8e80',1,'ksf::ksSimpleTimer']]], ['isa_3',['isA',['../classksf_1_1comps_1_1ks_config_provider.html#abd847581f934d5e67b0deafdf2884d27',1,'ksf::comps::ksConfigProvider::isA()'],['../classksf_1_1comps_1_1ks_device_portal.html#a17f39258b36ee0f902ed28ba71dc8532',1,'ksf::comps::ksDevicePortal::isA()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a12ee5aa09cbaa9f7419e097a42357d1c',1,'ksf::comps::ksDevStatMqttReporter::isA()'],['../classksf_1_1comps_1_1ks_led.html#a381037e05ed26b334c81853cb53fc817',1,'ksf::comps::ksLed::isA()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#a1b5e47d42f23e33853ac1b0d4275c540',1,'ksf::comps::ksMqttConfigProvider::isA()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#ae2515a6080975c49fa5f8fddda90dcda',1,'ksf::comps::ksMqttConnector::isA()'],['../classksf_1_1comps_1_1ks_reset_button.html#a6ea1bf709aee9cca8796b8739a68d57c',1,'ksf::comps::ksResetButton::isA()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a652a9aefbb8729c75ef16bb1a9d3eb63',1,'ksf::comps::ksWifiConfigurator::isA()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a3c9f5b528500d8ec016fd50207bd9d21',1,'ksf::comps::ksWifiConnector::isA()'],['../classksf_1_1ks_component.html#a286b01d0faa7e74983efb15cdc80c748',1,'ksf::ksComponent::isA()'],['../classksf_1_1ks_rtti.html#a84c5ab0cd0a529fd085e68de557ab4f4',1,'ksf::ksRtti::isA()']]], diff --git a/search/all_9.js b/search/all_9.js index 43909fc..a80dfdb 100644 --- a/search/all_9.js +++ b/search/all_9.js @@ -8,21 +8,23 @@ var searchData= ['ksconfigparameter_5',['ksConfigParameter',['../structksf_1_1comps_1_1ks_config_parameter.html',1,'ksf::comps']]], ['ksconfigprovider_6',['ksConfigProvider',['../classksf_1_1comps_1_1ks_config_provider.html',1,'ksf::comps']]], ['ksdeviceportal_7',['ksDevicePortal',['../classksf_1_1comps_1_1ks_device_portal.html',1,'ksf::comps::ksDevicePortal'],['../classksf_1_1comps_1_1ks_device_portal.html#aa08cdda2becff4848d75630cd0add2ed',1,'ksf::comps::ksDevicePortal::ksDevicePortal()'],['../classksf_1_1comps_1_1ks_device_portal.html#a78752a7ad1ac3566ace00a1f84b1ef6f',1,'ksf::comps::ksDevicePortal::ksDevicePortal(std::string portalPassword)']]], - ['ksdevstatmqttreporter_8',['ksDevStatMqttReporter',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html',1,'ksf::comps']]], + ['ksdevstatmqttreporter_8',['ksDevStatMqttReporter',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html',1,'ksf::comps::ksDevStatMqttReporter'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#aeba778fa1e37f1b71e24e9e6a3659067',1,'ksf::comps::ksDevStatMqttReporter::ksDevStatMqttReporter()']]], ['ksevent_9',['ksEvent',['../classksf_1_1evt_1_1ks_event.html',1,'ksf::evt']]], ['ksevent_3c_20const_20std_3a_3astring_5fview_20_26_2c_20bool_20_26_2c_20std_3a_3astring_20_26_20_3e_10',['ksEvent< const std::string_view &, bool &, std::string & >',['../classksf_1_1evt_1_1ks_event.html',1,'ksf::evt']]], ['ksevent_3c_20const_20std_3a_3astring_5fview_20_26_2c_20const_20std_3a_3astring_5fview_20_26_20_3e_11',['ksEvent< const std::string_view &, const std::string_view & >',['../classksf_1_1evt_1_1ks_event.html',1,'ksf::evt']]], ['ksevent_3c_3e_12',['ksEvent<>',['../classksf_1_1evt_1_1ks_event.html',1,'ksf::evt']]], ['kseventhandle_13',['ksEventHandle',['../classksf_1_1evt_1_1ks_event_handle.html',1,'ksf::evt::ksEventHandle'],['../classksf_1_1evt_1_1ks_event_handle.html#a2ba584af638b4d972ecac8ed0660db14',1,'ksf::evt::ksEventHandle::ksEventHandle()']]], ['kseventinterface_14',['ksEventInterface',['../classksf_1_1evt_1_1ks_event_interface.html',1,'ksf::evt']]], - ['ksiotframeworklib_15',['ksIotFrameworkLib',['../index.html',1,'']]], - ['ksled_16',['ksLed',['../classksf_1_1comps_1_1ks_led.html',1,'ksf::comps::ksLed'],['../classksf_1_1comps_1_1ks_led.html#a9900da46e213614c74662553ac07a8ea',1,'ksf::comps::ksLed::ksLed()']]], - ['ksmqttconfigprovider_17',['ksMqttConfigProvider',['../classksf_1_1comps_1_1ks_mqtt_config_provider.html',1,'ksf::comps']]], - ['ksmqttconnector_18',['ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html',1,'ksf::comps::ksMqttConnector'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a97dd66cd5cb6dbb6819ff73376c048ed',1,'ksf::comps::ksMqttConnector::ksMqttConnector()']]], - ['ksresetbutton_19',['ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html',1,'ksf::comps::ksResetButton'],['../classksf_1_1comps_1_1ks_reset_button.html#afb9e9f21f6eccae844dd0c77cede2dc5',1,'ksf::comps::ksResetButton::ksResetButton()']]], - ['ksrtti_20',['ksRtti',['../classksf_1_1ks_rtti.html',1,'ksf']]], - ['kssimpletimer_21',['ksSimpleTimer',['../classksf_1_1ks_simple_timer.html',1,'ksf::ksSimpleTimer'],['../classksf_1_1ks_simple_timer.html#a76af38376cf65d3062352ebcaca1c12f',1,'ksf::ksSimpleTimer::ksSimpleTimer()']]], - ['kswificonfigurator_22',['ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html',1,'ksf::comps::ksWifiConfigurator'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a3b0bcf71b8d738c3c45f7868c46c4b63',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#ad7366dac8b7fbbc30e82af7fa2b895bc',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator(std::string devicePrefixName)']]], - ['kswificonnector_23',['ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html',1,'ksf::comps::ksWifiConnector'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a4b9f2666dfdfa7af71bc8d897d0ea9d2',1,'ksf::comps::ksWifiConnector::ksWifiConnector()']]], - ['kswsserver_24',['ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html',1,'ksf::misc::ksWSServer'],['../classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72',1,'ksf::misc::ksWSServer::ksWSServer()']]] + ['ksf_3a_3acomps_3a_3aeconfigparamtype_15',['EConfigParamType',['../namespaceksf_1_1comps_1_1_e_config_param_type.html',1,'ksf::comps']]], + ['ksf_3a_3aeotatype_16',['EOTAType',['../namespaceksf_1_1_e_o_t_a_type.html',1,'ksf']]], + ['ksiotframeworklib_17',['ksIotFrameworkLib',['../index.html',1,'']]], + ['ksled_18',['ksLed',['../classksf_1_1comps_1_1ks_led.html',1,'ksf::comps::ksLed'],['../classksf_1_1comps_1_1ks_led.html#a9900da46e213614c74662553ac07a8ea',1,'ksf::comps::ksLed::ksLed()']]], + ['ksmqttconfigprovider_19',['ksMqttConfigProvider',['../classksf_1_1comps_1_1ks_mqtt_config_provider.html',1,'ksf::comps']]], + ['ksmqttconnector_20',['ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html',1,'ksf::comps::ksMqttConnector'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a97dd66cd5cb6dbb6819ff73376c048ed',1,'ksf::comps::ksMqttConnector::ksMqttConnector()']]], + ['ksresetbutton_21',['ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html',1,'ksf::comps::ksResetButton'],['../classksf_1_1comps_1_1ks_reset_button.html#afb9e9f21f6eccae844dd0c77cede2dc5',1,'ksf::comps::ksResetButton::ksResetButton()']]], + ['ksrtti_22',['ksRtti',['../classksf_1_1ks_rtti.html',1,'ksf']]], + ['kssimpletimer_23',['ksSimpleTimer',['../classksf_1_1ks_simple_timer.html',1,'ksf::ksSimpleTimer'],['../classksf_1_1ks_simple_timer.html#a76af38376cf65d3062352ebcaca1c12f',1,'ksf::ksSimpleTimer::ksSimpleTimer()']]], + ['kswificonfigurator_24',['ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html',1,'ksf::comps::ksWifiConfigurator'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a3b0bcf71b8d738c3c45f7868c46c4b63',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#ad7366dac8b7fbbc30e82af7fa2b895bc',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator(std::string devicePrefixName)']]], + ['kswificonnector_25',['ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html',1,'ksf::comps::ksWifiConnector'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a4b9f2666dfdfa7af71bc8d897d0ea9d2',1,'ksf::comps::ksWifiConnector::ksWifiConnector()']]], + ['kswsserver_26',['ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html',1,'ksf::misc::ksWSServer'],['../classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72',1,'ksf::misc::ksWSServer::ksWSServer()']]] ]; diff --git a/search/all_c.js b/search/all_c.js index 6d14b18..b4b66f9 100644 --- a/search/all_c.js +++ b/search/all_c.js @@ -1,18 +1,4 @@ var searchData= [ - ['onanymessage_0',['onAnyMessage',['../classksf_1_1comps_1_1ks_mqtt_connector.html#ad8b5761c616a2107091f97d54600003c',1,'ksf::comps::ksMqttConnector']]], - ['onapplog_1',['onAppLog',['../classksf_1_1comps_1_1ks_device_portal.html#ab12fafd5f49ecd9a36ba9d8b6002605b',1,'ksf::comps::ksDevicePortal']]], - ['onconnected_2',['onConnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aeb2e99942201a89db129abe571115db6',1,'ksf::comps::ksMqttConnector::onConnected'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a50a8b87a541070e20616a0815ce881d8',1,'ksf::comps::ksDevStatMqttReporter::onConnected()']]], - ['ondevicemessage_3',['onDeviceMessage',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a068e0ad483a487bf6e643355799b2fc1',1,'ksf::comps::ksMqttConnector']]], - ['ondisconnected_4',['onDisconnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aacb8a4b214c5ea6d71c74469fec167ce',1,'ksf::comps::ksMqttConnector']]], - ['onhandleportalcommand_5',['onHandlePortalCommand',['../classksf_1_1comps_1_1ks_device_portal.html#a5ead9113c131284ee325740154194c7d',1,'ksf::comps::ksDevicePortal']]], - ['onrequest_5findex_6',['onRequest_index',['../classksf_1_1comps_1_1ks_device_portal.html#a80b467535ec6279ad36ffaa1c181ad90',1,'ksf::comps::ksDevicePortal']]], - ['onrequest_5fnotfound_7',['onRequest_notFound',['../classksf_1_1comps_1_1ks_device_portal.html#a8feb8377e4cebd8c15e64071a62ae9fa',1,'ksf::comps::ksDevicePortal']]], - ['onrequest_5fotachunk_8',['onRequest_otaChunk',['../classksf_1_1comps_1_1ks_device_portal.html#a874a08f061b795a96dc4badf7415fd82',1,'ksf::comps::ksDevicePortal']]], - ['onrequest_5fotafinish_9',['onRequest_otaFinish',['../classksf_1_1comps_1_1ks_device_portal.html#aaf77328746a9a3f01a584ffdf53a90c8',1,'ksf::comps::ksDevicePortal']]], - ['onupdateend_10',['onUpdateEnd',['../classksf_1_1comps_1_1ks_device_portal.html#a7dc2e53045a02c604627f8101baa68e2',1,'ksf::comps::ksDevicePortal']]], - ['onupdatestart_11',['onUpdateStart',['../classksf_1_1comps_1_1ks_device_portal.html#a94f2d902c9447d79a165cdb0ed7417ab',1,'ksf::comps::ksDevicePortal']]], - ['onwebsockettextmessage_12',['onWebsocketTextMessage',['../classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885',1,'ksf::misc::ksWSServer::onWebsocketTextMessage'],['../classksf_1_1comps_1_1ks_device_portal.html#a2992c9c68c1b62d4ddc6e0a64e1edfc7',1,'ksf::comps::ksDevicePortal::onWebsocketTextMessage()']]], - ['operator_20bool_13',['operator bool',['../classksf_1_1ks_config.html#af05e375f48e5ce57902a587393a95134',1,'ksf::ksConfig']]], - ['owner_14',['owner',['../classksf_1_1comps_1_1ks_wifi_configurator.html#adf6a3a181faeec4431b72bd747aad08b',1,'ksf::comps::ksWifiConfigurator']]] + ['no_5fota_0',['NO_OTA',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a2598fe7d2a0a717818a81a8ec4406236',1,'ksf::EOTAType']]] ]; diff --git a/search/all_d.js b/search/all_d.js index bdfec2d..c8f3c87 100644 --- a/search/all_d.js +++ b/search/all_d.js @@ -1,12 +1,19 @@ var searchData= [ - ['password_0',['password',['../classksf_1_1comps_1_1ks_mqtt_connector.html#af38f406daf37f94b37cb74c9d7831cae',1,'ksf::comps::ksMqttConnector']]], - ['periodictaskstimeout_1',['periodicTasksTimeout',['../classksf_1_1comps_1_1ks_wifi_configurator.html#aa4b3048c5e1802e63c78cbe98a5ec121',1,'ksf::comps::ksWifiConfigurator']]], - ['pin_2',['pin',['../classksf_1_1comps_1_1ks_led.html#a5a944a7741ab9a0f1437021784a8d1e1',1,'ksf::comps::ksLed::pin'],['../classksf_1_1comps_1_1ks_reset_button.html#a29879006a4ff502303a11eb534d3d8b3',1,'ksf::comps::ksResetButton::pin']]], - ['portalpassword_3',['portalPassword',['../classksf_1_1comps_1_1ks_device_portal.html#a320c4d5b38d622379742b43f4fa99464',1,'ksf::comps::ksDevicePortal']]], - ['postinit_4',['postInit',['../classksf_1_1comps_1_1ks_device_portal.html#a3943c29bbb8bea8568154903c379a8a4',1,'ksf::comps::ksDevicePortal::postInit()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a',1,'ksf::comps::ksDevStatMqttReporter::postInit()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a21a416188683a4005560288cf71a7d4f',1,'ksf::comps::ksMqttConnector::postInit()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a2f9319297c384cf9b94037ac957f7782',1,'ksf::comps::ksWifiConfigurator::postInit()'],['../classksf_1_1ks_component.html#ac952d4ad53c77639a2bb6015c11800fb',1,'ksf::ksComponent::postInit()']]], - ['power_5',['Saving power',['../index.html#autotoc_md10',1,'']]], - ['prefix_6',['prefix',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a2acc73077e7b4ef0d5f7cd03ad75da19',1,'ksf::comps::ksMqttConnector']]], - ['pressedtime_7',['pressedTime',['../classksf_1_1comps_1_1ks_reset_button.html#a838f42f24cf1d8a95f4820faebb7e302',1,'ksf::comps::ksResetButton']]], - ['publish_8',['publish',['../classksf_1_1comps_1_1ks_mqtt_connector.html#ab101e26b5ea98a8b3e35295ab2b00680',1,'ksf::comps::ksMqttConnector']]] + ['onanymessage_0',['onAnyMessage',['../classksf_1_1comps_1_1ks_mqtt_connector.html#ad8b5761c616a2107091f97d54600003c',1,'ksf::comps::ksMqttConnector']]], + ['onapplog_1',['onAppLog',['../classksf_1_1comps_1_1ks_device_portal.html#a71a92f3fba9cf819aad4115ae41b9b9a',1,'ksf::comps::ksDevicePortal']]], + ['onconnected_2',['onConnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aeb2e99942201a89db129abe571115db6',1,'ksf::comps::ksMqttConnector::onConnected'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a50a8b87a541070e20616a0815ce881d8',1,'ksf::comps::ksDevStatMqttReporter::onConnected()']]], + ['ondevicemessage_3',['onDeviceMessage',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a068e0ad483a487bf6e643355799b2fc1',1,'ksf::comps::ksMqttConnector']]], + ['ondisconnected_4',['onDisconnected',['../classksf_1_1comps_1_1ks_mqtt_connector.html#aacb8a4b214c5ea6d71c74469fec167ce',1,'ksf::comps::ksMqttConnector']]], + ['onhandleportalcommand_5',['onHandlePortalCommand',['../classksf_1_1comps_1_1ks_device_portal.html#a5ead9113c131284ee325740154194c7d',1,'ksf::comps::ksDevicePortal']]], + ['onrequest_5findex_6',['onRequest_index',['../classksf_1_1comps_1_1ks_device_portal.html#a80b467535ec6279ad36ffaa1c181ad90',1,'ksf::comps::ksDevicePortal']]], + ['onrequest_5fnotfound_7',['onRequest_notFound',['../classksf_1_1comps_1_1ks_device_portal.html#a8feb8377e4cebd8c15e64071a62ae9fa',1,'ksf::comps::ksDevicePortal']]], + ['onrequest_5fotachunk_8',['onRequest_otaChunk',['../classksf_1_1comps_1_1ks_device_portal.html#a874a08f061b795a96dc4badf7415fd82',1,'ksf::comps::ksDevicePortal']]], + ['onrequest_5fotafinish_9',['onRequest_otaFinish',['../classksf_1_1comps_1_1ks_device_portal.html#aaf77328746a9a3f01a584ffdf53a90c8',1,'ksf::comps::ksDevicePortal']]], + ['onupdateend_10',['onUpdateEnd',['../classksf_1_1comps_1_1ks_device_portal.html#a7dc2e53045a02c604627f8101baa68e2',1,'ksf::comps::ksDevicePortal']]], + ['onupdatestart_11',['onUpdateStart',['../classksf_1_1comps_1_1ks_device_portal.html#a94f2d902c9447d79a165cdb0ed7417ab',1,'ksf::comps::ksDevicePortal']]], + ['onwebsockettextmessage_12',['onWebsocketTextMessage',['../classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885',1,'ksf::misc::ksWSServer::onWebsocketTextMessage'],['../classksf_1_1comps_1_1ks_device_portal.html#a2992c9c68c1b62d4ddc6e0a64e1edfc7',1,'ksf::comps::ksDevicePortal::onWebsocketTextMessage()']]], + ['operator_20bool_13',['operator bool',['../classksf_1_1ks_config.html#af05e375f48e5ce57902a587393a95134',1,'ksf::ksConfig']]], + ['ota_5fgeneric_14',['OTA_GENERIC',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a50ac0f5acec8516273300277d8091204',1,'ksf::EOTAType']]], + ['ota_5fportal_15',['OTA_PORTAL',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a47194ec74973e91ab4974f4c71865d90',1,'ksf::EOTAType']]] ]; diff --git a/search/all_e.js b/search/all_e.js index b0763dc..64001f9 100644 --- a/search/all_e.js +++ b/search/all_e.js @@ -1,16 +1,12 @@ var searchData= [ - ['readparams_0',['readParams',['../classksf_1_1comps_1_1ks_config_provider.html#a0d115049edd41092f31cb49a0eac2988',1,'ksf::comps::ksConfigProvider::readParams()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#ad41f00507bd0d2ec465cb4dd68884199',1,'ksf::comps::ksMqttConfigProvider::readParams()']]], - ['rebootdevice_1',['rebootDevice',['../classksf_1_1comps_1_1ks_device_portal.html#ace71e2cafe4c513d17b9a322f5916a74',1,'ksf::comps::ksDevicePortal']]], - ['reconnectcounter_2',['reconnectCounter',['../classksf_1_1comps_1_1ks_mqtt_connector.html#af7928b7e420a6e8b98b17e5b43127d27',1,'ksf::comps::ksMqttConnector']]], - ['reconnecttimer_3',['reconnectTimer',['../classksf_1_1comps_1_1ks_mqtt_connector.html#adac57d480a69d329fa59cf5ec897978b',1,'ksf::comps::ksMqttConnector']]], - ['registerevent_4',['registerEvent',['../classksf_1_1evt_1_1ks_event.html#a172f69d818c73df76abc833fdda016a7',1,'ksf::evt::ksEvent']]], - ['releasedtime_5',['releasedTime',['../classksf_1_1comps_1_1ks_reset_button.html#a3b7c09ba82d65c6aece78ac67e285258',1,'ksf::comps::ksResetButton']]], - ['reportdevstats_6',['reportDevStats',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a4c5d0897b01f93c21dace3130746bdc5',1,'ksf::comps::ksDevStatMqttReporter']]], - ['reportertimer_7',['reporterTimer',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a791ce03611c217822caabf91c6c601b1',1,'ksf::comps::ksDevStatMqttReporter']]], - ['requestappbreak_8',['requestAppBreak',['../classksf_1_1comps_1_1ks_device_portal.html#a493f65235eb09023daeae7db6a800f0d',1,'ksf::comps::ksDevicePortal']]], - ['requriedauthtoken_9',['requriedAuthToken',['../classksf_1_1misc_1_1ks_w_s_server.html#af459c67b491ce00347a590de9dcee044',1,'ksf::misc::ksWSServer']]], - ['restart_10',['restart',['../classksf_1_1ks_simple_timer.html#a7115f8d5cbd0be313e002f569e518879',1,'ksf::ksSimpleTimer']]], - ['rtti_11',['Custom RTTI',['../index.html#autotoc_md9',1,'']]], - ['rules_3a_12',['Rules:',['../index.html#autotoc_md5',1,'']]] + ['password_0',['password',['../classksf_1_1comps_1_1ks_mqtt_connector.html#af38f406daf37f94b37cb74c9d7831cae',1,'ksf::comps::ksMqttConnector']]], + ['periodictaskstimeout_1',['periodicTasksTimeout',['../classksf_1_1comps_1_1ks_wifi_configurator.html#aa4b3048c5e1802e63c78cbe98a5ec121',1,'ksf::comps::ksWifiConfigurator']]], + ['pin_2',['pin',['../classksf_1_1comps_1_1ks_led.html#a5a944a7741ab9a0f1437021784a8d1e1',1,'ksf::comps::ksLed::pin'],['../classksf_1_1comps_1_1ks_reset_button.html#a29879006a4ff502303a11eb534d3d8b3',1,'ksf::comps::ksResetButton::pin']]], + ['portalpassword_3',['portalPassword',['../classksf_1_1comps_1_1ks_device_portal.html#a320c4d5b38d622379742b43f4fa99464',1,'ksf::comps::ksDevicePortal']]], + ['postinit_4',['postInit',['../classksf_1_1comps_1_1ks_device_portal.html#a3943c29bbb8bea8568154903c379a8a4',1,'ksf::comps::ksDevicePortal::postInit()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a',1,'ksf::comps::ksDevStatMqttReporter::postInit()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#ae1e46595b6c1a5760c31149355e751c4',1,'ksf::comps::ksMqttConnector::postInit()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#af940a4472153cb497d35bf1ffe035dc2',1,'ksf::comps::ksWifiConfigurator::postInit()'],['../classksf_1_1ks_component.html#ac952d4ad53c77639a2bb6015c11800fb',1,'ksf::ksComponent::postInit()']]], + ['power_5',['Saving power',['../index.html#autotoc_md10',1,'']]], + ['prefix_6',['prefix',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a2acc73077e7b4ef0d5f7cd03ad75da19',1,'ksf::comps::ksMqttConnector']]], + ['pressedtime_7',['pressedTime',['../classksf_1_1comps_1_1ks_reset_button.html#a838f42f24cf1d8a95f4820faebb7e302',1,'ksf::comps::ksResetButton']]], + ['publish_8',['publish',['../classksf_1_1comps_1_1ks_mqtt_connector.html#ab101e26b5ea98a8b3e35295ab2b00680',1,'ksf::comps::ksMqttConnector']]] ]; diff --git a/search/all_f.js b/search/all_f.js index 075f51e..b0763dc 100644 --- a/search/all_f.js +++ b/search/all_f.js @@ -1,22 +1,16 @@ var searchData= [ - ['saveparams_0',['saveParams',['../classksf_1_1comps_1_1ks_config_provider.html#a137995e9f92a86526a6feec85d7721b5',1,'ksf::comps::ksConfigProvider::saveParams()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#a4d316f6e72e43ee5d121b48d2aee50fc',1,'ksf::comps::ksMqttConfigProvider::saveParams()']]], - ['savepower_1',['savePower',['../classksf_1_1comps_1_1ks_wifi_connector.html#ad712e221c2bcc55d500b0365075cfee2',1,'ksf::comps::ksWifiConnector']]], - ['saving_20power_2',['Saving power',['../index.html#autotoc_md10',1,'']]], - ['scannetworktimestamp_3',['scanNetworkTimestamp',['../classksf_1_1comps_1_1ks_device_portal.html#a4fafe81b3100c79214a84bec4b093556',1,'ksf::comps::ksDevicePortal']]], - ['sendconnectionstatus_4',['sendConnectionStatus',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a95b20ca302d48003c755183b21d65215',1,'ksf::comps::ksMqttConnector']]], - ['setblinking_5',['setBlinking',['../classksf_1_1comps_1_1ks_led.html#ac4b5388865229bfb8b841df7b690900a',1,'ksf::comps::ksLed']]], - ['setdriveaspushpull_6',['setDriveAsPushPull',['../classksf_1_1comps_1_1ks_led.html#ab6948ea0404741b5bd8c8ed6e1c957b2',1,'ksf::comps::ksLed']]], - ['setenabled_7',['setEnabled',['../classksf_1_1comps_1_1ks_led.html#a07bd8f91be11f266ac3a31bfe8c1c79a',1,'ksf::comps::ksLed']]], - ['setinterval_8',['setInterval',['../classksf_1_1ks_simple_timer.html#a15d32e956c02488bea6a50eddcdecc6a',1,'ksf::ksSimpleTimer']]], - ['setmessagehandler_9',['setMessageHandler',['../classksf_1_1misc_1_1ks_w_s_server.html#ab6465499a17fef0e369e9f0f5802ef13',1,'ksf::misc::ksWSServer']]], - ['setparam_10',['setParam',['../classksf_1_1ks_config.html#a714a7fe8087ccc2bd386bbadb467ce3e',1,'ksf::ksConfig']]], - ['setrequiredauthtoken_11',['setRequiredAuthToken',['../classksf_1_1misc_1_1ks_w_s_server.html#ad7c5303434271a77957a113dad7a2c37',1,'ksf::misc::ksWSServer']]], - ['setup_12',['setup',['../classksf_1_1ks_cert_fingerprint.html#af4672963f80f351ab4cfd9ee9c5adcf7',1,'ksf::ksCertFingerprint']]], - ['setupconnection_13',['setupConnection',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a9a7833df0f4760e30c26b9c08ff6d922',1,'ksf::comps::ksMqttConnector']]], - ['setuphttpserver_14',['setupHttpServer',['../classksf_1_1comps_1_1ks_device_portal.html#ae6c76bee527e97fbd9a4e08d09306633',1,'ksf::comps::ksDevicePortal']]], - ['setupmacaddress_15',['setupMacAddress',['../classksf_1_1comps_1_1ks_wifi_connector.html#ac52bb4438c4024c91066caec2795f2dc',1,'ksf::comps::ksWifiConnector']]], - ['setupmqttconnector_16',['setupMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#ab7ed416913dd45cd2f2ef3dd3f85bb2e',1,'ksf::comps::ksMqttConfigProvider']]], - ['setupwsserver_17',['setupWsServer',['../classksf_1_1comps_1_1ks_device_portal.html#a2fc892e79d3813ab7b6135df5a475aee',1,'ksf::comps::ksDevicePortal']]], - ['subscribe_18',['subscribe',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a327f16a26deb354be7374bdb0e26cdbd',1,'ksf::comps::ksMqttConnector']]] + ['readparams_0',['readParams',['../classksf_1_1comps_1_1ks_config_provider.html#a0d115049edd41092f31cb49a0eac2988',1,'ksf::comps::ksConfigProvider::readParams()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#ad41f00507bd0d2ec465cb4dd68884199',1,'ksf::comps::ksMqttConfigProvider::readParams()']]], + ['rebootdevice_1',['rebootDevice',['../classksf_1_1comps_1_1ks_device_portal.html#ace71e2cafe4c513d17b9a322f5916a74',1,'ksf::comps::ksDevicePortal']]], + ['reconnectcounter_2',['reconnectCounter',['../classksf_1_1comps_1_1ks_mqtt_connector.html#af7928b7e420a6e8b98b17e5b43127d27',1,'ksf::comps::ksMqttConnector']]], + ['reconnecttimer_3',['reconnectTimer',['../classksf_1_1comps_1_1ks_mqtt_connector.html#adac57d480a69d329fa59cf5ec897978b',1,'ksf::comps::ksMqttConnector']]], + ['registerevent_4',['registerEvent',['../classksf_1_1evt_1_1ks_event.html#a172f69d818c73df76abc833fdda016a7',1,'ksf::evt::ksEvent']]], + ['releasedtime_5',['releasedTime',['../classksf_1_1comps_1_1ks_reset_button.html#a3b7c09ba82d65c6aece78ac67e285258',1,'ksf::comps::ksResetButton']]], + ['reportdevstats_6',['reportDevStats',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a4c5d0897b01f93c21dace3130746bdc5',1,'ksf::comps::ksDevStatMqttReporter']]], + ['reportertimer_7',['reporterTimer',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a791ce03611c217822caabf91c6c601b1',1,'ksf::comps::ksDevStatMqttReporter']]], + ['requestappbreak_8',['requestAppBreak',['../classksf_1_1comps_1_1ks_device_portal.html#a493f65235eb09023daeae7db6a800f0d',1,'ksf::comps::ksDevicePortal']]], + ['requriedauthtoken_9',['requriedAuthToken',['../classksf_1_1misc_1_1ks_w_s_server.html#af459c67b491ce00347a590de9dcee044',1,'ksf::misc::ksWSServer']]], + ['restart_10',['restart',['../classksf_1_1ks_simple_timer.html#a7115f8d5cbd0be313e002f569e518879',1,'ksf::ksSimpleTimer']]], + ['rtti_11',['Custom RTTI',['../index.html#autotoc_md9',1,'']]], + ['rules_3a_12',['Rules:',['../index.html#autotoc_md5',1,'']]] ]; diff --git a/search/enums_0.js b/search/enums_0.js new file mode 100644 index 0000000..eaf4e1b --- /dev/null +++ b/search/enums_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['type_0',['Type',['../namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1',1,'ksf::comps::EConfigParamType::Type'],['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7',1,'ksf::EOTAType::Type']]] +]; diff --git a/search/enumvalues_0.js b/search/enumvalues_0.js new file mode 100644 index 0000000..b4b66f9 --- /dev/null +++ b/search/enumvalues_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['no_5fota_0',['NO_OTA',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a2598fe7d2a0a717818a81a8ec4406236',1,'ksf::EOTAType']]] +]; diff --git a/search/enumvalues_1.js b/search/enumvalues_1.js new file mode 100644 index 0000000..5a7ff3d --- /dev/null +++ b/search/enumvalues_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['ota_5fgeneric_0',['OTA_GENERIC',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a50ac0f5acec8516273300277d8091204',1,'ksf::EOTAType']]], + ['ota_5fportal_1',['OTA_PORTAL',['../namespaceksf_1_1_e_o_t_a_type.html#a87179a21f7223a29153289f63c8711e7a47194ec74973e91ab4974f4c71865d90',1,'ksf::EOTAType']]] +]; diff --git a/search/functions_6.js b/search/functions_6.js index 1ca005b..9e598bf 100644 --- a/search/functions_6.js +++ b/search/functions_6.js @@ -1,6 +1,6 @@ var searchData= [ - ['init_0',['init',['../classksf_1_1comps_1_1ks_device_portal.html#a2b75ab8090a6ac95008c3f6f417d821e',1,'ksf::comps::ksDevicePortal::init()'],['../classksf_1_1comps_1_1ks_led.html#a54708ddd80553023003ce7bba9f7430e',1,'ksf::comps::ksLed::init()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#afc908554cc4966eefa989baac31d6d02',1,'ksf::comps::ksMqttConnector::init()'],['../classksf_1_1comps_1_1ks_reset_button.html#aff554ea730fa9b9e830c4abb2d44d17f',1,'ksf::comps::ksResetButton::init()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a95ce665dfb9817352fb6d4aafc172cb0',1,'ksf::comps::ksWifiConfigurator::init()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a893fbb2fdb3c2b6a126e478ff92e325c',1,'ksf::comps::ksWifiConnector::init()'],['../classksf_1_1ks_application.html#ae0df7f797abc4f477f17448aa89613ce',1,'ksf::ksApplication::init()'],['../classksf_1_1ks_component.html#a684f870e77ac3795b3cf789a8a81cdde',1,'ksf::ksComponent::init()']]], + ['init_0',['init',['../classksf_1_1comps_1_1ks_device_portal.html#a2b75ab8090a6ac95008c3f6f417d821e',1,'ksf::comps::ksDevicePortal::init()'],['../classksf_1_1comps_1_1ks_led.html#a54708ddd80553023003ce7bba9f7430e',1,'ksf::comps::ksLed::init()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a5218003f79bceb2207178361fc124aeb',1,'ksf::comps::ksMqttConnector::init()'],['../classksf_1_1comps_1_1ks_reset_button.html#aff554ea730fa9b9e830c4abb2d44d17f',1,'ksf::comps::ksResetButton::init()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#aaf10ed3c6fa2336fc4d5b7e71bb89195',1,'ksf::comps::ksWifiConfigurator::init()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a893fbb2fdb3c2b6a126e478ff92e325c',1,'ksf::comps::ksWifiConnector::init()'],['../classksf_1_1ks_application.html#ae0df7f797abc4f477f17448aa89613ce',1,'ksf::ksApplication::init()'],['../classksf_1_1ks_component.html#a684f870e77ac3795b3cf789a8a81cdde',1,'ksf::ksComponent::init()']]], ['inrequest_5fneedauthentication_1',['inRequest_NeedAuthentication',['../classksf_1_1comps_1_1ks_device_portal.html#aadf8b151247f2364ac2da012acb51738',1,'ksf::comps::ksDevicePortal']]], ['isa_2',['isA',['../classksf_1_1comps_1_1ks_config_provider.html#abd847581f934d5e67b0deafdf2884d27',1,'ksf::comps::ksConfigProvider::isA()'],['../classksf_1_1comps_1_1ks_device_portal.html#a17f39258b36ee0f902ed28ba71dc8532',1,'ksf::comps::ksDevicePortal::isA()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a12ee5aa09cbaa9f7419e097a42357d1c',1,'ksf::comps::ksDevStatMqttReporter::isA()'],['../classksf_1_1comps_1_1ks_led.html#a381037e05ed26b334c81853cb53fc817',1,'ksf::comps::ksLed::isA()'],['../classksf_1_1comps_1_1ks_mqtt_config_provider.html#a1b5e47d42f23e33853ac1b0d4275c540',1,'ksf::comps::ksMqttConfigProvider::isA()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#ae2515a6080975c49fa5f8fddda90dcda',1,'ksf::comps::ksMqttConnector::isA()'],['../classksf_1_1comps_1_1ks_reset_button.html#a6ea1bf709aee9cca8796b8739a68d57c',1,'ksf::comps::ksResetButton::isA()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a652a9aefbb8729c75ef16bb1a9d3eb63',1,'ksf::comps::ksWifiConfigurator::isA()'],['../classksf_1_1comps_1_1ks_wifi_connector.html#a3c9f5b528500d8ec016fd50207bd9d21',1,'ksf::comps::ksWifiConnector::isA()'],['../classksf_1_1ks_component.html#a286b01d0faa7e74983efb15cdc80c748',1,'ksf::ksComponent::isA()'],['../classksf_1_1ks_rtti.html#a84c5ab0cd0a529fd085e68de557ab4f4',1,'ksf::ksRtti::isA()']]], ['isblinking_3',['isBlinking',['../classksf_1_1comps_1_1ks_led.html#a39401225820c0b94f07792287a6b9376',1,'ksf::comps::ksLed']]], diff --git a/search/functions_7.js b/search/functions_7.js index 3f28240..24f0edd 100644 --- a/search/functions_7.js +++ b/search/functions_7.js @@ -2,12 +2,13 @@ var searchData= [ ['ksconfig_0',['ksConfig',['../classksf_1_1ks_config.html#ae29595441a2aff5b0d0b43a3e9f55c8c',1,'ksf::ksConfig']]], ['ksdeviceportal_1',['ksDevicePortal',['../classksf_1_1comps_1_1ks_device_portal.html#aa08cdda2becff4848d75630cd0add2ed',1,'ksf::comps::ksDevicePortal::ksDevicePortal()'],['../classksf_1_1comps_1_1ks_device_portal.html#a78752a7ad1ac3566ace00a1f84b1ef6f',1,'ksf::comps::ksDevicePortal::ksDevicePortal(std::string portalPassword)']]], - ['kseventhandle_2',['ksEventHandle',['../classksf_1_1evt_1_1ks_event_handle.html#a2ba584af638b4d972ecac8ed0660db14',1,'ksf::evt::ksEventHandle']]], - ['ksled_3',['ksLed',['../classksf_1_1comps_1_1ks_led.html#a9900da46e213614c74662553ac07a8ea',1,'ksf::comps::ksLed']]], - ['ksmqttconnector_4',['ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a97dd66cd5cb6dbb6819ff73376c048ed',1,'ksf::comps::ksMqttConnector']]], - ['ksresetbutton_5',['ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html#afb9e9f21f6eccae844dd0c77cede2dc5',1,'ksf::comps::ksResetButton']]], - ['kssimpletimer_6',['ksSimpleTimer',['../classksf_1_1ks_simple_timer.html#a76af38376cf65d3062352ebcaca1c12f',1,'ksf::ksSimpleTimer']]], - ['kswificonfigurator_7',['ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html#a3b0bcf71b8d738c3c45f7868c46c4b63',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#ad7366dac8b7fbbc30e82af7fa2b895bc',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator(std::string devicePrefixName)']]], - ['kswificonnector_8',['ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html#a4b9f2666dfdfa7af71bc8d897d0ea9d2',1,'ksf::comps::ksWifiConnector']]], - ['kswsserver_9',['ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72',1,'ksf::misc::ksWSServer']]] + ['ksdevstatmqttreporter_2',['ksDevStatMqttReporter',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#aeba778fa1e37f1b71e24e9e6a3659067',1,'ksf::comps::ksDevStatMqttReporter']]], + ['kseventhandle_3',['ksEventHandle',['../classksf_1_1evt_1_1ks_event_handle.html#a2ba584af638b4d972ecac8ed0660db14',1,'ksf::evt::ksEventHandle']]], + ['ksled_4',['ksLed',['../classksf_1_1comps_1_1ks_led.html#a9900da46e213614c74662553ac07a8ea',1,'ksf::comps::ksLed']]], + ['ksmqttconnector_5',['ksMqttConnector',['../classksf_1_1comps_1_1ks_mqtt_connector.html#a97dd66cd5cb6dbb6819ff73376c048ed',1,'ksf::comps::ksMqttConnector']]], + ['ksresetbutton_6',['ksResetButton',['../classksf_1_1comps_1_1ks_reset_button.html#afb9e9f21f6eccae844dd0c77cede2dc5',1,'ksf::comps::ksResetButton']]], + ['kssimpletimer_7',['ksSimpleTimer',['../classksf_1_1ks_simple_timer.html#a76af38376cf65d3062352ebcaca1c12f',1,'ksf::ksSimpleTimer']]], + ['kswificonfigurator_8',['ksWifiConfigurator',['../classksf_1_1comps_1_1ks_wifi_configurator.html#a3b0bcf71b8d738c3c45f7868c46c4b63',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#ad7366dac8b7fbbc30e82af7fa2b895bc',1,'ksf::comps::ksWifiConfigurator::ksWifiConfigurator(std::string devicePrefixName)']]], + ['kswificonnector_9',['ksWifiConnector',['../classksf_1_1comps_1_1ks_wifi_connector.html#a4b9f2666dfdfa7af71bc8d897d0ea9d2',1,'ksf::comps::ksWifiConnector']]], + ['kswsserver_10',['ksWSServer',['../classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72',1,'ksf::misc::ksWSServer']]] ]; diff --git a/search/functions_a.js b/search/functions_a.js index 95f1103..98f14f8 100644 --- a/search/functions_a.js +++ b/search/functions_a.js @@ -1,6 +1,6 @@ var searchData= [ - ['onapplog_0',['onAppLog',['../classksf_1_1comps_1_1ks_device_portal.html#ab12fafd5f49ecd9a36ba9d8b6002605b',1,'ksf::comps::ksDevicePortal']]], + ['onapplog_0',['onAppLog',['../classksf_1_1comps_1_1ks_device_portal.html#a71a92f3fba9cf819aad4115ae41b9b9a',1,'ksf::comps::ksDevicePortal']]], ['onconnected_1',['onConnected',['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a50a8b87a541070e20616a0815ce881d8',1,'ksf::comps::ksDevStatMqttReporter']]], ['onrequest_5findex_2',['onRequest_index',['../classksf_1_1comps_1_1ks_device_portal.html#a80b467535ec6279ad36ffaa1c181ad90',1,'ksf::comps::ksDevicePortal']]], ['onrequest_5fnotfound_3',['onRequest_notFound',['../classksf_1_1comps_1_1ks_device_portal.html#a8feb8377e4cebd8c15e64071a62ae9fa',1,'ksf::comps::ksDevicePortal']]], diff --git a/search/functions_b.js b/search/functions_b.js index f0cfbef..040257c 100644 --- a/search/functions_b.js +++ b/search/functions_b.js @@ -1,5 +1,5 @@ var searchData= [ - ['postinit_0',['postInit',['../classksf_1_1comps_1_1ks_device_portal.html#a3943c29bbb8bea8568154903c379a8a4',1,'ksf::comps::ksDevicePortal::postInit()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a',1,'ksf::comps::ksDevStatMqttReporter::postInit()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#a21a416188683a4005560288cf71a7d4f',1,'ksf::comps::ksMqttConnector::postInit()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a2f9319297c384cf9b94037ac957f7782',1,'ksf::comps::ksWifiConfigurator::postInit()'],['../classksf_1_1ks_component.html#ac952d4ad53c77639a2bb6015c11800fb',1,'ksf::ksComponent::postInit()']]], + ['postinit_0',['postInit',['../classksf_1_1comps_1_1ks_device_portal.html#a3943c29bbb8bea8568154903c379a8a4',1,'ksf::comps::ksDevicePortal::postInit()'],['../classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a',1,'ksf::comps::ksDevStatMqttReporter::postInit()'],['../classksf_1_1comps_1_1ks_mqtt_connector.html#ae1e46595b6c1a5760c31149355e751c4',1,'ksf::comps::ksMqttConnector::postInit()'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#af940a4472153cb497d35bf1ffe035dc2',1,'ksf::comps::ksWifiConfigurator::postInit()'],['../classksf_1_1ks_component.html#ac952d4ad53c77639a2bb6015c11800fb',1,'ksf::ksComponent::postInit()']]], ['publish_1',['publish',['../classksf_1_1comps_1_1ks_mqtt_connector.html#ab101e26b5ea98a8b3e35295ab2b00680',1,'ksf::comps::ksMqttConnector']]] ]; diff --git a/search/namespaces_0.js b/search/namespaces_0.js new file mode 100644 index 0000000..5a38ace --- /dev/null +++ b/search/namespaces_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['ksf_3a_3acomps_3a_3aeconfigparamtype_0',['EConfigParamType',['../namespaceksf_1_1comps_1_1_e_config_param_type.html',1,'ksf::comps']]], + ['ksf_3a_3aeotatype_1',['EOTAType',['../namespaceksf_1_1_e_o_t_a_type.html',1,'ksf']]] +]; diff --git a/search/searchdata.js b/search/searchdata.js index 4ac4fb8..e8c258b 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,27 +1,36 @@ var indexSectionsWithContent = { - 0: "abcdefghiklmoprstuvw~", + 0: "abcdefghiklmnoprstuvw~", 1: "ck", - 2: "abcfghiklmoprstuvw~", - 3: "abcdegilmoprstuw", - 4: "k" + 2: "k", + 3: "abcfghiklmoprstuvw~", + 4: "abcdegilmoprstuw", + 5: "t", + 6: "no", + 7: "k" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "functions", - 3: "variables", - 4: "pages" + 2: "namespaces", + 3: "functions", + 4: "variables", + 5: "enums", + 6: "enumvalues", + 7: "pages" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Functions", - 3: "Variables", - 4: "Pages" + 2: "Namespaces", + 3: "Functions", + 4: "Variables", + 5: "Enumerations", + 6: "Enumerator", + 7: "Pages" }; diff --git a/search/variables_0.js b/search/variables_0.js index d831638..31f69f7 100644 --- a/search/variables_0.js +++ b/search/variables_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['app_0',['app',['../classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1',1,'ksf::comps::ksDevicePortal']]], + ['app_0',['app',['../classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1',1,'ksf::comps::ksDevicePortal::app'],['../classksf_1_1comps_1_1ks_wifi_configurator.html#a88bfef0ffa77358a7b26ed066bd5fe29',1,'ksf::comps::ksWifiConfigurator::app']]], ['arduinoota_1',['arduinoOTA',['../classksf_1_1comps_1_1ks_device_portal.html#a08bf056d0703b80eebf334e2e3830813',1,'ksf::comps::ksDevicePortal']]] ]; diff --git a/search/variables_9.js b/search/variables_9.js index 6fd8451..b9e8496 100644 --- a/search/variables_9.js +++ b/search/variables_9.js @@ -7,6 +7,5 @@ var searchData= ['onhandleportalcommand_4',['onHandlePortalCommand',['../classksf_1_1comps_1_1ks_device_portal.html#a5ead9113c131284ee325740154194c7d',1,'ksf::comps::ksDevicePortal']]], ['onupdateend_5',['onUpdateEnd',['../classksf_1_1comps_1_1ks_device_portal.html#a7dc2e53045a02c604627f8101baa68e2',1,'ksf::comps::ksDevicePortal']]], ['onupdatestart_6',['onUpdateStart',['../classksf_1_1comps_1_1ks_device_portal.html#a94f2d902c9447d79a165cdb0ed7417ab',1,'ksf::comps::ksDevicePortal']]], - ['onwebsockettextmessage_7',['onWebsocketTextMessage',['../classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885',1,'ksf::misc::ksWSServer']]], - ['owner_8',['owner',['../classksf_1_1comps_1_1ks_wifi_configurator.html#adf6a3a181faeec4431b72bd747aad08b',1,'ksf::comps::ksWifiConfigurator']]] + ['onwebsockettextmessage_7',['onWebsocketTextMessage',['../classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885',1,'ksf::misc::ksWSServer']]] ]; diff --git a/structksf_1_1comps_1_1ks_config_parameter.html b/structksf_1_1comps_1_1ks_config_parameter.html index 2d0d5e5..2304dd7 100644 --- a/structksf_1_1comps_1_1ks_config_parameter.html +++ b/structksf_1_1comps_1_1ks_config_parameter.html @@ -99,7 +99,7 @@ std::string value   -EConfigParamType::Type type {} +EConfigParamType::Type type {}   int maxLength {}