Eclipse.org Eclipse.org
XML Element

<writecommand> element

 Device Kit Attributes Elements XML Reference
The command tag denotes an action that can be performed by the hardware device. Usually, a message must be sent to the hardware device to cause the action to be performed. When an application requests a command to be executed, the software device requests the transport to send the command message to the hardware device. For example, you might use the command tag to send a message to a radio to "turn volume up" or "turn on power". The commands that the device should define are hardware specific. As such, the command set for a radio differs from the command set for a car bus. Also, the command set might vary based on the company that built the device. To send effective commands to hardware, be sure to use the hardware specifications from the manufacturer. Some commands can be executed with a parameter that will be encoded into the message before it is sent to the hardware device. The message that represent the command are defined in a message tag.

Examples: writecommand examples


NameTypeDescriptionUse
Element <writecommand> attributes
type "Boolean" "Integer" "List" "Long" "Map" "Number" "Object" "String" Specifies the command data type.optional

NameDescriptionUse
Element <writecommand> elements
<description>Specifies the command description.0 to 1
<deprecated>New Specifies that the contents of this element should be marked as deprecated.0 to 1
<specreference>Specification reference for this command.0 to unbounded
<key>Specifies a unique command key.0 to 1
<configuration>New Defines this command as a configuration command. 0 to 1
<commandreceived>New Specifies if a command message can be received from the device. 0 to 1
<rate>Specifies the polling rate in milliseconds.0 to 1
<message>Specifies the message to execute the command.0 to 1
<method>Specifies the method to execute the command.0 to 1
<data>Specifies the data to execute the command.0 to unbounded
<measurement>New Specifies the measurement to get the value for the command.0 to 1

Sibling NameSibling Description
Element <writecommand> element siblings
<method>Specifies the method.

