Added channel groups, state description, advanced flag and category t…

…o thing type xml files and extended parser. Added support for channel groups in things. Updated documentation and the hue and yahoo weather binding. Also-by: Michael Grammling <m.grammling@external.telekom.de> Signed-off-by: Dennis Nobel <d.nobel@external.telekom.de>
eclipse-archived · Dec 20, 2014 · a3f9495 · a3f9495
1 parent 1e7c744
commit a3f9495
Show file tree

Hide file tree

Showing 51 changed files with 2,222 additions and 401 deletions.
diff --git a/binding/org.eclipse.smarthome.binding.hue/ESH-INF/thing/channels.xml b/binding/org.eclipse.smarthome.binding.hue/ESH-INF/thing/channels.xml
@@ -11,10 +11,7 @@
         <description>The color channel allows to control the color of a light.
             It is also possible to dim values and switch the light on and off.
         </description>
-
-        <config-description>
-            <parameter name="lastDimValue" type="boolean" />
-        </config-description>
+        <category>ColorLight</category>
     </channel-type>
 
     <!-- Brightness Channel -->
@@ -24,10 +21,7 @@
         <description>The brightness channel allows to control the brightness of a light.
             It is also possible to switch the light on and off.
         </description>
-
-        <config-description>
-            <parameter name="lastDimValue" type="boolean" />
-        </config-description>
+        <category>DimmableLight</category>
     </channel-type>
 
     <!-- Color Temperature Channel -->
@@ -36,6 +30,7 @@
         <label>Color Temperature</label>
         <description>The color temperature channel allows to set the color
             temperature of a light from 0 (cold) to 100 (warm).</description>
+        <category>ColorLight</category>
     </channel-type>
 
 </thing:thing-descriptions>
diff --git a/binding/org.eclipse.smarthome.binding.yahooweather/ESH-INF/thing/thing-types.xml b/binding/org.eclipse.smarthome.binding.yahooweather/ESH-INF/thing/thing-types.xml
@@ -44,17 +44,26 @@
         <item-type>Number</item-type>
         <label>Temperature</label>
         <description>Current temperature in degrees celsius (metric) or fahrenheit (us)</description>
+        <category>Temperature</category>
+        <state readOnly="true">
+        </state>
     </channel-type>
 
     <channel-type id="humidity">
         <item-type>Number</item-type>
         <label>Humidity</label>
         <description>Current humidity in %</description>
+        <category>Humidity</category>
+        <state readOnly="true" pattern="%d %%">
+        </state>
     </channel-type>
 
     <channel-type id="pressure">
         <item-type>Number</item-type>
         <label>Pressure</label>
         <description>Current pressure in millibar (metric) or inches of mercury (us)</description>
+        <category>Pressure</category>
+        <state readOnly="true">
+        </state>
     </channel-type>
 </thing:thing-descriptions>
diff --git a/...nfig.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeAttributesConverter.java b/...nfig.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeAttributesConverter.java
@@ -30,8 +30,9 @@ public NodeAttributesConverter() {
     @Override
     public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
         String nodeName = reader.getNodeName();
-        Map<String, String> attributes = ConverterAttributeMapValidator.readValidatedAttributes(
-                reader, null);
+
+        Map<String, String> attributes =
+                ConverterAttributeMapValidator.readValidatedAttributes(reader, null);
 
         return new NodeAttributes(nodeName, attributes);
     }

diff --git a/...e.smarthome.config.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeValue.java b/...e.smarthome.config.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeValue.java
@@ -7,6 +7,8 @@
  */
 package org.eclipse.smarthome.config.xml.util;
 
+import java.util.Map;
+
 
 /**
  * The {@link NodeValue} class contains the node name and its according value for an XML tag.
@@ -21,23 +23,29 @@
 public class NodeValue implements NodeName {
 
     private String nodeName;
+    private Map<String, String> attributes;
     private Object value;
 
 
     /**
      * Creates a new instance of this class with the specified parameters.
      * 
      * @param nodeName the name of the node this object belongs to (must neither be null, nor empty)
+     * @param attributes the attributes of the node this object belongs to (could be null or empty)
      * @param value the value of the node this object belongs to (could be null or empty)
+     *
      * @throws IllegalArgumentException if the name of the node is null or empty
      */
