1 of 12

1.2.2.1.nn - WLAN Settings (WLAN Only) - A

Certificate Expiring Soon Notification Threshold - Property 1.2.2.1.1.B

Property Description

Property OID

1.2.2.1.1.B / 0x01020201010B

Name

Certificate Expiring Soon Notification Threshold

1.2.5.nnn - Security Settings - A

1.2.5.2.1.1 - Device Lock State

Property Description

Property OID

1.2.5.2.1.1 / 0x010205020101

Name

Device Lock State

1.2.5.nnn - Security Settings - A

1.2.5.2.1.1 - Device Lock State

Property Description

Property OID

1.2.5.2.1.1 / 0x010205020101

Name

Device Lock State

This property can be used to get or set the device lock state. Getting this property does not require security, however setting it does. Setting it requires the use of Command 0xD112 - Set Property (Secured) which requires MagTek's involvement. To set the device lock state without involving MagTek use Command 0xEF04 – Load LTPK Protection Key. The value of the device lock state will revert to the value of Property 1.2.5.2.1.2 Device Lock State After Reset after a reset or a power cycle. See Device Lock Feature for more information.

This property can be used to get or set what Property 1.2.5.2.1.1 Device Lock State will be set to after the device is reset or power cycled. Systems that use the optional device lock feature should set this property to locked, otherwise all someone would need to do to unlock the device would be to power cycle or reset it. The value of the device lock state after reset property is stored in non-volatile memory so changes made to it will persist after the device is reset or power cycled. See Device Lock Feature for more information.

This property can be used to set the device lock passcode. The value of the device lock passcode is stored in non-volatile memory so changes made to it will persist after the device is reset or power cycled. For security, the host can’t get the value of the device lock passcode from the device. If the host gets this property, the device will always return a length of 0 and no value. Setting this property requires security. Setting it requires the use of Command 0xD112 - Set Property (Secured) which requires MagTek's involvement. To set the device lock passcode without involving MagTek use Command 0xEF07 – Change Device Lock Passcode. See Device Lock Feature for more information.

1.2.2.1.nn - WLAN Settings (WLAN Only) - A

Certificate Expiring Soon Notification Threshold - Property 1.2.2.1.1.B

Property Description

Property OID

1.2.2.1.1.B / 0x01020201010B

Name

Certificate Expiring Soon Notification Threshold

The device uses this property to determine how many days before a certificate expires it should start notifying the host that it is about to expire. If the value is set to 0, the notification will be disabled.

The notification will only be sent if TLS is enabled, and the notification will only be sent for they server certificate that the device is configured to use. The notification will be sent every time the first client connects to the device shortly after it connects.

Notification 0x1001 - Device Information Update category Key management, reason Certificate Expiring Soon is related.

1.2.2.2.nn - USB Settings (USB Only)

Reduce Power During USB Suspend - Property 1.2.2.2.1.1

Property Description

Property OID

1.2.2.2.1.1 / 0x010202020101

Name

Reduce Power During USB Suspend

The device uses this property to determine whether it should reduce its power consumption when a USB host directs it to suspend. If this property is set to Disabled, the device will not have a USB compliant current draw when suspended, which, for example, allows it to continue to turn on LEDs and the display if present.

To activate changes made to this property, the device must be reset or power cycled.

The device uses this property to determine if it should behave as a USB HID device or an USB iAP2 device. USB HID devices can communicate with most hosts except for Apple hosts. USB iAP2 devices can communicate to Apple hosts like iPads and iPhones. The behavior affects USB enumeration and communications.

To activate changes made to this property, the device must be reset or power cycled.

The device uses this property to determine the lowest charge percentage level the battery must reach, before the device starts charging the battery. This forces the device to run off the battery as much as possible, only charging when necessary.

To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.

The device uses this property to determine the highest charge percentage level the battery must reach, before the device stops charging the battery. This forces the device to run off the battery as much as possible and only charge when necessary.

To activate this property, NORMAL_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode must be enabled first.

The device uses this property to define on-duty hours. It consists of an on-duty starting time and on-duty duration. When on-duty the battery charging behavior matches the DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. While off-duty the battery charging behavior is the same except it will charge to 100%, instead of the stop level set in Property 1.2.2.2.1.5 Battery Charging Stop Level. NOTE: The battery charging schedule is an optional feature of DYNAMIC_BATTERY_CHARGING.

