Filter Home Device Property Condition (deprecated)

A condition that listens for changes of the value of a home device property on all devices which have the same values for a set of device properties in common.

Managing Filter Home Device Property Condition

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

Via Java API

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

Target Devices

setDeviceProperties - Names and values of the device properties, to identify the target devices (those that you want to listen to).
You can retrieve a list of all devices that meet the criteria with the getMatchDevices method.
Optionally, you can add or remove devices from the list: Retrieve it, edit it and upload your modified version in HDM with the setMatchDevices method.
To revert any changes you've made and select devices by filter again, call updateMatchDevices.

Property

setDeviceProperties - Names and values of the device properties that you want to listen to.

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 Filter Home Device Property Condition Schema Definition

Download Common Datatypes Schema Definition

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

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

<xs:complexType name="filterHDPropertyCondition">

<xs:complexContent>

<xs:extension base="configNode">

<xs:all>

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

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

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

<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 '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 '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 '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 'string'" type="valueBoolean"/>

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

</xs:element>

<xs:element name="config" type="configNode" minOccurs="1" maxOccurs="1">

<xs:alternative test="@name eq 'properties'" type="filterDeviceProperties"/>

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

<xs:unique ref="uniqueProperties"/>

</xs:element>

</xs:all>

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

</xs:extension>

</xs:complexContent>

</xs:complexType>

<xs:complexType name="attributeFilterHDPropertyCondition">

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

<xs:simpleType>

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

<xs:enumeration value="FilterHDPropertyCondition"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:complexType name="filterHDPropertyConditions">

<xs:complexContent>

<xs:extension base="attributeFilterHDPropertyCondition">

<xs:all>

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

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

<xs:unique ref="uniqueProperties"/>

<xs:unique ref="uniqueConfigNodes"/>

</xs:element>

</xs:all>

</xs:extension>

</xs:complexContent>

</xs:complexType>

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

<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 Filter Home Device Property Condition that listens for all devices with type equal to Controller and is triggered every time one of them changes its status.

</config>