Eclipse.org Eclipse.org key Device Kit

XML Element 

<key> element

Device Kit Attributes Elements XML Reference
Specifies a unique command key.

Content type: ID

Examples: key examples


Sibling NameSibling Description
Element <key> element siblings
<description>Specifies the command description.
<history>New Specifies the command history.
<optional>Defines if this command is optional.
<units>Specifies the command data units.
<deprecated>Specifies that the contents of this element should be marked as deprecated.
<specreference>Specification reference for this command.
<configuration>Defines this command as a configuration command.
<commandreceived>Specifies if a command message can be received from the device.
<rate>Specifies the polling rate in milliseconds.
<measurement>Specifies the measurement to get the value for the command.

Element NameElement Description
Element <key> element tree
<dkml>Specifies the root element of a Device Kit &lt;b&gt;D&lt;/b&gt;evice &lt;b&gt;K&lt;/b&gt;it &lt;b&gt;L&lt;/b&gt;anguage (dkml) document.
¦-<pids>Specifies the defined pids.
¦ ¦-<key>Specifies the unique pids key.
¦ ¦-<pid>Specifies the pid.
¦ ¦ ¦-<key>Specifies the parameter identifier (pid) key.(see key)
¦-<adapter>Specifies an adapter.
¦ ¦-<customparameter>Specifies a custom parameter for this adapter.
¦ ¦ ¦-<enum>Specifies a enumeration option configuration.
¦ ¦ ¦ ¦-<key>Specifies a enumeration key.(see key)
¦ ¦-<command>Defines a command supported by this concrete device.
¦ ¦ ¦-<key>Specifies a unique command key.(see key)
¦ ¦ ¦-<configuration>Defines this command as a configuration command.
¦ ¦ ¦ ¦-<enum>Specifies a enumeration option configuration.(see enum)
¦ ¦ ¦-<message>Specifies the message to execute the command.
¦ ¦ ¦ ¦-<parameters>Specifies a group of parameters.
¦ ¦ ¦ ¦ ¦-<key>Specifies the unique parameters key.(see key)
¦ ¦ ¦ ¦ ¦-<parameters>Specifies the parameters.(see parameters)
¦ ¦ ¦-<data>Specifies the data to execute the command.
¦ ¦ ¦ ¦-<key>Specifies the data key.(see key)
¦ ¦ ¦ ¦-<enum>New Specifies a enumeration.(see enum)
¦ ¦ ¦ ¦-<data>Specifies the data to execute the command.(see data)
¦ ¦-<commands>Specifies a command group.
¦ ¦ ¦-<key>Specifies a unique commands key.(see key)
¦ ¦ ¦-<configuration>Defines this command as a configuration command.(see configuration)
¦ ¦ ¦-<command>Specifies the command within the group of commands.(see command)
¦ ¦-<group>Defines a group supported by this concrete device.
¦ ¦ ¦-<key>Specifies an optional key value.(see key)
¦ ¦ ¦-<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)
¦ ¦ ¦-<measurement>Specifies a measurement supported by this group.
¦ ¦ ¦ ¦-<key>Specifies a unique measurement key.(see key)
¦ ¦ ¦ ¦-<configuration>Defines this measurement as a configuration measurement.(see configuration)
¦ ¦ ¦ ¦-<message>Specifies the measurement message.(see message)
¦ ¦ ¦ ¦-<data>Specifies the measurement data.(see data)
¦ ¦ ¦ ¦-<readcommand>Specifies the command to request a read of the current value of the measurement.
¦ ¦ ¦ ¦ ¦-<key>Specifies a unique command key.(see key)
¦ ¦ ¦ ¦ ¦-<configuration>Defines this command as a configuration command.(see configuration)
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to execute the command.(see message)
¦ ¦ ¦ ¦ ¦-<data>Specifies the data to execute the command.(see data)
¦ ¦ ¦ ¦-<writecommand>Specifies the command to request a change of the measurement value.
¦ ¦ ¦ ¦ ¦-<key>Specifies a unique command key.(see key)
¦ ¦ ¦ ¦ ¦-<configuration>Defines this command as a configuration command.(see configuration)
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to execute the command.(see message)
¦ ¦ ¦ ¦ ¦-<data>Specifies the data to execute the command.(see data)
¦ ¦ ¦ ¦-<signal>Specifies the signal containing the measurement value.
¦ ¦ ¦ ¦ ¦-<key>Specifies the unique signal key.(see key)
¦ ¦ ¦ ¦ ¦-<configuration>Defines this signal as a configuration signal.(see configuration)
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to trigger the signal.(see message)
¦ ¦ ¦ ¦ ¦-<data>Specifies the data when the signal triggers.(see data)
¦ ¦ ¦ ¦ ¦-<signal>Specifies the signal to listen. (see signal)
¦ ¦ ¦ ¦ ¦-<messages>Specifies the messages to trigger the signal.
¦ ¦ ¦ ¦ ¦ ¦-<key>Specifies the unique messages key.(see key)
¦ ¦ ¦ ¦ ¦ ¦-<message>Specifies the message.(see message)
¦ ¦ ¦ ¦ ¦-<pid>Specifies the pid for this signal.(see pid)
¦ ¦ ¦ ¦ ¦-<parameters>Specifies a parameter group.(see parameters)
¦ ¦ ¦ ¦-<parameters>Specifies a group of parameters.(see parameters)
¦ ¦ ¦-<signal>Specifies a signal supported by this group.(see signal)
¦ ¦-<measurement>Defines a measurement supported by this concrete device.(see measurement)
¦ ¦-<signal>Defines a signal supported by this concrete device.(see signal)
¦ ¦-<device>Specifies the device used by the adapter.
¦ ¦ ¦-<customparameter>Specifies a custom parameter for this device.(see customparameter)
¦ ¦ ¦-<key>Specifies an optional key value.(see key)
¦ ¦ ¦-<pids>Specifies the defined pids.(see pids)
¦ ¦ ¦-<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)
¦ ¦ ¦-<measurement>Specifies a measurement supported by this device.(see measurement)
¦ ¦ ¦-<signal>Specifies a signal supported by this device.(see signal)
¦ ¦ ¦-<transport>Specifies the transport used by the device.
¦ ¦ ¦ ¦-<customparameter>Specifies a custom parameter.(see customparameter)
¦ ¦ ¦ ¦-<message>Specifies a transport message.(see message)
¦ ¦ ¦ ¦-<connection>Specifies an connection to be used by the transport.
¦ ¦ ¦ ¦ ¦-<customparameter>Specifies a custom parameter for this connection.(see customparameter)
¦-<adaptertest>Specifies an adapter test.
¦ ¦-<customparameter>New Specifies a custom parameter for this adapter test.(see customparameter)
¦ ¦-<send>Specifies the message(s) to send during the test.
¦ ¦ ¦-<message>Specifies the message to send.(see message)
¦ ¦-<adapter>Specifies the adapter to be tested.(see adapter)
¦-<agent>Specifies an agent.
¦ ¦-<customparameter>Specifies a custom parameter for this agent.(see customparameter)
¦ ¦-<agentmodel>Specifies the agent model used by the agent.
¦ ¦ ¦-<customparameter>Specifies a custom parameter for this agent model.(see customparameter)
¦ ¦ ¦-<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)
¦ ¦-<measurement>Specifies a measurement supported by this device.(see measurement)
¦ ¦-<signal>Specifies a signal supported by this device.(see signal)
¦-<agentmodel>Specifies the agent model used by the agent.(see agentmodel)
¦-<agenttest>Specifies an agent test.
¦ ¦-<customparameter>New Specifies a custom parameter for this agent test.(see customparameter)
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦ ¦-<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.
¦ ¦-<customparameter>New Specifies a custom parameter for this concrete device.(see customparameter)
¦ ¦-<key>Specifies an optional key value.(see key)
¦ ¦-<pids>Specifies the defined pids.(see pids)
¦ ¦-<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)
¦ ¦-<measurement>Defines a measurement supported by this concrete device.(see measurement)
¦ ¦-<signal>Defines a signal supported by this concrete device.(see signal)
¦ ¦-<transport>Specifies the transport used by the concrete device.(see transport)
¦-<concretetest>Specifies a concrete test.
¦ ¦-<customparameter>New Specifies a custom parameter for this concrete device test.(see customparameter)
¦ ¦-<concrete>Specifies the concrete device to be tested.(see concrete)
¦-<connection>Specifies an connection.(see connection)
¦-<connectiontest>Specifies an connection test.
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦ ¦-<connection>Specifies the connection to be tested.(see connection)
¦-<device>Specifies a device.(see device)
¦-<devicetest>Specifies a device test.
¦ ¦-<customparameter>New Specifies a custom parameter for this device test.(see customparameter)
¦ ¦-<device>Specifies the device to be tested.(see device)
¦-<profile>Specifies a profile.
¦ ¦-<customparameter>Specifies a custom parameter for this profile.(see customparameter)
¦ ¦-<key>Specifies an optional key value.(see key)
¦ ¦-<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)
¦ ¦-<measurement>Specifies a measurement supported by this profile.(see measurement)
¦ ¦-<signal>Specifies a signal supported by this profile.(see signal)
¦ ¦-<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.
¦ ¦-<customparameter>New Specifies a custom parameter for this profile test.(see customparameter)
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦ ¦-<profile>Specifies the profile to be tested.(see profile)
¦-<testagent>Specifies a test agent.
¦ ¦-<customparameter>New Specifies a custom parameter for this test.(see customparameter)
¦ ¦-<profile>Specifies the profile to be tested.(see profile)
¦-<receivertest>Specifies a receiver transport test.
¦ ¦-<customparameter>New Specifies a custom parameter for this receiver test.(see customparameter)
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦-<transport>Specifies a transport.(see transport)
¦-<transporttest>Specifies a transport test.
¦ ¦-<customparameter>New Specifies a custom parameter for this transport test.(see customparameter)
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦ ¦-<transport>Specifies the transport to be tested.(see transport)

Copyright (c) 2009 IBM. See license in Legal section. 2009-01-22 Device Kit XML Reference 1.2.0