mirror of
https://github.com/letscontrolit/ESPEasy.git
synced 2026-09-12 01:24:04 +00:00
Gijs Noorlander
022ca8a6ec
For LoRa, it may take a while to send out samples of different plugins. This makes it hard to match samples belonging to the same set after receiving them. The Sample Set Initiator is a task index which should always be considered as the first of a set samples sent to the controller. For example when triggering to send a set of samples from rules, its order can be always the same. Setting the initiator to the first one of the sequence, the same sample set counter will be sent along with the samples.
262 lines
11 KiB
Arduino
262 lines
11 KiB
Arduino
/*********************************************************************************************\
|
|
* Functions to load and store controller settings on the web page.
|
|
\*********************************************************************************************/
|
|
String getControllerParameterName(byte ProtocolIndex, byte parameterIdx, bool displayName, bool& isAlternative) {
|
|
String name;
|
|
|
|
if (displayName) {
|
|
EventStruct tmpEvent;
|
|
tmpEvent.idx = parameterIdx;
|
|
|
|
if (CPluginCall(ProtocolIndex, CPLUGIN_GET_PROTOCOL_DISPLAY_NAME, &tmpEvent, name)) {
|
|
// Found an alternative name for it.
|
|
isAlternative = true;
|
|
return name;
|
|
}
|
|
}
|
|
isAlternative = false;
|
|
|
|
switch (parameterIdx) {
|
|
case CONTROLLER_USE_DNS: name = F("Locate Controller"); break;
|
|
case CONTROLLER_HOSTNAME: name = F("Controller Hostname"); break;
|
|
case CONTROLLER_IP: name = F("Controller IP"); break;
|
|
case CONTROLLER_PORT: name = F("Controller Port"); break;
|
|
case CONTROLLER_USER: name = F("Controller User"); break;
|
|
case CONTROLLER_PASS: name = F("Controller Password"); break;
|
|
|
|
case CONTROLLER_MIN_SEND_INTERVAL: name = F("Minimum Send Interval"); break;
|
|
case CONTROLLER_MAX_QUEUE_DEPTH: name = F("Max Queue Depth"); break;
|
|
case CONTROLLER_MAX_RETRIES: name = F("Max Retries"); break;
|
|
case CONTROLLER_FULL_QUEUE_ACTION: name = F("Full Queue Action"); break;
|
|
case CONTROLLER_CHECK_REPLY: name = F("Check Reply"); break;
|
|
|
|
case CONTROLLER_SUBSCRIBE: name = F("Controller Subscribe"); break;
|
|
case CONTROLLER_PUBLISH: name = F("Controller Publish"); break;
|
|
case CONTROLLER_LWT_TOPIC: name = F("Controller LWT Topic"); break;
|
|
case CONTROLLER_LWT_CONNECT_MESSAGE: name = F("LWT Connect Message"); break;
|
|
case CONTROLLER_LWT_DISCONNECT_MESSAGE: name = F("LWT Disconnect Message"); break;
|
|
case CONTROLLER_TIMEOUT: name = F("Client Timeout"); break;
|
|
case CONTROLLER_SAMPLE_SET_INITIATOR: name = F("Sample Set Initiator"); break;
|
|
|
|
case CONTROLLER_ENABLED:
|
|
|
|
if (displayName) { name = F("Enabled"); }
|
|
else { name = F("controllerenabled"); }
|
|
break;
|
|
|
|
default:
|
|
name = F("Undefined");
|
|
}
|
|
|
|
if (!displayName) {
|
|
// Change name to lower case and remove spaces to make it an internal name.
|
|
name.toLowerCase();
|
|
name.replace(" ", "");
|
|
}
|
|
return name;
|
|
}
|
|
|
|
String getControllerParameterInternalName(byte ProtocolIndex, byte parameterIdx) {
|
|
bool isAlternative; // Dummy, not needed for internal name
|
|
bool displayName = false;
|
|
|
|
return getControllerParameterName(ProtocolIndex, parameterIdx, displayName, isAlternative);
|
|
}
|
|
|
|
String getControllerParameterDisplayName(byte ProtocolIndex, byte parameterIdx, bool& isAlternative) {
|
|
bool displayName = true;
|
|
|
|
return getControllerParameterName(ProtocolIndex, parameterIdx, displayName, isAlternative);
|
|
}
|
|
|
|
void addControllerParameterForm(const ControllerSettingsStruct& ControllerSettings, byte controllerindex, byte parameterIdx) {
|
|
byte ProtocolIndex = getProtocolIndex(Settings.Protocol[controllerindex]);
|
|
bool isAlternativeDisplayName = false;
|
|
String displayName = getControllerParameterDisplayName(ProtocolIndex, parameterIdx, isAlternativeDisplayName);
|
|
String internalName = getControllerParameterInternalName(ProtocolIndex, parameterIdx);
|
|
|
|
switch (parameterIdx) {
|
|
case CONTROLLER_USE_DNS:
|
|
{
|
|
byte choice = ControllerSettings.UseDNS;
|
|
String options[2];
|
|
options[0] = F("Use IP address");
|
|
options[1] = F("Use Hostname");
|
|
addFormSelector(displayName, internalName, 2, options, NULL, NULL, choice, true);
|
|
break;
|
|
}
|
|
case CONTROLLER_HOSTNAME:
|
|
{
|
|
addFormTextBox(displayName, internalName, ControllerSettings.HostName, sizeof(ControllerSettings.HostName) - 1);
|
|
break;
|
|
}
|
|
case CONTROLLER_IP:
|
|
{
|
|
addFormIPBox(displayName, internalName, ControllerSettings.IP);
|
|
break;
|
|
}
|
|
case CONTROLLER_PORT:
|
|
{
|
|
addFormNumericBox(displayName, internalName, ControllerSettings.Port, 1, 65535);
|
|
break;
|
|
}
|
|
case CONTROLLER_USER:
|
|
{
|
|
addFormTextBox(displayName,
|
|
internalName,
|
|
SecuritySettings.ControllerUser[controllerindex],
|
|
sizeof(SecuritySettings.ControllerUser[0]) - 1);
|
|
break;
|
|
}
|
|
case CONTROLLER_PASS:
|
|
{
|
|
if (isAlternativeDisplayName) {
|
|
// It is not a regular password, thus use normal text field.
|
|
addFormTextBox(displayName, internalName, SecuritySettings.ControllerPassword[controllerindex],
|
|
sizeof(SecuritySettings.ControllerPassword[0]) - 1);
|
|
} else {
|
|
addFormPasswordBox(displayName, internalName, SecuritySettings.ControllerPassword[controllerindex],
|
|
sizeof(SecuritySettings.ControllerPassword[0]) - 1);
|
|
}
|
|
break;
|
|
}
|
|
case CONTROLLER_MIN_SEND_INTERVAL:
|
|
{
|
|
addFormNumericBox(displayName, internalName, ControllerSettings.MinimalTimeBetweenMessages, 1, CONTROLLER_DELAY_QUEUE_DELAY_MAX);
|
|
addUnit(F("ms"));
|
|
break;
|
|
}
|
|
case CONTROLLER_MAX_QUEUE_DEPTH:
|
|
{
|
|
addFormNumericBox(displayName, internalName, ControllerSettings.MaxQueueDepth, 1, CONTROLLER_DELAY_QUEUE_DEPTH_MAX);
|
|
break;
|
|
}
|
|
case CONTROLLER_MAX_RETRIES:
|
|
{
|
|
addFormNumericBox(displayName, internalName, ControllerSettings.MaxRetry, 1, CONTROLLER_DELAY_QUEUE_RETRY_MAX);
|
|
break;
|
|
}
|
|
case CONTROLLER_FULL_QUEUE_ACTION:
|
|
{
|
|
String options[2];
|
|
options[0] = F("Ignore New");
|
|
options[1] = F("Delete Oldest");
|
|
addFormSelector(displayName, internalName, 2, options, NULL, NULL, ControllerSettings.DeleteOldest, false);
|
|
break;
|
|
}
|
|
case CONTROLLER_CHECK_REPLY:
|
|
{
|
|
String options[2];
|
|
options[0] = F("Ignore Acknowledgement");
|
|
options[1] = F("Check Acknowledgement");
|
|
addFormSelector(displayName, internalName, 2, options, NULL, NULL, ControllerSettings.MustCheckReply, false);
|
|
break;
|
|
}
|
|
case CONTROLLER_SUBSCRIBE:
|
|
addFormTextBox(displayName, internalName, ControllerSettings.Subscribe, sizeof(ControllerSettings.Subscribe) - 1);
|
|
break;
|
|
case CONTROLLER_PUBLISH:
|
|
addFormTextBox(displayName, internalName, ControllerSettings.Publish, sizeof(ControllerSettings.Publish) - 1);
|
|
break;
|
|
case CONTROLLER_LWT_TOPIC:
|
|
addFormTextBox(displayName, internalName, ControllerSettings.MQTTLwtTopic, sizeof(ControllerSettings.MQTTLwtTopic) - 1);
|
|
break;
|
|
case CONTROLLER_LWT_CONNECT_MESSAGE:
|
|
addFormTextBox(displayName, internalName, ControllerSettings.LWTMessageConnect, sizeof(ControllerSettings.LWTMessageConnect) - 1);
|
|
break;
|
|
case CONTROLLER_LWT_DISCONNECT_MESSAGE:
|
|
addFormTextBox(displayName, internalName, ControllerSettings.LWTMessageDisconnect, sizeof(ControllerSettings.LWTMessageDisconnect) - 1);
|
|
break;
|
|
case CONTROLLER_TIMEOUT:
|
|
addFormNumericBox(displayName, internalName, ControllerSettings.ClientTimeout, 10, CONTROLLER_CLIENTTIMEOUT_MAX);
|
|
addUnit(F("ms"));
|
|
break;
|
|
case CONTROLLER_SAMPLE_SET_INITIATOR:
|
|
addTaskSelectBox(displayName, internalName, ControllerSettings.SampleSetInitiator);
|
|
break;
|
|
case CONTROLLER_ENABLED:
|
|
addFormCheckBox(displayName, internalName, Settings.ControllerEnabled[controllerindex]);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void saveControllerParameterForm(ControllerSettingsStruct& ControllerSettings, byte controllerindex, byte parameterIdx) {
|
|
byte ProtocolIndex = getProtocolIndex(Settings.Protocol[controllerindex]);
|
|
String internalName = getControllerParameterInternalName(ProtocolIndex, parameterIdx);
|
|
|
|
switch (parameterIdx) {
|
|
case CONTROLLER_USE_DNS: ControllerSettings.UseDNS = getFormItemInt(internalName); break;
|
|
case CONTROLLER_HOSTNAME:
|
|
|
|
if (ControllerSettings.UseDNS)
|
|
{
|
|
strncpy_webserver_arg(ControllerSettings.HostName, internalName);
|
|
IPAddress IP;
|
|
resolveHostByName(ControllerSettings.HostName, IP);
|
|
|
|
for (byte x = 0; x < 4; x++) {
|
|
ControllerSettings.IP[x] = IP[x];
|
|
}
|
|
}
|
|
break;
|
|
case CONTROLLER_IP:
|
|
|
|
if (!ControllerSettings.UseDNS)
|
|
{
|
|
String controllerip = WebServer.arg(internalName);
|
|
str2ip(controllerip, ControllerSettings.IP);
|
|
}
|
|
break;
|
|
case CONTROLLER_PORT:
|
|
ControllerSettings.Port = getFormItemInt(internalName, ControllerSettings.Port);
|
|
break;
|
|
case CONTROLLER_USER:
|
|
strncpy_webserver_arg(SecuritySettings.ControllerUser[controllerindex], internalName);
|
|
break;
|
|
case CONTROLLER_PASS:
|
|
copyFormPassword(internalName, SecuritySettings.ControllerPassword[controllerindex], sizeof(SecuritySettings.ControllerPassword[0]));
|
|
break;
|
|
|
|
case CONTROLLER_MIN_SEND_INTERVAL:
|
|
ControllerSettings.MinimalTimeBetweenMessages = getFormItemInt(internalName, ControllerSettings.MinimalTimeBetweenMessages);
|
|
break;
|
|
case CONTROLLER_MAX_QUEUE_DEPTH:
|
|
ControllerSettings.MaxQueueDepth = getFormItemInt(internalName, ControllerSettings.MaxQueueDepth);
|
|
break;
|
|
case CONTROLLER_MAX_RETRIES:
|
|
ControllerSettings.MaxRetry = getFormItemInt(internalName, ControllerSettings.MaxRetry);
|
|
break;
|
|
case CONTROLLER_FULL_QUEUE_ACTION:
|
|
ControllerSettings.DeleteOldest = getFormItemInt(internalName, ControllerSettings.DeleteOldest);
|
|
break;
|
|
case CONTROLLER_CHECK_REPLY:
|
|
ControllerSettings.MustCheckReply = getFormItemInt(internalName, ControllerSettings.MustCheckReply);
|
|
break;
|
|
|
|
case CONTROLLER_SUBSCRIBE:
|
|
strncpy_webserver_arg(ControllerSettings.Subscribe, internalName);
|
|
break;
|
|
case CONTROLLER_PUBLISH:
|
|
strncpy_webserver_arg(ControllerSettings.Publish, internalName);
|
|
break;
|
|
case CONTROLLER_LWT_TOPIC:
|
|
strncpy_webserver_arg(ControllerSettings.MQTTLwtTopic, internalName);
|
|
break;
|
|
case CONTROLLER_LWT_CONNECT_MESSAGE:
|
|
strncpy_webserver_arg(ControllerSettings.LWTMessageConnect, internalName);
|
|
break;
|
|
case CONTROLLER_LWT_DISCONNECT_MESSAGE:
|
|
strncpy_webserver_arg(ControllerSettings.LWTMessageDisconnect, internalName);
|
|
break;
|
|
case CONTROLLER_TIMEOUT:
|
|
ControllerSettings.ClientTimeout = getFormItemInt(internalName, ControllerSettings.ClientTimeout);
|
|
break;
|
|
case CONTROLLER_SAMPLE_SET_INITIATOR:
|
|
ControllerSettings.SampleSetInitiator = getFormItemInt(internalName, ControllerSettings.SampleSetInitiator);
|
|
break;
|
|
case CONTROLLER_ENABLED:
|
|
Settings.ControllerEnabled[controllerindex] = isFormItemChecked(internalName);
|
|
break;
|
|
}
|
|
}
|