Eclipse.org Eclipse.org
XML Element

<measurement> element

Device Kit Attributes Elements XML Reference
The measurement tag denotes a logical property of the hardware device. This logical property is usually stored in the hardware device and requires that commands to be sent to the device to read (readcommand tag) or write (writecommand tag) the value of the measurement. The siganl tag is used to define the signal that will be triggered when the value of the measurement is sent by the hardware device. Hardware devices vary on how the measurements are implemented. Some hardware devices only support the reading of measurement values and do not support writing new values via messages. Other hardware devices support both reading and writing of the measurement. Some hardware devices support notification of the signal message when the value changes while other hardware device require that a read message be sent to get the measurement value. See the hardware device specifications to determain the correct tags that must be defined by this device.

Examples: measurement examples


NameTypeDescriptionUse
Element <measurement> attributes
type "Boolean" "Integer" "List" "Long" "Map" "Number" "Object" "String" Specifies the measurement data type.optional
listenbooleanSpecifies the containing object to listen to this measurement. The default is false.optional
triggeronsetvaluebooleanSpecifies to trigger the signal on set value. The default is true.optional
triggeronreadcommandbooleanSpecifies to trigger the signal on read command. The default is true.optional
executereadbooleanSpecifies the measurement supports executeRead. The default is true.optional
executewritebooleanSpecifies the measurement supports executeWrite. If both the setvalue and setwrite attributes are false, then the measurement is a read only measurement. The default is true.optional
setvaluebooleanSpecifies the measurement supports setValue. If both the setvalue and setwrite attributes are false, then the measurement is a read only measurement. The default is true.optional

NameDescriptionUse
Element <measurement> elements
<description>Specifies the measurement description.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 measurement.0 to unbounded
<key>Specifies a unique measurement key.0 to 1
<configuration>New Defines this measurement as a configuration measurement. 0 to 1
<rate>Specifies the measurement polling rate in milliseconds.0 to 1
<message>Specifies the measurement message.0 to 1
<data>Specifies the measurement data.0 to unbounded
<readcommand>Specifies the command to request a read of the current value of the measurement.0 to 1
<writecommand>Specifies the command to request a change of the measurement value.0 to 1
<method>Specifies the method.0 to 1
<signal>Specifies the signal containing the measurement value.0 to 1
<measurement>New Defines the parent measurement.0 to unbounded
<parameter>New Specifies a parameter used to extract/insert the information within the parent data.0 to unbounded
<parameters>New Specifies a group of parameters.0 to unbounded
<units>Specifies the measurement units.0 to 1
<value>Specifies the optional initial measurement value.0 to 1
<maximum>Specifies the maximum value.1 to 1
<minimum>Specifies the minimum value.1 to 1
<negative>Negate the value.1 to 1
<not>Logical not of a boolean value.1 to 1
<scale>Specifies a numeric scale value.1 to 1
<shift>Specifies an integer shift value.1 to 1
<translate>Specifies a numeric translate (add) value.1 to 1

Sibling NameSibling Description
Element <measurement> element siblings
<command>Defines a command supported by this concrete device.
<commands>Specifies a command group.
<group>Defines a group supported by this concrete device.
<signal>Defines a signal supported by this concrete device.
<description>Specifies the command description.
<deprecated>New Specifies that the contents of this element should be marked as deprecated.
<specreference>Specification reference for this command.
<key>Specifies a unique command key.
<configuration>New Defines this command as a configuration command.
<commandreceived>New Specifies if a command message can be received from the device.
<rate>Specifies the polling rate in milliseconds.
<message>Specifies the message to execute the command.
<method>Specifies the method to execute the command.
<data>Specifies the data to execute the command.

Element NameElement Description
Element <measurement> 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.
¦  ¦  ¦--<measurement>New Specifies the measurement to get the value for the command.
¦  ¦--<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.(see measurement)
¦  ¦--<measurement>Defines a measurement supported by this concrete device.(see measurement)
¦  ¦--<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)
¦--<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.
¦  ¦--<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)
¦--<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.
¦  ¦--<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)
¦  ¦--<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