deploy: 9a3f862

ks_device_portal_8h_source.html

@@ -212,7 +212,7 @@
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a0ed6c88eac9a0254d732d74566ca12b1"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1">ksf::comps::ksDevicePortal::app</a></div><div class="ttdeci">ksf::ksApplication * app</div><div class="ttdoc">Application pointer.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:55</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a2992c9c68c1b62d4ddc6e0a64e1edfc7"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a2992c9c68c1b62d4ddc6e0a64e1edfc7">ksf::comps::ksDevicePortal::onWebsocketTextMessage</a></div><div class="ttdeci">void onWebsocketTextMessage(uint8_t clientNum, const std::string_view &amp;message)</div><div class="ttdoc">Handles websocket text message.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:206</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a2b75ab8090a6ac95008c3f6f417d821e"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a2b75ab8090a6ac95008c3f6f417d821e">ksf::comps::ksDevicePortal::init</a></div><div class="ttdeci">bool init(ksApplication *app) override</div><div class="ttdoc">Initializes the device portal component.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:100</div></div>
-<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a2fc892e79d3813ab7b6135df5a475aee"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a2fc892e79d3813ab7b6135df5a475aee">ksf::comps::ksDevicePortal::setupWsServer</a></div><div class="ttdeci">void setupWsServer()</div><div class="ttdoc">Starts device portal WebSocket server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:601</div></div>
+<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a2fc892e79d3813ab7b6135df5a475aee"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a2fc892e79d3813ab7b6135df5a475aee">ksf::comps::ksDevicePortal::setupWsServer</a></div><div class="ttdeci">void setupWsServer()</div><div class="ttdoc">Starts device portal WebSocket server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:606</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a2febff831199e81498a8bbf8b91f0e4b"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a2febff831199e81498a8bbf8b91f0e4b">ksf::comps::ksDevicePortal::updateFinished</a></div><div class="ttdeci">void updateFinished(bool fromPortal)</div><div class="ttdoc">Implements post-OTA update actions.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:188</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a320c4d5b38d622379742b43f4fa99464"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a320c4d5b38d622379742b43f4fa99464">ksf::comps::ksDevicePortal::portalPassword</a></div><div class="ttdeci">std::string portalPassword</div><div class="ttdoc">Portal password.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:63</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a3943c29bbb8bea8568154903c379a8a4"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a3943c29bbb8bea8568154903c379a8a4">ksf::comps::ksDevicePortal::postInit</a></div><div class="ttdeci">bool postInit(ksApplication *app) override</div><div class="ttdoc">Post-initializes the device portal component.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:110</div></div>
@@ -231,13 +231,13 @@
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a936722fcf49ca3cd49b58ad6fe207e22"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a936722fcf49ca3cd49b58ad6fe207e22">ksf::comps::ksDevicePortal::logKeepAliveTimestamp</a></div><div class="ttdeci">uint32_t logKeepAliveTimestamp</div><div class="ttdoc">Flag indicating whether logs are enabled.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:58</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a94f2d902c9447d79a165cdb0ed7417ab"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a94f2d902c9447d79a165cdb0ed7417ab">ksf::comps::ksDevicePortal::onUpdateStart</a></div><div class="ttdeci">std::shared_ptr&lt; ksf::evt::ksEvent&lt;&gt; &gt; onUpdateStart</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:178</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_a9d9ecd302b4ef31f3778baf91eed0e48"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#a9d9ecd302b4ef31f3778baf91eed0e48">ksf::comps::ksDevicePortal::dnsServer</a></div><div class="ttdeci">std::unique_ptr&lt; DNSServer &gt; dnsServer</div><div class="ttdoc">DNS server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:68</div></div>
-<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aa22aed11bcaa38f7977b3aa1c2313142"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aa22aed11bcaa38f7977b3aa1c2313142">ksf::comps::ksDevicePortal::loop</a></div><div class="ttdeci">bool loop(ksApplication *app) override</div><div class="ttdoc">Handles core logic of the device portal component.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:614</div></div>
+<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aa22aed11bcaa38f7977b3aa1c2313142"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aa22aed11bcaa38f7977b3aa1c2313142">ksf::comps::ksDevicePortal::loop</a></div><div class="ttdeci">bool loop(ksApplication *app) override</div><div class="ttdoc">Handles core logic of the device portal component.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:619</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aa3e6eaa1d017188595ae3eee922eca06"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aa3e6eaa1d017188595ae3eee922eca06">ksf::comps::ksDevicePortal::handle_getIdentity</a></div><div class="ttdeci">void handle_getIdentity(std::string &amp;response)</div><div class="ttdoc">Websocket handler for identity endpoint (device details).</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:332</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aadf8b151247f2364ac2da012acb51738"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aadf8b151247f2364ac2da012acb51738">ksf::comps::ksDevicePortal::inRequest_NeedAuthentication</a></div><div class="ttdeci">bool inRequest_NeedAuthentication()</div><div class="ttdoc">Checks if current HTTP request requires authentication.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:194</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aaf77328746a9a3f01a584ffdf53a90c8"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aaf77328746a9a3f01a584ffdf53a90c8">ksf::comps::ksDevicePortal::onRequest_otaFinish</a></div><div class="ttdeci">void onRequest_otaFinish()</div><div class="ttdoc">HTTP handler for OTA finish endpoint.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:534</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_ac0a6eac49ee8ccd90f1f074b0e097ef2"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#ac0a6eac49ee8ccd90f1f074b0e097ef2">ksf::comps::ksDevicePortal::lastLoopExecutionTimestamp</a></div><div class="ttdeci">uint32_t lastLoopExecutionTimestamp</div><div class="ttdoc">Time of last loop execution (us)/.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:59</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_ace71e2cafe4c513d17b9a322f5916a74"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#ace71e2cafe4c513d17b9a322f5916a74">ksf::comps::ksDevicePortal::rebootDevice</a></div><div class="ttdeci">void rebootDevice()</div><div class="ttdoc">Reboots the device.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:136</div></div>
-<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_ae6c76bee527e97fbd9a4e08d09306633"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#ae6c76bee527e97fbd9a4e08d09306633">ksf::comps::ksDevicePortal::setupHttpServer</a></div><div class="ttdeci">void setupHttpServer()</div><div class="ttdoc">Starts device portal HTTP server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:571</div></div>
+<div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_ae6c76bee527e97fbd9a4e08d09306633"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#ae6c76bee527e97fbd9a4e08d09306633">ksf::comps::ksDevicePortal::setupHttpServer</a></div><div class="ttdeci">void setupHttpServer()</div><div class="ttdoc">Starts device portal HTTP server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:576</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_ae705cc9a95902b82e08c6d87340cb380"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#ae705cc9a95902b82e08c6d87340cb380">ksf::comps::ksDevicePortal::loopExecutionTime</a></div><div class="ttdeci">uint32_t loopExecutionTime</div><div class="ttdoc">Diff (loop exec time).</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:60</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_aed3161ec11cf98fc8afa61e0868596ad"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#aed3161ec11cf98fc8afa61e0868596ad">ksf::comps::ksDevicePortal::webServer</a></div><div class="ttdeci">std::unique_ptr&lt; WebServerClass &gt; webServer</div><div class="ttdoc">HTTP server.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.h:66</div></div>
 <div class="ttc" id="aclassksf_1_1comps_1_1ks_device_portal_html_af57917c7ec92be83bf93cc83e6f92cc4"><div class="ttname"><a href="classksf_1_1comps_1_1ks_device_portal.html#af57917c7ec92be83bf93cc83e6f92cc4">ksf::comps::ksDevicePortal::handle_scanNetworks</a></div><div class="ttdeci">void handle_scanNetworks(std::string &amp;response)</div><div class="ttdoc">Websocket handler for network scan endpoint.</div><div class="ttdef"><b>Definition</b> ksDevicePortal.cpp:373</div></div>