Doxygen with github
Loading...
Searching...
No Matches
ksWifiConfigurator.h
1/*
2 * Copyright (c) 2021-2023, Krzysztof Strehlau
3 *
4 * This file is a part of the ksIotFramework library.
5 * All licensing information can be found inside LICENSE.md file.
6 *
7 * https://github.com/cziter15/ksIotFrameworkLib/blob/master/LICENSE
8 */
9
10#pragma once
11
12#include <string>
13#include "../ksComponent.h"
14#include "../ksSimpleTimer.h"
15namespace ksf::comps
16{
24 {
25 KSF_RTTI_DECLARATIONS(ksWifiConfigurator, ksComponent)
26
27 protected:
28 ksApplication* app{nullptr};
29 std::string deviceName;
32
37
38 public:
43
48 ksWifiConfigurator(std::string devicePrefixName);
49
59 bool loop(ksApplication* app) override;
60
66 bool init(ksApplication* app) override;
67
73 bool postInit(ksApplication* app) override;
74
78 virtual ~ksWifiConfigurator();
79 };
80}
A component that manages AP-based configuration.
Definition ksWifiConfigurator.h:24
ksf::ksSimpleTimer configTimeout
Timeout for captive portal in ms.
Definition ksWifiConfigurator.h:30
ksWifiConfigurator()
Constructs WiFi configurator object.
Definition ksWifiConfigurator.cpp:29
void handlePeriodicTasks()
Handles periodic tasks like WiFi management.
Definition ksWifiConfigurator.cpp:68
ksApplication * app
Pointer to ksApplication object that owns this component.
Definition ksWifiConfigurator.h:28
virtual ~ksWifiConfigurator()
Destructs WiFi configurator component.
Definition ksWifiConfigurator.cpp:82
bool loop(ksApplication *app) override
Handles ksWifiConfigurator logic.
Definition ksWifiConfigurator.cpp:74
ksf::ksSimpleTimer periodicTasksTimeout
Timeout for loop in ms.
Definition ksWifiConfigurator.h:31
bool init(ksApplication *app) override
Implements ksWifiConfigurator initialization logic.
Definition ksWifiConfigurator.cpp:49
std::string deviceName
Device name (prefix).
Definition ksWifiConfigurator.h:29
bool postInit(ksApplication *app) override
Implements ksWifiConfigurator post-initialization logic.
Definition ksWifiConfigurator.cpp:56
A class that is a base for user-defined application.
Definition ksApplication.h:43
Base component class.
Definition ksComponent.h:51
Simple timer class, without using component architecture.
Definition ksSimpleTimer.h:27