For the complete documentation index, see llms.txt. This page is also available as Markdown.

Show QR Code

Command 0x1822 - Show QR Code (Display Only)

The host uses this command to direct the device to immediately show a QR code on the display, provided the device is not in a mode that has exclusive use of the display (such as during a transaction).

1

Prepare and send the request

  • Ensure the device is not currently running another command (for example, not running a transaction such as Command 0x1001 - Start Transaction.

  • Select the data for the QR code to display.

  • Compose a command request in the format described below and send it to the device.

2

Device generates and displays the QR code

  • The device generates and displays the QR code.

  • If the Display Time parameter is set to Indefinite:

    • The device returns a command response message with Response Status, Operation Status Summary byte set to 0x00 (OK, Done). After this response the host is free to send further commands.

  • If the Display Time parameter is set to a 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 report Display / Display Message / Timed Out / Reserved.

Table - Request Data for Command 0x1822 - Show QR Code (Display Only)

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Request Message.

1822 = Command 0x1822 - Show QR Code (Display Only)

81

01

Display Time - 0x00 = Indefinite - 0x01 to 0xFF = 1 to 255 seconds

B

O

0x00

82

var

Data to Encode — See ISO/IEC 18004:2015

B

R

83

01

Error Correction - 0x00 = Low - 0x01 = Medium - 0x02 = Quartile - 0x03 = High See ISO/IEC 18004:2015

B

O

0x00

84

01

Mask Pattern - 0x00 to 0x07 = Mask Pattern - 0xFF = Device Select Optimal Mask Pattern — See ISO/IEC 18004:2015

B

O

0xFF

85

01

Minimum Version — Must be less than or equal to Maximum Version - 0x01 to 0x28 = Version 1 to Version 40 — See ISO/IEC 18004:2015

B

O

0x01

86

01

Maximum Version — Must be greater than or equal to Minimum Version - 0x01 to 0x28 = Version 1 to Version 40

See ISO/IEC 18004:2015

B

O

0x28

87

03

Block Color — Use RRGGBB format.

B

O

0x000000 (Black)

88

03

Background Color — Use RRGGBB format.

B

O

0xFFFFFF (White)

89

var

Prompt

Text for the device to display below the QR code. Because the device shows the Prompt using a proportional font, the maximum length that fits the display depends on the text and the device’s orientation set by Property 1.2.3.1.1.2 Custom Idle Page Image Device Locked (Display Only). In Landscape orientation, the upper limit is approximately 30 characters. In Portrait orientation, the limit is approximately 22 characters.

B

)

No prompt

End of any wrappers, at minimum including Request Message

Table - Response Data for Command 0x1822 - Show QR Code (Display Only)

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Request Message.

1822 = Command 0x1822 - Show QR Code (Display Only)

No parameters

End of any wrappers, at minimum including Request Message

If the request started successfully, the Request Status in the message wrapper is All Good, Requested Operation Was Successful.

Table - Response Example

Table - Notification Example

Last updated