Eclipse.org Eclipse.org parameters Device Kit

XML Element 

<parameters> element

Device Kit Attributes Elements XML Reference
Message can contain multiple parameters. The parameters tag enables you to set multiple parameters for a message. This tag can have multiple parameter children. The idref attribute references the parameters in the parameters tag. The value of ""idref"" corresponds to the id of a previously defined parameter.

Examples: parameters examples


NameTypeDescriptionUse
Element <parameters> attributes
type "Array" "List" "Map" Specifies the data type of parameters.optional

NameDescriptionUse
Element <parameters> elements
<description>Specifies the parameters description.0 to unbounded
<units>Specifies the parameters 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 group of parameters.0 to unbounded
<key>Specifies the unique parameters key.0 to 1
<parameters>New Specifies the parameters.0 to unbounded

Sibling NameSibling Description
Element <parameters> element siblings
<field>New Specifies the field name to use on the receiving measurement.
<description>Specifies the signal description.
<optional>New Defines if this signal is optional.
<units>Specifies the signal units.
<deprecated>Specifies that the contents of this element should be marked as deprecated.
<specreference>Specification reference for this signal.
<key>Specifies the unique signal key.
<configuration>Defines this signal as a configuration signal.
<rate>Specifies the rate that the signal is received in milliseconds.

Element NameElement Description
Element <parameters> 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.
¦-<adapter>Specifies an adapter.
¦ ¦-<command>Defines a command supported by this concrete device.
¦ ¦ ¦-<message>Specifies the message to execute the command.
¦ ¦ ¦ ¦-<parameters>Specifies a group of parameters.
¦ ¦ ¦ ¦ ¦-<description>Specifies the parameters description.
¦ ¦ ¦ ¦ ¦-<units>Specifies the parameters units.
¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the units.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.
¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this units.
¦ ¦ ¦ ¦ ¦ ¦ ¦-<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.
¦ ¦ ¦ ¦ ¦-<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.
¦ ¦ ¦ ¦ ¦-<parameters>New Specifies the parameters.(see parameters)
¦ ¦-<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)
¦ ¦ ¦-<measurement>Specifies a measurement supported by this group.
¦ ¦ ¦ ¦-<message>Specifies the measurement message.(see message)
¦ ¦ ¦ ¦-<readcommand>Specifies the command to request a read of the current value of the measurement.
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to execute the command.(see message)
¦ ¦ ¦ ¦-<writecommand>Specifies the command to request a change of the measurement value.
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to execute the command.(see message)
¦ ¦ ¦ ¦-<signal>Specifies the signal containing the measurement value.
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to trigger the signal.(see message)
¦ ¦ ¦ ¦ ¦-<signal>Specifies the signal to listen. (see signal)
¦ ¦ ¦ ¦ ¦-<messages>Specifies the messages to trigger the signal.
¦ ¦ ¦ ¦ ¦ ¦-<message>Specifies the message.(see message)
¦ ¦ ¦ ¦ ¦-<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.
¦ ¦ ¦-<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.
¦ ¦ ¦ ¦-<message>Specifies a transport message.(see message)
¦-<adaptertest>Specifies an adapter test.
¦ ¦-<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.
¦ ¦-<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)
¦ ¦-<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.
¦ ¦-<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.
¦ ¦-<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.
¦ ¦-<concrete>Specifies the concrete device to be tested.(see concrete)
¦-<connectiontest>Specifies an connection test.
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦-<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)
¦ ¦-<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.
¦ ¦-<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.
¦ ¦-<profile>Specifies the profile to be tested.(see profile)
¦-<receivertest>New Specifies a receiver transport test.
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦-<transport>Specifies a transport.(see transport)
¦-<transporttest>Specifies a transport test.
¦ ¦-<send>Specifies the message(s) to send during the test.(see send)
¦ ¦-<transport>Specifies the transport to be tested.(see transport)

Copyright (c) 2008 IBM. See license in Legal section. 2008-09-10 Device Kit XML Reference 1.1.0