[pwm] Initial Contribution #10205

fwolter · 2021-02-20T18:32:59Z

This introduces a Pulse Width Modulation module for openHAB.

PWM can be used to control actuators continuously from 0 to 100% that only support ON/OFF commands. E.g. valves or heating burners. It accomplishes that by switching the actuator on and off with a fixed interval. The higher the control percentage (duty cycle), the longer the ON phase.

https://community.openhab.org/t/new-automation-pulse-width-modulation-pwm/117498

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Skinah · 2021-02-25T02:09:00Z

bundles/org.openhab.automation.pwm/README.md

+The higher the control percentage (duty cycle), the longer the ON phase.
+
+Example: If the fixed interval is 10 sec and the duty cycle is 30%, the output is ON for 3 sec and OFF for 7 sec.
+


I feel a warning is necessary about relay contact life expectancy. If this example was done for a full year it would be over 1.3 Million contact cycles which would wear most cheap devices out and make even quality units fail.

kaikreuzer

Hey @fwolter,

Many thanks for this contribution!
I am very sorry that this PR was unregarded for such a long time, despite you yourself reviewing and merging so many other PRs continuously. Feel free to nag all maintainers in such cases, you do not deserve to have your PRs not being processed quickly.

Overall, it looks good to me and I like the approach.
I was actually first wondering whether a profile might have been a better choice (and easier to use), but I think this solution here has the benefit that the input does not have to come from a binding/channel, but can be any item (like a totally virtual one that is just set by a slider in the UI).
I have a few comments below, though, happy to discuss.

bundles/org.openhab.automation.pwm/README.md

...g.openhab.automation.pwm/src/main/java/org/openhab/automation/pwm/internal/PWMConstants.java

...tion.pwm/src/main/java/org/openhab/automation/pwm/internal/handler/state/AlwaysOffState.java

kaikreuzer · 2021-04-14T22:08:40Z

...omation.pwm/src/main/java/org/openhab/automation/pwm/internal/handler/PWMTriggerHandler.java

+    public static final String MODULE_TYPE_ID = AUTOMATION_NAME + ".trigger";
+    private static final Set<String> SUBSCRIBED_EVENT_TYPES = Set.of(ItemStateEvent.TYPE);
+    private final Logger logger = LoggerFactory.getLogger(PWMTriggerHandler.class);
+    private final ScheduledExecutorService scheduler = Executors


I see that we do not offer a scheduler for ModuleHandlers as we do for ThingHandlers.
I do not feel good about every ModuleHandler therefore creating it's own thread for scheduling tasks and wonder if we shouldn't change this in the framework. We could e.g. add some suitable method (like getScheduler() or maybe directly schedule()) to it and make it use a thread pool. Wdyt?

I was thinking the same when implementing this. And I was dreaming of a schedule() that cancels all scheduled and still active tasks in dispose() of the super class :) Like in the modbus binding.

Just had a look. The TriggerHandlerCallbackImpl actually already has an executor internally, which is even shut down when the handler (or rather the callback) is disposed.
How about making it a scheduled executor and expose it through a method?

OK, I'll file a PR.

bundles/org.openhab.automation.pwm/README.md

...omation.pwm/src/main/java/org/openhab/automation/pwm/internal/handler/PWMTriggerHandler.java

bundles/org.openhab.automation.pwm/README.md

kaikreuzer · 2021-05-12T20:45:11Z

...tomation.pwm/src/main/java/org/openhab/automation/pwm/internal/template/PWMRuleTemplate.java

