Feature/triggers #1936

phxql · 2016-07-28T15:47:47Z

This PR implements a PoC for triggers.

Sample XML snippet:

    <channel-type id="trigger_1" advanced="false">
        <trigger-type>String</trigger-type>
        <label>Trigger 1</label>
        <description>Description of trigger 1</description>
        <event>
            <options>
                <option value="PRESSED">pressed</option>
                <option value="RELEASED">released</option>
                <option value="DOUBLE_PRESSED">double pressed</option>
            </options>
        </event>
    </channel-type>

In the handler:

emitEvent(TRIGGER_1, new StringType("PRESSED"));

In the rule engine DSL:

rule "Test the trigger"
when
  Channel 'triggertest:sample:9c9a498d:trigger_1' triggered PRESSED
then
  DemoString.postUpdate("Triggered: " + receivedEvent.event)
end

kaikreuzer · 2016-08-01T09:35:41Z

...se.smarthome.core.thing/src/main/java/org/eclipse/smarthome/core/thing/type/ChannelType.java

+     * @throws IllegalArgumentException if the UID or the item type is null or empty,
+     *             or the the meta information is null
+     */
+    public ChannelType(ChannelTypeUID uid, boolean advanced, String itemType, String triggerType, String label,


I would say this new constructor should NOT have itemType and state params, so that it is the one used for creating instances of trigger channels.

ChannelType has two constructors: The first one for use without triggerType, the second for use withTriggerType (itemType is then null). I can't add a constructor only for triggerType, as itemType and triggerType are both String and then it would clash with the itemType constructor.

kaikreuzer · 2016-08-01T10:34:24Z

Thanks @phxql Looks in general good to me as a starting point - and it isn't that much code change after all.

What seems to be still completely missing is the adaption of the Channel class itself, right? To fully see the implications, we would need the triggers to be considered there as well as in the REST API and the thing file definitions.

phxql · 2016-08-02T09:00:41Z

What do you mean with thing file definitions? The thing-types.xml?

kaikreuzer · 2016-08-02T09:02:03Z

https://www.eclipse.org/smarthome/documentation/features/dsl.html#thing-configuration-dsl

phxql · 2016-08-02T09:03:29Z

Ah, the DSL. I'll start with the adaption of the channel class and the REST interface, as i know that already.

phxql · 2016-08-23T10:28:32Z

I updated the PR:

Items are only created for channels which have an item type
The ChannelDTO for the REST API now includes a triggerType
Declared ThingEventTrigger in the JSON for the ruleengine
Added TRIGGER rules to the rule engine and updated the DSL.

rule "Test the trigger"
when
  Channel 'triggertest:sample:9c9a498d:trigger_1' triggered PRESSED
then
  DemoString.postUpdate("Triggered: " + receivedEvent.event)
end

phxql · 2016-08-23T10:52:12Z

Open issues:

RuleEngineImpl#executeRules(java.lang.Iterable<Rule>, Type): Add the trigger event to the DSL context.

sjsf · 2016-08-24T04:51:50Z

Having had a quick glance, the approach still looks good so far.

However, I'm missing a change in Thing.xtext and GenericThingProvider so that it becomes possible to define the channels in the Thing DSL.

phxql · 2016-08-24T10:45:44Z

Proposal:

Thing channel with item type String

Thing yahooweather:weather:losangeles [ location="2442047", unit="us", refresh=120 ] {
    Channels:
        String : customChannel1 []
}

That's the syntax right now.

Thing channel with item type String

Thing yahooweather:weather:losangeles [ location="2442047", unit="us", refresh=120 ] {
    Channels:
        Item String : customChannel1 []
}

Thats an alternative syntax for the same usecase.

Thing channel with trigger type String

Thing yahooweather:weather:losangeles [ location="2442047", unit="us", refresh=120 ] {
    Channels:
        Trigger String : customChannel1 []
}

Thats the syntax for adding a trigger channel.

phxql · 2016-08-24T12:14:32Z

Wrote a gist containing the changes: https://gist.github.com/phxql/e75b287ab8601d43d63d553175e6b877

sjsf · 2016-08-25T07:39:47Z

...in/java/org/eclipse/smarthome/automation/module/core/handler/GenericEventTriggerHandler.java

@@ -92,6 +92,7 @@ public void receive(Event event) {
        if (callback != null) {
            logger.trace("Received Event: Source: " + event.getSource() + " Topic: " + event.getTopic() + " Type: "
                    + event.getType() + " Payload: " + event.getPayload());
+            // TODO MKA: Why is the topic checked against the source and not event.getSource()?


simply because for some event types the event source is not the item (or even not set...)

sjsf · 2016-08-25T15:45:03Z

@maggu2810, @kaikreuzer could you please have a look?

maggu2810 · 2016-08-26T11:11:23Z

@SJKA Sure, it is already placed somewhere in my PriorityQueue 😉

kaikreuzer · 2016-08-31T15:03:51Z

...in/java/org/eclipse/smarthome/automation/module/core/handler/GenericEventTriggerHandler.java

@@ -93,7 +93,7 @@ public void receive(Event event) {
        if (callback != null) {
            logger.trace("Received Event: Source: " + event.getSource() + " Topic: " + event.getTopic() + " Type: "
                    + event.getType() + " Payload: " + event.getPayload());
-
+            // Check the topic for the source as the event source is not set for the most events.


This is pretty misleading - the event.source is something completely different than the "source" configuration property in this handler (which means "object that this event refers to", but not "sender of the event").

phxql · 2016-09-08T08:46:46Z

Added system triggers.

kaikreuzer · 2016-09-08T10:49:07Z

...smarthome.core.thing/src/main/java/org/eclipse/smarthome/core/thing/CommonTriggerEvents.java

@@ -0,0 +1,21 @@
+package org.eclipse.smarthome.core.thing;


license header missing

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

marcelrv · 2016-09-11T18:48:16Z

@kaikreuzer

"no feedback" from my person should be interpret as "still no time to review the trigger stuff" 😉

Here as well, bit challenged in time... will take a look shortly

maggu2810

Haven't tested the code, but code review done with some minor comments.

maggu2810 · 2016-09-20T07:53:42Z

...se.smarthome.core.thing/src/main/java/org/eclipse/smarthome/core/thing/type/ChannelType.java

+     *
+     * @param uid the unique identifier which identifies this Channel type within
+     *            the overall system (must neither be null, nor empty)
+     *


Why do you add an empty line after every @param tag?
Please remove it.

maggu2810 · 2016-09-20T07:58:08Z

...arthome.model.rule/src/org/eclipse/smarthome/model/rule/jvmmodel/RulesJvmModelInferrer.xtend

@@ -29,112 +31,121 @@ import org.slf4j.LoggerFactory
 */
 class RulesJvmModelInferrer extends ScriptJvmModelInferrer {

+    static private final Logger logger = LoggerFactory.getLogger(RulesJvmModelInferrer)


Don't know anything about Xtend / Xtext, but does we need to use a static variable here?

But you should use the common modifier order: private static final (or drop static).

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

kaikreuzer · 2016-09-21T23:19:01Z

Thanks for the review @maggu2810.
I think we are ready to merge then (@marcelrv & others, if you have comments/change requests, we can still address those in follow-up PRs). I'll wait for another day in case anyone still wants to veto.

kaikreuzer · 2016-09-21T23:27:18Z

I just noticed that this PR has >1000 lines, so we anyhow cannot merge immediately - I have created CQ 12006 for it.
@phxql Please DO NOT add any further commits to your branch; we need to keep this exact state for the CQ to be valid. Any further changes would then need to go into new PRs.

kaikreuzer · 2016-09-24T02:50:19Z

CQ has been approved!

digitaldan · 2016-12-02T20:48:18Z

I am looking at this for the HarmonyHub binding now. I can see their use in rules, but how does a thing handler respond to a trigger channel?

To give a little background, The HarmonyHub has a thing type called "device" , think of this as your TV or Stereo. Each "device" has a channel called "buttonPress", think of this as pressing a button on your remote control. This channels sends the name of the button to press as a string, so "Power On" or "ENTER" for example. This value are dynamically created for the channel as State Options. So for example:

DeviceThing -> ButtonPressChannel -> ButtonName {PowerOn, PowerOff, Enter, 1, 2, 3, 4 ...}

I can see how I could use trigger events to send the button names, but how would the ThingHandler get these events. Also how would a user define a trigger channel in say a sitemap? Should I rather be looking on how to compliment my current button channel just for rules or is this meant as a replacement for this type of "Send Only" channel.

kaikreuzer · 2016-12-03T09:54:40Z

It seems I misinterpreted the "buttonPress" channel in the HarmonyHub binding when I suggested you to look at the trigger channels. Trigger channels are ONLY meant for events coming from the remote device, i.e. you get hold of an external button press on some remote control.
In the Harmony case, you actually want to trigger a button press yourself - for this, you will have to use "regular" channels as you do. What doesn't fit well is to use "state options", because in effect, what you need would be "command options" instead.

kaikreuzer reviewed Aug 1, 2016
View reviewed changes

kaikreuzer mentioned this pull request Aug 2, 2016

Introduce trigger channels for things, which allow modelling of buttons and remote controls #1043

Closed

sjsf reviewed Aug 25, 2016
View reviewed changes

phxql mentioned this pull request Aug 25, 2016

Added example trigger binding. #2048

Closed

kaikreuzer reviewed Aug 31, 2016
View reviewed changes

kaikreuzer reviewed Sep 8, 2016
View reviewed changes

Added missing license header.

691cb1d

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

phxql mentioned this pull request Sep 19, 2016

Documentation for the trigger channels #2189

Merged

Merge remote-tracking branch 'upstream/master' into feature/triggers

8d871d8

maggu2810 reviewed Sep 20, 2016

View reviewed changes

phxql added 3 commits September 21, 2016 13:17

Fixed line break.

2207d95

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

Fixed useless line breaks.

e85dd53

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

Fixed logger declaration.

32c8048

Signed-off-by: Moritz Kammerer <moritz.kammerer@qaware.de>

maggu2810 approved these changes Sep 21, 2016

View reviewed changes

kaikreuzer added CQ and removed CQ labels Sep 21, 2016

kaikreuzer merged commit fb42a5d into eclipse-archived:master Sep 24, 2016

phxql deleted the feature/triggers branch September 26, 2016 07:52

sjsf mentioned this pull request Oct 19, 2016

renamed channelType to channelKind in the model #2342

Merged

kaikreuzer mentioned this pull request Nov 2, 2016

Astrobinding for openhab 2 is not support all features of the openhab 1 version openhab/openhab-addons#310

Closed

svilenvul mentioned this pull request Apr 6, 2017

[rfxcom] Send commands on control channels so that switches behave as expected openhab/openhab-addons#2103

Merged

kaikreuzer added this to the 0.9.0 milestone Nov 30, 2017

snyk-bot mentioned this pull request Mar 14, 2022

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.8 cniweb/smarthome#28

Open

cniweb mentioned this pull request May 18, 2022

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.10 cniweb/smarthome#31

Open

snyk-bot mentioned this pull request Oct 30, 2022

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.8 cniweb/smarthome#33

Open

snyk-bot mentioned this pull request Nov 21, 2022

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.8 cniweb/smarthome#34

Open

snyk-bot mentioned this pull request Dec 19, 2022

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.11 cniweb/smarthome#35

Open

cniweb mentioned this pull request Dec 6, 2023

[Snyk] Security upgrade browser-sync from 2.26.14 to 2.27.8 cniweb/smarthome#42

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/triggers #1936

Feature/triggers #1936

phxql commented Jul 28, 2016 •

edited

kaikreuzer Aug 1, 2016

phxql Aug 19, 2016

kaikreuzer Sep 1, 2016

kaikreuzer commented Aug 1, 2016

phxql commented Aug 2, 2016

kaikreuzer commented Aug 2, 2016

phxql commented Aug 2, 2016

phxql commented Aug 23, 2016 •

edited

phxql commented Aug 23, 2016 •

edited by kaikreuzer

sjsf commented Aug 24, 2016

phxql commented Aug 24, 2016 •

edited

phxql commented Aug 24, 2016

sjsf Aug 25, 2016

sjsf commented Aug 25, 2016

maggu2810 commented Aug 26, 2016

kaikreuzer Aug 31, 2016

phxql commented Sep 8, 2016

kaikreuzer Sep 8, 2016

phxql Sep 8, 2016

kaikreuzer Sep 8, 2016

marcelrv commented Sep 11, 2016 •

edited by kaikreuzer

maggu2810 left a comment

maggu2810 Sep 20, 2016

phxql Sep 21, 2016

maggu2810 Sep 20, 2016

phxql Sep 21, 2016

kaikreuzer commented Sep 21, 2016

kaikreuzer commented Sep 21, 2016

kaikreuzer commented Sep 24, 2016

digitaldan commented Dec 2, 2016

kaikreuzer commented Dec 3, 2016

Feature/triggers #1936

Feature/triggers #1936

Conversation

phxql commented Jul 28, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaikreuzer commented Aug 1, 2016

phxql commented Aug 2, 2016

kaikreuzer commented Aug 2, 2016

phxql commented Aug 2, 2016

phxql commented Aug 23, 2016 • edited

phxql commented Aug 23, 2016 • edited by kaikreuzer

sjsf commented Aug 24, 2016

phxql commented Aug 24, 2016 • edited

Thing channel with item type String

Thing channel with item type String

Thing channel with trigger type String

phxql commented Aug 24, 2016

Choose a reason for hiding this comment

sjsf commented Aug 25, 2016

maggu2810 commented Aug 26, 2016

Choose a reason for hiding this comment

phxql commented Sep 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcelrv commented Sep 11, 2016 • edited by kaikreuzer

maggu2810 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

kaikreuzer commented Sep 21, 2016

kaikreuzer commented Sep 21, 2016

kaikreuzer commented Sep 24, 2016

digitaldan commented Dec 2, 2016

kaikreuzer commented Dec 3, 2016

phxql commented Jul 28, 2016 •

edited

phxql commented Aug 23, 2016 •

edited

phxql commented Aug 23, 2016 •

edited by kaikreuzer

phxql commented Aug 24, 2016 •

edited

marcelrv commented Sep 11, 2016 •

edited by kaikreuzer