Eclipse.org|
Eclipse.org |
signal | Device Kit |
<signal> element |
Device Kit Attributes Elements XML Reference |
Examples: signal examples
| Name | Type | Description | Use |
|---|---|---|---|
| type | "Boolean" "Integer" "List" "Long" "Map" "Number" "Object" "String" | Specifies the signal data type. | optional |
| trigger | boolean | Specifies the signal supports trigger. The default is true. | optional |
| Name | Description | Use |
|---|---|---|
| <description> | Specifies the signal description. | 0 to unbounded |
| <optional> |  Defines if this signal is optional. | 0 to 1 |
| <units> | Specifies the signal units. | 0 to 1 |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. | 0 to 1 |
| <specreference> | Specification reference for this signal. | 0 to unbounded |
| <key> | Specifies the unique signal key. | 0 to 1 |
| <configuration> | Defines this signal as a configuration signal. | 0 to 1 |
| <rate> | Specifies the rate that the signal is received in milliseconds. | 0 to 1 |
| <message> | Specifies the message to trigger the signal. | 0 to unbounded |
| <method> | Specifies the method to handle the signal. | 0 to 1 |
| <data> | Specifies the data when the signal triggers. | 0 to unbounded |
| <signal> | Specifies the signal to listen. | 1 to 1 |
| <field> | Specifies the field name to use on the receiving signal. | 1 to 1 |
| <messages> | Specifies the messages to trigger the signal. | 0 to 1 |
| <pid> | Specifies the pid for this signal. | 0 to unbounded |
| <parameters> | Specifies a parameter group. | 0 to unbounded |
| <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> | Scale the value. | 1 to 1 |
| <shift> | Shift the value. | 1 to 1 |
| <translate> | Translate (add) to the value. | 1 to 1 |
| Sibling Name | Sibling Description |
|---|---|
| <command> | Defines a command supported by this concrete device. |
| <commands> | Specifies a command group. |
| <group> | Defines a group supported by this concrete device. |
| <measurement> | Defines a measurement supported by this concrete device. |
| <description> | Specifies the measurement description. |
| <optional> | Defines if this measurement is optional. |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. |
| <specreference> | Specification reference for this measurement. |
| <key> | Specifies a unique measurement key. |
| <configuration> | Defines this measurement as a configuration measurement. |
| <rate> | Specifies the measurement polling rate in milliseconds. |
| <readcommand> | Specifies the command to request a read of the current value of the measurement. |
| <units> | Specifies the measurement units. |
| <value> | Specifies the optional initial measurement value. |
| Element Name | Element Description |
|---|---|
| <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. |
| ¦ ¦ ¦-<group> | Specifies a group.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this group. |
| ¦ ¦ ¦ ¦-<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<description> | Specifies the signal description. |
| ¦ ¦ ¦ ¦ ¦-<optional> | Defines if this signal is optional.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<description> | Description of the optional item.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this optional item. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<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. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<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. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<specsection> | The reference to section in the protocol specification documentation. |
| ¦ ¦ ¦ ¦ ¦-<units> | Specifies the signal 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 signal.(see specreference) |
| ¦ ¦ ¦ ¦ ¦-<key> | Specifies the unique signal key. |
| ¦ ¦ ¦ ¦ ¦-<configuration> | Defines this signal as a configuration signal. |
| ¦ ¦ ¦ ¦ ¦ ¦-<description> | Description of the configuration.(see description) |
| ¦ ¦ ¦ ¦ ¦ ¦-<units> | Specifies the configuration units.(see units) |
| ¦ ¦ ¦ ¦ ¦ ¦-<deprecated> | Specifies that the contents of this element should be marked as deprecated.(see deprecated) |
| ¦ ¦ ¦ ¦ ¦ ¦-<specreference> | Specification reference for this configuration.(see specreference) |
| ¦ ¦ ¦ ¦ ¦ ¦-<enum> | 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> | Specification reference for this enumeration.(see specreference) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<key> | Specifies a enumeration key.(see key) |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<label> | Specifies a enumeration label.
|
| ¦ ¦ ¦ ¦ ¦ ¦ ¦-<value> | 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). |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<map> | Specifies a Map value. |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<short> | Specifies a Short value (16 bits). |
| ¦ ¦ ¦ ¦ ¦ ¦ ¦ ¦-<string> | Specifies a String value. |
| ¦ ¦ ¦ ¦ ¦ ¦-<minimum> | Specifies the minimum value.
|
| ¦ ¦ ¦ ¦ ¦ ¦-<maximum> | Specifies the maximum value.
|
| ¦ ¦ ¦ ¦ ¦-<rate> | Specifies the rate that the signal is received in milliseconds. |
| ¦ ¦ ¦ ¦ ¦-<message> | Specifies the message to trigger the signal. |
| ¦ ¦ ¦ ¦ ¦ ¦-<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> | 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 handle the signal. |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data when the signal triggers. |
| ¦ ¦ ¦ ¦ ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦-<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) |
| ¦ ¦ ¦-<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. |
| ¦ ¦ ¦-<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) |
| ¦-<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) |
| ¦ ¦-<measurement> | Specifies a measurement supported by this device.(see measurement) |
| ¦ ¦-<signal> | Specifies a signal supported by this device.(see signal) |
| ¦-<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) |
| ¦ ¦-<measurement> | Defines a measurement supported by this concrete device.(see measurement) |
| ¦ ¦-<signal> | Defines a signal supported by this concrete device.(see signal) |
| ¦-<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) |
| ¦ ¦-<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. |
| ¦ ¦-<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-09-10 | Device Kit XML Reference 1.1.0 |