Eclipse.org Eclipse.org device Device Kit

XML Element 

<device> element

Device Kit Attributes Elements XML Reference
The device tag is used to denote the interface to a hardware device. The command tags denote the actions that are supported by the hardware device. The signals tags denote the events that are supported by the hardware device. The measurement tags denote the properties supported by the hardware device. Use the transportservice tag to specify the device?s transport. You can specify the Open Services Gateway Initiative (OSGi) service and transport class implementation with the transportservice tag.

Examples: device examples


NameTypeDescriptionUse
Element <device> attributes
getbooleanSpecifies to generate get methods. The default is false unless abstract or lazy.optional

NameDescriptionUse
Element <device> elements
<description>Description of the device.0 to 1
<deprecated>Specifies that the contents of this element should be marked as deprecated.0 to 1
<provider>Specifies the provider.0 to 1
<version>Specifies the version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.0 to 1
<vendor>Specifies an implementing vendor.0 to unbounded
<incubation>If the contents of this element is true, then this is an incubation project.0 to 1
<spec>Hardware specification documentation for this device.0 to unbounded
<specreference>Specification reference for this device.0 to unbounded
<deviceparent>New Specifies the Device parent.0 to 1
<commandreceived>Specifies if a command message can be received from the device. 0 to 1
<initializemeasurements>Specifies that the device should initialize the measurements when the device is started.0 to 1
<key>Specifies an optional key value.0 to 1
<pids>Specifies the defined pids.0 to unbounded
<priority>Specifies the device execution priority.0 to 1
<command>Specifies a command that is supported by this device.0 to unbounded
<commands>Specifies a command group.0 to unbounded
<group>Defines a group supported by this device.0 to 1
<measurement>Specifies a measurement supported by this device.0 to unbounded
<signal>Specifies a signal supported by this device.0 to unbounded
<commandref>Specifies a command reference.0 to unbounded
<measurementref>Specifies a measurement reference.0 to unbounded
<signalref>Specifies a signal reference.0 to unbounded
<exportservice>Specifies the name of the Open Services Gateway initiative (OSGi) service to be exported.0 to unbounded
<import>Specifies the name of the package of be imported.0 to unbounded
<transport>Specifies the transport used by the device.0 to 1
<transportservice>Specifies the Open Services Gateway Initiative (OSGi) transport service name.0 to 1
<udp>Specifies a User Diagram Protocol (UDP) transport.0 to 1
<bundle>Specifies an Open Services Gateway Initiative (OSGi) bundle should be created.0 to 1
<managedbundle>Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created.0 to 1
<managedfactorybundle>Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created.0 to 1

Sibling NameSibling Description
Element <device> element siblings
<description>Description of the device test.
<deprecated>Specifies that the contents of this element should be marked as deprecated.
<provider>Specifies the provider.
<version>Specifies the version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.
<vendor>Specifies an implementing vendor.
<incubation>If the contents of this element is true, then this is an incubation project.
<spec>Hardware specification documentation for this device test.
<testcount>Unsigned integer that specifies the number of times to execute tests.
<testdelay>Specifies the milliseconds to sleep between each test.
<testexecute>Specifies if all commands should be executed.
<testexecuteread>Specifies if the executeRead method should be invoked on all measurements.
<testexecutewrite>Specifies if the executeWrite method should be invoked on all measurements.
<testread>Specifies if the read method should be invoked on all measurements.
<testtrigger>Specifies if all signals should be triggered.
<junit>Specifies a junit test. Currently, not supported.
<monitor>Specifies a monitor test. Currently, not supported.
<playback>Specifies a playback test. Currently, not supported.
<swt>New Specifies a Standard Widget Toolkit (SWT) user interface device test.
<testcase>Specifies a junit testcase.
<bundle>Specifies an Open Services Gateway Initiative (OSGi) bundle should be created.
<managedbundle>Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created.
<managedfactorybundle>Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created.

