Eclipse.org Eclipse.org
XML Element

<message> element

Device Kit Attributes Elements XML Reference
The message tag specifies the actual message or set of bytes that the are sent or received from the hardware device. The ascii, bytes, nibbles, tokens, parameter, parameters, and filter subtags define the content of a message. The specific tags to use within the message tag depend on a combination of the hardware specification and the controls that the application needs. For example, if the hardware communicates with bytes or eight bits use the bytes tag. If the hardware understands four-bit increments (MOST), use a series of nibbles to define the message. You can also set a filter mask for a message. The contents of the filter determine which bits are relevant. The content of a binary message is often defined by using the bytes subtag to specify a special byte or set of bytes. The content of a American National Stardard Code for Intormation Interchange (ASCII) message is normally defined by using the ascii subtag. You can set the delimiter with the tokens tag. Messages can also have parameters that hold important value information. Specify message parameters with the parameter and parameters tags. Defining the messages correctly is very important activity. WARNING: Defining the messages incorrectly and sending the wrong messages to a hardware device can be dangerous.

Examples: message examples


NameDescriptionUse
Element <message> elements
<description>Description of the message.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 message.0 to unbounded
<ascii>Specifies a set of ASCII character (8 bits).1 to unbounded
<bytes>Specifies a set of bytes. Each byte is 8 bits.1 to unbounded
<nibbles>Specifies a set of nibbles. Each nibble is 4 bits.1 to unbounded
<tokens>Specifies the message tokens.0 to 1
<parameter>Specifies a parameter within the message.0 to unbounded
<parameters>Specifies a group of parameters.0 to unbounded
<filter>Specifies the message filter.0 to 1
<sentmessage>Specifies the message that was sent that caused this message.0 to 1

Sibling NameSibling Description
Element <message> element siblings
<method>Specifies the method to execute the command.
<data>Specifies the data to execute the command.
<description>Specifies the messages description.
<deprecated>New Specifies that the contents of this element should be marked as deprecated.
<specreference>Specification reference for this group of messages.
<key>Specifies the unique messages key.

Element NameElement Description
Element <message> element tree
<dkml>Specifies the root element of a Device Kit Device Kit Language (dkml) document.
¦--<adapter>Specifies an adapter.
¦  ¦--<command>Defines a command supported by this concrete device.
¦  ¦  ¦--<message>Specifies the message to execute the command.
¦  ¦  ¦  ¦--<description>Description of the message.
¦  ¦  ¦  ¦--<deprecated>New Specifies that the contents of this element should be marked as deprecated.
¦  ¦  ¦  ¦--<specreference>Specification reference for this message.
¦  ¦  ¦  ¦  ¦--<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.
¦  ¦  ¦  ¦--<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>New 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>New 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>New 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>New 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>New 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>New 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>New 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>New 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.
¦  ¦--<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)
¦  ¦  ¦--<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)
¦  ¦  ¦  ¦  ¦--<messages>Specifies the messages to trigger the signal.
¦  ¦  ¦  ¦  ¦  ¦--<message>Specifies the message.(see message)
¦  ¦  ¦--<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)
¦--<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 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)
¦--<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) IBM 2007. Device Kit XML Reference 1.0.0