The battery charging schedule is disabled by default. After enabling it, the charging mode must also be set to DYNAMIC_BATTERY_CHARGING described in Property 1.2.2.2.1.3 Battery Charging Mode. When disabled, the dynamic battery charging behavior does not take into account of on-duty or off-duty times, instead it charges according to the charging start and stop level properties only.

0x00 = HID only 0x01 = iAP2 only

0x02 = autodetect (iAP2 with HID fallback)

The autodetect option can allow a device to work with iAP2 hosts and HID hosts. With this option, every time the device is attached to a USB host it will first enumerate as an iAP2 device, if the device does not receive an iAP2 initialization sequence response from the host within 2 seconds the device will perform a soft USB detach from the host and then a soft USB attach and next enumerate as a USB HID device.

Valid Values

0x00 = NORMAL_BATTERY_CHARGING

0x01 = DYNAMIC_BATTERY_CHARGING

When the device is in NORMAL_BATTERY_CHARGING mode it charges continuously until full, if it is connected to a dedicated charger or a USB host device like a tablet.

When the device is VBUS_BATTERY_DYNAMIC_CHARGING mode the device will run off the battery only until it reaches the battery charge percentage defined in Property 1.2.2.2.1.4 Battery Charging Start Level, then it will charge until it reaches the battery charge percentage defined in Property 1.2.2.2.1.5 Battery Charging Stop Level. In this mode it will repeat this cycle repeatedly. However, if the device is connected to dedicated charger, it will charge until full and not run off the battery unless the charger is disconnected.

The Property 1.2.2.2.1.6 Battery Charging Schedule feature can optionally be enabled while in DYNAMIC_BATTERY_CHARGING mode. When ON-DUTY the charging behavior is as described above When OFF-DUTY it will charge until full and not run off the battery until ON-DUTY.

Example Setting: 00 08 00 0C 00

0x00 = Charge Schedule Enable (0x00 disable, 0x01 enable) 0x08 = Start Hour 00 – 23 (value range 0x00 – 0x17)

0x00 = Start Minute 00 – 59 (value range 0x00 – 0x3B) 0x0C = Duration Hour 00 – 23 (value range 0x00 – 0x17) 0x00 = Duration Minute 00 – 59 (value range 0x00 – 0x3B)

The Battery Charging Schedule determines when the goes ON-DUTY and OFF_DUTY. The start hour and minute are used to determine the start of ON-DUTY. The device will remain On-DUTY until the duration hour and minute expires. Then it will go OFF- DUTY.

1.2.2.3.1.1 - Bluetooth LE Device Name

Bluetooth LE Device Name - Property 1.2.2.3.1.1

Property Description

Property OID

1.2.2.3.1.1 / 0x010202030101

Name

Bluetooth® LE Device Name

This property contains the Bluetooth® device name, which is typically used by the host software to present an operator with a list of devices to interact with. To avoid ambiguity, if the solution specifies that more than one device of the same name will be available, MagTek recommends including a unique identifier in the device name so the operator can differentiate.

The name should not contain any null string characters (0x00) at the beginning or in the middle, 0x00 can be used at the end of the name for padding to a total length of 20 characters. When setting this property, you can enter 0 to 20 characters. If set to a length of 0, the value reverts to its original default value described below. After modifying the Bluetooth® device name, you must reset the Bluetooth® LE module.

When getting this property, device will always return 20 characters If the name is less than 20 characters long, device will return 0x00 for the remaining characters.

A prefix, such as “DF II Go-“ for DynaFlex II Go, followed by the device’s serial number. For example, “DF II Go-B603226”.

Devices are always deployed with the serial number loaded, but prior to loading the serial number at MagTek, the prefix will be followed by the second to last and the last least significant bytes of the Bluetooth® device address converted to ASCII hex. For example, “DF II Go-97C2”.

This two-byte property, in most significant byte order, contains the Interval Min value in

1.25 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 6 and 3200 are valid.

After the host changes this property, the device must be reset before the changes will take effect.

This two-byte property, in most significant byte order, contains the Interval Max value in

1.25 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for more details. Only values between 6 and 3200 are valid.

After the host changes this property, the device must be reset before the changes will take effect.

This two byte property, in most significant byte order, contains the Slave Latency value the device sends to the Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 0 and 499 are valid.

After the host changes this property, the device must be reset before the changes will take effect.

