Eclipse.org Eclipse.org group Device Kit
XML Element 

<group> element

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

Examples: group examples


NameDescriptionUse
Element <group> elements
<description>Description of the group.0 to 1
<deprecated>Specifies that the contents of this element should be marked as deprecated.0 to 1
<spec>Hardware specification documentation for this group.0 to unbounded
<specreference>Specification reference for this group.0 to unbounded
<commandreceived>Specifies if a command message can be received from the group. 0 to 1
<key>Specifies an optional key value.0 to 1
<command>Specifies a command that is supported by this group.0 to unbounded
<commands>Specifies a command group.0 to unbounded
<group>Specifies a group.0 to unbounded
<measurement>Specifies a measurement supported by this group.0 to unbounded
<signal>Specifies a signal supported by this group.0 to unbounded
<exportservice>Specifies the name of the Open Services Gateway initiative (OSGi) group to be exported.0 to unbounded
<import>Specifies the name of the package of be imported.0 to unbounded

Sibling NameSibling Description
Element <group> element siblings
<command>Defines a command supported by this concrete device.
<commands>Specifies a command group.
<measurement>Defines a measurement supported by this concrete device.
<signal>Defines a signal supported by this concrete device.

Element NameElement Description
Element <group> 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.
¦ ¦-<group>Defines a group supported by this concrete device.
¦ ¦ ¦-<description>Description of the group.
¦ ¦ ¦-<deprecated>Specifies that the contents of this element should be marked as deprecated.
¦ ¦ ¦-<spec>Hardware specification documentation for this group.
¦ ¦ ¦ ¦-<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 group.
¦ ¦ ¦ ¦-<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.
¦ ¦ ¦-<commandreceived>Specifies if a command message can be received from the group.
¦ ¦ ¦-<key>Specifies an optional key value.
¦ ¦ ¦-<command>Specifies a command that is supported by this group.
¦ ¦ ¦ ¦-<description>Specifies the command description.(see description)
¦ ¦ ¦ ¦-<optional>New Defines if this command is optional.
¦ ¦ ¦ ¦ ¦-<description>New Description of the optional item.(see description)
¦ ¦ ¦ ¦ ¦-<deprecated>New Specifies that the contents of this element should be marked as deprecated.(see deprecated)
¦ ¦ ¦ ¦ ¦-<specreference>Specification reference for this optional item.(see specreference)
¦ ¦ ¦ ¦-<units>Specifies the command data 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)
¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦-<units>Specifies the configuration units.(see units)
¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦ ¦-<units>Specifies the enum units.(see units)
¦ ¦ ¦ ¦ ¦ ¦-<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.
¦ ¦ ¦ ¦ ¦-<maximum>New Specifies the maximum value.
¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦ ¦-<units>Specifies the parameters units.(see units)
¦ ¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦ ¦-<optional>Defines if this data item is optional.(see optional)
¦ ¦ ¦ ¦ ¦-<units>Specifies the data units.(see units)
¦ ¦ ¦ ¦ ¦-<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.
¦ ¦ ¦ ¦ ¦-<size>Specifies the data size in bytes. See the length element to specify the data length in bits.
¦ ¦ ¦ ¦ ¦-<minimum>Specifies the minimum value.(see minimum)
¦ ¦ ¦ ¦ ¦-<maximum>Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦ ¦-<data>Specifies the data to execute the command.(see data)
¦ ¦ ¦ ¦ ¦-<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)
¦ ¦ ¦ ¦-<units>Specifies the commands units.(see units)
¦ ¦ ¦ ¦-<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>Specifies a group.(see group)
¦ ¦ ¦-<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)
¦ ¦ ¦ ¦-<optional>New Defines if this signal is optional.(see optional)
¦ ¦ ¦ ¦-<units>Specifies the signal units.(see units)
¦ ¦ ¦ ¦-<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.
¦ ¦ ¦ ¦ ¦-<description>Description of the parameter identifier (PID).(see description)
¦ ¦ ¦ ¦ ¦-<units>Specifies the parameter identifier (PID) units.(see units)
¦ ¦ ¦ ¦ ¦-<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.(see length)
¦ ¦ ¦ ¦ ¦-<size>Specifies the parameter identifier (pid) size in bytes. See the length element to specify the parameter (pid) data length in bits. (see size)
¦ ¦ ¦ ¦ ¦-<minimum>Specifies the minimum value.(see minimum)
¦ ¦ ¦ ¦ ¦-<maximum>Specifies the maximum value.(see maximum)
¦ ¦ ¦ ¦ ¦-<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.(see units)
¦ ¦ ¦ ¦-<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.
¦ ¦-<device>Specifies the device used by the adapter.
¦ ¦ ¦-<group>Defines a group supported by this device.(see group)
¦-<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)
¦ ¦-<group>Defines a group supported by this device.(see group)
¦-<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.
¦ ¦-<group>Defines a group supported by this concrete device.(see group)
¦-<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.
¦ ¦-<group>Defines a group supported by this profile.(see group)
¦ ¦-<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-07-29 Device Kit XML Reference 1.1.0