Eclipse.org Eclipse.org
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>New 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>New 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
<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 Device Kit Language (dkml) document.
¦--<adapter>Specifies an adapter.
¦  ¦--<group>Defines a group supported by this concrete device.
¦  ¦  ¦--<description>Description of the group.
¦  ¦  ¦--<deprecated>New 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>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.
¦  ¦  ¦--<specreference>Specification reference for this group.
¦  ¦  ¦  ¦--<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.(see spec)
¦  ¦  ¦  ¦--<specsection>The reference to section in the hardware specification documentation.
¦  ¦  ¦--<commandreceived>New 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)
¦  ¦  ¦  ¦--<deprecated>New 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>New Defines this command as a configuration command.
¦  ¦  ¦  ¦--<commandreceived>New 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>New 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>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.(see 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.
¦  ¦  ¦  ¦--<method>Specifies the method to execute the command.
¦  ¦  ¦  ¦--<data>Specifies the data to execute the command.
¦  ¦  ¦  ¦  ¦--<description>Description of the data.(see description)
¦  ¦  ¦  ¦  ¦--<deprecated>New 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 length 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>New Specifies the measurement to get the value for the command.
¦  ¦  ¦--<commands>Specifies a command group.
¦  ¦  ¦  ¦--<description>Specifies the commands 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 commands.(see specreference)
¦  ¦  ¦  ¦--<key>Specifies a unique commands key.(see key)
¦  ¦  ¦  ¦--<configuration>New Defines this command as a configuration command. (see configuration)
¦  ¦  ¦  ¦--<commandreceived>New 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.
¦  ¦  ¦--<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>New 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>New 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)
¦  ¦  ¦  ¦--<messages>Specifies the messages to trigger the signal.
¦  ¦  ¦  ¦  ¦--<description>Specifies the messages 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 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)
¦  ¦  ¦  ¦  ¦--<deprecated>New 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.(see negative)
¦  ¦  ¦  ¦  ¦--<not>Logical not of a boolean value.(see not)
¦  ¦  ¦  ¦  ¦--<scale>Specifies the value to scale the parameter value.(see scale)
¦  ¦  ¦  ¦  ¦--<shift>Specifies the value to shift the parameter value.(see shift)
¦  ¦  ¦  ¦  ¦--<translate>Specifies the value to add (translate) to the parameter value.(see translate)
¦  ¦  ¦  ¦  ¦--<units>Specifies the optional parameter identifier (pid) units.(see units)
¦  ¦  ¦  ¦--<parameter>Specifies a message parameter.(see parameter)
¦  ¦  ¦  ¦--<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)
¦--<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) IBM 2007. Device Kit XML Reference 1.0.0