This two-byte property, in most significant byte order, contains the value of the Timeout Multiplier sent in 10 millisecond units that the device sends to a Bluetooth® LE host in a CONNECTION PARAMETER UPDATE REQUEST. See the Core Bluetooth® Specification for details. Only values between 10 and 3200 are valid.

After the host changes this property, the device must be reset before the changes will take effect.

This two property, in most significant byte order, contains the device’s minimum Bluetooth® LE advertising interval in 625 microsecond increments. This property, combined with Property 1.2.2.3.1.8 Bluetooth® LE Maximum Advertising Interval, specifies the Bluetooth® LE advertising interval the device uses. Smaller advertising intervals cause the device to consume more power when advertising, which may be a concern when running on battery power.

Only values between 32 (20ms) and 65535 (40.96s) are valid. The host may need to adjust the maximum advertising interval property when changing this property; if the maximum advertising interval is less than the minimum, the device may behave unpredictably.

After the host changes this property, the device must be reset before the changes will take effect.

This two-byte property, in most significant byte order, contains the device’s maximum Bluetooth® LE advertising interval in 625 microsecond increments. This property, combined with Interval, specifies the Bluetooth® LE advertising interval the device uses. Smaller advertising intervals cause the device to consume more power when advertising, which may be a concern when running on battery power.

Only values between 32 (20ms) and 65535 (40.96s) are valid. The host may need to adjust the minimum advertising interval property when changing this property. If the minimum advertising interval is greater than the maximum, the device may behave unpredictably.

After the host changes this property, the device must be reset before the changes will take effect.

This six-byte property contains the device’s Bluetooth® passkey as a six-character with valid value for each character between ‘0’ and ‘9’

After the host changes this property, the device must be reset before the changes will take effect.

For security, the Get request for this property will always return a length of zero and no value, so you can only set the passkey and not get it.

The device uses this property to determine if the Bluetooth® LE Never Advertise is enabled. When it is enabled, the device never advertises. This mode may be useful for operators who only want to use the USB interface and don’t want the device to advertise.

After the host changes this property, the device must be reset before the changes will take effect.

Description

The device uses this property to determine if Bluetooth® LE Debug Mode is enabled. When it is enabled, the secure connections bonding uses known debug keys, so that the encrypted packet can be opened by a Bluetooth® protocol analyzer. Bondings made in debug mode are unsecure. This mode should only be enabled for debugging for development purposes and not for regular device use.

Prior to enabling or disabling Debug Mode, the following should be done. Erase all of the device's bonds with Command 0x1F05 – Erase All Bluetooth® LE Bonds (Bluetooth® LE Only). Forget the device on all hosts that have paired with it by using the host's Bluetooth® settings application. Reboot all of those hosts.

Some hosts like Windows 10 will not pair with devices that use known debug keys.

If the value of this property is set to 0, Debug Mode is disabled. If it is set to 1, Debug Mode is enabled.

After the host changes this property, the device must be reset before the changes will take effect.

1.2.2.1.nn - WLAN Settings (WLAN Only) - B

Property Description

Property OID

1.2.2.1.2.4 / 0x010202010204

Name

MQTT Subscribe Topic

The device uses this property to disable/enable WLAN Feature.

0x00 = WLAN Disabled

0x01 = WLAN Enabled

Changes to this property do not take effect until the device is power cycled or reset.

The device uses this property to set password for WLAN settings. If the password is shorter than 63 bytes, all remaining bytes after the password should be set to zeros.

For EAP-PEAP authentication, the maximum length of password is 32 bytes. The real password has to be <= 32 bytes, all bytes after the desired password must be set to zeroes.

For security, the Get request for this property will always return a value with 63 zeroes, so you can only set the password and not get it.

The device uses this property to determine how many clients it will allow to connect to its WLAN WebSocket server at one time. Most use cases will only want to allow one client at a time. If more than one client is connected, all outgoing data from the device will be sent to all clients. For example, all notifications and all command responses will be sent to all clients. If more than one client is connected, any client can send a command to the device at any time. Since having more than one client send commands to the device at the same time can result in command collisions and unexpected device behavior, it is recommended that only one client be in charge of sending commands and that other clients only listen to outgoing messages. A use case for allowing more than once client may be to have a second client for diagnostic or monitoring purposes.

Property 2.1.2.5.6.4 Active Client Connections is related.

1.2.1.nnn - Transaction Settings - B

