transporttest

Eclipse.org

`<transporttest>` element

Device Kit Attributes Elements XML Reference

Specifies a transport test.

Release: 3.0.0

**`<transporttest>` elements**
Name	Description	Use
`<description>`	Description of transport test.	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
`<spec>`	Hardware specification documentation for this device.	0 to unbounded
`<send>`	Specifies the message(s) to send during the test.	0 to unbounded
`<transport>`	Specifies the transport to be tested.	1 to 1
`<testcount>`	Unsigned integer that specifies the number of times to execute tests.	0 to 1
`<testdelay>`	Specifies the milliseconds to sleep between each test.	0 to 1
`<junit>`	Specifies a junit test. Currently, not supported.	0 to 1
`<monitor>`	Specifies a monitor test. Currently, not supported.	0 to 1
`<playback>`	Specifies a playback test. Currently, not supported.	0 to 1
`<testcase>`	Specifies a junit testcase.	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

**`<transporttest>` element siblings**
Sibling Name	Sibling Description
`<adapter>`	Specifies an adapter.
`<adaptertest>`	Specifies an adapter test.
`<agent>`	Specifies an agent.
`<agentmodel>`	Specifies the agent model used by the agent.
`<agenttest>`	Specifies an agent test.
`<agentmodeltest>`	Specifies an agent model test.
`<concrete>`	Specifies a concrete device.
`<concretetest>`	Specifies a concrete test.
`<connection>`	Specifies an connection.
`<connectiontest>`	Specifies an connection test.
`<device>`	Specifies a device.
`<devicetest>`	Specifies a device test.
`<profile>`	Specifies a profile.
`<profiletest>`	Specifies a profile test.
`<testagent>`	Specifies a test agent.
`<transport>`	Specifies a transport.

**`<transporttest>` element tree**
Element Name	Element Description
`<dkml>`	Specifies the root element of a Device Kit Device Kit Language (dkml) document.
`¦--<transporttest>`	Specifies a transport test.
`¦ ¦--<description>`	Description of transport 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.
`¦ ¦--<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 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.
`¦ ¦--<send>`	Specifies the message(s) to send during the test.
`¦ ¦ ¦--<description>`	Specifies the send description.(see description)
`¦ ¦ ¦--<deprecated>`	Specifies that the contents of this element should be marked as deprecated.(see deprecated)
`¦ ¦ ¦--<specreference>`	Specification reference for this send.
`¦ ¦ ¦ ¦--<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 hardware specification documentation.(see spec)
`¦ ¦ ¦ ¦--<specsection>`	The reference to section in the hardware specification documentation.
`¦ ¦ ¦--<message>`	Specifies the message to send.
`¦ ¦ ¦ ¦--<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 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>`	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.
`¦ ¦ ¦ ¦ ¦--<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>`	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>`	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 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)
`¦ ¦ ¦ ¦--<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)
`¦ ¦ ¦ ¦ ¦--<parameter>`	Specifies the parameter.(see parameter)
`¦ ¦ ¦ ¦--<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.
`¦ ¦ ¦--<sleep>`	Specifies a sleep time.
`¦ ¦--<transport>`	Specifies the transport to be tested.
`¦ ¦ ¦--<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)
`¦ ¦ ¦--<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)
`¦ ¦ ¦--<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.
`¦ ¦ ¦--<import>`	Specifies the name of the package to be imported.
`¦ ¦ ¦--<connectionservice>`	Specifies the connection 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 com 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.
`¦ ¦ ¦--<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.
`¦ ¦ ¦--<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.
`¦ ¦--<testcount>`	Unsigned integer that specifies the number of times to execute tests.
`¦ ¦--<testdelay>`	Specifies the milliseconds to sleep between each test.
`¦ ¦--<junit>`	Specifies a junit test. Currently, not supported.
`¦ ¦--<monitor>`	Specifies a monitor test. Currently, not supported.
`¦ ¦ ¦--<description>`	Description of the monitor test.(see description)
`¦ ¦ ¦--<deprecated>`	Specifies that the contents of this element should be marked as deprecated.(see deprecated)
`¦ ¦--<playback>`	Specifies a playback test. Currently, not supported.
`¦ ¦ ¦--<description>`	Description of the playback test.(see description)
`¦ ¦ ¦--<deprecated>`	Specifies that the contents of this element should be marked as deprecated.(see deprecated)
`¦ ¦--<testcase>`	Specifies a junit testcase.
`¦ ¦--<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)

Device Kit XML Reference 1.0.0

<transporttest> element

`<transporttest>` element