A condition that listens for changes of the value of a home device property on a specific device.

Managing Home Device Property Conditions

The type of the condition is stored in the CONDITION_TYPE constant of the com.prosyst.mbs.services.hdm.ham.condition.HDPropertyCondition interface.

Via Java API

To configure the condition, use the following methods from the HDPropertyCondition class:

Target Device

• setDeviceUID - The UID of the Home Device

Property

• setDeviceProperty - The name of the property to listen for

When the value of this property changes the condition will be triggered

After you configure your condition, call the save method. The Condition Provider will save the condition in Config Tree.

Via ConfigTree

All conditions are stored in ConfigTree, which allows you to import/export them and to add/edit commands by modifying XML files.

You can create a condition directly from ConfigTree by writing/generating an XML file, according to the following schema definitions:

Download Home Device Property Condition Schema Definition

Download Common Datatypes Schema Definition

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <!-- Include common types -->

    <xs:include schemaLocation="HAMCommonTypes.xsd"/>

    <!-- Global elements definitions -->

    <xs:complexType name="hdPropertyCondition">

        <xs:complexContent>

            <xs:extension base="configNode">

                <xs:sequence>

                    <xs:element name="property" type="propertyType" minOccurs="2" maxOccurs="unbounded">

                        <xs:alternative test="@key eq 'uid' and @type eq 'string'" type="valueString"/>

                        <xs:alternative test="@key eq 'device_property' and @type eq 'string'" type="deviceProperty"/>

                        <xs:alternative test="@key eq 'comparison_operation' and @type eq 'string'" type="comparisonOperation"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'int'" type="valueInt"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'char'" type="valueChar"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'byte'" type="valueByte"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'boolean'" type="valueBoolean"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'float'" type="valueFloat"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'double'" type="valueDouble"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'short'" type="valueShort"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'long'" type="valueLong"/>

                        <xs:alternative test="@key eq 'constraint' and @type eq 'map'" type="valueMap"/>

                        <xs:alternative test="@key eq 'constraint'" type="valueString"/>

                        <xs:alternative test="@key eq 'condition_id' and @type eq 'string'" type="valueString"/>

                        <xs:alternative test="@key eq 'condition_type' and @type eq 'string'" type="valueString"/>

                        <xs:alternative test="@key eq 'state' and @type eq 'int'" type="valueSceneState"/>

                        <xs:alternative test="@key eq 'usedInScenes' and @type eq 'string[]'" type="valueString"/>

                        <xs:alternative test="@key eq 'usedInRules' and @type eq 'string[]'" type="valueString"/>

                        <xs:alternative test="@key eq 'command_count' and @type eq 'int'" type="valuePositiveInt"/>

                        <xs:alternative test="@key eq 'name' and @type eq 'string'" type="valueString"/>

                        <xs:alternative test="@key eq 'application' and @type eq 'string'" type="valueString"/>

                        <xs:alternative test="@key eq 'internal' and @type eq 'boolean'" type="valueBoolean"/>

                        <xs:alternative type="xs:error"/>

                    </xs:element>

                </xs:sequence>

                <xs:assert test="count(property[@key='uid']) eq 1"/>

                <xs:assert test="count(property[@key='device_property']) eq 1"/>

            </xs:extension>

        </xs:complexContent>

    </xs:complexType>

     <xs:complexType name="attributeHDPropertyCondition">

         <xs:attribute name="name" use="required">

             <xs:simpleType>

                 <xs:restriction base="xs:string">

                     <xs:enumeration value="HDPropertyCondition"/>

                 </xs:restriction>

             </xs:simpleType>

         </xs:attribute>

     </xs:complexType>

     <xs:complexType name="hdPropertyConditions">

         <xs:complexContent>

             <xs:extension base="attributeHDPropertyCondition">

                 <xs:all>

                     <xs:element name="property" type="valueString" minOccurs="0" maxOccurs="unbounded"/>

                     <xs:element name="config" type="hdPropertyCondition" minOccurs="0" maxOccurs="unbounded">

                         <xs:unique ref="uniqueProperties"/>

                     </xs:element>

                 </xs:all>

             </xs:extension>

         </xs:complexContent>

     </xs:complexType>

     <!-- XML Schema definition -->

     <xs:element name="config" type="hdPropertyConditions">

         <xs:unique name="uniqueProperties">

             <xs:selector xpath="property"/>

             <xs:field xpath="@key"/>

         </xs:unique>

         <xs:unique name="uniqueConfigNodes">

             <xs:selector xpath="config"/>

             <xs:field xpath="@name"/>

         </xs:unique>

     </xs:element>

</xs:schema>

The following example contains a Home Device Property Condition that is triggered when the device with an UID hdm:ZigBee:000d6f0001b57a6e changes its status.

Home Device Property Condition Configuration

<config name="HDPropertyCondition">

  <config name="HDPropertyCondition1">

    <property key="uid" value="hdm:ZigBee:000d6f0001b57a6e" type="string"/>

    <property key="device_property" value="status" type="string"/>

  </config>

</config>