diff --git a/_config_app_8h_source.html b/_config_app_8h_source.html deleted file mode 100644 index 3e15043..0000000 --- a/_config_app_8h_source.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config/src/apps/ConfigApp.h Source File - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
ConfigApp.h
-
-
-
1#pragma once
-
2
-
3#include <ksIotFrameworkLib.h>
-
4
-
5namespace apps
-
6{
-
-
7 class ConfigApp : public ksf::ksApplication
-
8 {
-
9 public:
-
10 static const char myDeviceName[];
-
11
-
12 bool init() override;
-
13 bool loop() override;
-
14 };
-
-
15}
-
apps::ConfigApp
Definition ConfigApp.h:8
-
apps::ConfigApp::loop
bool loop() override
Executes application logic loop.
Definition ConfigApp.cpp:18
-
apps::ConfigApp::init
bool init() override
Initializes application.
Definition ConfigApp.cpp:8
-
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/_device_functions_app_8h_source.html b/_device_functions_app_8h_source.html deleted file mode 100644 index a1a8b61..0000000 --- a/_device_functions_app_8h_source.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config/src/apps/DeviceFunctionsApp.h Source File - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
DeviceFunctionsApp.h
-
-
-
1#pragma once
-
2
-
3#include <ksIotFrameworkLib.h>
-
4
-
5namespace apps
-
6{
-
-
7 class DeviceFunctionsApp : public ksf::ksApplication
-
8 {
-
9 protected:
-
10
-
11 std::weak_ptr<ksf::comps::ksLed> connectionStatusLedWp; // Weeak pointer to the status LED component.
-
12 std::weak_ptr<ksf::comps::ksMqttConnector> mqttConnWp; // Weeak pointer to MQTT component.
-
13
-
14 std::unique_ptr<ksf::evt::ksEventHandle> connEventHandle, disEventHandle; // Handles to MQTT events.
-
15
-
16 void onMqttConnected();
-
17 void onMqttDisconnected();
-
18
-
19 public:
-
20 bool init() override;
-
21 bool loop() override;
-
22 };
-
-
23}
-
apps::DeviceFunctionsApp
Definition DeviceFunctionsApp.h:8
-
apps::DeviceFunctionsApp::loop
bool loop() override
Executes application logic loop.
Definition DeviceFunctionsApp.cpp:46
-
apps::DeviceFunctionsApp::init
bool init() override
Initializes application.
Definition DeviceFunctionsApp.cpp:8
-
ksf::ksApplication
A class that is a base for user-defined application.
Definition ksApplication.h:43
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/annotated.html b/annotated.html index 7473a3f..3c273db 100644 --- a/annotated.html +++ b/annotated.html @@ -89,34 +89,31 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼Napps
 CConfigApp
 CDeviceFunctionsApp
 ▼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
 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
 CksWifiConfiguratorA component that manages AP-based configuration
 CksWifiConnectorA component that manages WiFi connection
 ▼Nevt
 CksEventBase class for multicasting events
 CksEventHandleImplements event handle, used to automatically unbind callback on destruction
 CksEventInterfaceImplements interface for multicasting events
 ▼Nmisc
 CksWSServerWrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling
 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
 ▼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
 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
 CksWifiConfiguratorA component that manages AP-based configuration
 CksWifiConnectorA component that manages WiFi connection
 ▼Nevt
 CksEventBase class for multicasting events
 CksEventHandleImplements event handle, used to automatically unbind callback on destruction
 CksEventInterfaceImplements interface for multicasting events
 ▼Nmisc
 CksWSServerWrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling
 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
diff --git a/board_8h_source.html b/board_8h_source.html deleted file mode 100644 index 72c044f..0000000 --- a/board_8h_source.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config/src/board.h Source File - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
board.h
-
-
-
1#pragma once
-
2
-
3#define CFG_STATUS_LED 6
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/classapps_1_1_config_app-members.html b/classapps_1_1_config_app-members.html deleted file mode 100644 index d7bfe5f..0000000 --- a/classapps_1_1_config_app-members.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - -Doxygen with github: Member List - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
apps::ConfigApp Member List
-
-
- -

This is the complete list of members for apps::ConfigApp, including all inherited members.