MIFARE Plus AES_Key1. - Property 1.2.1.1.4.5

Property Description

Property OID

1.2.1.1.4.5 / 0x0102010100405

Name

MIFARE Plus AES_Key1.

MIFARE Plus AES_Key5. - Get Request Example

The device uses this property to set 16-byte of the AES_Key1 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_Key2 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_Key3 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_Key4 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_Key5 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_Key6 for MIFARE Plus.

On example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

1.2.nnnn - Device Settings

Device Settings

These sections of the DynaFamily Programmer's Manual details information on sending masked/tracking data..

Applies to: All Dyna Family products

Settings in this group

Setting

Information

Configure how the device runs financial transactions — EMV terminal and kernel parameters, supported entry methods, and amount, currency, and timeout handling.

Need Help?

For additional support, please contact MagTek Support:

Technical Support:

📧 Email: support@magtek.com
📞 Phone: 1-562-546-6800 (US)
🕐 Hours: Monday-Friday, 5:30 AM - 5:00 PM PST

Online Resources:

🌐 Support Portal: developer.magtek.com

Documentation Feedback:

Help us improve this documentation!

1.2.3.nnn - User Interface Settings - B

Custom Idle Page Image (Display Only) - Property 1.2.3.1.1.1

Property Description

Property OID

1.2.3.1.1.1 / 0x010203010101

Name

Custom Idle Page Image

United States +1 (321) 689-1234, international number, with 1-digit country code, 3-digit area code

United States (321) 689-2213, local number, with 3-digit area code, dash in position 3

Australia +61 (5) 1234-5678, international number, with 2-digit country code, 1-digit area code

Australia (05) 1234-5678, local number, with leading zero, 1-digit area code, dash in position 4

Hong Kong +852 12345678, international number, with 3-digit country code, no area code

Hong Kong 1234-5678, local number, with no area code, dash in position 4

Default

OID Default

0x0001 = country code (+1) USA 0x03 = num area code digits

0x00 = add area code leading zero (T/F)

0x07 = num local number Digits

0x03 = local number dash position 0x00 = hide digits (T/F)

Valid Values

Example valid value for the USA

04 00 – (04 capture 4 digits, 00 show digits)

09 00 – (09 capture 9 digits, 00 show digits)

04 01 – (04 capture 4 digits, 01 hide)

09 01 – (09 capture 9 digits, 01 hide)

Description

The device uses this property to set which custom image it displays when idle. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting).

· 0x00 = Show text “Welcome”

· 0x01 = Show custom image 1

· 0x02 = Show custom image 2

· 0x03 = Show custom image 3

· 0x04 = Show custom image 4

To use this feature, the host must first load an image into the selected slot using Command 0xD812 - Start Send File to Device (Unsecured). Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.

Description

The device uses this property to set which custom image it displays when idle and locked. If the selected image does not exist, the device falls back to showing text. This property does not take effect instantly; it takes effect the next time the device transitions to idle (for example, after a transaction or after resetting). See Device Lock Feature for more information.

· 0x00 = Show text “Welcome” “Device is Locked”

· 0x01 = Show custom image 1

· 0x02 = Show custom image 2

· 0x03 = Show custom image 3

· 0x04 = Show custom image 4

The device uses this property to set the orientation of the display. There are four modes: Landscape with magnetic stripe reader (MSR) on the top, Landscape with MSR on the bottom, Portrait with MSR on the right, and Portrait with MSR on the left. This property does not take effect immediately, it takes effect the next time the device transitions to idle (for example, after a transaction or after power cycle / reset).

This property sets the output volume for all sounds the device produces after startup, expressed as a percentage range from 0% (no sound) to 100%. The volume setting takes effect immediately after the host changes it.

Note that devices with limited volume control hardware allocate ranges of numbers to represent the same physical volume level (for example, 1..49 = Low, 50..100 = High).

Description

This property is used to change the displayed format of the phone number entered in the touch screen. It fully supports the International E.164 format that defines the fields allowed for global phone numbers. This property is an array of 7 bytes divided into fields. All values are HEX. Byte 0-1 – Country code (0x0000): 1 – 999 (value range 0x01 – 0x3E7) see NOTE 1 Byte 2 – Number of Area code digits: 0 – 3 (value range 0x00 – 0x03) Byte 3 – Add Area code leading zero: (T/F) 0 – 1 (value range 0x00 – 0x01) NOTE 3

