Feature/triggers

.gitignore

@@ -6,6 +6,8 @@ bin/
 .metadata/
 */plugin.xml_gen
 .DS_Store
+*.iml
+.idea/
 
 distribution/smarthome/logs/*.log
 distribution/smarthome/*.zip

bundles/automation/org.eclipse.smarthome.automation.module.core/ESH-INF/automation/moduletypes/EventTriggersTypeDefinition.json

@@ -110,6 +110,41 @@
  "reference":"itemStateChangeTriggerID.event"
  }
  ]
+ },
+ {
+ "uid":"ChannelEventTrigger",
+ "label":"Channel Trigger",
+ "description":"This triggers a rule if a channel emits a trigger",
+ "configDescriptions":[
+ {
+ "name":"channelUID",
+ "type":"TEXT",
+ "context":"channel",
+ "label":"Channel",
+ "description":"the id of the channel which should be observed for triggers",
+ "required":true
+ }
+ ],
+ "children":[
+ {
+ "id":"channelEventTriggerId",
+ "type":"GenericEventTrigger",
+ "configuration":{
+ "eventSource":"$channelUID",
+ "eventTopic":"smarthome/channels/*/triggered",
+ "eventTypes":"ChannelTriggeredEvent"
+ }
+ }
+ ],
+ "outputs":[
+ {
+ "name":"event",
+ "type":"org.eclipse.smarthome.core.events.Event",
+ "description":"the event of the channel trigger",
+ "label":"Event",
+ "reference":"channelEventTriggerId.event"
+ }
+ ]
  }
  ]
 }

bundles/automation/org.eclipse.smarthome.automation.module.core/META-INF/MANIFEST.MF

@@ -14,6 +14,7 @@ Import-Package: com.google.common.collect,
  org.eclipse.smarthome.core.items,
  org.eclipse.smarthome.core.items.events,
  org.eclipse.smarthome.core.library.types,
+ org.eclipse.smarthome.core.thing.events,
  org.eclipse.smarthome.core.types,
  org.osgi.framework,
  org.osgi.service.component,

bundles/automation/org.eclipse.smarthome.automation.module.core/src/main/java/org/eclipse/smarthome/automation/module/core/factory/BasicModuleHandlerFactory.java

@@ -23,6 +23,11 @@
 import org.eclipse.smarthome.automation.module.core.handler.ItemStateConditionHandler;
 import org.eclipse.smarthome.core.events.EventPublisher;
 import org.eclipse.smarthome.core.items.ItemRegistry;
