Zone Device Class Object Operation Command (deprecated)

A command for simultaneous execution of a Device Class Object operation on all devices which belong to the same zone.

Managing Zone Operation Commands

The type of the command is stored in the TYPE constant of the com.prosyst.mbs.services.hdm.ham.command.ZoneDCOOperationCommand interface.

Via Java API

To configure the command, use the following methods from the ZoneDCOOperationCommand class:

Target devices

setZoneUID - the ID of the zone, where the devices are added.
setChildZonesIncluded - true if you want to execute the command on the children of that zone, false if you don't.

The HDM retrieves all devices from the selected zone or zones.

Operation

setDCOOperationName - The name of the Device Class Object operation to be executed
setDCOOperationArguments - An array of the arguments, that the operation accepts or null if it doesn't accept any.
setDeviceClass - The name of the Device Class Interface that contains the operation.

When the command is executed the HAM invokes the operation on all target devices.

Asynchronous Execution

setAsync - true if you want to execute the operation asynchronously and false to execute it in the same thread.
setTimeToLive - If the operation is executed asynchronously you can specify how long the request should remain active (in milliseconds). After that period, the request will be canceled automatically, if it isn't performed.

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

Via ConfigTree

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

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

Download Zone Operation Operation Command 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="zoneDCOOperationCommand">

<xs:complexContent>

<xs:extension base="configNode">

<xs:all>

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

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

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

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

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

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

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

<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 'command_id' and @type eq 'string'" type="valueString"/>

<xs:alternative test="@key eq 'command_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="0" maxOccurs="1">

<xs:alternative test="@name eq 'args'" type="commandOperationArguments"/>

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

<xs:unique ref="uniqueProperties"/>

<xs:unique ref="uniqueConfigNodes"/>

</xs:element>

</xs:all>

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

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

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

</xs:extension>

</xs:complexContent>

</xs:complexType>

<xs:complexType name="attributeZoneDCOOperationCommand">

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

<xs:simpleType>

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

<xs:enumeration value="ZoneDCOOperationCommand"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:complexType name="zoneDCOOperationCommands">

<xs:complexContent>

<xs:extension base="attributeZoneDCOOperationCommand">

<xs:all>

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

<xs:element name="config" type="zoneDCOOperationCommand" 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="zoneDCOOperationCommands">

<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 Zone Operation Command which executes the toggle operation on all devices in the bathroom zone which have the BinarySwitch Device Class Object.

Device Class Object Operation Command Configuration

</config>