Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-09-14 10:35:30 +00:00
Code Issues Releases Activity
Files
7dfe49cda786f3cfbe8ab4d297e2f186a5f3df91
ESPEasy/src/WebServer_ControllerPage.ino
T

390 lines
15 KiB
Arduino
Raw Blame History

#ifdef WEBSERVER_CONTROLLERS
#include "src/Globals/CPlugins.h"
// ********************************************************************************
// Web Interface controller page
// ********************************************************************************
void handle_controllers() {
checkRAM(F("handle_controllers"));
if (!isLoggedIn()) { return; }
navMenuIndex = MENU_INDEX_CONTROLLERS;
TXBuffer.startStream();
sendHeadandTail_stdtemplate(_HEAD);
byte controllerindex = getFormItemInt(F("index"), 0);
boolean controllerNotSet = controllerindex == 0;
--controllerindex; // Index in URL is starting from 1, but starting from 0 in the array.
const int protocol = getFormItemInt(F("protocol"), -1);
// submitted data
if ((protocol != -1) && !controllerNotSet)
{
bool mustInit = false;
bool mustCallCpluginSave = false;
{
// Place in a scope to free ControllerSettings memory ASAP
MakeControllerSettings(ControllerSettings);
if (Settings.Protocol[controllerindex] != protocol)
{
// Protocol has changed.
Settings.Protocol[controllerindex] = protocol;
// there is a protocol selected?
if (protocol != 0)
{
mustInit = true;
handle_controllers_clearLoadDefaults(controllerindex, ControllerSettings);
}
}
// subitted same protocol
else
{
// there is a protocol selected
if (protocol != 0)
{
mustInit = true;
handle_controllers_CopySubmittedSettings(controllerindex, ControllerSettings);
mustCallCpluginSave = true;
}
}
addHtmlError(SaveControllerSettings(controllerindex, ControllerSettings));
}
if (mustCallCpluginSave) {
// Call CPLUGIN_WEBFORM_SAVE after destructing ControllerSettings object to reduce RAM usage.
// Controller plugin almost only deals with custom controller settings.
// Even if they need to save things to the ControllerSettings, then the changes must
// already be saved first as the CPluginCall does not have the ControllerSettings as argument.
handle_controllers_CopySubmittedSettings_CPluginCall(controllerindex);
}
addHtmlError(SaveSettings());
if (mustInit) {
// Init controller plugin using the new settings.
protocolIndex_t ProtocolIndex = getProtocolIndex_from_ControllerIndex(controllerindex);
if (validProtocolIndex(ProtocolIndex)) {
struct EventStruct TempEvent;
TempEvent.ControllerIndex = controllerindex;
String dummy;
byte cfunction = Settings.ControllerEnabled[controllerindex] ? CPlugin::Function::CPLUGIN_INIT : CPlugin::Function::CPLUGIN_EXIT;
CPluginCall(ProtocolIndex, static_cast<CPlugin::Function>(cfunction), &TempEvent, dummy);
}
}
}
html_add_form();
if (controllerNotSet)
{
handle_controllers_ShowAllControllersTable();
}
else
{
handle_controllers_ControllerSettingsPage(controllerindex);
}
sendHeadandTail_stdtemplate(_TAIL);
TXBuffer.endStream();
}
// ********************************************************************************
// Selected controller has changed.
// Clear all Controller settings and load some defaults
// ********************************************************************************
void handle_controllers_clearLoadDefaults(byte controllerindex, ControllerSettingsStruct& ControllerSettings)
{
// Protocol has changed and it was not an empty one.
// reset (some) default-settings
protocolIndex_t ProtocolIndex = getProtocolIndex(Settings.Protocol[controllerindex]);
if (!validProtocolIndex(ProtocolIndex)) {
return;
}
ControllerSettings.reset();
ControllerSettings.Port = Protocol[ProtocolIndex].defaultPort;
// Load some templates from the controller.
struct EventStruct TempEvent;
if (Protocol[ProtocolIndex].usesTemplate) {
String dummy;
CPluginCall(ProtocolIndex, CPlugin::Function::CPLUGIN_PROTOCOL_TEMPLATE, &TempEvent, dummy);
}
safe_strncpy(ControllerSettings.Subscribe, TempEvent.String1.c_str(), sizeof(ControllerSettings.Subscribe));
safe_strncpy(ControllerSettings.Publish, TempEvent.String2.c_str(), sizeof(ControllerSettings.Publish));
safe_strncpy(ControllerSettings.MQTTLwtTopic, TempEvent.String3.c_str(), sizeof(ControllerSettings.MQTTLwtTopic));
safe_strncpy(ControllerSettings.LWTMessageConnect, TempEvent.String4.c_str(), sizeof(ControllerSettings.LWTMessageConnect));
safe_strncpy(ControllerSettings.LWTMessageDisconnect, TempEvent.String5.c_str(), sizeof(ControllerSettings.LWTMessageDisconnect));
// NOTE: do not enable controller by default, give user a change to enter sensible values first
Settings.ControllerEnabled[controllerindex] = false;
// not resetted to default (for convenience)
// SecuritySettings.ControllerUser[controllerindex]
// SecuritySettings.ControllerPassword[controllerindex]
ClearCustomControllerSettings(controllerindex);
}
// ********************************************************************************
// Collect all submitted form data and store in the ControllerSettings
// ********************************************************************************
void handle_controllers_CopySubmittedSettings(byte controllerindex, ControllerSettingsStruct& ControllerSettings)
{
// copy all settings to controller settings struct
for (int parameterIdx = 0; parameterIdx <= ControllerSettingsStruct::CONTROLLER_ENABLED; ++parameterIdx) {
ControllerSettingsStruct::VarType varType = static_cast<ControllerSettingsStruct::VarType>(parameterIdx);
saveControllerParameterForm(ControllerSettings, controllerindex, varType);
}
}
void handle_controllers_CopySubmittedSettings_CPluginCall(byte controllerindex) {
protocolIndex_t ProtocolIndex = getProtocolIndex_from_ControllerIndex(controllerindex);
if (validProtocolIndex(ProtocolIndex)) {
struct EventStruct TempEvent;
TempEvent.ControllerIndex = controllerindex;
// Call controller plugin to save CustomControllerSettings
String dummy;
CPluginCall(ProtocolIndex, CPlugin::Function::CPLUGIN_WEBFORM_SAVE, &TempEvent, dummy);
}
}
// ********************************************************************************
// Show table with all selected controllers
// ********************************************************************************
void handle_controllers_ShowAllControllersTable()
{
html_table_class_multirow();
html_TR();
html_table_header("", 70);
html_table_header("Nr", 50);
html_table_header(F("Enabled"), 100);
html_table_header(F("Protocol"));
html_table_header("Host");
html_table_header("Port");
MakeControllerSettings(ControllerSettings);
if (AllocatedControllerSettings()) {
for (controllerIndex_t x = 0; x < CONTROLLER_MAX; x++)
{
const bool cplugin_set = Settings.Protocol[x] != INVALID_C_PLUGIN_ID;
LoadControllerSettings(x, ControllerSettings);
html_TR_TD();
if (cplugin_set && !supportedCPluginID(Settings.Protocol[x])) {
html_add_button_prefix(F("red"), true);
} else {
html_add_button_prefix();
}
{
String html;
html.reserve(32);
html += F("controllers?index=");
html += x + 1;
html += F("'>");
if (cplugin_set) {
html += F("Edit");
} else {
html += F("Add");
}
html += F("</a><TD>");
html += getControllerSymbol(x);
addHtml(html);
}
html_TD();
if (cplugin_set)
{
addEnabled(Settings.ControllerEnabled[x]);
html_TD();
addHtml(getCPluginNameFromCPluginID(Settings.Protocol[x]));
html_TD();
{
const protocolIndex_t ProtocolIndex = getProtocolIndex_from_ControllerIndex(x);
String hostDescription;
CPluginCall(ProtocolIndex, CPlugin::Function::CPLUGIN_WEBFORM_SHOW_HOST_CONFIG, 0, hostDescription);
if (hostDescription.length() != 0) {
addHtml(hostDescription);
} else {
addHtml(ControllerSettings.getHost());
}
}
html_TD();
addHtml(String(ControllerSettings.Port));
}
else {
html_TD(3);
}
}
}
html_end_table();
html_end_form();
}
// ********************************************************************************
// Show the controller settings page
// ********************************************************************************
void handle_controllers_ControllerSettingsPage(controllerIndex_t controllerindex)
{
if (!validControllerIndex(controllerindex)) {
return;
}
// Show controller settings page
html_table_class_normal();
addFormHeader(F("Controller Settings"));
addRowLabel(F("Protocol"));
byte choice = Settings.Protocol[controllerindex];
addSelector_Head_reloadOnChange(F("protocol"));
addSelector_Item(F("- Standalone -"), 0, false, false, "");
for (byte x = 0; x <= protocolCount; x++)
{
boolean disabled = false; // !((controllerindex == 0) || !Protocol[x].usesMQTT);
addSelector_Item(getCPluginNameFromProtocolIndex(x),
Protocol[x].Number,
choice == Protocol[x].Number,
disabled,
"");
}
addSelector_Foot();
addHelpButton(F("EasyProtocols"));
const protocolIndex_t ProtocolIndex = getProtocolIndex_from_ControllerIndex(controllerindex);
if (Settings.Protocol[controllerindex])
{
{
MakeControllerSettings(ControllerSettings);
if (!AllocatedControllerSettings()) {
addHtmlError(F("Out of memory, cannot load page"));
} else {
LoadControllerSettings(controllerindex, ControllerSettings);
if (!Protocol[ProtocolIndex].Custom)
{
if (Protocol[ProtocolIndex].usesHost) {
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_USE_DNS);
if (ControllerSettings.UseDNS)
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_HOSTNAME);
}
else
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_IP);
}
}
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_PORT);
if (Protocol[ProtocolIndex].usesQueue) {
addTableSeparator(F("Controller Queue"), 2, 3);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_MIN_SEND_INTERVAL);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_MAX_QUEUE_DEPTH);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_MAX_RETRIES);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_FULL_QUEUE_ACTION);
}
if (Protocol[ProtocolIndex].usesCheckReply) {
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_CHECK_REPLY);
}
if (Protocol[ProtocolIndex].usesTimeout) {
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_TIMEOUT);
}
if (Protocol[ProtocolIndex].usesSampleSets) {
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_SAMPLE_SET_INITIATOR);
}
if (Protocol[ProtocolIndex].useExtendedCredentials()) {
addTableSeparator(F("Credentials"), 2, 3);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_USE_EXTENDED_CREDENTIALS);
}
if (Protocol[ProtocolIndex].usesAccount)
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_USER);
}
if (Protocol[ProtocolIndex].usesPassword)
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_PASS);
}
#ifdef USES_MQTT
if (Protocol[ProtocolIndex].usesMQTT) {
addTableSeparator(F("MQTT"), 2, 3);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_CLIENT_ID);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_UNIQUE_CLIENT_ID_RECONNECT);
addRowLabel(F("Current Client ID"));
addHtml(getMQTTclientID(ControllerSettings));
addFormNote(F("Updated on load of this page"));
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_RETAINFLAG);
}
#endif // USES_MQTT
if (Protocol[ProtocolIndex].usesTemplate || Protocol[ProtocolIndex].usesMQTT)
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_SUBSCRIBE);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_PUBLISH);
}
#ifdef USES_MQTT
if (Protocol[ProtocolIndex].usesMQTT)
{
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_LWT_TOPIC);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_LWT_CONNECT_MESSAGE);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_LWT_DISCONNECT_MESSAGE);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_SEND_LWT);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_WILL_RETAIN);
addControllerParameterForm(ControllerSettings, controllerindex, ControllerSettingsStruct::CONTROLLER_CLEAN_SESSION);
}
#endif // USES_MQTT
}
}
// End of scope for ControllerSettings, destruct it to save memory.
}
{
// Load controller specific settings
struct EventStruct TempEvent;
TempEvent.ControllerIndex = controllerindex;
String webformLoadString;
CPluginCall(ProtocolIndex, CPlugin::Function::CPLUGIN_WEBFORM_LOAD, &TempEvent, webformLoadString);
if (webformLoadString.length() > 0) {
addHtmlError(F("Bug in CPlugin::Function::CPLUGIN_WEBFORM_LOAD, should not append to string, use addHtml() instead"));
}
}
// Separate enabled checkbox as it doesn't need to use the ControllerSettings.
// So ControllerSettings object can be destructed before controller specific settings are loaded.
addControllerEnabledForm(controllerindex);
}
addFormSeparator(2);
html_TR_TD();
html_TD();
addButton(F("controllers"), F("Close"));
addSubmitButton();
html_end_table();
html_end_form();
}
#endif // ifdef WEBSERVER_CONTROLLERS
View Git Blame Copy Permalink