-    public NodeValue(String nodeName, Object value) throws IllegalArgumentException {
+    public NodeValue(String nodeName, Map<String, String> attributes, Object value)
+            throws IllegalArgumentException {
+
         if ((nodeName == null) || (nodeName.isEmpty())) {
             throw new IllegalArgumentException(
                     "The name of the node must neither be null nor empty!");
         }
 
         this.nodeName = nodeName;
+        this.attributes = attributes;
         this.value = formatText(value);
     }
 
@@ -56,9 +64,18 @@ public String getNodeName() {
     }
 
     /**
-     * Returns the value of the node
+     * Returns the attributes of the node.
+     * 
+     * @return the attributes of the node (could be null or empty)
+     */
+    public Map<String, String> getAttributes() {
+        return this.attributes;
+    }
+
+    /**
+     * Returns the value of the node.
      *
-     * @return the value of the node (could be null or empty).
+     * @return the value of the node (could be null or empty)
      */
     public Object getValue() {
         return this.value;

diff --git a/...me.config.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeValueConverter.java b/...me.config.xml/src/main/java/org/eclipse/smarthome/config/xml/util/NodeValueConverter.java
@@ -7,6 +7,8 @@
  */
 package org.eclipse.smarthome.config.xml.util;
 
+import java.util.Map;
+
 import com.thoughtworks.xstream.converters.Converter;
 import com.thoughtworks.xstream.converters.UnmarshallingContext;
 import com.thoughtworks.xstream.io.HierarchicalStreamReader;
@@ -27,7 +29,10 @@ public NodeValueConverter() {
 
     @Override
     public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
-        return new NodeValue(reader.getNodeName(), reader.getValue());
+        Map<String, String> attributes =
+                ConverterAttributeMapValidator.readValidatedAttributes(reader, null);
+
+        return new NodeValue(reader.getNodeName(), attributes, reader.getValue());
     }
 
 }
diff --git a/...smarthome.core.thing.test/src/test/groovy/org/eclipse/smarthome/core/thing/UIDTest.groovy b/...smarthome.core.thing.test/src/test/groovy/org/eclipse/smarthome/core/thing/UIDTest.groovy
@@ -27,4 +27,13 @@ class UIDTest {
         new ThingUID("binding:type:ID")
         new ThingUID("00:type:ID")
     }
+
+    @Test
+    void 'channel UID with group'() {
+        def channelUID = new ChannelUID("binding", "thing-type", "thing", "group", "id")
+        assertThat channelUID.toString(), is(equalTo("binding:thing-type:thing:group#id"))
+        assertThat channelUID.isInGroup(), is(true)
+        assertThat channelUID.getId(), is("group#id")
+        assertThat channelUID.getIdWithoutGroup(), is("id")
+    }
 }
diff --git a/...ing.test/src/test/groovy/org/eclipse/smarthome/core/thing/binding/ThingFactoryTest.groovy b/...ing.test/src/test/groovy/org/eclipse/smarthome/core/thing/binding/ThingFactoryTest.groovy
@@ -21,12 +21,14 @@ import org.eclipse.smarthome.core.thing.ThingTypeUID
 import org.eclipse.smarthome.core.thing.ThingUID
 import org.eclipse.smarthome.core.thing.type.BridgeType
 import org.eclipse.smarthome.core.thing.type.ChannelDefinition
+import org.eclipse.smarthome.core.thing.type.ChannelGroupDefinition
+import org.eclipse.smarthome.core.thing.type.ChannelGroupType
+import org.eclipse.smarthome.core.thing.type.ChannelGroupTypeUID
 import org.eclipse.smarthome.core.thing.type.ChannelType
 import org.eclipse.smarthome.core.thing.type.ChannelTypeUID
 import org.eclipse.smarthome.core.thing.type.ThingType
 import org.junit.Test
 