- - - - - - - - -
addComponent(TParams... arg)ksf::ksApplicationinline
componentsksf::ksApplicationprotected
findComponent()ksf::ksApplicationinline
findComponents(std::vector< std::weak_ptr< TComponentType > > &outComponents)ksf::ksApplicationinline
init() overrideapps::ConfigAppvirtual
loop() overrideapps::ConfigAppvirtual
myDeviceName (defined in apps::ConfigApp)apps::ConfigAppstatic
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/classapps_1_1_config_app.html b/classapps_1_1_config_app.html deleted file mode 100644 index de7628a..0000000 --- a/classapps_1_1_config_app.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - - -Doxygen with github: apps::ConfigApp Class Reference - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
-Public Member Functions | -Static Public Attributes | -List of all members
-
apps::ConfigApp Class Reference
-
-
-
- + Inheritance diagram for apps::ConfigApp:
-
-
- - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

bool init () override
 Initializes application.
 
bool loop () override
 Executes application logic loop.
 
- Public Member Functions inherited from ksf::ksApplication
template<class TComponentType , class... TParams>
std::weak_ptr< TComponentType > addComponent (TParams... arg)
 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)
 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 ()
 Iterates through all components and returns a weak pointer to the first component that matches the type passed as a template parameter.
 
- - - -

-Static Public Attributes

-static const char myDeviceName [] = "ExampleDevice"
 
- - - - - -

-Additional Inherited Members

- Protected Attributes inherited from ksf::ksApplication
-std::list< std::shared_ptr< ksComponent > > components
 An array with shared_ptr of components (holding main reference).
 
-

Member Function Documentation

- -

◆ init()

- -
-
- - - - - -
- - - - - - - -
bool apps::ConfigApp::init ()
- 		-overridevirtual
-
- -

Initializes application.

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

Implements ksf::ksApplication.

- -

References ksf::ksApplication::addComponent().

- -
-
- -

◆ loop()

- -
-
- - - - - -
- - - - - - - -
bool apps::ConfigApp::loop ()
- 		-overridevirtual
-
- -

Executes application logic loop.

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

Reimplemented from ksf::ksApplication.

- -
-
-
The documentation for this class was generated from the following files: -
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/classapps_1_1_config_app.png b/classapps_1_1_config_app.png deleted file mode 100644 index 726f5d7..0000000 Binary files a/classapps_1_1_config_app.png and /dev/null differ diff --git a/classapps_1_1_device_functions_app-members.html b/classapps_1_1_device_functions_app-members.html deleted file mode 100644 index 38fa9e0..0000000 --- a/classapps_1_1_device_functions_app-members.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - -Doxygen with github: Member List - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
apps::DeviceFunctionsApp Member List
-
-
- -

This is the complete list of members for apps::DeviceFunctionsApp, including all inherited members.

