Commands

Command 0x0000 - Get Property

This command lets the host retrieve a property (see section on properties) from the device using the 1-byte Property ID.

Table - Get Property Command

Command	Parameter Data Len	Parameter Data
0x0000	0x0001	Property ID (1-byte)

Table - Get Property Response

Return Code	Response Data Len	Response Data
0x0000	varies	Property Value

Legacy (if needed) for simple & short properties.

Table - Legacy Get Property

Command	Parameter Data Len	Parameter Data
0x00	0x01	Property ID (1-byte)

Table - Legacy Response Structure

Return Code	Response Data Len	Response Data
0x00	varies	0 to 58 bytes

Command 0x0001 - Set Property (MAC Protected for Some Properties)

This command sets a property in the device. For secure properties, this command should be the payload for the Send Secured Command.

Table - Set Property Command

Command	Parameter Data Len	Parameter Data
0x0001	varies	Property ID (1 byte) Property Value (varies)

Table - Set Property Response

Return Code	Response Data Len	Response Data
0x0001	0x0001	0=Property in effect 1=Needs reset

Command 0x0002 - Reset Device

This command is used to reset the device.

Table - Reset Device Command

Command	Parameter Data Len	Parameter Data
0x0002	0x0000	None

Command 0x030D - Read Date and Time

The host uses this command to get the date / time from the device’s internal clock. The value returned is set to Coordinated Universal Time (UTC). The host is responsible for converting the response to local time.

Table - Read RTC Command

Command	Parameter Data Len	Parameter Data
0x030D	0x0000	None

Table - Read RTC Response

Return Code	Response Data Len	Response Data
0x0000	0x0007	See Table

Table - Read RTC Response Data

Length	Field Name	Value
1	Month	Value from 0x01...0x0C (1-12)
1	Day	Value from 0x01...0x1F (1-31, depends on the month)
1	Hour	Value from 0x00...0x17 (0-23)
1	Minute	Value from 0x00...0x3B (0-59)
1	Second	Value from 0x00...0x3B (0-59)
1	Unused	0x00
1	Year	Value from 0x00 (2008) ...0xFF (2263)

Command 0x0703 – Get Key Information

This command returns the information about the specified key to the host.

Table - Get Key Info Command

Command	Parameter Data Len	Parameter Data
0703	0x0002	Key ID

Table - Response Data for Get Key Information Command

Offset	Field Name	Description
0	Key Slot Status (1 byte)	0 = Empty 1 = Loaded (Purpose not assigned) 2 = Loaded & active 3 = Exhausted (End of DUKPT key sequence) 4 = Expired (RFU, cert status?) 0xFF = Not supported in this device
1	Slot Type (1 byte)	First byte of Slot ID (Slot ID = Key ID)
2	TK ID (2 byte)	The Key ID used to transport this key (a parent key ID)

The following fields are required if Key Slot is not empty.

Offset	Field Name	Description
4	Key Environment (1 byte)	‘T’ for test or ‘P’ for production
5	X9.143 Attributes (4 bytes)	‘Key Usage || Algorithm || Mode of Use’ from X9.143 Key Block Header.
9	Key Algorithm (1 byte)	1 = DES 4 = AES128 2 = 2TDES 5 = AES192 3 = 3TDES 6 = AES256
10	KCV (5 or 3 bytes)	5 bytes for AES-CMAC or 3 bytes for TDES-CBCMAC including the KCV algorithm info as defined in X9.143 ‘KP’/’KC’ format (A.5.8 of X9.143 spec)
15 or 13	Length of KSI (1 bytes)	Length of Key Set Identifier
16 or 14	Key Set Identifier (n bytes)	Encoded in Hex-ASCII refer to Table 11 in X9.143 specification.
(16 + n) or (14 + n)	Key Restriction (2 bytes)	16-bit Key Restriction Bitmask (for TK and DKPT keys)
(16 + n + 3) or (14 + n + 3)	Key Configuration (2 bytes)	16-bit Key Configuration Bitmask Currently supports Data Type Configuration only.
(16 + n + 4) or (14 + n + 4)	Timestamp (24 bytes)	Time and date in UTC time format that indicates when the key block was formed.

Command 0x07E0 – Set Button Mode (MAC Protected)

This command is used to activate or deactivate the button. The command is rejected if the device is not in Qwantum mode. The button always defaults to disabled after reset or when switching modes.

Table - Set Button Mode

Command	Parameter Data Len	Parameter Data
0x07E0	0x0001	0x00 – Disable button The push-button functionality is disabled. 0x01 – Enable button The push-button functionality is enabled, allowing the operator to output buffer data by pressing the button. The functionality remains active until a command is issued to disable it or the device is power cycled. 0x02 – Enable button for single press The push-button functionality is enabled, allowing the operator to output buffer data by pressing the button once. The functionality will be disabled automatically afterward or upon power cycling. 0x03 – Enable Button Persistently The push-button functionality is enabled, allowing the operator to output buffer data by pressing the button. The push-button activation persists even after a power cycle. The functionality remains active until a command is issued to disable it.