-
 /**
  * ThingFactoryTest is a test for the ThingFactory class.
  * 
@@ -74,8 +76,8 @@ class ThingFactoryTest {
 
     private List getChannelDefinitions(){
         List channelDefinitions = new ArrayList<ChannelDefinition>()
-        def cd1 = new ChannelDefinition("channel1", new ChannelType(new ChannelTypeUID("channel:cd1"), "itemType", "channelLabel", "description", new HashSet<String>(), new URI("scheme", "channelType:cd1", null)))
-        def cd2 = new ChannelDefinition("channel2", new ChannelType(new ChannelTypeUID("channel:cd2"), "itemType2", "label2", "description22222", new HashSet<String>(), new URI("scheme", "channelType:cd2",null)))
+        def cd1 = new ChannelDefinition("channel1", new ChannelType(new ChannelTypeUID("channel:cd1"), false, "itemType", "channelLabel", "description", "category", new HashSet<String>(), null, new URI("scheme", "channelType:cd1", null)))
+        def cd2 = new ChannelDefinition("channel2", new ChannelType(new ChannelTypeUID("channel:cd2"), false, "itemType2", "label2", "description22222", "category", new HashSet<String>(), null, new URI("scheme", "channelType:cd2",null)))
         channelDefinitions.add(cd1)
         channelDefinitions.add(cd2)
         return channelDefinitions;
@@ -84,7 +86,7 @@ class ThingFactoryTest {
 
     @Test
     void 'create Thing with Default values'(){
-        def thingType = new ThingType(new ThingTypeUID("myThingType","myThing"), null, "label", "description", getChannelDefinitions(), new URI("scheme", "thingType", null))
+        def thingType = new ThingType(new ThingTypeUID("myThingType","myThing"), null, "label", "description", getChannelDefinitions(), null, new URI("scheme", "thingType", null))
         def configuration = new Configuration()
 
         def configDescriptionRegistry = new ConfigDescriptionRegistry() {
@@ -138,13 +140,13 @@ class ThingFactoryTest {
 	@Test
 	void 'create Thing with Channels'() {
 
-		ChannelType channelType1 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId1"), "Color", "label", "description", new HashSet([ "tag1", "tag2" ]), null)
-		ChannelType channelType2 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId2"), "Dimmer", "label", "description", new HashSet([ "tag3" ]), null)
+		ChannelType channelType1 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId1"), false, "Color", "label", "description", "category", new HashSet([ "tag1", "tag2" ]), null, null)
+		ChannelType channelType2 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId2"), false, "Dimmer", "label", "description", "category", new HashSet([ "tag3" ]), null, null)
 
 		ChannelDefinition channelDef1 = new ChannelDefinition("ch1", channelType1)
 		ChannelDefinition channelDef2 = new ChannelDefinition("ch2", channelType2)
 
-		def thingType = new ThingType(new ThingTypeUID("bindingId:thingType"), [], "label", null, [channelDef1, channelDef2], null)
+		def thingType = new ThingType(new ThingTypeUID("bindingId:thingType"), [], "label", null, [channelDef1, channelDef2], null, null)
 		def configuration = new Configuration();
 
 		def thing = ThingFactory.createThing(thingType, new ThingUID(thingType.getUID(), "thingId"), configuration)
@@ -159,4 +161,30 @@ class ThingFactoryTest {
         assertThat thing.getChannels().get(1).getDefaultTags().contains("tag2"), is(false)
         assertThat thing.getChannels().get(1).getDefaultTags().contains("tag3"), is(true)
 	}
+
+    @Test
+    void 'create Thing with channels groups'() {
+
+        ChannelType channelType1 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId1"), false, "Color", "label", "description", "category", new HashSet([ "tag1", "tag2" ]), null, null)
+        ChannelType channelType2 = new ChannelType(new ChannelTypeUID("bindingId:channelTypeId2"), false, "Dimmer", "label", "description", "category", new HashSet([ "tag3" ]), null, null)
+
+        ChannelDefinition channelDef1 = new ChannelDefinition("ch1", channelType1)
+        ChannelDefinition channelDef2 = new ChannelDefinition("ch2", channelType2)
+
+        ChannelGroupType channelGroupType1 = new ChannelGroupType(new ChannelGroupTypeUID("bindingid:groupTypeId1"), false, "label", "description", [channelDef1, channelDef2])
+        ChannelGroupType channelGroupType2 = new ChannelGroupType(new ChannelGroupTypeUID("bindingid:groupTypeId2"), false, "label", "description", [channelDef1])
+
+        ChannelGroupDefinition channelGroupDef1 = new ChannelGroupDefinition("group1", channelGroupType1)
+        ChannelGroupDefinition channelGroupDef2 = new ChannelGroupDefinition("group2", channelGroupType2)
+
+        def thingType = new ThingType(new ThingTypeUID("bindingId:thingType"), [], "label", null, null, [channelGroupDef1, channelGroupDef2], null)
+        def configuration = new Configuration();
+
+        def thing = ThingFactory.createThing(thingType, new ThingUID(thingType.getUID(), "thingId"), configuration)
+
+        assertThat thing.getChannels().size, is(3)
+        assertThat thing.getChannels().get(0).getUID().toString(), is(equalTo("bindingId:thingType:thingId:group1#ch1"))
+        assertThat thing.getChannels().get(1).getUID().toString(), is(equalTo("bindingId:thingType:thingId:group1#ch2"))
+        assertThat thing.getChannels().get(2).getUID().toString(), is(equalTo("bindingId:thingType:thingId:group2#ch1"))
+    }
 }
diff --git a/....core.thing.xml.test/example/channels.xml → ...e.core.thing.xml.test/example/example.xml b/....core.thing.xml.test/example/channels.xml → ...e.core.thing.xml.test/example/example.xml
@@ -4,6 +4,20 @@
     xmlns:thing="http://eclipse.org/smarthome/schemas/thing-description/v1.0.0"
     xsi:schemaLocation="http://eclipse.org/smarthome/schemas/thing-description/v1.0.0 http://eclipse.org/smarthome/schemas/thing-description-1.0.0.xsd">
 
+    <!-- Hue Lamp -->
+    <thing-type id="lamp">
+        <supported-bridge-type-refs>
+            <bridge-type-ref id="bridge" />
+        </supported-bridge-type-refs>
+
+        <label>HUE Lamp</label>
+        <description>My own great HUE Lamp.</description>
+
+        <channel-groups>
+            <channel-group id="alarm_system" typeId="alarm_system"/>
+        </channel-groups>
+    </thing-type>
+
     <!-- Color Channel -->
     <channel-type id="color">
         <item-type>Color</item-type>
@@ -50,4 +64,46 @@
         </tags>
     </channel-type>
 
+    <!-- Alarm Channel -->
+    <channel-type id="alarm">
+        <item-type>Number</item-type>
+        <label>Alarm System</label>
+        <description>The light blinks if alarm is set.</description>
+        <category>ALARM</category>
+        <tags>
+            <tag>Hue</tag>
+            <tag>AlarmSystem</tag>
+        </tags>
+        <state min="0" max="100.0" step="10.0" pattern="%d Peek">
+            <options>
+                <option value="SOUND">My great sound.</option>
+                <option value="LIGHT"/>
+            </options>
+        </state>
+    </channel-type>
+
+    <!-- Motion Channel -->
+    <channel-type id="motion" advanced="true">
+        <item-type>Number</item-type>
+        <label>Motion Sensor</label>
+        <description>The sensor detecting motion.</description>
+        <category>MOTION</category>
+        <tags>
+            <tag>Hue</tag>
+            <tag>AlarmSystem</tag>
+        </tags>
+    </channel-type>
+
+    <!-- Alarm System Channel -->
+    <channel-group-type id="alarm_system" advanced="false">
+        <label>Alarm System</label>
+        <description>The alarm system.</description>
+        <channels>
+            <channel id="colorId" typeId="color" />
+            <channel id="color_temperatureId" typeId="color_temperature" />
+            <channel id="alarmId" typeId="alarm" />
+            <channel id="motionId" typeId="motion"/>
+        </channels>
+    </channel-group-type>
+
 </thing:thing-descriptions>
diff --git a/...e.thing.xml.test/src/test/groovy/org/eclipse/smarthome/core/thing/xml/test/Example.groovy b/...e.thing.xml.test/src/test/groovy/org/eclipse/smarthome/core/thing/xml/test/Example.groovy
@@ -2,6 +2,7 @@ package org.eclipse.smarthome.core.thing.xml.test;
 
 import static org.junit.Assert.*
 
+import org.eclipse.smarthome.core.thing.type.ChannelType
 import org.eclipse.smarthome.core.thing.xml.internal.ChannelTypeXmlResult
 import org.eclipse.smarthome.core.thing.xml.internal.ThingDescriptionList
 import org.eclipse.smarthome.core.thing.xml.internal.ThingDescriptionReader
@@ -13,13 +14,13 @@ import org.junit.Test
  * can be used. This example can also be used for manual tests when the schema is extended or
  * changed.
  * 
- * @author Michael Grammling
+ * @author Michael Grammling - Initial Contribution.
  */
 class Example {
 
     @Test
     public void test() {
-        File file = new File("./example/channels.xml")
+        File file = new File("./example/example.xml")
         URL channelsURL = file.toURI().toURL()
 
         ThingDescriptionReader reader = new ThingDescriptionReader()
@@ -29,7 +30,15 @@ class Example {
             print it
 
             if (it instanceof ChannelTypeXmlResult) {
-                print ", tags=" + ((ChannelTypeXmlResult) it).getChannelType().getTags()
+                ChannelType channelType = ((ChannelTypeXmlResult) it).getChannelType()
+
+                print ", advanced=" + channelType.isAdvanced() +
+                      ", itemType=" + channelType.getItemType() +
+                      ", label=" + channelType.getLabel() +
+                      ", description=" + channelType.getDescription() +
+                      ", category=" + channelType.getCategory() +
+                      ", tags=" + channelType.getTags() +
+                      ", state=" + channelType.getState();
             }
 
             print "\n"