- - - - - - - - - - - - - -
addComponent(TParams... arg)ksf::ksApplicationinline
componentsksf::ksApplicationprotected
connectionStatusLedWp (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
connEventHandle (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
disEventHandle (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
findComponent()ksf::ksApplicationinline
findComponents(std::vector< std::weak_ptr< TComponentType > > &outComponents)ksf::ksApplicationinline
init() overrideapps::DeviceFunctionsAppvirtual
loop() overrideapps::DeviceFunctionsAppvirtual
mqttConnWp (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
onMqttConnected() (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
onMqttDisconnected() (defined in apps::DeviceFunctionsApp)apps::DeviceFunctionsAppprotected
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/classapps_1_1_device_functions_app.html b/classapps_1_1_device_functions_app.html deleted file mode 100644 index 95a47cc..0000000 --- a/classapps_1_1_device_functions_app.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - - -Doxygen with github: apps::DeviceFunctionsApp Class Reference - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
-Public Member Functions | -Protected Member Functions | -Protected Attributes | -List of all members
-
apps::DeviceFunctionsApp Class Reference
-
-
-
- + Inheritance diagram for apps::DeviceFunctionsApp:
-
-
- - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

bool init () override
 Initializes application.
 
bool loop () override
 Executes application logic loop.
 
- Public Member Functions inherited from ksf::ksApplication
template<class TComponentType , class... TParams>
std::weak_ptr< TComponentType > addComponent (TParams... arg)
 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)
 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 ()
 Iterates through all components and returns a weak pointer to the first component that matches the type passed as a template parameter.
 
- - - - - -

-Protected Member Functions

-void onMqttConnected ()
 
-void onMqttDisconnected ()
 
- - - - - - - - - - - - - -

-Protected Attributes

-std::weak_ptr< ksf::comps::ksLed > connectionStatusLedWp
 
-std::weak_ptr< ksf::comps::ksMqttConnector > mqttConnWp
 
-std::unique_ptr< ksf::evt::ksEventHandle > connEventHandle
 
-std::unique_ptr< ksf::evt::ksEventHandle > disEventHandle
 
- Protected Attributes inherited from ksf::ksApplication
-std::list< std::shared_ptr< ksComponent > > components
 An array with shared_ptr of components (holding main reference).
 
-

Member Function Documentation

- -

◆ init()

- -
-
- - - - - -
- - - - - - - -
bool apps::DeviceFunctionsApp::init ()
- 		-overridevirtual
-
- -

Initializes application.

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

Implements ksf::ksApplication.

- -

References ksf::ksApplication::addComponent().

- -
-
- -

◆ loop()

- -
-
- - - - - -
- - - - - - - -
bool apps::DeviceFunctionsApp::loop ()
- 		-overridevirtual
-
- -

Executes application logic loop.

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

Reimplemented from ksf::ksApplication.

- -
-
-
The documentation for this class was generated from the following files: -
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/classapps_1_1_device_functions_app.png b/classapps_1_1_device_functions_app.png deleted file mode 100644 index ee8586e..0000000 Binary files a/classapps_1_1_device_functions_app.png and /dev/null differ diff --git a/classes.html b/classes.html index 2191c43..2a3c900 100644 --- a/classes.html +++ b/classes.html @@ -87,15 +87,9 @@
Class Index
-
C | D | K
+
K
-
C
-
ConfigApp (apps)
-
-
D
-
DeviceFunctionsApp (apps)
-
K
ksApplication (ksf)
ksAppRotator (ksf)
ksCertFingerprint (ksf)
ksComponent (ksf)
ksConfig (ksf)
ksConfigParameter (ksf::comps)
ksConfigProvider (ksf::comps)
ksDevicePortal (ksf::comps)
ksDevStatMqttReporter (ksf::comps)
ksEvent (ksf::evt)
ksEventHandle (ksf::evt)
ksEventInterface (ksf::evt)
ksLed (ksf::comps)
ksMqttConfigProvider (ksf::comps)
ksMqttConnector (ksf::comps)
ksResetButton (ksf::comps)
ksRtti (ksf)
ksSimpleTimer (ksf)
ksWifiConfigurator (ksf::comps)
ksWifiConnector (ksf::comps)
ksWSServer (ksf::misc)
diff --git a/classksf_1_1ks_application.html b/classksf_1_1ks_application.html index cbce0f9..2c3fdbe 100644 --- a/classksf_1_1ks_application.html +++ b/classksf_1_1ks_application.html @@ -100,18 +100,6 @@ More...

#include <ksApplication.h>

-
- + Inheritance diagram for ksf::ksApplication:
-
-
- @@ -191,7 +179,7 @@

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

-

Referenced by apps::ConfigApp::init(), apps::DeviceFunctionsApp::init(), and ksf::comps::ksWifiConfigurator::init().

+

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

@@ -306,8 +294,6 @@

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

Implemented in apps::ConfigApp, and apps::DeviceFunctionsApp.

- @@ -336,8 +322,6 @@

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

Reimplemented in apps::ConfigApp, and apps::DeviceFunctionsApp.

-

References components.

diff --git a/classksf_1_1ks_application.png b/classksf_1_1ks_application.png deleted file mode 100644 index 7bda50a..0000000 Binary files a/classksf_1_1ks_application.png and /dev/null differ diff --git a/dir_1f104b2c6eb7d5c118c6907f137f69a0.html b/dir_1f104b2c6eb7d5c118c6907f137f69a0.html deleted file mode 100644 index a2d014d..0000000 --- a/dir_1f104b2c6eb7d5c118c6907f137f69a0.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config/src Directory Reference - - - - - - - - - - - - - -
-
-

Public Member Functions

- - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - - -
-
-
src Directory Reference
-
-
- - - - -

-Directories

 apps
 
- - - -

-Files

 board.h
 
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/dir_3d0e092b0158a3eaeaca2f1ad6ae24b9.html b/dir_3d0e092b0158a3eaeaca2f1ad6ae24b9.html deleted file mode 100644 index 1548498..0000000 --- a/dir_3d0e092b0158a3eaeaca2f1ad6ae24b9.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config/src/apps Directory Reference - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
apps Directory Reference
-
-
- - - - - - -

-Files

 ConfigApp.h
 
 DeviceFunctionsApp.h
 
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/dir_d28a4824dc47e487b107a5db32ef43c4.html b/dir_d28a4824dc47e487b107a5db32ef43c4.html deleted file mode 100644 index 65d85c1..0000000 --- a/dir_d28a4824dc47e487b107a5db32ef43c4.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - -Doxygen with github: examples Directory Reference - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
examples Directory Reference
-
-
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/dir_e966fe1926f574752dde60e975f7ccec.html b/dir_e966fe1926f574752dde60e975f7ccec.html deleted file mode 100644 index c4a0ed1..0000000 --- a/dir_e966fe1926f574752dde60e975f7ccec.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - -Doxygen with github: examples/basic-config Directory Reference - - - - - - - - - - - - - -
-
- - - - - - -
-
Doxygen with github -
-
-
- - - - - - - - - - -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- - -
-
-
-
basic-config Directory Reference
-
-
- - - - -

-Directories

 src
 
-
- -
-Generated by doxygen 1.11.0 -
-
- - diff --git a/doxygen_crawl.html b/doxygen_crawl.html index e95da77..ca6bc7f 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -8,9 +8,6 @@ - - - @@ -34,11 +31,6 @@ - - - - - @@ -81,19 +73,14 @@ - - - - - @@ -154,16 +141,7 @@ - - - - - - - - - @@ -402,13 +380,9 @@ - - - - @@ -437,6 +411,7 @@ + @@ -444,12 +419,11 @@ - - - - - - + + + + + @@ -475,12 +449,6 @@ - - - - - - diff --git a/files.html b/files.html index d8e131b..562b475 100644 --- a/files.html +++ b/files.html @@ -88,43 +88,36 @@
Here is a list of all documented files with brief descriptions:
-
[detail level 12345]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
[detail level 1234]
 ▼ examples
 ▼ basic-config
 ▼ src
 ▼ apps
 ConfigApp.h
 DeviceFunctionsApp.h
 board.h
 ▼ src
 ▼ ksf
 ▼ comp
 ksConfigProvider.h
 ksDevicePortal.h
 ksDevStatMqttReporter.h
 ksLed.h
 ksMqttConfigProvider.h
 ksMqttConnector.h
 ksResetButton.h
 ksWifiConfigurator.h
 ksWifiConnector.h
 ▼ evt
 ksEvent.h
 ksEventHandle.h
 ksEventInterface.h
 ▼ misc
 ksWSServer.h
 ▼ res
 otaWebpage.h
 ksApplication.h
 ksAppRotator.h
 ksCertUtils.h
 ksComponent.h
 ksConfig.h
 ksConstants.h
 ksRtti.h
 ksSimpleTimer.h
 ksIotFrameworkLib.h
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼ src
 ▼ ksf
 ▼ comp
 ksConfigProvider.h
 ksDevicePortal.h
 ksDevStatMqttReporter.h
 ksLed.h
 ksMqttConfigProvider.h
 ksMqttConnector.h
 ksResetButton.h
 ksWifiConfigurator.h
 ksWifiConnector.h
 ▼ evt
 ksEvent.h
 ksEventHandle.h
 ksEventInterface.h
 ▼ misc
 ksWSServer.h
 ▼ res
 otaWebpage.h
 ksApplication.h
 ksAppRotator.h
 ksCertUtils.h
 ksComponent.h
 ksConfig.h
 ksConstants.h
 ksRtti.h
 ksSimpleTimer.h
 ksIotFrameworkLib.h
diff --git a/functions_func.html b/functions_func.html index 5cb430f..4591ecb 100644 --- a/functions_func.html +++ b/functions_func.html @@ -135,7 +135,7 @@

- h -