Eclipse.org|
Eclipse.org |
optional | Device Kit |
<optional> element |
Device Kit Attributes Elements XML Reference |
Release: 1.0.0
Examples: optional examples
| Name | Type | Description | Use |
|---|---|---|---|
| idref | anyURI | Specifies a reference to the element with the matching id attribute. The matching id attribute must be specified before the idref attribute can be used. | optional |
| Name | Description | Use |
|---|---|---|
| <description> | Description of the optional item. | 0 to unbounded |
| <history> |  Specifies the optional history. | 0 to unbounded |
| <deprecated> | Specifies that the contents of this element should be marked as deprecated. | 0 to 1 |
| <specreference> | Specification reference for this optional item. | 0 to unbounded |
| Sibling Name | Sibling Description |
|---|---|
| <description> | Specifies the command description. |
| <history> | Specifies the command history. |
| <units> | Specifies the command data units. |
| <deprecated> | 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> | Defines this command as a configuration command. |
| <commandreceived> | Specifies if a command message can be received from the device. |
| <rate> | Specifies the polling rate in milliseconds. |
| <measurement> | Specifies the measurement to get the value for the command. |
| 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. |
| ¦ ¦-<command> | Defines a command supported by this concrete device. |
| ¦ ¦ ¦-<optional> | Defines if this command is optional. |
| ¦ ¦ ¦ ¦-<description> | Description of the optional item. |
| ¦ ¦ ¦ ¦-<history> | Specifies the optional history.
|
| ¦ ¦ ¦ ¦ ¦-<description> | Description of the history.(see description) |
| ¦ ¦ ¦ ¦ ¦-<provider> | Specifies the provider history. |
| ¦ ¦ ¦ ¦ ¦-<version> | Version of the history documentation. |
| ¦ ¦ ¦ ¦-<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) |
| ¦ ¦ ¦ ¦ ¦ ¦-<history> | Specifies the specification history.(see history) |
| ¦ ¦ ¦ ¦ ¦ ¦-<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. |
| ¦ ¦ ¦-<data> | Specifies the data to execute the command. |
| ¦ ¦ ¦ ¦-<optional> | Defines if this data item is optional.(see optional) |
| ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦-<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) |
| ¦ ¦ ¦-<group> | Specifies a group.(see group) |
| ¦ ¦ ¦-<measurement> | Specifies a measurement supported by this group. |
| ¦ ¦ ¦ ¦-<optional> | Defines if this measurement is optional.(see optional) |
| ¦ ¦ ¦ ¦-<data> | Specifies the measurement data.(see data) |
| ¦ ¦ ¦ ¦-<readcommand> | Specifies the command to request a read of the current value of the measurement. |
| ¦ ¦ ¦ ¦ ¦-<optional> | Defines if this command is optional.(see optional) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<writecommand> | Specifies the command to request a change of the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<optional> | Defines if this command is optional.(see optional) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data to execute the command.(see data) |
| ¦ ¦ ¦ ¦-<signal> | Specifies the signal containing the measurement value. |
| ¦ ¦ ¦ ¦ ¦-<optional> | Defines if this signal is optional.(see optional) |
| ¦ ¦ ¦ ¦ ¦-<data> | Specifies the data when the signal triggers.(see data) |
| ¦ ¦ ¦ ¦ ¦-<signal> | Specifies the signal to listen. (see signal) |
| ¦ ¦ ¦-<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) |
| ¦-<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) |
| ¦ ¦-<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) |
| ¦-<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) |
| ¦ ¦-<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. |
| ¦ ¦-<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. |
| ¦ ¦-<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) 2009 IBM. See license in Legal section. | 2009-01-22 | Device Kit XML Reference 1.2.0 |