Byte 4 – Number of local number digits: l – 12 (value range 0x01 – 0x0C)

Byte 5 – Local number dash position: 0 – ‘Byte 4’s value minus 1’

Byte 6 – Hide digits with ‘*’: (T/F) 0 – 1 (value range 0x00 – 0x01) NOTE 1: If country code is set to zero, then the local number format is automatically enabled.

NOTE 2: The maximum number of digits specified by the E.164 format is 15. The country code digits + area code digits + local number digits cannot exceed 15 total digits.

NOTE 3: Setting Byte 3 to true only takes effect if country code is set to zero. If Byte 3 is set to true, then Byte 2 must be set to 2 or 3. Reason: Adding a leading zero automatically makes the number of area code digits greater than 1.

This property is used to change the displayed format of the social security number entered

in the touch screen. The default obfuscated character is ‘*’.

Byte 0 – Number of digits

Valid values are 4 or 9 (0x04 or 0x09) 4 = Last 4 social security number digits 9 = All 9 social security number digits

Byte 1 – Hide digits with ‘*’ (T/F) 0 – 1 (0x00 – 0x01)

This property is used to format the zip code. Byte 2 is used to control the input type, For example, a numeric zip code 23452 (United states) or an alphanumeric zip code M5V 2T6 (Canada).

Byte 0 – Number of digits: 1 – 9 (value range 0x01 – 0x09)

Byte 1 – Dash position: 0 – ‘Byte 0’s value minus 1’

When set to 0, no dash will appear

Byte 2 – Zip code type: Numeric or Alphanumeric 0 - 1 (value 0x00 – 0x01)

Byte 3 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)

This property is used to determine if the birth date should be displayed on the screen or hidden. The default hidden character is ‘*’.

Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01) Byte 1 – Birth date format

0x00 = MM-DD-YYYY

0x01 = DD-MM-YYYY

This property is used to determine if the General Information should be displayed on the screen or hidden. The default hidden character is ‘*’. The maximum number of characters for General Information is 18.

Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)

1.2.3.nnn - User Interface Settings - A

1.2.3.1.1.1 - Custom Idle Page Image (Display Only)

Property Description

Property OID

1.2.3.1.1.1 / 0x010203010101

Name

Custom Idle Page Image

United States +1 (321) 689-1234, international number, with 1-digit country code, 3-digit area code

United States (321) 689-2213, local number, with 3-digit area code, dash in position 3

Australia +61 (5) 1234-5678, international number, with 2-digit country code, 1-digit area code

Australia (05) 1234-5678, local number, with leading zero, 1-digit area code, dash in position 4

Hong Kong +852 12345678, international number, with 3-digit country code, no area code

Hong Kong 1234-5678, local number, with no area code, dash in position 4

Default

OID Default

0x0001 = country code (+1) USA 0x03 = num area code digits

0x00 = add area code leading zero (T/F)

0x07 = num local number Digits

0x03 = local number dash position 0x00 = hide digits (T/F)

Valid Values

Example valid value for the USA

04 00 – (04 capture 4 digits, 00 show digits)

09 00 – (09 capture 9 digits, 00 show digits)

04 01 – (04 capture 4 digits, 01 hide)

09 01 – (09 capture 9 digits, 01 hide)

Description

· 0x00 = Show text “Welcome”

· 0x01 = Show custom image 1

· 0x02 = Show custom image 2

· 0x03 = Show custom image 3

· 0x04 = Show custom image 4

Description

· 0x00 = Show text “Welcome” “Device is Locked”

· 0x01 = Show custom image 1

· 0x02 = Show custom image 2

· 0x03 = Show custom image 3

· 0x04 = Show custom image 4

Note that devices with limited volume control hardware allocate ranges of numbers to represent the same physical volume level (for example, 1..49 = Low, 50..100 = High).

Description

Byte 4 – Number of local number digits: l – 12 (value range 0x01 – 0x0C)

Byte 5 – Local number dash position: 0 – ‘Byte 4’s value minus 1’

Byte 6 – Hide digits with ‘*’: (T/F) 0 – 1 (value range 0x00 – 0x01) NOTE 1: If country code is set to zero, then the local number format is automatically enabled.

NOTE 2: The maximum number of digits specified by the E.164 format is 15. The country code digits + area code digits + local number digits cannot exceed 15 total digits.

