Eclipse.org Eclipse.org
XML Element

<serial> element

Device Kit Attributes Elements XML Reference
Specifies a serial port connection.

Examples: serial examples


NameDescriptionUse
Element <serial> elements
<description>Description of the serial connection.0 to 1
<deprecated>New Specifies that the contents of this element should be marked as deprecated.0 to 1
<specreference>Specification reference for this serial connection.0 to unbounded
<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
0 to 1
<comport>Specifies the serial port com port. This value starts at 1.0 to 1
<databits>Specifies the serial port data bits.0 to 1
<hardwareflowcontrol>Specifies the serial port hardware flow control value.0 to 1
<parity>Specifies the serial port parity.0 to 1
<readintervaltimeout>Specifies the number of milliseconds that the serial port read between bytes.0 to 1
<readtotaltimeout>Specifies the maximum amount of time in milliseconds that the serial port will wait for a read.0 to 1
<softwareflowcontrol>Specifies the serial port software flow control value.0 to 1
<stopbits>Specifies the serial port stop bits.0 to 1
<writetotaltimeout>Specifies the serial port write timeout value in milliseconds.0 to 1

Sibling NameSibling Description
Element <serial> element siblings
<connectionservice>Specifies the connection used by the transport.
<echo>Specifies an echo connection.
<file>Specifies a file connection.
<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.
<tcpip>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) connection.
<tcpipserver>Specifies a Transmission Control Protocol/Internet Protocol (TCP/IP) server connection.
<urlconnection>Specifies a Uniform Resource Locator (URL) connection.
<usb>Specifies a USB connection.
<transportservice>Specifies the name of the Open Services Gateway Initiative (OSGi) transport service to be used by the transport.

Element NameElement Description
Element <serial> element tree
<dkml>Specifies the root element of a Device Kit Device Kit Language (dkml) document.
¦--<adapter>Specifies an adapter.
¦  ¦--<device>Specifies the device used by the adapter.
¦  ¦  ¦--<transport>Specifies the transport used by the device.
¦  ¦  ¦  ¦--<serial>Specifies a serial port connection.
¦  ¦  ¦  ¦  ¦--<description>Description of the serial connection.
¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦  ¦  ¦  ¦  ¦--<specreference>Specification reference for this serial connection.
¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the specification reference.(see description)
¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦  ¦  ¦  ¦  ¦  ¦--<spec>The hardware specification documentation.
¦  ¦  ¦  ¦  ¦  ¦  ¦--<description>Description of the specification.(see description)
¦  ¦  ¦  ¦  ¦  ¦  ¦--<deprecated>New 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.
¦  ¦  ¦  ¦  ¦  ¦--<specsection>The reference to section in the hardware specification documentation.
¦  ¦  ¦  ¦  ¦--<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.
¦--<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)
¦--<concrete>Specifies a concrete device.
¦  ¦--<transport>Specifies the transport used by the device.(see transport)
¦--<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.
¦  ¦--<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)
¦--<transport>Specifies a transport.(see transport)
¦--<transporttest>Specifies a transport test.
¦  ¦--<transport>Specifies the transport to be tested.(see transport)

Copyright (c) IBM 2007. Device Kit XML Reference 1.0.0