Command 0X04 - Set Key Map Item - Magtek MICRSafe Technical Reference Manual

5 - USB Communication

5.1.11 Command 0x04 - Set Key Map Item

Command number:
The host uses this command to set a key map item in the device's active key map. For information about
the key map, see Command 0x03 - Get Key Map Item.
After the host modifies a key map item, the changes take effect immediately. However, to make the
changes permanent, the host must send Command 0x05 - Save Custom Key Map. To use the new
custom key map after a reset or power cycle, the host must set Property 0x11 - Active Key Map to
custom.
Request Data
Offset Field Name
0 ASCII value
1 Key Usage ID
2 Key Modifier Byte
Response Data: None
Result codes: 0 (success)
The following example maps the card ASCII data end sentinel character '?' to the '>' keyboard key.
Example Request (Hex):
Cmd Num
04
Example Response (Hex):
Result Code
00
MICRSafe| Check Reader and Magnetic Stripe Reader | Technical Reference Manual
4
Value of the ASCII character to be set in the key map. This
can be any value between 0 and 127 (0x7F). For example, to
set the key map item for ASCII character '?' (card data end
sentinel) use the ASCII value of '?' which is 63 (0x3F).
The value of the USB key usage ID that is to be mapped to
the given ASCII value. For example, for the United States
keyboard map, usage ID 56 (0x38) (keyboard / and ?) is
mapped to ASCII character '?'. To change this to the ASCII
character '>' use usage ID 55 (0x37) (keyboard . and >).
The value of the USB key modifier byte that is to be mapped
to the given ASCII value. For example, for the United States
keyboard map, modifier byte 0x02 (left shift key) is mapped
to ASCII character '?'. To change this to the ASCII character
'>' use modifier byte 0x02 (left shift key).
Data Len
03
Data Len
00
Page 43 of 83 (D99875466-33)
Description
3F 37 02
Data
Data