Properties - 0x00 - 0x22

About Properties

Properties are used to provide information about the device and how to configure it. Secured properties are set at the factory or by an administrator using software tools supplied by MagTek. Property values take effect immediately unless specified otherwise.

Property 0x00 – Main Firmware ID

Property Type:

String

Length:

Varies

Get Property:

Yes

Set Property:

Default Value:

Part number of installed firmware

This read-only property returns the main firmware part number, a dash, the major and minor revision number, followed by a dash and the firmware type. {main firmware part number}-{3 character rev}-{type}

Example

1000004854-AD9-PCI

Property 0x02 - USB Polling Interval

Property ID:

0x02

Property Type:

Byte

Length:

1 byte

Get Property:

Yes

Set Property:

Yes

Default Value:

0x01

This one-byte value (1-255) sets the device’s polling interval in milliseconds for the Interrupt in Endpoint. The device sends the value of this property as part of USB device enumeration to the host.

Property 0x03 - Device Serial Number

Property ID:

0x03

Property Type:

String

Length:

Get Property:

Yes

Set Property:

Default Value:

N/A

This value is also found on the product label. The property contains the 7-character MagTek device serial number. This value is used for USB device enumeration, data messages, and message security.

Property 0x04 - MagneSafe Version Number

Property ID:

0x04

Property Type:

String

Length:

0 - 7 bytes

Get Property:

Yes

Set Property:

Standard Value:

PCIV01

This is a maximum 7-byte read-only property that identifies the MagneSafe Feature Level supported on this device.

Property 0x05 - Track ID Enable

Property ID:

0x05

Property Type:

Byte

Length:

1 byte

Get Property:

Yes

Set Property:

Yes

Default Value:

0x95

This property is defined as follows:

Table - Track Enable Property

Bit Position

T₃

T₂

T₁

id = 0: Decodes standard ISO/ABA cards only
id = 1: Decodes AAMVA and 7-bit cards also

If the id flag is set to 0, only tracks that conform to the ISO card data format allowed for that track are decoded. If the track cannot be decoded by the ISO method, the device reports a decode error.

For each pair of track bits, valid values are as follows:

T_# = 00: Track Disabled
T_# = 01: Track Enabled
T_# = 10: Track Enabled and Required (Generates error if track is blank)

Property 0x07 - ISO Track PAN Mask

Property ID:

0x07

Property Type:

String

Length:

6 bytes

Get Property:

Yes

Set Property:

Yes

Default Value:

04040Y

This property specifies how the device should mask data on ISO/ABA type cards: Each byte in the sequence has the following meaning:

Table - ISO Track PAN Masking - Non-PCI Device

Length

Description

These bytes are an ASCII representation of a decimal value that specifies how many of the leading characters of the PAN the device sends unmasked. The range is from “00” to “99”.

These bytes are an ASCII representation of a decimal value that specifies how many of the trailing characters of the PAN the device sends unmasked. The range is from “00” to “99”.

Masking Character. This byte specifies which character the device uses for masking. If this byte contains the uppercase letter ‘V’, the following rules apply:

The device masks the PAN using character ‘0’
The device leaves all data after the PAN unmasked, leaving Discretionary Data (“DD”) and other non-PAN data available for the host to read.
0x00 (NULL character) is not allowed.

This byte specifies whether the device applies Mod 10 Correction to the PAN. “Y” means Yes, “N” means No. This option is only effective if the Masking Character specified by this command is “0”.

Table - ISO Track PAN Masking - PCI Device

Length

Description

These bytes are an ASCII representation of a decimal value that specifies how many of the leading characters of the PAN the device sends unmasked.

The leading character range is from “00” to “08” when the PAN length is greater than 15.
The leading character range is from “00” to “06” when the PAN length is 15 or less.

These bytes are an ASCII representation of a decimal value that specifies how many of the trailing characters of the PAN the device sends unmasked. The range is from “00” to “04”.

Masking Character. This byte specifies which character the device uses for masking.

The uppercase letter ‘V’ is not supported.
0x00 (NULL character) is not allowed.

Property 0x08 - AAMVA Track Mask

Property ID:

0x08

Property Type:

String

Length:

6 bytes

Get Property:

Yes

Set Property:

Yes

Default Value:

04040Y

This property specifies the factors for masking data on AAMVA type cards. Each byte in the property has the following meaning:

Table - Factors for Masking Data on AAMVA Type Cards - Non-PCI device

Length

Description

These bytes are an ASCII representation of a decimal value that specifies how many of the leading characters of the Driver’s License/ID Number (DL/ID#) the device sends unmasked. The range is from “00” to “99”.

These bytes are an ASCII representation of a decimal value that specifies how many of the trailing characters of the DL/ID# sends unmasked. The range is from “00” to “99”.

Masking Character. This byte specifies which character the device uses for masking. If this byte contains the uppercase letter ‘V’, the following rules apply:

The device masks the PAN according to the rules of this property (Property 0x34 - Send AAMVA Card Data is ignored).
The device uses ‘0’ for masking the PAN.
The device sends all data after the PAN without masking.
0x00 (NULL character) is not allowed.

This byte specifies whether the device applies Mod 10 Correction to the DL/ID#. “Y” means Yes, “N” means No. This option is only effective if the masking character specified in this command is “0”.

Table - Factors for Masking Data on AAMVA Type Cards - PCI device

Length

Description

These bytes are an ASCII representation of a decimal value that specifies how many of the trailing characters of the DL/ID# sends unmasked. The range is from “00” to “99”.

Masking Character. This byte specifies which character the device uses for masking.

The uppercase letter ‘V’ is not supported.
0x00 (NULL character) is not allowed.

Property 0x10 - Interface Type

Property ID:

0x10

Property Type:

Byte

Length:

1 byte

Get Property:

Yes

Set Property:

Yes (No for devices that switch connections automatically)

Default Value:

Dependent on device type:

This property represents the device’s current connection type.

Valid values for this property are:

0x00 = USB HID (HID Only)
0x01 = USB Keyboard Emulation (KB) (USB KB Only)
0x02 = iAP2
0xFF = One-Time Automatic (HID Only | iAP2 Only). When the property is set to this value and the device connects to a host, the device attempts to determine which interface type the host is using. After it successfully detects the interface type, it automatically sets this property to the value that corresponds to that interface type.

Property 0x15 – MP Options (MAC MREQMK)

Property ID:

0x15

Property Type:

Byte

Length:

1 byte

Get Property:

Yes

Set Property:

Yes (Secure MAC)

Default Value:

0x00

Configures Magneprint options.

Table - MP Option Byte

Bit 2

Bit 1

Bit 0

0=Use SRED encrypt key

1=Use MP encrypt key

0=Normal Length MP

1=Extended Length MP

Property 0x1E – Start of Message

Property ID:

0x1E

Property Type:

String

Length:

0-7 bytes

Get Property:

Yes

Set Property:

Yes

Default Value:

Null String

The device sends the value of this property to the host before all other card data. For example, if the host software requires a set of keystrokes to begin the process of receiving card data, this property could be set to transmit that keystroke sequence.

Property 0x22 – End of Message

Property ID:

0x22

Property Type:

String

Length:

0-7 bytes

Get Property:

Yes

Set Property:

Yes

Default Value:

0x0D (carriage return)

The device sends the value of this property to the host at the end of the data message. For example, if the host software requires a set of keystrokes to end the process of receiving card data, this property could be set to transmit that keystroke sequence. If the value is 0, the device does not send a termination string.

Last updated 1 month ago