parameter

The parameter tag specifies a parameter within a message. By using the parameter tag, the value of the parameter can be extracted from the message received from the hardware device. The parameter tag is also used to define how to stored a parameter into a message to be sent to the hardware device. This value in the message can be translated into/from the application value by using the translate tags. Valid subtags of parameter include those that specify where to place the parameter within the message and a series of transforms that manipulate the parameter''s data. You can set the units of the parameter with the units tag.

Examples: parameter examples

**`<parameter>` attributes**
Name	Type	Description	Use
type	"ascii" "asciiz" "bit" "boolean" "boolean[]" "byte" "byte[]" "bytes" "double" "double[]" "float" "float[]" "hexascii" "hexstring" "int" "int[]" "long" "long[]" "nascii" "nstring" "numericstring" "short" "string" "ubyte" "ubytes" "uint" "ulong" "ushort"	Specifies the data type.	optional

Name

Type

Description

Use

<parameter> attributes

type

"ascii" "asciiz" "bit" "boolean" "boolean[]" "byte" "byte[]" "bytes" "double" "double[]" "float" "float[]" "hexascii" "hexstring" "int" "int[]" "long" "long[]" "nascii" "nstring" "numericstring" "short" "string" "ubyte" "ubytes" "uint" "ulong" "ushort"

Specifies the data type.

optional

**`<parameter>` elements**
Name	Description	Use
`<description>`	Description of the parameter.	0 to 1
`<deprecated>`	Specifies that the contents of this element should be marked as deprecated.	0 to 1
`<specreference>`	Specification reference for this parameter.	0 to unbounded
`<key>`	Specifies the parameter key.	0 to 1
`<bigendian>`	Specifies that the parameter data is in big endian order. This is the default order.	0 to 1
`<field>`	Specifies the field parameter name.	0 to 1
`<insert>`	Specifies that the parameter should be inserted into the message.	0 to 1
`<littleendian>`	Specifies that the parameter data is in little endian order.	0 to 1
`<offset>`	Specifies the starting bit offset of the parameter within the message. Offset 0 is the first bit in the message. See the index element to specify the parameter position in bytes.	1 to 1
`<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.	1 to 1
`<length>`	Specifies the parameter length in bits. See the size element to specify the parameter length in bytes.	1 to 1
`<lengthtoend>`	Specifies the parameter continues until the end of the message or segment.	1 to 1
`<size>`	Specifies the parameter size in bytes (1 byte is 8 bits). See the length element to specify the parameter length in bits.	1 to 1
`<enum>`	Specifies a enumeration for this parameter.	1 to 1
`<minimum>`	Specifies the minimum value.	1 to 1
`<maximum>`	Specifies the maximum value.	1 to 1
`<negative>`	Negate the parameter value.	1 to 1
`<not>`	Logical not of a boolean value.	1 to 1
`<scale>`	Specifies the value to scale the parameter value.	1 to 1
`<shift>`	Specifies the value to shift the parameter value.	1 to 1
`<translate>`	Specifies the value to add (translate) to the parameter value.	1 to 1
`<units>`	Specifies the optional parameter units.	0 to 1

Name

Description

Use

<parameter> elements

<description>

Description of the parameter.

0 to 1

<deprecated>

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

0 to 1

<specreference>

Specification reference for this parameter.

0 to unbounded

<key>

Specifies the parameter key.

0 to 1

<bigendian>

Specifies that the parameter data is in big endian order. This is the default order.

0 to 1

<field>

Specifies the field parameter name.

0 to 1

<insert>

Specifies that the parameter should be inserted into the message.

0 to 1

<littleendian>

Specifies that the parameter data is in little endian order.

0 to 1

<offset>

Specifies the starting bit offset of the parameter within the message. Offset 0 is the first bit in the message. See the index element to specify the parameter position in bytes.

1 to 1

<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.

1 to 1

<length>

Specifies the parameter length in bits. See the size element to specify the parameter length in bytes.

1 to 1

<lengthtoend>

Specifies the parameter continues until the end of the message or segment.

1 to 1

<size>

Specifies the parameter size in bytes (1 byte is 8 bits). See the length element to specify the parameter length in bits.

1 to 1

<enum>

Specifies a enumeration for this parameter.

1 to 1

<minimum>

Specifies the minimum value.

1 to 1

<maximum>

Specifies the maximum value.

1 to 1

<negative>

Negate the parameter value.

1 to 1

<not>

Logical not of a boolean value.

1 to 1

<scale>

Specifies the value to scale the parameter value.

1 to 1

<shift>

Specifies the value to shift the parameter value.

1 to 1

<translate>

Specifies the value to add (translate) to the parameter value.

1 to 1

<units>

Specifies the optional parameter units.

0 to 1

**`<parameter>` 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>`
`<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 multi 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>`
`<protocol>`
`<transport>`
`<transporttest>`
`<receiver>`	Defines a receiver.
`<value>`

Sibling Name

Sibling Description

<parameter> element siblings

<dkml>

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

<filter>

<message>

<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 multi 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>

<protocol>

<transport>

<transporttest>

<receiver>

Defines a receiver.

<value>

**`<parameter>` 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

<parameter> element tree

<dkml>

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

<parameter> element

`<parameter>` element