Element NameElement Description
Element <device> 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.
¦ ¦-<device>Specifies the device used by the adapter.
¦ ¦ ¦-<description>Description of the device.
¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.
¦ ¦ ¦-<provider>Specifies the provider.
¦ ¦ ¦-<version>Specifies the version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.
¦ ¦ ¦-<vendor>Specifies an implementing vendor.
¦ ¦ ¦-<incubation>If the contents of this element is true, then this is an incubation project.
¦ ¦ ¦-<spec>Hardware specification documentation for this device.
¦ ¦ ¦ ¦-<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.
¦ ¦ ¦-<specreference>Specification reference for this device.
¦ ¦ ¦ ¦-<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.(see spec)
¦ ¦ ¦ ¦-<specsection>The reference to section in the protocol specification documentation.
¦ ¦ ¦-<deviceparent>New Specifies the Device parent.
¦ ¦ ¦ ¦-<description>Description of the device parent.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<deviceref>Specifies device parent reference.
¦ ¦ ¦-<commandreceived>Specifies if a command message can be received from the device.
¦ ¦ ¦-<initializemeasurements>Specifies that the device should initialize the measurements when the device is started.
¦ ¦ ¦-<key>Specifies an optional key value.
¦ ¦ ¦-<pids>Specifies the defined pids.
¦ ¦ ¦ ¦-<description>Specifies the pids description.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for pids.(see specreference)
¦ ¦ ¦ ¦-<key>Specifies the unique pids key.(see key)
¦ ¦ ¦ ¦-<pid>Specifies the pid.
¦ ¦ ¦ ¦ ¦-<description>Description of the parameter identifier (PID).(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this parameter identifier (PID).(see specreference)
¦ ¦ ¦ ¦ ¦-<key>Specifies the parameter identifier (pid) key.(see key)
¦ ¦ ¦ ¦ ¦-<identifier>Specifies the parameter identifier.
¦ ¦ ¦ ¦ ¦-<length>Specifies the parameter (pid) data length in bits.
¦ ¦ ¦ ¦ ¦-<size>Specifies the parameter identifier (pid) size in bytes. See the length element to specify the parameter (pid) data length in bits.
¦ ¦ ¦ ¦ ¦-<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>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>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>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 identifier (pid) 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)
¦ ¦ ¦-<priority>Specifies the device execution priority.
¦ ¦ ¦-<command>Specifies a command that is supported by this device.
¦ ¦ ¦ ¦-<description>Specifies the command description.(see description)
¦ ¦ ¦ ¦-<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.(see key)
¦ ¦ ¦ ¦-<configuration>Defines this command as a configuration command.
¦ ¦ ¦ ¦ ¦-<description>New Description of the configuration.(see description)
¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦ ¦-<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.(see minimum)
¦ ¦ ¦ ¦ ¦-<maximum>New Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦-<commandreceived>Specifies if a command message can be received from the device. (see commandreceived)
¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦-<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. (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>Specifies the measurement to get the value for the command.
¦ ¦ ¦-<commands>Specifies a command group.
¦ ¦ ¦ ¦-<description>Specifies the commands description.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this group of commands.(see specreference)
¦ ¦ ¦ ¦-<key>Specifies a unique commands key.(see key)
¦ ¦ ¦ ¦-<configuration>Defines this command as a configuration command. (see configuration)
¦ ¦ ¦ ¦-<commandreceived>Specifies if a command message can be received from the device. (see commandreceived)
¦ ¦ ¦ ¦-<command>Specifies the command within the group of commands.(see command)
¦ ¦ ¦ ¦-<sleep>Specifies a sleep command.
¦ ¦ ¦-<group>Defines a group supported by this device.
¦ ¦ ¦ ¦-<description>Description of the group.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<spec>Hardware specification documentation for this group.(see spec)
¦ ¦ ¦ ¦-<specreference>Specification reference for this group.(see specreference)
¦ ¦ ¦ ¦-<commandreceived>Specifies if a command message can be received from the group. (see commandreceived)
¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦-<measurement>Specifies a measurement supported by this group.(see measurement)
¦ ¦ ¦ ¦-<signal>Specifies a signal supported by this group.
¦ ¦ ¦ ¦ ¦-<description>Specifies the signal description.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this signal.(see specreference)
¦ ¦ ¦ ¦ ¦-<key>Specifies the unique signal key.(see key)
¦ ¦ ¦ ¦ ¦-<configuration>Defines this signal as a configuration signal. (see configuration)
¦ ¦ ¦ ¦ ¦-<rate>Specifies the rate that the signal is received in milliseconds.(see rate)
¦ ¦ ¦ ¦ ¦-<message>Specifies the message to trigger the signal.(see message)
¦ ¦ ¦ ¦ ¦-<method>Specifies the method to handle the signal.(see method)
¦ ¦ ¦ ¦ ¦-<data>Specifies the data when the signal triggers.(see data)
¦ ¦ ¦ ¦ ¦-<signal>Specifies the signal to listen. (see signal)
¦ ¦ ¦ ¦ ¦-<field>Specifies the field name to use on the receiving signal.
¦ ¦ ¦ ¦ ¦-<messages>Specifies the messages to trigger the signal.
¦ ¦ ¦ ¦ ¦ ¦-<description>Specifies the messages description.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this group of messages.(see specreference)
¦ ¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦-<maximum>Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦ ¦-<minimum>Specifies the minimum value.(see minimum)
¦ ¦ ¦ ¦ ¦-<negative>Negate the value.(see negative)
¦ ¦ ¦ ¦ ¦-<not>Logical not of a boolean value.(see not)
¦ ¦ ¦ ¦ ¦-<scale>Scale the value.(see scale)
¦ ¦ ¦ ¦ ¦-<shift>Shift the value.(see shift)
¦ ¦ ¦ ¦ ¦-<translate>Translate (add) to the value.(see translate)
¦ ¦ ¦ ¦-<exportservice>Specifies the name of the Open Services Gateway initiative (OSGi) group to be exported.
¦ ¦ ¦ ¦-<import>Specifies the name of the package of be imported.
¦ ¦ ¦-<measurement>Specifies a measurement supported by this device.(see measurement)
¦ ¦ ¦-<signal>Specifies a signal supported by this device.(see signal)
¦ ¦ ¦-<commandref>Specifies a command reference.
¦ ¦ ¦ ¦-<description>Description of the command reference.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦-<measurementref>Specifies a measurement reference.
¦ ¦ ¦ ¦-<description>Description of the measurement reference.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦-<signalref>Specifies a signal reference.
¦ ¦ ¦ ¦-<description>Description of the signal reference.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦-<exportservice>Specifies the name of the Open Services Gateway initiative (OSGi) service to be exported.(see exportservice)
¦ ¦ ¦-<import>Specifies the name of the package of be imported.(see import)
¦ ¦ ¦-<transport>Specifies the transport used by the device.
¦ ¦ ¦ ¦-<description>Description of the transport.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<provider>Specifies the provider.(see provider)
¦ ¦ ¦ ¦-<version>Specifies the version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.(see version)
¦ ¦ ¦ ¦-<vendor>Specifies an implementing vendor.(see vendor)
¦ ¦ ¦ ¦-<incubation>If the contents of this element is true, then this is an incubation project.(see incubation)
¦ ¦ ¦ ¦-<spec>Hardware specification documentation for this device.(see spec)
¦ ¦ ¦ ¦-<specreference>Specification reference for this transport.(see specreference)
¦ ¦ ¦ ¦-<customparameter>Specifies a custom parameter.
¦ ¦ ¦ ¦ ¦-<description>Description of the custom parameter.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this custom parameter.(see specreference)
¦ ¦ ¦ ¦ ¦-<enum>New Specifies a enumeration option configuration.(see enum)
¦ ¦ ¦ ¦ ¦-<minimum>New Specifies the minimum value.(see minimum)
¦ ¦ ¦ ¦ ¦-<maximum>New Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦-<noactivitytimeout>No activity timeout value in milliseconds.
¦ ¦ ¦ ¦-<responsetimeout>Response timeoutout value in milliseconds.
¦ ¦ ¦ ¦-<retrytime>Retry time value in milliseconds.
¦ ¦ ¦ ¦-<message>Specifies a transport message.(see message)
¦ ¦ ¦ ¦-<exportservice>Specifies the name of the Open Services Gateway Initiative (OSGi) transport service to be exported.(see exportservice)
¦ ¦ ¦ ¦-<import>Specifies the name of the package to be imported.(see import)
¦ ¦ ¦ ¦-<connection>Specifies an connection to be used by the transport.
¦ ¦ ¦ ¦ ¦-<description>Description of the connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<provider>Specifies the provider.(see provider)
¦ ¦ ¦ ¦ ¦-<version>Specifies the version level. The format of the version number should be n.n.n where n is a number. For example, 1.0.0 is a valid version.(see version)
¦ ¦ ¦ ¦ ¦-<vendor>Specifies an implementing vendor.(see vendor)
¦ ¦ ¦ ¦ ¦-<incubation>If the contents of this element is true, then this is an incubation project.(see incubation)
¦ ¦ ¦ ¦ ¦-<spec>Hardware specification documentation for this device.(see spec)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<customparameter>New Specifies a custom parameter for this connection.(see customparameter)
¦ ¦ ¦ ¦ ¦-<bundle>Specifies an Open Services Gateway Initiative (OSGi) bundle should be created.
¦ ¦ ¦ ¦ ¦-<managedbundle>Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created.
¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the managed bundle.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<managedfactorybundle>Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created.
¦ ¦ ¦ ¦ ¦ ¦-<description>Description of the factory bundle.(see description)
¦ ¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<connectionservice>Specifies the connection to be used by the transport.
¦ ¦ ¦ ¦ ¦-<description>Description of the connection service.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this connection service.(see specreference)
¦ ¦ ¦ ¦-<echo>Specifies an echo connection.
¦ ¦ ¦ ¦-<file>Specifies a file connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the file connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this file connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<inputpath>Specifies the file input path name.
¦ ¦ ¦ ¦ ¦-<inputname>Specifies the input file name.
¦ ¦ ¦ ¦ ¦-<outputpath>Specifies the file output path name.
¦ ¦ ¦ ¦ ¦-<outputname>Specifies the output file name.
¦ ¦ ¦ ¦-<gpio>Specifies a General Purpose Input Output (GPIO) connection.
¦ ¦ ¦ ¦-<i2c>Specifies an Inter-IC (I2C) connection.
¦ ¦ ¦ ¦-<most>Specifies a Media Oriented Systems Transport (MOST) connection.
¦ ¦ ¦ ¦-<randomaccessfile>Specifies a random access file connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the random access file connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this random access file connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<name>Specifies the file name.
¦ ¦ ¦ ¦ ¦-<mode>Specifies the file mode.
¦ ¦ ¦ ¦ ¦-<path>Specifies the file path name.
¦ ¦ ¦ ¦-<serial>Specifies a serial port connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the serial connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this serial connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<baudrate>Specifies the serial port baud rate. Common baud rates for a serial port:
  • 110
  • 300
  • 1200
  • 2400
  • 4800
  • 9600
  • 19200
  • 38400
  • 57600
  • 115200
  • 230400
  • 460800
  • 921600
¦ ¦ ¦ ¦ ¦-<comport>Specifies the serial port communication port. This value starts at 1.
¦ ¦ ¦ ¦ ¦-<databits>Specifies the serial port data bits.
¦ ¦ ¦ ¦ ¦-<hardwareflowcontrol>Specifies the serial port hardware flow control value.
¦ ¦ ¦ ¦ ¦-<parity>Specifies the serial port parity.
¦ ¦ ¦ ¦ ¦-<readintervaltimeout>Specifies the number of milliseconds that the serial port read between bytes.
¦ ¦ ¦ ¦ ¦-<readtotaltimeout>Specifies the maximum amount of time in milliseconds that the serial port will wait for a read.
¦ ¦ ¦ ¦ ¦-<softwareflowcontrol>Specifies the serial port software flow control value.
¦ ¦ ¦ ¦ ¦-<stopbits>Specifies the serial port stop bits.
¦ ¦ ¦ ¦ ¦-<writetotaltimeout>Specifies the serial port write timeout value in milliseconds.
¦ ¦ ¦ ¦-<tcpip>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the Transmission Control Protocol/Internet Protocol (TCP/IP) connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this Transmission Control Protocol/Internet Protocol (TCP/IP) connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<host>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) host name.
¦ ¦ ¦ ¦ ¦-<remoteport>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) remote port.
¦ ¦ ¦ ¦ ¦-<localport>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) local port.
¦ ¦ ¦ ¦ ¦-<linger>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) linger value. A value of -1 specifies to use the default values. A value of zero speciifes no linger. A value greater than zero is the milliseconds linger value. See the Socket class for more details.
¦ ¦ ¦ ¦ ¦-<readtimeout>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) read timeout in milliseconds.
¦ ¦ ¦ ¦-<tcpipserver>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) server connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the Transmission Control Protocol/Internet Protocol (TCP/IP) server connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this Transmission Control Protocol/Internet Protocol (TCP/IP) server connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<port>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) port.
¦ ¦ ¦ ¦-<ssl>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) SSL connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this Transmission Control Protocol/Internet Protocol (TCP/IP) SSL connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<host>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL host name.(see host)
¦ ¦ ¦ ¦ ¦-<remoteport>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL remote port.(see remoteport)
¦ ¦ ¦ ¦ ¦-<localport>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL local port.(see localport)
¦ ¦ ¦ ¦ ¦-<linger>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL linger value. A value of -1 specifies to use the default values. A value of zero speciifes no linger. A value greater than zero is the milliseconds linger value. See the Socket class for more details.(see linger)
¦ ¦ ¦ ¦ ¦-<readtimeout>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL read timeout in milliseconds.(see readtimeout)
¦ ¦ ¦ ¦-<sslserver>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) SSL server connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL server connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this Transmission Control Protocol/Internet Protocol (TCP/IP) SSL server connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<port>Specifies the Transmission Control Protocol/Internet Protocol (TCP/IP) SSL port.(see port)
¦ ¦ ¦ ¦-<urlconnection>Specifies a Uniform Resource Locator (URL) connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the Uniform Resource Locator (URL) connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this Uniform Resource Locator (URL) connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<url>Specifies the Uniform Resource Locator (URL) name.
¦ ¦ ¦ ¦-<usb>Specifies a USB connection.
¦ ¦ ¦ ¦ ¦-<description>Description of the USB connection.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this USB connection.(see specreference)
¦ ¦ ¦ ¦ ¦-<productid>Specifies the USB product id.
¦ ¦ ¦ ¦ ¦-<usage>Specifies the USB usage.
¦ ¦ ¦ ¦ ¦-<usagepage>Specifies the USB usage page.
¦ ¦ ¦ ¦ ¦-<vendorid>Specifies the USB vendor id.
¦ ¦ ¦ ¦-<transportservice>Specifies the name of the Open Services Gateway Initiative (OSGi) transport service to be used by the transport.
¦ ¦ ¦ ¦ ¦-<description>Description of the Open Services Gateway Initiative (OSGi) transport service.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<bundle>Specifies an Open Services Gateway Initiative (OSGi) bundle should be created.(see bundle)
¦ ¦ ¦ ¦-<managedbundle>Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created.(see managedbundle)
¦ ¦ ¦ ¦-<managedfactorybundle>Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created.(see managedfactorybundle)
¦ ¦ ¦-<transportservice>Specifies the Open Services Gateway Initiative (OSGi) transport service name.(see transportservice)
¦ ¦ ¦-<udp>Specifies a User Diagram Protocol (UDP) transport.
¦ ¦ ¦ ¦-<description>Description of the User Diagram Protocol (UDP) transport.(see description)
¦ ¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦-<specreference>Specification reference for this User Diagram Protocol (UDP) transport.(see specreference)
¦ ¦ ¦ ¦-<remotehost>Specifies the User Datagram Protocol (UDP) remote host name.
¦ ¦ ¦ ¦-<remoteport>Specifies the User Datagram Protocol (UDP) remote port.(see remoteport)
¦ ¦ ¦ ¦-<localhost>Specifies the User Datagram Protocol (UDP) local host name.
¦ ¦ ¦ ¦-<localport>Specifies the User Datagram Protocol (UDP) local port.(see localport)
¦ ¦ ¦ ¦-<packetsize>Specifies the User Datagram Protocol (UDP) packet size in bytes.
¦ ¦ ¦-<bundle>Specifies an Open Services Gateway Initiative (OSGi) bundle should be created.(see bundle)
¦ ¦ ¦-<managedbundle>Specifies an Open Services Gateway Initiative (OSGi) managed bundle should be created.(see managedbundle)
¦ ¦ ¦-<managedfactorybundle>Specifies an Open Services Gateway Initiative (OSGi) managed factory bundle should be created.(see managedfactorybundle)
¦-<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)
¦-<device>Specifies a device.(see device)
¦-<devicetest>Specifies a device test.
¦ ¦-<device>Specifies the device to be tested.(see device)
¦-<profile>Specifies a profile.
¦ ¦-<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-02-07 Device Kit XML Reference 1.1.0