Element NameElement Description
Element <writecommand> element tree
<dkml>Specifies the root element of a Device Kit Device Kit Language (dkml) document.
¦--<adapter>Specifies an adapter.
¦  ¦--<group>Defines a group supported by this concrete device.
¦  ¦  ¦--<measurement>Specifies a measurement supported by this group.
¦  ¦  ¦  ¦--<writecommand>Specifies the command to request a change of the measurement value.
¦  ¦  ¦  ¦  ¦--<description>Specifies the command description.
¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this command.
¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the specification reference.(see description)
¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦--<spec>The hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the specification.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<speccomment>Comment about the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specdate>Date of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<spectitle>Title of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specvendor>Vendor the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specversion>Version of the hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦--<specsection>The reference to section in the hardware specification documentation.
¦  ¦  ¦  ¦  ¦--<key>Specifies a unique command key.
¦  ¦  ¦  ¦  ¦--<configuration>New Defines this command as a configuration command.
¦  ¦  ¦  ¦  ¦--<commandreceived>New Specifies if a command message can be received from the device.
¦  ¦  ¦  ¦  ¦--<rate>Specifies the polling rate in milliseconds.
¦  ¦  ¦  ¦  ¦--<message>Specifies the message to execute the command.
¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the message.(see description)
¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this message.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦--<ascii>Specifies a set of ASCII character (8 bits).
¦  ¦  ¦  ¦  ¦  ¦--<bytes>Specifies a set of bytes. Each byte is 8 bits.
¦  ¦  ¦  ¦  ¦  ¦--<nibbles>Specifies a set of nibbles. Each nibble is 4 bits.
¦  ¦  ¦  ¦  ¦  ¦--<tokens>Specifies the message tokens.
¦  ¦  ¦  ¦  ¦  ¦--<parameter>Specifies a parameter within the message.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the parameter.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this parameter.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<key>Specifies the parameter key.(see key)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<bigendian>Specifies that the parameter data is in big endian order. This is the default order.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<field>Specifies the field parameter name.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<insert>Specifies that the parameter should be inserted into the message.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<littleendian>Specifies that the parameter data is in little endian order.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<offset>Specifies the starting bit offset of the parameter within the message. Offset 0 is the first bit in the message. See the offset element to specify the parameter offset in bytes.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<index>Specifies the starting byte index of the parameter within the message. Index 0 is the first byte of the message. See the offset element to specify the parameter offset in bits.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<length>Specifies the parameter length in bits. See the length element to specify the parameter length in bytes.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<size>Specifies the parameter size in bytes. See the length element to specify the parameter length in bits.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<enum>Specifies a enum for this parameter.
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the enum.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this enum.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<minimum>Specifies the minimum value.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<maximum>Specifies the maximum value.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<negative>Negate the parameter value.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<not>Logical not of a boolean value.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<scale>Specifies the value to scale the parameter value.
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the scale.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this scale.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<shift>Specifies the value to shift the parameter value.
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the shift.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this shift.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<translate>Specifies the value to add (translate) to the parameter value.
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the translate.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this translate.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<units>Specifies the optional parameter units.
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the units.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this units.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦--<parameters>Specifies a group of parameters.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Specifies the parameters description.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this group of parameters.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<key>Specifies the unique parameters key.(see key)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<parameter>Specifies the parameter.(see parameter)
¦  ¦  ¦  ¦  ¦  ¦--<filter>Specifies the message filter.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the filter.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this filter.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<bytes>Specifies the message filter (Bit off - ignore, Bit on - compare).(see bytes)
¦  ¦  ¦  ¦  ¦  ¦--<sentmessage>Specifies the message that was sent that caused this message.
¦  ¦  ¦  ¦  ¦--<method>Specifies the method to execute the command.
¦  ¦  ¦  ¦  ¦--<data>Specifies the data to execute the command.
¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the data.(see description)
¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this data.(see specreference)
¦  ¦  ¦  ¦  ¦  ¦--<key>Specifies the data key.(see key)
¦  ¦  ¦  ¦  ¦  ¦--<length>Specifies the data length in bits. See the length element to specify the data length in bytes. (see length)
¦  ¦  ¦  ¦  ¦  ¦--<size>Specifies the data size in bytes. See the length element to specify the data length in bits. (see size)
¦  ¦  ¦  ¦  ¦  ¦--<minimum>Specifies the minimum value.(see minimum)
¦  ¦  ¦  ¦  ¦  ¦--<maximum>Specifies the maximum value.(see maximum)
¦  ¦  ¦  ¦  ¦  ¦--<units>Specifies the optional data units.(see units)
¦  ¦  ¦  ¦  ¦--<measurement>New Specifies the measurement to get the value for the command.(see measurement)
¦  ¦--<measurement>Defines a measurement supported by this concrete device.(see measurement)
¦  ¦--<device>Specifies the device used by the adapter.
¦  ¦  ¦--<group>Defines a group supported by this device.(see group)
¦  ¦  ¦--<measurement>Specifies a measurement supported by this device.(see measurement)
¦--<adaptertest>Specifies an adapter test.
¦  ¦--<adapter>Specifies the adapter to be tested.(see adapter)
¦--<agent>Specifies an agent.
¦  ¦--<agentmodel>Specifies the agent model used by the agent.
¦  ¦  ¦--<device>Specifies the device used by the agent model.(see device)
¦  ¦--<device>Specifies the device used by the agent.(see device)
¦--<agentmodel>Specifies the agent model used by the agent.(see agentmodel)
¦--<agenttest>Specifies an agent test.
¦  ¦--<agent>Specifies the agent to be tested.(see agent)
¦  ¦--<agentmodeltest>Specifies the agent model test.
¦  ¦  ¦--<agentmodel>Specifies the agent model to be tested.(see agentmodel)
¦--<agentmodeltest>Specifies an agent model test.(see agentmodeltest)
¦--<concrete>Specifies a concrete device.
¦  ¦--<group>Defines a group supported by this concrete device.(see group)
¦  ¦--<measurement>Defines a measurement supported by this concrete device.(see measurement)
¦--<concretetest>Specifies a concrete test.
¦  ¦--<concrete>Specifies the concrete device to be tested.(see concrete)
¦--<device>Specifies a device.(see device)
¦--<devicetest>Specifies a device test.
¦  ¦--<device>Specifies the device to be tested.(see device)
¦--<profile>Specifies a profile.
¦  ¦--<group>Defines a group supported by this profile.(see group)
¦  ¦--<measurement>Specifies a measurement supported by this profile.(see measurement)
¦  ¦--<adapter>Specifies the adapter used by the profile.(see adapter)
¦  ¦--<device>Specifies the device used by the profile.(see device)
¦--<profiletest>Specifies a profile test.
¦  ¦--<profile>Specifies the profile to be tested.(see profile)
¦--<testagent>Specifies a test agent.
¦  ¦--<profile>Specifies the profile to be tested.(see profile)
Copyright (c) IBM 2007. Device Kit XML Reference 1.0.0