Show Bitmap Image
Command 0x1823 - Show Bitmap Image (Display Only)
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 Property 1.2.3.1.1.1 Custom Idle Page Image.
This command is different from Command 0x1806 – Personal Info Entry.
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 Command 0x1001 - Start Transaction.
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 Notification 0x1805 - User Interface Operation Complete 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.
Table - Request Data for Command 0x1806 – Personal Info Entry
Beginning of any wrappers, at minimum including Request Message (see message wrapper definition)
1806 = Command 0x1806 – Personal Info Entry
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
Table - Response Data for Personal Info Entry
Beginning of any wrappers, at minimum including Response Message (see message wrapper definition)
1806 = Command 0x1806 – Personal Info Entry
No parameters.
Beginning of any wrappers, at minimum including Response Message
If the request started successfully, the Request Status in the message wrapper is OK, Started / Running (All good / requested operation was successful).
Table - Request Example
Table - Response Example
Command 0x1823 - Show Bitmap Image (Display Only) differs from Command 0x1821 - Show Image (Display Only) 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:
Step: Display placement and timing
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.
Table - Request Data for Command 0x1823 - Show Bitmap Image (Display Only)
Beginning of any wrappers, at minimum including Request Message
1823 = Command 0x1823 - Show Bitmap Image (Display Only)
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 Property 1.2.3.1.1.2 Custom Idle Page Image Device Locked (Display Only). 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 Property 1.2.3.1.1.2 Custom Idle Page Image Device Locked (Display Only). 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
Table - Response Data for Command 0x1823 - Show Bitmap Image (Display Only)
1823 = Command 0x1823 - Show Bitmap Image (Display Only)
No parameters.
If the request started successfully, the Request Status in the message wrapper is All Good, Requested Operation Was Successful.
Table - Request Example (Hex)
Table - Response Example
Table - Notification Example (Hex)
Last updated