This property is used to change the displayed format of the social security number entered

in the touch screen. The default obfuscated character is ‘*’.

Byte 0 – Number of digits

Valid values are 4 or 9 (0x04 or 0x09) 4 = Last 4 social security number digits 9 = All 9 social security number digits

Byte 1 – Hide digits with ‘*’ (T/F) 0 – 1 (0x00 – 0x01)

This property is used to format the zip code. Byte 2 is used to control the input type, For example, a numeric zip code 23452 (United states) or an alphanumeric zip code M5V 2T6 (Canada).

Byte 0 – Number of digits: 1 – 9 (value range 0x01 – 0x09)

Byte 1 – Dash position: 0 – ‘Byte 0’s value minus 1’

When set to 0, no dash will appear

Byte 2 – Zip code type: Numeric or Alphanumeric 0 - 1 (value 0x00 – 0x01)

Byte 3 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)

This property is used to determine if the birth date should be displayed on the screen or hidden. The default hidden character is ‘*’.

Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01) Byte 1 – Birth date format

0x00 = MM-DD-YYYY

0x01 = DD-MM-YYYY

Byte 0 – Hide digits with ‘*’ (T/F) 0 – 1 (value range 0x00 – 0x01)

1.2.7.nnn - System Settings - B

Device Reset Occurred Notification Control - Property 1.2.7.1.1.1

Property Description

Property OID

1.2.7.1.1.1 / 0x010207010101

Name

Device Reset Occurred Notification Control

The host can use this property to acknowledge it has received the Device Reset Occurred notification in Notification 0x1001 - Device Information Update and to request that the device stop sending it.

Alternatively, because the device automatically sets the value of this property to 0x00 on boot, the host can use this property to detect power cycles or resets using a polling method. To implement this, the host should read the value on a set schedule (for example, every 2 seconds). If the host finds a value of 0x00, a power cycle or reset has occurred, and the host should set the value back to 0x01. From that point until the next power cycle or reset, the value will remain 0x01.

Changes made to this property will not persist after a power cycle or reset. After a power cycle or reset, this property has a value of 0x00 until the host changes it to 0x01.

The host can use this property to control behavior of the Device Reset Will Occur Soon

notification in Notification 0x1001 - Device Information Update.

See 24 Hour Automatic Reset PCI Requirement for more information.

Changes to this property do not take effect until the device is power cycled or reset.

This property controls the device’s auto reset feature. The auto reset feature can be configured such that the device automatically resets 23 hours after booting up or at a specific time of day. Or device can be configured to enter a restricted mode after 24 hours without a reset or power down. When device enters restricted mode it will respond to first command received with Response Message - Request Handler: Group 0x02, Subgroup 0x01, Code 0x1D. Device then sends Notification 0x1001 – Device Information Update: Category 0x00, Reason 0x01 - Reset will occur soon. Device will then auto reset. The auto-reset feature cannot be disabled.

See 24 Hour Automatic Reset PCI Requirement for more information.

Changes to this property do not take effect until the device is power cycled or reset.

Description

The host can use this property to enable notification reasons defined in Notification 0x1001 - Device Information Update in the User Events Category. Each bit enables a specific Reason by setting that bit to 1. Byte 0 is the first byte, bit 0 is the LSB of each byte.

The device only detects these user events and sends these notifications when it is idle. While processing a command (not idle), such as when processing a transaction with Command 0x1001 - Start Transaction, the device only sends notifications related to the command it is currently processing.

Notification reasons may consume power when idle. For example, enabling Contactless reasons requires the device to continuously consume some radio frequency power to detect the presence of a contactless card when idle. To conserve power, only enable the notification reasons that are required by the solution design, if any. The readers and their associated notifications will be disabled if the battery charge is 5 percent or lower.

Changes to this property do not take effect until the device is power cycled or reset.

This parameter defines the number of seconds the device waits for the host to take action (by sending Command 0x1001 - Start Transaction) after the device sends Notification 0x1001 - Device Information Update to report a User Event / Card Swiped event.

After this period of time passes, the device erases the buffered card data from memory.

Changes to this property do not take effect until the device is power cycled or reset.

This OID has been deprecated. The OID can be written or read but it will have no effect of the device’s behavior.

The host can use this property to control the maximum charge level for the battery. All charge percentages reported or displayed will use this percentage as 100% charged.

Setting this value to lower than 0x64 (100%) will increase the life of the battery but reduce the run time when running from the battery.

