<Command id="?" requestId="?" version="?" answerRecipient="?" deviceId="?" serviceId="?" logicalId="?">
    <Field1>value1</Field1>
    <Field2>value2</Field2>
        ...
    <Field3>value3</Field3>
</Command>

id

Command Identification Constant. It can be followed by a description of the command, separated by comma i.e.: id="0x7060015,XPEAK_COMMAND_INITIALIZE"

requestId

Sequential number to identify the answer. The answer of this command will include the same requestId

version

Version of the command. Each command can have any number of versions, so the Service can proceed depending on it i.e.: version="0x706"

answerReceipient

This field can vary depending on the Xpeak Server used. Indicates where the answer must be sent. For example, a Socket Xpeak Server will need the IP address and PORT. i.e.: answerRecipient="192.168.2.7:9003"

deviceId

Identifies the Xpeak Device to use. It has 3 parts separated by '-': Manufacturer, Type and Model i.e.: deviceId="Acme-Card-Swing" or deviceId="Olivetti-Printer-PR2"

serviceId

Each device can have any number of services. For example, a PinPad device can include a Card Reader, a Display, a Keyboard, etc. i.e.: serviceId="CardGuideLight" or serviceId="Printer"

logicalId

When an application uses the same service of the same device more than once at a time (for example 2 chip card readers), it needs to name them in a different way i.e.: logicalId="MyChip1"

<Answer id="?" requestId="?" version="?" deviceId="?" serviceId="?" logicalId="?">
    <Field1>value1</Field1>
    <Field2>value2</Field2>
        ...
    <Field3>value3</Field3>
</Answer>

The Answer structure is the same as the Command one, except the answerRecipient field that, obviously, is not needed

<Event id="?" version="?" deviceId="?" serviceId="?" logicalId="?">
    <Field1>value1</Field1>
    <Field2>value2</Field2>
        ...
    <Field3>value3</Field3>
</Event>

The Event structure is the same as the Answer one, except the requestId field that is not included

<Trace version="?" deviceId="?" serviceId="?" logicalId="?" level="?" timestamp="?" data="?">
</Trace>

version

See Commands

deviceId

See Commands

serviceId

See Commands

logicalId

See Commands

level

Indicates the level corresponding to this trace info. Possible values are:

"0x07060012[,XPEAK_TRACE_LEVEL_PROTOCOL]"
"0x0706002F[,XPEAK_TRACE_LEVEL_CONNECTION]"
"0x07060013[,XPEAK_TRACE_LEVEL_SERVICE]"
"0x07060014[,XPEAK_TRACE_LEVEL_DEBUG]"

timestamp

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT

data

Contains the trace data, encoded using Base64 algorithm

<Error version="?" deviceId="?" serviceId="?" logicalId="?" level="?" severity=?" timestamp="?" description="?">
</Error>

version

See Commands

deviceId

See Commands

serviceId

See Commands

logicalId

See Commands

timestamp

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT

severity

Possible values are:

"0x07060028[,XPEAK_ERROR_SEVERITY_WARNING]"
"0x0706002B[,XPEAK_ERROR_SEVERITY_FATAL]"
"0x07060029[,XPEAK_ERROR_SEVERITY_SOFTWARE_RECOVERABLE]"
"0x0706002A[,XPEAK_ERROR_SEVERITY_OPERATOR_RECOVERABLE]"

level

Possible values are:

"0x0706002C[,XPEAK_ERROR_LEVEL_GENERIC]"
"0x0706002D[,XPEAK_ERROR_LEVEL_SERVICE]"
"0x0706002E[,XPEAK_ERROR_LEVEL_CONNECTION]"

error

This is the vendor error code

description

Contains the vendor error description, encoded using Base64 algorithm

String

<MyString>String data value</MyString>

int

<MyInt1>123</MyInt1>
<MyInt2>0x7B</MyInt2>

long

<MyLong1>456</MyLong1>
<MyLong2>0x1C8</MyLong2>

double

<MyDouble>789.12</MyDouble>

boolean

<MyBoolean1>no</MyBoolean1>
<MyBoolean2>yes</MyBoolean2>

Constant

Indicates a value of one of the Xpeak constants

<MyConstant1 type="constant">0x0706002F<MyConstant1>
<MyConstant2 type="constant">0x0706002F,XPEAK_TRACE_LEVEL_CONNECTION<MyConstant2>

Color

An integer value specifying the RGB of the color

<MyColor1 type="color">0x123456<MyColor1>
<MyColor2 type="color">1193046<MyColor2>

Base64

The field is encoded using Base64 algorithm. The following example is a Base64 field of an array of 3 bytes with values 49, 50 and 51

<MyBase64 type="base64">MTIz</MyBase64>

Unicode

The string field containing unicode characters (double byte) is encoded using Base64 algorithm. The following example is a Unicode field of the 3 characters length String "123"

<MyUnicode type="unicode">ADEAMgAz</MyUnicode>

Structs

All structs are identified by a name

<Struct name="MyStruct">
<Field1>value1</Field1>
<Field2>value2</Field2>
...
<Field3>value3</Field3>
</Struct>

Arrays

If a field is define as an array (i.e.: int Levels[]), the XML will include as many fields labeled with the array name as needed

<Level>100</Level> <Level>400</Level>