demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

[pidcontroller] Reset command Item; Fix read-only states of config parameters (#9992)

Browse Source 
* [pidcontroller] Reset state of command Item after command has been processed
* Fix read-only state of item parameters

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
This commit is contained in:
Fabian Wolter 2021-01-31 21:03:25 +01:00 committed by GitHub
parent f1aec07181
commit fd1caea5aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 66 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/handler/PIDControllerTriggerHandler.java
View File

@ -47,6 +47,7 @@ import org.openhab.core.items.events.ItemStateEvent;
import org.openhab.core.library.types.StringType; import org.openhab.core.library.types.StringType;
import org.openhab.core.types.RefreshType; import org.openhab.core.types.RefreshType;
import org.openhab.core.types.State; import org.openhab.core.types.State;
import org.openhab.core.types.UnDefType;
import org.osgi.framework.BundleContext; import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration; import org.osgi.framework.ServiceRegistration;
import org.slf4j.Logger; import org.slf4j.Logger;
@ -73,10 +74,12 @@ public class PIDControllerTriggerHandler extends BaseTriggerModuleHandler implem
private Item setpointItem; private Item setpointItem;
private Optional<String> commandTopic; private Optional<String> commandTopic;
private EventFilter eventFilter; private EventFilter eventFilter;
private EventPublisher eventPublisher;
public PIDControllerTriggerHandler(Trigger module, ItemRegistry itemRegistry, EventPublisher eventPublisher, public PIDControllerTriggerHandler(Trigger module, ItemRegistry itemRegistry, EventPublisher eventPublisher,
BundleContext bundleContext) { BundleContext bundleContext) {
super(module); super(module);
this.eventPublisher = eventPublisher;
Configuration config = module.getConfiguration(); Configuration config = module.getConfiguration();
@ -210,7 +213,8 @@ public class PIDControllerTriggerHandler extends BaseTriggerModuleHandler implem
if ("RESET".equals(changedEvent.getItemState().toString())) { if ("RESET".equals(changedEvent.getItemState().toString())) {
controller.setIntegralResult(0); controller.setIntegralResult(0);
controller.setDerivativeResult(0); controller.setDerivativeResult(0);
} else { eventPublisher.post(ItemEventFactory.createStateEvent(changedEvent.getItemName(), UnDefType.NULL));
} else if (changedEvent.getItemState() != UnDefType.NULL) {
logger.warn("Unknown command: {}", changedEvent.getItemState()); logger.warn("Unknown command: {}", changedEvent.getItemState());
} }
} else { } else {

88
bundles/org.openhab.automation.pidcontroller/src/main/java/org/openhab/automation/pidcontroller/internal/type/PIDControllerTriggerType.java
View File

@ -37,33 +37,67 @@ public class PIDControllerTriggerType extends TriggerType {
public static PIDControllerTriggerType initialize() { public static PIDControllerTriggerType initialize() {
List<ConfigDescriptionParameter> configDescriptions = new ArrayList<>(); List<ConfigDescriptionParameter> configDescriptions = new ArrayList<>();
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_INPUT_ITEM, Type.TEXT).withRequired(true) configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_INPUT_ITEM, Type.TEXT) //
.withReadOnly(true).withMultiple(false).withContext("item").withLabel("Input Item") .withRequired(true) //
.withDescription("Item to monitor").build()); .withMultiple(false) //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_SETPOINT_ITEM, Type.TEXT) .withContext("item") //
.withRequired(true).withReadOnly(true).withMultiple(false).withContext("item").withLabel("Setpoint") .withLabel("Input Item") //
.withDescription("Targeted setpoint").build()); .withDescription("Item to monitor") //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KP_GAIN, Type.DECIMAL).withRequired(true) .build());
.withMultiple(false).withDefault("1.0").withMinimum(BigDecimal.ZERO).withLabel("Proportional Gain (Kp)") configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_SETPOINT_ITEM, Type.TEXT) //
.withDescription("Change to output propertional to current error value.").build()); .withRequired(true) //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KI_GAIN, Type.DECIMAL).withRequired(true) .withMultiple(false) //
.withMultiple(false).withDefault("1.0").withMinimum(BigDecimal.ZERO).withLabel("Integral Gain (Ki)") .withContext("item") //
.withDescription("Accelerate movement towards the setpoint.").build()); .withLabel("Setpoint") //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KD_GAIN, Type.DECIMAL).withRequired(true) .withDescription("Targeted setpoint") //
.withMultiple(false).withDefault("1.0").withMinimum(BigDecimal.ZERO).withLabel("Derivative Gain (Kd)") .build());
.withDescription("Slows the rate of change of the output.").build()); configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KP_GAIN, Type.DECIMAL).withRequired(true) //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KD_TIMECONSTANT, Type.DECIMAL) .withMultiple(false) //
.withRequired(true).withMultiple(false).withMinimum(BigDecimal.ZERO).withDefault("1.0") .withDefault("1.0") //
.withLabel("Derivative Time Constant") .withMinimum(BigDecimal.ZERO) //
.withDescription("Slows the rate of change of the D part (T1) in seconds.").withUnit("s").build()); .withLabel("Proportional Gain (Kp)") //
configDescriptions .withDescription("Change to output propertional to current error value.") //
.add(ConfigDescriptionParameterBuilder.create(CONFIG_COMMAND_ITEM, Type.TEXT).withRequired(false) .build());
.withReadOnly(true).withMultiple(false).withContext("item").withLabel("Command Item") configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KI_GAIN, Type.DECIMAL) //
.withDescription("You can send String commands to this Item like \"RESET\".").build()); .withRequired(true) //
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_LOOP_TIME, Type.DECIMAL) .withMultiple(false) //
.withRequired(true).withMultiple(false).withDefault(DEFAULT_LOOPTIME_MS).withLabel("Loop Time") .withDefault("1.0") //
.withDescription("The interval the output value is updated in ms").withUnit("ms").build()); .withMinimum(BigDecimal.ZERO) //
.withLabel("Integral Gain (Ki)") //
.withDescription("Accelerate movement towards the setpoint.") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KD_GAIN, Type.DECIMAL) //
.withRequired(true) //
.withMultiple(false) //
.withDefault("1.0") //
.withMinimum(BigDecimal.ZERO) //
.withLabel("Derivative Gain (Kd)") //
.withDescription("Slows the rate of change of the output.") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KD_TIMECONSTANT, Type.DECIMAL) //
.withRequired(true) //
.withMultiple(false) //
.withMinimum(BigDecimal.ZERO) //
.withDefault("1.0") //
.withLabel("Derivative Time Constant") //
.withDescription("Slows the rate of change of the D part (T1) in seconds.") //
.withUnit("s") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_COMMAND_ITEM, Type.TEXT) //
.withRequired(false) //
.withMultiple(false) //
.withContext("item") //
.withLabel("Command Item") //
.withDescription("You can send String commands to this Item like \"RESET\".") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_LOOP_TIME, Type.DECIMAL) //
.withRequired(true) //
.withMultiple(false) //
.withDefault(DEFAULT_LOOPTIME_MS) //
.withLabel("Loop Time") //
.withDescription("The interval the output value is updated in ms") //
.withUnit("ms") //
.build());
Output output = new Output(OUTPUT, BigDecimal.class.getName(), "Output", "Output value of the PID Controller", Output output = new Output(OUTPUT, BigDecimal.class.getName(), "Output", "Output value of the PID Controller",
null, null, null); null, null, null);
Output pInspector = new Output(P_INSPECTOR, BigDecimal.class.getName(), "P Inspector", Output pInspector = new Output(P_INSPECTOR, BigDecimal.class.getName(), "P Inspector",