The host uses this command to trigger the device to immediately show a bitmap file the host includes as a parameter, provided the device is not in a mode that has exclusive use of the display (such as during a transaction).
This is an immediate and temporary directive. For a solution that affects the device’s idle page behavior on a more permanent basis, see Custom Idle Page Image - Property 1.2.3.1.1.1.
This command is different from Personal Info Entry - Command 0x1806.
The host uses Command 0x1806 to prompt a cardholder for customer information.
The sequence of events for Command 0x1806 is:
The host ensures the device is not currently running another command, for example, that it is not running a transaction using Start Transaction - Command 0x1001.
If the host determines it should request customer information, it composes a command request in the format below.
The device presents a keypad interface to the cardholder on the display.
The device sends User Interface Operation Complete - Notification 0x1805 to the host to report data available, or hardware failure.
If the device reported data available, the host can retrieve the data as defined in the Notification Detail Codes and Notification Payload for Personal Info Entry.
Response Data for Personal Info Entry
If the request started successfully, the Request Status in the message wrapper is OK, Started / Running (All good / requested operation was successful).
Show Bitmap Image (Display Only) - Command 0x1823 differs from Show Image (Display Only) - Command 0x1821 in that the host sends bitmaps as parameters instead of pre-loading them, and the host can call this command multiple times without clearing the display to show multiple bitmaps on the display at the same time.
The sequence of events for Command 0x1823 is:
The host ensures the device is not currently running another command, for example, that it is not running a transaction using Start Transaction - Command 0x1001.
The host selects a bitmap file it wants to display.
The host composes a command request in the format below and sends it to the device.
If the request started successfully, the Request Status in the message wrapper is All Good, Requested Operation Was Successful.
1806 = Personal Info Entry - Command 0x1806
81
01
Capture Type: 0x01 = Phone Number; 0x02 = Social; 0x03 = Zip code; 0x04 = Employee ID; 0x05 = Birth Date (USA format); 0xFF = Cancel Capture
B
R
Beginning of any wrappers, at minimum including Request Message
1806 = Personal Info Entry - Command 0x1806
No parameters.
Beginning of any wrappers, at minimum including Response Message
The device shows the bitmap with the upper left corner at the specified X Position and Y Position. If the host omits either parameter, the device centers the bitmap along the unspecified axis.
If the Display Time parameter is Indefinite or is not included, the device returns a command response message with Response Status, Operation Status Summary byte set to 0x00 (OK, Done) after which the host is free to send further commands.
If the timeout parameter is set to a specific number of seconds:
The device returns a command response message with its Response Status, Operation Status Summary byte set to 0x01 (OK, Started / Running).
While the host is waiting for the timeout to expire, it should not send any commands to the device, because the device is busy processing the current command.
After the timeout period expires, the device unlocks to allow other commands and sends Notification 0x1805 - User Interface Operation Complete to inform the host.
1823 = Show Bitmap Image (Display Only) - Command 0x1823
81
01
Display Time: 0x00 = Indefinite; 0x01 to 0xFF = 1 to 255 seconds
B
O
0x00
82
03
Background Color. Use RRGGBB format.
B
O
N/A
83
02
X Position.
The device places the left edge of the image at this pixel position relative to the left edge of the display, which is position 0x0000. This parameter plus the pixel width of the image must be less than the pixel width of the display. The display’s pixel width depends on the device’s orientation set by Custom Idle Page Image Device Locked (Display Only) - Property 1.2.3.1.1.2. For information about the resolution of the display, see the specifications in the device’s Installation and Operation Manual.
B
O
Centered
84
02
Y Position.
The device places the top edge of the image at this pixel position relative to the top edge of the display, which is position 0x0000. This parameter plus the pixel height of the image must be less than the pixel height of the display. The display’s pixel height depends on the device’s orientation set by Custom Idle Page Image Device Locked (Display Only) - Property 1.2.3.1.1.2. For information about the resolution of the display, see the specifications in the device’s Installation and Operation Manual.
B
O
Centered
85
var
Bitmap
Image encoded in full BMP file format as defined by Microsoft (e.g., starting with “BM”) or Magtek signed image file format
B
R
86
01
Display Option:
0x00 = Default (cover/uncover the top status bar depends on the current status of the display). If the current display shows the top status bar, the Show Bitmap Image command won’t cover the top status bar. If the current display doesn’t show the top status bar, the Show Bitmap Image command will cover the top status bar.
0x01 = Cover the top status bar regardless of the current status of the display.
0x02 = Not cover the top status bar regardless of the current status of the display.
B
O
0
End of any wrappers, at minimum including Request Message
1823 = Show Bitmap Image (Display Only) - Command 0x1823
No parameters.
End of any wrappers, at minimum including Response Message
Beginning of any wrappers, at minimum including Request Message (see message wrapper definition)
Beginning of any wrappers, at minimum including Response Message (see message wrapper definition)
Beginning of any wrappers, at minimum including Request Message
Beginning of any wrappers, at minimum including Response Message
AA00 810401031806 8405 1806 8101 01AA00 810482031806 8204 01000000AA 00 81 04 01 05 18 22 84 41 18 22 81 01 3C 82 0F 54 68 69 73 20 69 73 20 61 20 74
65 73 74 21 83 01 00 84 01 FF 85 01 01 86 01 28 87 03 00 00 00 88 03 FF FF FF 89 13
50 6c 65 61 73 65 20 73 63 61 6e 20 51 52 20 63 6f 64 65AA 00 81 04 82 2C 18 22 82 04 00 00 00 00AA 00 81 04 83 00 18 05 82 04 02 01 00 00