Skip to content

Commit

Permalink
[pidcontroller] Reset command Item; Fix read-only states of config pa…
Browse files Browse the repository at this point in the history 
…rameters (openhab#9992)

* [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>
Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com>
  • Loading branch information
@fwolter @lucacalcaterra
fwolter authored and lucacalcaterra committed Feb 23, 2021
1 parent 02148df commit 7074532
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 28 deletions.
6 changes: 5 additions & 1 deletion ...va/org/openhab/automation/pidcontroller/internal/handler/PIDControllerTriggerHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import org.openhab.core.library.types.StringType;
import org.openhab.core.types.RefreshType;
import org.openhab.core.types.State;
import org.openhab.core.types.UnDefType;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration;
import org.slf4j.Logger;
Expand All @@ -73,10 +74,12 @@ public class PIDControllerTriggerHandler extends BaseTriggerModuleHandler implem
private Item setpointItem;
private Optional<String> commandTopic;
private EventFilter eventFilter;
private EventPublisher eventPublisher;

public PIDControllerTriggerHandler(Trigger module, ItemRegistry itemRegistry, EventPublisher eventPublisher,
BundleContext bundleContext) {
super(module);
this.eventPublisher = eventPublisher;

Configuration config = module.getConfiguration();

Expand Down Expand Up @@ -210,7 +213,8 @@ public void receive(Event event) {
if ("RESET".equals(changedEvent.getItemState().toString())) {
controller.setIntegralResult(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());
}
} else {
Expand Down
88 changes: 61 additions & 27 deletions ...ain/java/org/openhab/automation/pidcontroller/internal/type/PIDControllerTriggerType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,67 @@ public class PIDControllerTriggerType extends TriggerType {

public static PIDControllerTriggerType initialize() {
List<ConfigDescriptionParameter> configDescriptions = new ArrayList<>();
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_INPUT_ITEM, Type.TEXT).withRequired(true)
.withReadOnly(true).withMultiple(false).withContext("item").withLabel("Input Item")
.withDescription("Item to monitor").build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_SETPOINT_ITEM, Type.TEXT)
.withRequired(true).withReadOnly(true).withMultiple(false).withContext("item").withLabel("Setpoint")
.withDescription("Targeted setpoint").build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KP_GAIN, Type.DECIMAL).withRequired(true)
.withMultiple(false).withDefault("1.0").withMinimum(BigDecimal.ZERO).withLabel("Proportional Gain (Kp)")
.withDescription("Change to output propertional to current error value.").build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KI_GAIN, Type.DECIMAL).withRequired(true)
.withMultiple(false).withDefault("1.0").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)
.withReadOnly(true).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());

configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_INPUT_ITEM, Type.TEXT) //
.withRequired(true) //
.withMultiple(false) //
.withContext("item") //
.withLabel("Input Item") //
.withDescription("Item to monitor") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_SETPOINT_ITEM, Type.TEXT) //
.withRequired(true) //
.withMultiple(false) //
.withContext("item") //
.withLabel("Setpoint") //
.withDescription("Targeted setpoint") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KP_GAIN, Type.DECIMAL).withRequired(true) //
.withMultiple(false) //
.withDefault("1.0") //
.withMinimum(BigDecimal.ZERO) //
.withLabel("Proportional Gain (Kp)") //
.withDescription("Change to output propertional to current error value.") //
.build());
configDescriptions.add(ConfigDescriptionParameterBuilder.create(CONFIG_KI_GAIN, Type.DECIMAL) //
.withRequired(true) //
.withMultiple(false) //
.withDefault("1.0") //
.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",
null, null, null);
Output pInspector = new Output(P_INSPECTOR, BigDecimal.class.getName(), "P Inspector",
Expand Down

0 comments on commit 7074532

Please sign in to comment.