The Maximum Battery Charge Level takes effect immediately after the host changes it.

While the device’s temperature is outside of the range defined by Device Low Temperature Notification Level (1.2.7.1.4.1) and Device High Temperature Notification Level (1.2.7.1.4.2), notifications will be sent to the host. This property sets the period between notifications.

The Device Temperature Notification Repeat Interval takes effect immediately after the host changes it.

First byte 0 - 23 hours and second byte 0 - 59 minutes = Reset at the time of day specified. The time of day specified should be 24-hour Universal Time Coordinated (UTC). For example, values of 0 0 would be 12:00am UTC and values of 23 59 (0x17 0x3B) would be 11:59pm UTC.

First byte 0xFF and second byte 0xFF = Auto reset 23 hours after booting up. First byte 0xEE and second byte 0xEE = Device enters Restricted Mode 24 hours after booting up.

Valid Values

Byte 0

· bit 0 = Reason: Contactless Card Presented

· bit 1 = Reason: Contactless Card Removed

· bit 2 = Reason: Card Seated in Slot

· bit 3 = Reason: Card Unseated from Slot

· bit 4 = Reason: Card Swiped

· bit 5 = Reason: Touch Sensor Press Detected

· bit 6 = Reason: Touch Sensor Release Detected

· bit 7 = Reason: Barcode Read Detected

Byte 1

· bit 0 = Reason: Encrypt Barcode Reader Event Data

· bit 1 = Reserved (set to 0x00)

· etc.

Byte 2

· bit 0 = Reserved (set to 0x00)

· etc.

Byte 3

· bit 0 = Reserved (set to 0x00)

· etc.

Any byte / bit not listed here is reserved for future use. The host should set those values to 0, so if a future revision of firmware starts using those bits, the related notifications will be disabled and will not affect the existing host software.

Byte 0 - bit 0: Code128

Byte 0 - bit 1: GS1-128 (UCC/EAN-128)

Byte 0 - bit 2: EAN-8

Byte 0 - bit 3: EAN-13

Byte 0 - bit 4: UPC-E

Byte 0 - bit 5: UPC-A

Byte 0 - bit 6: Interleaved 2 of 5

Byte 0 - bit 7: ITF-14

Byte 1 - bit 0: ITF-6

Byte 1 - bit 1: Matrix 2 of 5

Byte 1 - bit 2: Code 39, Code 32

Byte 1 - bit 3: Codabar

Byte 1 - bit 4: Code 93

Byte 1 - bit 5: AIM 128

Byte 1 - bit 6: ISSN

Byte 1 - bit 7: ISBN

Byte 2 - bit 0: Industrial 25

Byte 2 - bit 1: Standard 25

Byte 2 - bit 2: Plessey

Byte 2 - bit 3: Code 11

Byte 2 - bit 4: MSI Plessey

Byte 2 - bit 5: GS1 Databar (RSS)

Byte 2 - bit 6: PDF417

Byte 2 - bit 7: QR Code

Byte 3 - bit 0: Aztec

Byte 3 - bit 1: Data Matrix

Byte 3 - bit 2: Micro QR

1.2.1.nnn - Transaction Settings - A

Device-Driven Fallback Behavior (MSR Only) - Property 1.2.1.1.1.1

Property Description

Property OID

1.2.1.1.1.1 / 0x010201010101

Name

Device-Driven Fallback Behavior

The device uses this property to set 16-byte of the 2keys 3DES for MIFARE Ultralight C authentication.

On an example of Key1 = 0001020304050607h and Key2 = 08090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 3-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES_DataProtKey for MIFARE Ultralight AES authentication.

On an example of ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES UIDRetrKey for MIFARE Ultralight AES authentication.

On an example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

The device uses this property to set 16-byte of the AES OriginalityKey for MIFARE Ultralight AES.

On an example of the ASE Key = 000102030405060708090A0B0C0D0E0Fh, the setting should be 000102030405060708090A0B0C0D0E0F

For security, the Get request for this property will always return 4-MSB of KCV. This key will be encrypted and stored in KPM.

Valid Values

0x00 –Card Preference.

The device automatically chooses the application that is mutually supported by the card and the terminal, based on the priority order specified by the card. This is the default and is standard EMV transaction flow behavior.

0x01 – Reserved 0x02 – Reserved

0x03 – Enhanced Prompt Cardholder.

