Eclipse.org Eclipse.org command Device Kit

XML Element 

<command> 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: command examples


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

NameDescriptionUse
Element <command> elements
<description>Specifies the command description.0 to 1
<optional>New Defines if this command is optional.0 to 1
<units>Specifies the command data units.0 to 1
<deprecated>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>Defines this command as a configuration command. 0 to 1
<commandreceived>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>Specifies the measurement to get the value for the command.0 to 1

Sibling NameSibling Description
Element <command> element siblings
<commands>Specifies a command group.
<group>Defines a group supported by this concrete device.
<measurement>Defines a measurement supported by this concrete device.
<signal>Defines a signal supported by this concrete device.

Element NameElement Description
Element <command> element tree
<dkml>Specifies the root element of a Device Kit <b>D</b>evice <b>K</b>it <b>L</b>anguage (dkml) document.
¦-<adapter>Specifies an adapter.
¦ ¦-<command>Defines a command supported by this concrete device.
¦ ¦ ¦-<description>Specifies the command description.
¦ ¦ ¦-<optional>New Defines if this command is optional.
¦ ¦ ¦ ¦-<description>New Description of the optional item.(see description)
¦ ¦ ¦ ¦-<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦ ¦ ¦ ¦-<specreference>Specification reference for this optional item.
¦ ¦ ¦ ¦ ¦-<description>Description of the specification reference.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<spec>The protocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the specification.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦ ¦-<speccomment>Comment about the protocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<specdate>Date of the protocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<spectitle>Title of the protoocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<specurl>Url of the protocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<specvendor>Vendor of the protocol specification documentation.
¦ ¦ ¦ ¦ ¦ ¦-<specversion>Version of the protocol specification documentation.
¦ ¦ ¦ ¦ ¦-<specsection>The reference to section in the protocol specification documentation.
¦ ¦ ¦-<units>Specifies the command data units.
¦ ¦ ¦ ¦-<description>Description of the units.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this units.(see specreference)
¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦-<specreference>Specification reference for this command.(see specreference)
¦ ¦ ¦-<key>Specifies a unique command key.
¦ ¦ ¦-<configuration>Defines this command as a configuration command.
¦ ¦ ¦ ¦-<description>New Description of the configuration.(see description)
¦ ¦ ¦ ¦-<units>Specifies the configuration units.(see units)
¦ ¦ ¦ ¦-<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this configuration.(see specreference)
¦ ¦ ¦ ¦-<enum>New Specifies a enumeration option configuration.
¦ ¦ ¦ ¦ ¦-<description>Description of the enumeration.(see description)
¦ ¦ ¦ ¦ ¦-<units>Specifies the enum units.(see units)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>New Specification reference for this enumeration.(see specreference)
¦ ¦ ¦ ¦ ¦-<key>New Specifies a enumeration key.(see key)
¦ ¦ ¦ ¦ ¦-<label>New Specifies a enumeration label.
¦ ¦ ¦ ¦ ¦-<value>New Specifies the enumeration value.
¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the value.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this value.(see specreference)
¦ ¦ ¦ ¦ ¦ ¦-<boolean>Specifies a Boolean value.
¦ ¦ ¦ ¦ ¦ ¦-<byte>Specifies a Byte value (8 bits).
¦ ¦ ¦ ¦ ¦ ¦-<bytes>Specifies bytes.
¦ ¦ ¦ ¦ ¦ ¦-<character>Specifies a character value (16 bits).
¦ ¦ ¦ ¦ ¦ ¦-<double>Specifies a Double value.
¦ ¦ ¦ ¦ ¦ ¦-<float>Specifies a Float value.
¦ ¦ ¦ ¦ ¦ ¦-<int>Specifies an Integer value (32 bits).
¦ ¦ ¦ ¦ ¦ ¦-<list>Specifies list data.
¦ ¦ ¦ ¦ ¦ ¦-<long>Specifies a Long value (64 bits).
¦ ¦ ¦ ¦ ¦ ¦-<long>Specifies a Long value (64 bits).(see long)
¦ ¦ ¦ ¦ ¦ ¦-<map>Specifies a Map value.
¦ ¦ ¦ ¦ ¦ ¦-<short>Specifies a Short value (16 bits).
¦ ¦ ¦ ¦ ¦ ¦-<string>Specifies a String value.
¦ ¦ ¦ ¦-<minimum>New Specifies the minimum value.
¦ ¦ ¦ ¦-<maximum>New Specifies the maximum value.
¦ ¦ ¦-<commandreceived>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>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 characters (8 bits).
¦ ¦ ¦ ¦-<bytes>Specifies a set of bytes. Each byte is 8 bits.(see bytes)
¦ ¦ ¦ ¦-<nibbles>Specifies a set of nibbles. Each nibble is 4 bits.
¦ ¦ ¦ ¦-<utf8>Specifies a set of UTF-8 characters.
¦ ¦ ¦ ¦-<tokens>Specifies the message tokens.
¦ ¦ ¦ ¦-<parameters>Specifies a group of parameters.
¦ ¦ ¦ ¦ ¦-<description>Specifies the parameters description.(see description)
¦ ¦ ¦ ¦ ¦-<units>Specifies the parameters units.(see units)
¦ ¦ ¦ ¦ ¦-<deprecated>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)
¦ ¦ ¦ ¦ ¦-<parameters>New Specifies the parameters.(see parameters)
¦ ¦ ¦ ¦-<filter>Specifies the message filter.
¦ ¦ ¦ ¦ ¦-<description>Description of the filter.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>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)
¦ ¦ ¦ ¦-<optional>Defines if this data item is optional.(see optional)
¦ ¦ ¦ ¦-<units>Specifies the data units.(see units)
¦ ¦ ¦ ¦-<deprecated>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 size element to specify the data length in bytes.
¦ ¦ ¦ ¦-<size>Specifies the data size in bytes. See the length element to specify the data length in bits.
¦ ¦ ¦ ¦-<minimum>Specifies the minimum value.(see minimum)
¦ ¦ ¦ ¦-<maximum>Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦-<data>Specifies the data to execute the command.(see data)
¦ ¦ ¦ ¦-<units>Specifies the optional data units.(see units)
¦ ¦ ¦-<measurement>Specifies the measurement to get the value for the command.
¦ ¦-<commands>Specifies a command group.
¦ ¦ ¦-<command>Specifies the command within the group of commands.(see command)
¦ ¦-<group>Defines a group supported by this concrete device.
¦ ¦ ¦-<command>Specifies a command that is supported by this group.(see command)
¦ ¦ ¦-<commands>Specifies a command group.(see commands)
¦ ¦ ¦-<group>Specifies a group.(see group)
¦ ¦-<device>Specifies the device used by the adapter.
¦ ¦ ¦-<command>Specifies a command that is supported by this device.(see command)
¦ ¦ ¦-<commands>Specifies a command group.(see commands)
¦ ¦ ¦-<group>Defines a group supported by this device.(see group)
¦-<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)
¦ ¦-<command>Specifies a command that is supported by this device.(see command)
¦ ¦-<commands>Specifies a command group.(see commands)
¦ ¦-<group>Defines a group supported by this device.(see group)
¦-<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.
¦ ¦-<command>Defines a command supported by this concrete device.(see command)
¦ ¦-<commands>Specifies a command group.(see commands)
¦ ¦-<group>Defines a group supported by this concrete device.(see group)
¦-<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.
¦ ¦-<command>Specifies a command that is supported by this profile.(see command)
¦ ¦-<commands>Specifies a command group.(see commands)
¦ ¦-<group>Defines a group supported by this profile.(see group)
¦ ¦-<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) 2008 IBM. See license in Legal section. 2008-07-29 Device Kit XML Reference 1.1.0