protocol

The protocol tag is used to denote the interface to a hardware protocol. The command tags denote the actions that are supported by the hardware protocol. The signals tags denote the events that are supported by the hardware protocol. The measurement tags denote the properties supported by the hardware protocol. Use the transportprotocol tag to specify the protocol?s transport. You can specify the Open Services Gateway Initiative (OSGi) protocol and transport class implementation with the transportprotocol tag. Release: 1.1.0

Examples: protocol examples

**`<protocol>` elements**
Name	Description	Use
`<description>`	Description of the protocol.	0 to unbounded
`<deprecated>`	Specifies that the contents of this element should be marked as deprecated.	0 to 1
`<spec>`	Hardware specification documentation for this protocol.	0 to unbounded
`<specreference>`	Specification reference for this protocol.	0 to unbounded

Name

Description

Use

<protocol> elements

<description>

Description of the protocol.

0 to unbounded

<deprecated>

Specifies that the contents of this element should be marked as deprecated.

0 to 1

<spec>

Hardware specification documentation for this protocol.

0 to unbounded

<specreference>

Specification reference for this protocol.

0 to unbounded

**`<protocol>` element siblings**
Sibling Name	Sibling Description
`<dkml>`	Specifies the root element of a Device Kit <b>D</b>evice <b>K</b>it <b>L</b>anguage (dkml) document.
`<filter>`
`<message>`
`<parameter>`
`<block>`	Defines a block.
`<constantblock>`	Defines a constant block.
`<reserveblock>`	Defines a reserve block.
`<versionblock>`	Defines a version block.
`<idblock>`	Defines a id block.
`<identifierblock>`	Defines a identifierblock block.
`<typeblock>`	Defines a type block.
`<countblock>`	Defines a count block.
`<lengthblock>`	Defines a length in bits block. The contents of the block is the length in bits.
`<sizeblock>`	Defines a length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).
`<segmentlengthblock>`	Defines a segment length in bits block. The contents of the block is the length in bits.
`<segmentsizeblock>`	Defines a segment length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).
`<messagelengthblock>`	Defines a message length in bits block. The contents of the block is the length in bits.
`<messagesizeblock>`	Defines a message length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).
`<bytesparameter>`	Defines a bytes parameter.
`<bitsparameter>`	Defines a bits parameter.
`<multiparameter>`	Defines a multiple parameter.
`<variablelengthparameter>`	Defines a variable length parameter.
`<listparameter>`	Defines a list parameter.
`<mapparameter>`	Defines a map parameter.
`<arrayparameter>`	Defines a array parameter.
`<utf8stringparameter>`	Defines a UTF-8 string parameter.
`<stringparameter>`	Defines a string parameter.
`<booleanparameter>`	Defines a binary boolean parameter. Normally, a boolean parameter length should not be longer than 1 bit.
`<numberparameter>`
`<integerparameter>`	Defines a binary integer parameter. An integer parameter length should not be longer than 32 bits (4 bytes).
`<unsignedintegerparameter>`	Defines a binary unsigned integer parameter. An unsigned integer parameter length should not be longer than 32 bits (4 bytes).
`<longparameter>`	Defines a binary long parameter. An long parameter length should not be longer than 64 bits (8 bytes).
`<unsignedlongparameter>`	Defines a binary unsigned long parameter. An unsigned long parameter length should not be longer than 64 bits (8 bytes).
`<shortparameter>`	Defines a binary short parameter. An short parameter length should not be longer than 16 bits (2 bytes).
`<unsignedshortparameter>`	Defines a binary unsigned short parameter. An unsigned short parameter length should not be longer than 16 bits (2 bytes).
`<byteparameter>`	Defines a binary byte parameter. An byte parameter length should not be longer than 8 bits (1 byte).
`<unsignedbyteparameter>`	Defines a binary unsigned byte parameter. An unsigned byte parameter length should not be longer than 8 bits (1 byte).
`<floatparameter>`	Defines a binary IEEE 754 floating-point single 32 bit parameter. The float parameter length should be 32 bits (4 bytes).
`<doubleparameter>`	Defines a binary IEEE 754 floating-point double 64 bit parameter. The double parameter length should be 64 bits (8 bytes).
`<segment>`
`<parametersegment>`
`<singleparametersegment>`
`<choicesegment>`
`<transport>`
`<transporttest>`
`<receiver>`	Defines a receiver transport.
`<value>`

Sibling Name

Sibling Description

<protocol> element siblings

<dkml>

Specifies the root element of a Device Kit Device Kit Language (dkml) document.

<filter>

<message>

<parameter>

<block>

Defines a block.

<constantblock>

Defines a constant block.

<reserveblock>

Defines a reserve block.

<versionblock>

Defines a version block.

<idblock>

Defines a id block.

<identifierblock>

Defines a identifierblock block.

<typeblock>

Defines a type block.

<countblock>

Defines a count block.

<lengthblock>

Defines a length in bits block. The contents of the block is the length in bits.

<sizeblock>

Defines a length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).

<segmentlengthblock>

Defines a segment length in bits block. The contents of the block is the length in bits.

<segmentsizeblock>

Defines a segment length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).

<messagelengthblock>

Defines a message length in bits block. The contents of the block is the length in bits.

<messagesizeblock>

Defines a message length in bytes block. The contents of the block is the length in bytes(each byte is 8 bits).

<bytesparameter>

Defines a bytes parameter.

<bitsparameter>

Defines a bits parameter.

<multiparameter>

Defines a multiple parameter.

<variablelengthparameter>

Defines a variable length parameter.

<listparameter>

Defines a list parameter.

<mapparameter>

Defines a map parameter.

<arrayparameter>

Defines a array parameter.

<utf8stringparameter>

Defines a UTF-8 string parameter.

<stringparameter>

Defines a string parameter.

<booleanparameter>

Defines a binary boolean parameter. Normally, a boolean parameter length should not be longer than 1 bit.

<numberparameter>

<integerparameter>

Defines a binary integer parameter. An integer parameter length should not be longer than 32 bits (4 bytes).

<unsignedintegerparameter>

Defines a binary unsigned integer parameter. An unsigned integer parameter length should not be longer than 32 bits (4 bytes).

<longparameter>

Defines a binary long parameter. An long parameter length should not be longer than 64 bits (8 bytes).

<unsignedlongparameter>

Defines a binary unsigned long parameter. An unsigned long parameter length should not be longer than 64 bits (8 bytes).

<shortparameter>

Defines a binary short parameter. An short parameter length should not be longer than 16 bits (2 bytes).

<unsignedshortparameter>

Defines a binary unsigned short parameter. An unsigned short parameter length should not be longer than 16 bits (2 bytes).

<byteparameter>

Defines a binary byte parameter. An byte parameter length should not be longer than 8 bits (1 byte).

<unsignedbyteparameter>

Defines a binary unsigned byte parameter. An unsigned byte parameter length should not be longer than 8 bits (1 byte).

<floatparameter>

Defines a binary IEEE 754 floating-point single 32 bit parameter. The float parameter length should be 32 bits (4 bytes).

<doubleparameter>

Defines a binary IEEE 754 floating-point double 64 bit parameter. The double parameter length should be 64 bits (8 bytes).

<segment>

<parametersegment>

<singleparametersegment>

<choicesegment>

<transport>

<transporttest>

<receiver>

Defines a receiver transport.

<value>

**`<protocol>` element tree**
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.

Element Name

Element Description

<protocol> element tree

<dkml>

Specifies the root element of a Device Kit Device Kit Language (dkml) document.

<protocol> element

`<protocol>` element