The device sends the host Notification 0x1803 – 02 02 00 00 (Display Cardholder, Data Attached, Reserved) to request that the cardholder select from a list of available applications. Each application may include additional tags such as - priority indicator, Issuer Country Code and Issuer Identification Number. After the cardholder selects an application, the host passes the selection to the device using Command 0x1802 - Report Cardholder Selection to device to return the cardholder’s selection to the device.

Note that if the device is configured to use this option, the cardholder must hold the card or contactless payment device in contact with the device for until cardholder application selection is complete, otherwise the device will report the transaction failed. For this reason, MagTek does not recommend using this setting.

1.2.2.1.nn - WLAN Settings (WLAN Only) - A

Certificate Expiring Soon Notification Threshold - Property 1.2.2.1.1.B

1.2.5.nnn - Security Settings - A

1.2.5.2.1.1 - Device Lock State

1.2.5.nnn - Security Settings - A

1.2.5.2.1.1 - Device Lock State

Get Request Example

Get Response Example

Set Request Example

Set Response Example

1.2.5.2.1.2 - Device Lock State After Reset

Get Request Example

Get Response Example

Set Request Example

Set Response Example

1.2.5.2.1.3 - Device Lock Passcode

Get Request Example

Get Response Example

Set Request Example

Set Response Example

1.2.2.1.nn - WLAN Settings (WLAN Only) - A

Certificate Expiring Soon Notification Threshold - Property 1.2.2.1.1.B

Certificate Expiring Soon Notification Threshold - Get Request Example

Certificate Expiring Soon Notification Threshold - Get Response Example

Certificate Expiring Soon Notification Threshold - Set Request Example

Certificate Expiring Soon Notification Threshold - Set Response Example

Username - Property 1.2.2.1.1.C

Username - Get Request Example

Username - Get Response Example

Username - Set Request Example

Username - Set Response Example

SoftAP IP Address - Property 1.2.2.1.1.D

SoftAP IP Address - Get Request Example

SoftAP IP Address - Get Response Example

SoftAP IP Address - Set Request Example

SoftAP IP Address - Set Response Example

WLAN Protocol - Property 1.2.2.1.2.11

WLAN Protocol - Get Request Example

WLAN Protocol - Get Response Example

WLAN Protocol - Set Request Example

WLAN Protocol - Set Response Example

WLAN Disable - Property 1.2.2.1.1.12

WLAN Disable - Get Request Example

WLAN Disable - Get Response Example

WLAN Disable - Set Request Example

Table WSWA-25 - WLAN Disable - Set Response Example

MQTT Broker Address - Property 1.2.2.1.2.1

MQTT Broker Address - Get Request Example

MQTT Broker Address - Get Response Example

MQTT Broker Address - Set Request Example

MQTT Broker Address - Set Response Example

MQTT Port - Property 1.2.2.1.2.2

MQTT Port - Get Request Example

MQTT Port - Get Response Example

MQTT Port - Set Request Example

MQTT Port - Set Response Example

MQTT QoS Quality of Service - Property 1.2.2.1.2.3

MQTT QoS Quality of Service - Get Request Example

MQTT QoS Quality of Service - Get Response Example

MQTT QoS Quality of Service - Set Request Example

MQTT QoS Quality of Service - Set Response Example

1.2.2.2.nn - USB Settings (USB Only)

Reduce Power During USB Suspend - Property 1.2.2.2.1.1

Reduce Power During USB Suspend - Get Request Example

Reduce Power During USB Suspend - Get Response Example

Reduce Power During USB Suspend - Set Request Example

Reduce Power During USB Suspend - Set Response Example

USB Configuration Type - Property 1.2.2.2.1.2

USB Configuration Type - Get Request Example

USB Configuration Type - Get Response Example (HID only)

USB Configuration Type - Set Request Example (HID only)

USB Configuration Type - Set Response Example (HID only)

USB Configuration Type - Set Request Example (iAP2 only)

USB Configuration Type - Set Response Example (iAP2 only)

USB Configuration Type - Set Request Example (autodetect (iAP2 with HID fallback))

USB Configuration Type - Set Response Example (autodetect (iAP2 with HID fallback))

Battery Charging Mode - Property 1.2.2.2.1.3

Battery Charging Mode - Get Request Example

Battery Charging Mode - Get Response Example

Battery Charging Mode - Set Request Example