Properties are stored in flash memory, which inherently has a limited number of read-write cycles before it begins to wear. For this reason, MagTek recommends setting properties as few times as possible over the lifecycle of the device.
The host uses this command to set device configuration / settings that do not require security. For setting properties that require security see Set Property (Secured) - Command 0xD112.
Each data element representing device configuration is part of a tree of values and is uniquely identified by an Object Identifier (also known as an Object ID or OID) as defined in ITU-T X.660 | ISO/IEC 9834-1, which can be found by searching for X.660 in the publications on www.itu.int. This document refers to these data elements collectively as Properties. The list of all properties and their corresponding OIDs and other characteristics is provided in Configuration.
This command can be used in multiple ways. For simplicity, this document describes one possible way that does not require detailed knowledge of the X.660 specification.
To set a property, follow these steps:
1
The host determines which property it wants to set and the value it wants to set in the device (see Configuration).
2
The host composes a command request in the format described below and sends it to the device.
3
The device sends a response in the format described below. If the request succeeded, the response payload is identical to the request payload. If it did not succeed, the device returns a failure response with no command-specific parameters.
Tag
Len
Value / Description
Typ
Req
Default
Tag
Len
Value / Description
Typ
Req
Default
D111 = Set Property (Unsecured) - Command 0xD111
81
var
Company ID This value is the root of the “long form” of the Property OID, and is the same for all MagTek devices. Leave this parameter empty and use the default.
B
O
2B 06 01 04 01 F6 09
82
03
Device Family ID This value is the second portion of the “long form” of the Property OID, and is the same for all similar MagTek devices within the same product family. Unless you have a specific use case that uses this parameter, leave this parameter empty and use the default otherwise your software may not work with multiple products.
Byte 1 Platform
0x02 = Apollo Platform
Byte 2 Product
0x01 = DynaFlex, 0x02 = DynaProx, 0x03 = DynaFlex II PED, 0x04 = DynaFlex II, 0x05 = DynaFlex II Go
B
O
Product dependent
85
01
Property Type This parameter contains the first number of the Property OID as documented in Configuration. - 0x01 = Device Settings - 0x02 = Device Information
B
R
87
var
Property OID Tree Prefix This optional parameter contains subsequent numbers of the Property’s OID as documented in Configuration, but can not include the final number. For simplicity, populate this with the 2nd through the second-to-last number in the property’s OID.
This can also be populated with fewer numbers from the OID, in which case the remaining numbers of the OID must be included in the Property OID Remainder.
B
O
Null
89
var
Property OID Remainder This contains the remaining numbers of the Property’s OID, BER TLV encoded per X.660 section 8 Basic encoding rules. For details about TLV encoding an OID.
For simplicity, include all numbers except the final number of the property’s OID in Property Type and Property OID Tree Prefix, and include the final number of the OID OR 0xC0 here, then append a length corresponding to one of the following, then append the value to set the property to:
If the length of the value you are setting is 0x7F or shorter, include one byte equal to the length of the value.
B
R
End of any wrappers, at minimum including Request Message
D111 = Set Property (Unsecured) - Command 0xD111
81
var
Company ID This contains the Company ID the host included in the request message. If this parameter is not included in the request, the response does not include it.
B
O
N/A
82
03
Device Family ID This contains the Device Family ID the host included in the request message. If this parameter is not included in the request, the response does not include it.
B
O
N/A
85
01
Property Type This contains the Property Type the host included in the request message.
B
R
N/A
87
var
Property OID Tree Prefix This contains the Property OID Tree Prefix the host included in the request message. If this parameter is not included in the request, the response does not include it.
B
O
N/A
89
var
Property OID Remainder This contains the same TLV-encoded portion of the OID the host included in the Property OID Remainder of the request message.
B
R
N/A
End of any wrappers, at minimum including Response Message
Beginning of any wrappers, at minimum including Request Message
Beginning of any wrappers, at minimum including Response Message