+import org.eclipse.smarthome.core.thing.events.ThingEventFactory;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.osgi.util.tracker.ServiceTracker;
+import org.osgi.util.tracker.ServiceTrackerCustomizer;
 import org.osgi.service.component.ComponentContext;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -39,10 +44,10 @@ public class BasicModuleHandlerFactory extends BaseModuleHandlerFactory {
 
  private Logger logger = LoggerFactory.getLogger(BasicModuleHandlerFactory.class);
 
- private static final Collection<String> types = Arrays
- .asList(new String[] { ItemStateConditionHandler.ITEM_STATE_CONDITION,
-  ItemPostCommandActionHandler.ITEM_POST_COMMAND_ACTION, GenericEventTriggerHandler.MODULE_TYPE_ID,
-  EventConditionHandler.MODULETYPE_ID, CompareConditionHandler.MODULE_TYPE });
+ private static final Collection<String> types = Arrays.asList(new String[] {
+ ItemStateConditionHandler.ITEM_STATE_CONDITION, ItemPostCommandActionHandler.ITEM_POST_COMMAND_ACTION,
+ GenericEventTriggerHandler.MODULE_TYPE_ID, EventConditionHandler.MODULETYPE_ID,
+ CompareConditionHandler.MODULE_TYPE });
 
  private ItemRegistry itemRegistry;
  private EventPublisher eventPublisher;

bundles/automation/org.eclipse.smarthome.automation.module.core/src/main/java/org/eclipse/smarthome/automation/module/core/handler/GenericEventTriggerHandler.java

@@ -93,7 +93,6 @@ public void receive(Event event) {
  if (callback != null) {
  logger.trace("Received Event: Source: " + event.getSource() + " Topic: " + event.getTopic() + " Type: "
  + event.getType() + " Payload: " + event.getPayload());
-
  if (!event.getTopic().contains(source)) {
  return;
  }

bundles/core/org.eclipse.smarthome.core.persistence/OSGI-INF/persistenceserviceregistry.xml

@@ -1,4 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Copyright (c) 2014-2016 by the respective copyright holders.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/epl-v10.html
+
+-->
 <scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" modified="modified" name="org.eclipse.smarthome.persistence">
  <implementation class="org.eclipse.smarthome.core.persistence.internal.PersistenceServiceRegistryImpl"/>
  <property name="service.pid" type="String" value="org.eclipse.smarthome.persistence"/>

bundles/core/org.eclipse.smarthome.core.thing.test/src/test/groovy/org/eclipse/smarthome/core/thing/events/ThingEventFactoryTest.groovy

@@ -10,17 +10,17 @@ package org.eclipse.smarthome.core.thing.events;
 import static org.hamcrest.CoreMatchers.*
 import static org.junit.Assert.*
 import static org.junit.matchers.JUnitMatchers.*
-
 import org.eclipse.smarthome.core.events.Event
+import org.eclipse.smarthome.core.thing.ChannelUID
 import org.eclipse.smarthome.core.thing.ThingStatus
 import org.eclipse.smarthome.core.thing.ThingStatusDetail
 import org.eclipse.smarthome.core.thing.ThingUID
 import org.eclipse.smarthome.core.thing.binding.builder.ThingStatusInfoBuilder
 import org.eclipse.smarthome.core.thing.dto.ThingDTOMapper
+import org.eclipse.smarthome.core.thing.events.ThingEventFactory.TriggerEventPayloadBean
 import org.eclipse.smarthome.core.thing.internal.ThingImpl
 import org.eclipse.smarthome.test.OSGiTest
 import org.junit.Test
-
 import com.google.gson.Gson
 
 /**
@@ -40,13 +40,18 @@ class ThingEventFactoryTest extends OSGiTest {
 
  def THING_STATUS_EVENT_TYPE = ThingStatusInfoEvent.TYPE
  def THING_ADDED_EVENT_TYPE = ThingAddedEvent.TYPE
+ def CHANNEL_TRIGGERED_EVENT_TYPE = ChannelTriggeredEvent.TYPE
 
  def THING_STATUS_EVENT_TOPIC = ThingEventFactory.THING_STATUS_INFO_EVENT_TOPIC.replace("{thingUID}", THING_UID.getAsString())
  def THING_ADDED_EVENT_TOPIC = ThingEventFactory.THING_ADDED_EVENT_TOPIC.replace("{thingUID}", THING_UID.getAsString())
 
  def THING_STATUS_EVENT_PAYLOAD = new Gson().toJson(THING_STATUS_INFO)
  def THING_ADDED_EVENT_PAYLOAD = new Gson().toJson(ThingDTOMapper.map(THING))
 
+ def CHANNEL_UID = new ChannelUID(THING_UID, "channel")
+ def CHANNEL_TRIGGERED_EVENT_TOPIC = ThingEventFactory.CHANNEL_TRIGGERED_EVENT_TOPIC.replace("{channelUID}", CHANNEL_UID.getAsString())
+ def TRIGGER_EVENT = "PRESSED"
+ def CHANNEL_TRIGGERED_EVENT_PAYLOAD = new Gson().toJson(new TriggerEventPayloadBean(TRIGGER_EVENT, CHANNEL_UID.getAsString()))
 
  @Test
  void 'ThingEventFactory creates Event as ThingStatusInfoEvent correctly'() {
@@ -95,4 +100,28 @@ class ThingEventFactoryTest extends OSGiTest {
  assertThat event.getThing(), not(null)
  assertThat event.getThing().UID, is(THING_UID.getAsString())
  }
+
+ @Test
+ void 'ThingEventFactory creates ChannelTriggeredEvent correctly'() {
+ ChannelTriggeredEvent event = ThingEventFactory.createTriggerEvent(TRIGGER_EVENT, CHANNEL_UID)
+
+ assertThat event.getType(), is(CHANNEL_TRIGGERED_EVENT_TYPE)
+ assertThat event.getTopic(), is(CHANNEL_TRIGGERED_EVENT_TOPIC)
+ assertThat event.getPayload(), is(CHANNEL_TRIGGERED_EVENT_PAYLOAD)
+ assertThat event.getEvent(), not(null)
+ assertThat event.getEvent(), is(TRIGGER_EVENT)
+ }
+
+ @Test
+ void 'ThingEventFactory creates Event as ChannelTriggeredEvent correctly'() {
+ Event event = factory.createEvent(CHANNEL_TRIGGERED_EVENT_TYPE, CHANNEL_TRIGGERED_EVENT_TOPIC, CHANNEL_TRIGGERED_EVENT_PAYLOAD, null)
+
+ assertThat event, is(instanceOf(ChannelTriggeredEvent))
+ ChannelTriggeredEvent triggeredEvent = event as ChannelTriggeredEvent
+ assertThat triggeredEvent.getType(), is(CHANNEL_TRIGGERED_EVENT_TYPE)
+ assertThat triggeredEvent.getTopic(), is(CHANNEL_TRIGGERED_EVENT_TOPIC)
+ assertThat triggeredEvent.getPayload(), is(CHANNEL_TRIGGERED_EVENT_PAYLOAD)
+ assertThat triggeredEvent.getEvent(), not(null)
+ assertThat triggeredEvent.getEvent(), is(TRIGGER_EVENT)
+ }
 }

bundles/core/org.eclipse.smarthome.core.thing.xml/src/main/java/org/eclipse/smarthome/core/thing/xml/internal/AbstractDescriptionTypeConverter.java

@@ -29,9 +29,9 @@
  * definition information within an XML document into a concrete type object.
  * <p>
  * This class should be used for each type definition which inherits from the {@link AbstractDescriptionType} class.
- * 
+ *
  * @param <T> the result type of the conversion
- * 
+ *
  * @author Michael Grammling - Initial Contribution
  */
 public abstract class AbstractDescriptionTypeConverter<T> extends GenericUnmarshaller<T> {
@@ -42,7 +42,7 @@ public abstract class AbstractDescriptionTypeConverter<T> extends GenericUnmarsh
 
  /**
  * Creates a new instance of this class with the specified parameter.
- * 
+ *
  * @param clazz the class of the result type (must not be null)
  * @param type the name of the type (e.g. "thing-type", "channel-type")
  */
@@ -56,7 +56,7 @@ public AbstractDescriptionTypeConverter(Class<T> clazz, String type) {
 
  /**
  * Returns the {@code id} attribute of the specific XML type definition.
- * 
+ *
  * @param attributes the attributes where to extract the ID information (must not be null)
  * @return the ID of the type definition (neither null, nor empty)
  */
@@ -66,10 +66,10 @@ protected String getID(Map<String, String> attributes) {
 
  /**
  * Returns the full extracted UID of the specific XML type definition.
- * 
+ *
  * @param attributes the attributes where to extract the ID information (must not be null)
  * @param context the context where to extract the binding ID information (must not be null)
- * 
+ *
  * @return the UID of the type definition (neither null, nor empty)
  */
  protected String getUID(Map<String, String> attributes, UnmarshallingContext context) {
@@ -83,7 +83,7 @@ protected String getUID(Map<String, String> attributes, UnmarshallingContext con
 
  /**
  * Returns the value of the {@code label} tag from the specific XML type definition.
- * 
+ *
  * @param nodeIterator the iterator to be used to extract the information (must not be null)
  * @return the value of the label (neither null, nor empty)
  * @throws ConversionException if the label could not be read
@@ -94,7 +94,7 @@ protected String readLabel(NodeIterator nodeIterator) throws ConversionException
 
  /**
  * Returns the value of the {@code description} tag from the specific XML type definition.
- * 
+ *
  * @param nodeIterator the iterator to be used to extract the information (must not be null)
  * @return the value of the description (could be null or empty)
  */
@@ -109,8 +109,8 @@ private URI readConfigDescriptionURI(NodeIterator nodeIterator) throws Conversio
  try {
  return new URI(uriText);
  } catch (NullPointerException | URISyntaxException ex) {
- throw new ConversionException("The URI '" + uriText + "' in node "
- + "'config-description-ref' is invalid!", ex);
+ throw new ConversionException(
+ "The URI '" + uriText + "' in node " + "'config-description-ref' is invalid!", ex);
  }
  }
 
@@ -134,9 +134,9 @@ private ConfigDescription readConfigDescription(NodeIterator nodeIterator) {
  /**
  * Returns the value of the {@code config-description-ref} and the {@code config-description} tags from the specific
  * XML type definition.
- * 
+ *
  * @param nodeIterator the iterator to be used to extract the information (must not be null)
- * 
+ *
  * @return the URI and configuration object
  * (contains two elements: URI - could be null, ConfigDescription - could be null)
  */
@@ -155,19 +155,19 @@ protected Object[] getConfigDescriptionObjects(NodeIterator nodeIterator) {
 
  /**
  * The abstract unmarshal method which must be implemented by the according type converter.
- * 
+ *
  * @param reader the reader to be used to read XML information from a stream (not null)
- * 
+ *
  * @param context the context to be used for the XML document conversion (not null)
- * 
+ *
  * @param attributes the attributes map containing attributes of the type - only UID -
  * (not null, could be empty)
- * 
+ *
  * @param nodeIterator the iterator to be used to simply extract information in the right
  * order and appearance from the XML stream
- * 
+ *
  * @return the concrete type definition object (could be null)
- * 
+ *
  * @throws ConversionException if any conversion error occurs
  */
  protected abstract T unmarshalType(HierarchicalStreamReader reader, UnmarshallingContext context,

bundles/core/org.eclipse.smarthome.core.thing.xml/src/main/java/org/eclipse/smarthome/core/thing/xml/internal/ChannelTypeConverter.java

@@ -12,15 +12,15 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-
 import org.eclipse.smarthome.config.core.ConfigDescription;
 import org.eclipse.smarthome.config.xml.util.ConverterAttributeMapValidator;
 import org.eclipse.smarthome.config.xml.util.NodeIterator;
 import org.eclipse.smarthome.config.xml.util.NodeValue;
+import org.eclipse.smarthome.core.thing.type.ChannelKind;
 import org.eclipse.smarthome.core.thing.type.ChannelType;
 import org.eclipse.smarthome.core.thing.type.ChannelTypeUID;
+import org.eclipse.smarthome.core.types.EventDescription;
 import org.eclipse.smarthome.core.types.StateDescription;
-
 import com.thoughtworks.xstream.converters.ConversionException;
 import com.thoughtworks.xstream.converters.Converter;
 import com.thoughtworks.xstream.converters.UnmarshallingContext;
@@ -33,7 +33,7 @@
  * <p>
  * This converter converts {@code channel-type} XML tags. It uses the {@link AbstractDescriptionTypeConverter} which
  * offers base functionality for each type definition.
- * 
+ *
  * @author Michael Grammling - Initial Contribution
  * @author Ivan Iliev - Added support for system wide channel types
  */
@@ -42,8 +42,8 @@ public class ChannelTypeConverter extends AbstractDescriptionTypeConverter<Chann
  public ChannelTypeConverter() {
  super(ChannelTypeXmlResult.class, "channel-type");
 
- super.attributeMapValidator = new ConverterAttributeMapValidator(new String[][] { { "id", "true" },
- { "advanced", "false" }, { "system", "false" } });
+ super.attributeMapValidator = new ConverterAttributeMapValidator(
+ new String[][] { { "id", "true" }, { "advanced", "false" }, { "system", "false" } });
  }
 
  private boolean readBoolean(Map<String, String> attributes, String attributeName, boolean defaultValue) {
@@ -57,7 +57,11 @@ private boolean readBoolean(Map<String, String> attributes, String attributeName
  }
 
  private String readItemType(NodeIterator nodeIterator) throws ConversionException {
- return (String) nodeIterator.nextValue("item-type", true);
+ return (String) nodeIterator.nextValue("item-type", false);
+ }
+
+ private String readKind(NodeIterator nodeIterator) throws ConversionException {
+ return (String) nodeIterator.nextValue("kind", false);
  }
 
  private String readCategory(NodeIterator nodeIterator) throws ConversionException {
@@ -104,6 +108,20 @@ private StateDescription readStateDescription(NodeIterator nodeIterator) {
  return null;
  }
 
+ private EventDescription readEventDescription(NodeIterator nodeIterator) {
+ Object nextNode = nodeIterator.next();
+
+ if (nextNode != null) {
+ if (nextNode instanceof EventDescription) {
+ return (EventDescription) nextNode;
+ }
+
+ nodeIterator.revert();
+ }
+
+ return null;
+ }
+
  @Override
  protected ChannelTypeXmlResult unmarshalType(HierarchicalStreamReader reader, UnmarshallingContext context,
  Map<String, String> attributes, NodeIterator nodeIterator) throws ConversionException {
@@ -115,17 +133,24 @@ protected ChannelTypeXmlResult unmarshalType(HierarchicalStreamReader reader, Un
  ChannelTypeUID channelTypeUID = new ChannelTypeUID(uid);
 
  String itemType = readItemType(nodeIterator);
+ String kind = readKind(nodeIterator);
  String label = super.readLabel(nodeIterator);
  String description = super.readDescription(nodeIterator);
  String category = readCategory(nodeIterator);
  Set<String> tags = readTags(nodeIterator);
 
  StateDescription stateDescription = readStateDescription(nodeIterator);
+ EventDescription eventDescription = readEventDescription(nodeIterator);
 
  Object[] configDescriptionObjects = super.getConfigDescriptionObjects(nodeIterator);
 
- ChannelType channelType = new ChannelType(channelTypeUID, advanced, itemType, label, description, category,
- tags, stateDescription, (URI) configDescriptionObjects[0]);
+ if (kind == null) {
+ // Default for kind is 'state'
+ kind = "state";
+ }
+
+ ChannelType channelType = new ChannelType(channelTypeUID, advanced, itemType, ChannelKind.parse(kind), label,
+ description, category, tags, stateDescription, eventDescription, (URI) configDescriptionObjects[0]);
 
  ChannelTypeXmlResult channelTypeXmlResult = new ChannelTypeXmlResult(channelType,
  (ConfigDescription) configDescriptionObjects[1], system);