+ * @author Fabian Wolter - Initial Contribution
+ */
+@NonNullByDefault
+public class PWMRuleTemplate extends RuleTemplate {


Nice to also see a rule template being defined.
I noticed that our Main UI is still lacking support for rule templates, is that correct?
If so, I think we should have that added asap as it is a very powerful feature.

Honestly, I copied that from the PID controller, which copied it from Hilbrand's PID code without knowing what I was doing.

@ghys Did you already spend any thoughts on adding support for rule templates in the Main UI? After all, the Paper UI already had that feature - would be awesome to have it in the Main UI, too!

Vaguely, but I didn't look into them in detail, only saw a video or two about them and a couple examples on the Eclipse Marketplace. And didn't ever see anything but an empty list in Paper UI so kind of still considered them an experimental-grade/proof-of-concept feature, didn't know they were in actual use.

IMHO it's rather limiting to have only Java code able to contribute rule templates, they themselves should be able to be defined by the user and shared on whatever will become the new community marketplace.

IMHO it's rather limiting to have only Java code able to contribute rule templates

This is not the case. You can also add templates as JSON files in your conf folder and it should be possible to also add a provider that stores stuff in the db, so that templates can also be managed through the UI. Would be actually cool to add a feature to convert an existing rule into a template and let the user share it (for the start as JSON on the forum, later than through a marketplace).
But the starting point would be to be able to at least use existing templates in the UI. This should actually be fairly easy to do. I can create an issue with some details, if that's ok.

@ghys, as promised: openhab/openhab-webui#1082

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

fwolter · 2021-05-20T20:08:12Z

Thanks for your feedback and your words! Not a problem that it is in the backlog for some time.

...ab.automation.pwm/src/main/java/org/openhab/automation/pwm/internal/type/PWMTriggerType.java

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

kaikreuzer · 2021-05-31T14:07:51Z

Build failed with 1 SAT error. Could you please check?

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

kaikreuzer

Hooray, finally the build is green - thanks for the contribution!

fwolter · 2021-06-01T20:18:04Z

Thank you for your review!

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Signed-off-by: Fabian Wolter <github@fabian-wolter.de> Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com>

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

[automation.pwm] Initial Contribution

e9c44b8

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

fwolter added the new automation label Feb 20, 2021

fwolter requested a review from a team February 20, 2021 18:32

Naming

4f556af

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Skinah reviewed Feb 25, 2021

View reviewed changes

kaikreuzer added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Mar 31, 2021

kaikreuzer requested changes May 12, 2021

View reviewed changes

Add line breaks in readme; Fix javadoc; Use action module

3e93c31

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

kaikreuzer mentioned this pull request May 23, 2021

[automation] add tags to item modules openhab/openhab-core#2378

Merged

kaikreuzer reviewed May 23, 2021

View reviewed changes

...ab.automation.pwm/src/main/java/org/openhab/automation/pwm/internal/type/PWMTriggerType.java Outdated Show resolved Hide resolved

fwolter mentioned this pull request May 29, 2021

[automation] Expose TriggerHandlerCallback scheduler openhab/openhab-core#2388

Merged

fwolter added 4 commits May 29, 2021 16:15

Use the newly exposed scheduler of the callback

6f847ad

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Use tags and remove the action module

7edeb61

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Remove reset command

1296502

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Call scheduler in setCallback method; remove command config parameter

c110db9

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

fwolter force-pushed the pwm branch from c1e8545 to c110db9 Compare May 30, 2021 20:10

Remove command parameter from readme

20ffc9b

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

kaikreuzer added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels May 31, 2021

Fix feature name

366f32a

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

kaikreuzer added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Jun 1, 2021

kaikreuzer approved these changes Jun 1, 2021

View reviewed changes

kaikreuzer merged commit 9d903c2 into openhab:main Jun 1, 2021

kaikreuzer added this to the 3.1 milestone Jun 1, 2021

fwolter deleted the pwm branch June 1, 2021 20:18

computergeek1507 pushed a commit to computergeek1507/openhab-addons that referenced this pull request Jul 13, 2021

[pwm] Initial Contribution (openhab#10205)

42beb61

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

lucacalcaterra pushed a commit to lucacalcaterra/openhab-addons that referenced this pull request Jul 26, 2021

[pwm] Initial Contribution (openhab#10205)

27488c4

Signed-off-by: Fabian Wolter <github@fabian-wolter.de> Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com>

lucacalcaterra pushed a commit to lucacalcaterra/openhab-addons that referenced this pull request Aug 3, 2021

[pwm] Initial Contribution (openhab#10205)

cca23e7

Signed-off-by: Fabian Wolter <github@fabian-wolter.de> Signed-off-by: Luca Calcaterra <calcaterra.luca@gmail.com>

frederictobiasc pushed a commit to frederictobiasc/openhab-addons that referenced this pull request Oct 26, 2021

[pwm] Initial Contribution (openhab#10205)

0a3b70d

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this pull request Nov 7, 2021

[pwm] Initial Contribution (openhab#10205)

bb825dc

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022

[pwm] Initial Contribution (openhab#10205)

1879b46

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[pwm] Initial Contribution #10205

[pwm] Initial Contribution #10205

fwolter commented Feb 20, 2021

Skinah Feb 25, 2021 •

edited

Loading

kaikreuzer left a comment

kaikreuzer Apr 14, 2021

fwolter May 20, 2021

kaikreuzer May 23, 2021

fwolter May 24, 2021

kaikreuzer May 12, 2021

fwolter May 20, 2021

kaikreuzer May 23, 2021

ghys May 24, 2021

kaikreuzer May 25, 2021

kaikreuzer Jun 1, 2021

fwolter commented May 20, 2021

kaikreuzer commented May 31, 2021

kaikreuzer left a comment

fwolter commented Jun 1, 2021

		The higher the control percentage (duty cycle), the longer the ON phase.

		Example: If the fixed interval is 10 sec and the duty cycle is 30%, the output is ON for 3 sec and OFF for 7 sec.

[pwm] Initial Contribution #10205

[pwm] Initial Contribution #10205

Conversation

fwolter commented Feb 20, 2021

Skinah Feb 25, 2021 • edited Loading

Choose a reason for hiding this comment

kaikreuzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fwolter commented May 20, 2021

kaikreuzer commented May 31, 2021

kaikreuzer left a comment

Choose a reason for hiding this comment

fwolter commented Jun 1, 2021

Skinah Feb 25, 2021 •

edited

Loading