Generating QR Codes for Afero Products

This page contains instructions for generating QR codes for:

QR Codes for ASR-1 Modules

The QR code encodes only one piece of information: the ASR-1 Association ID.

About the ASR-1 Association ID

  • Association ID size: 6 bytes
  • Character encoding for QR code: HEX
  • Number of characters (after encoding): 12

Here is an example of one Association ID in its various formats:

  • Binary: 0001 0010 0011 0100 0101 0110 0001 0010 0011 0100 0101 0110
  • Hex: 0x123456123456
  • Formatted for printing as plain-text: 1234-5612-3456

Label Printing

Every label must include the following two pieces of information: 1) the QR code, and 2) a plain-text version of the Association ID. The code can optionally include other information, such as an FCC ID.

  1. QR Code Generation  The following parameters should be used when generating a QR code:
    • Version: 1 (21x21)
    • Error Connection: Q (quartile)
    • Input Mode: Alphanumeric
  2. Plain-Text Association ID  The plain-text Association ID is used for manual-entry of the Association ID by a user in the case that the QR code is unusable (e.g., QR code is damaged, camera on phone is not working). The plain-text Association ID consists of the 12 characters of the hex-encoded Association ID broken into three distinct four-character blocks. Each character block is separated by a hyphen.
    • Association ID (hex): 0x123456123456
    • Association ID (formatted for printing as plain-text): 1234-5612-3456
    • Font Type: Monospaced (such as Consolas or Courier) for all Association ID characters. A proportional font (such as Times New Roman) may be used for the hyphens.

Examples

Example QR Codes for ASR-1

QR Codes for Modulo-2

The QR code for an Afero enabled device contains three pieces of information:

  • Payload Version Number
  • Association ID
  • Device ID

There is a colon delimiter character (:) between each piece of information. We will refer to these three pieces of information (including the delimiters) as the “Payload”.

QR Payload Details

Data Size (bytes) Data Encoding within Payload Number of Alphanumeric Characters
(after encoding)
Example Data Notes
Payload Version Number 0.5
(4 bits)
HEXIDECIMAL 1 1 The only valid Payload Version Number is 1. Other values are reserved for future use and are not valid.
Association ID 12 HEXIDECIMAL 24 ABCDEF1234567890ABCDEF12
Device ID 8 HEXIDECIMAL 16 1234567890ABCDEF

QR Code Details

When using the Payload to generate a QR code, the following QR code parameters should be used. (Additional information about QR codes can be found at https://en.wikipedia.org/wiki/QR_code.)

Parameter Required Value Notes
QR Code Version 3 Version 3 QR codes are 29x29 modules in size.
Error Correction Q Quartile-level error correction allows for 25% of the codewords to be restored.
Input Mode Alphanumeric Supports all hex-encoded characters (0-9, A-F) as well as the colon (:) delimiter.
QR Code Minimum Print Dimensions (excluding border) 17.19 x 17.19mm The minimum printed dimensions ensures high-reliability scanning by a variety of mobile phone cameras in differing light conditions. The minimum dimensions of 17.19mm2 has a size of 0.593mm2 per module within the QR code.
Minimum QR Border Thickness 0.593mm Best practice is to leave a border around the QR code that is at least one module thick. In the case of a QR code that is 17.19mm2, each module within the QR code is 0.593mm2; therefore, the minimum border thickness around the QR code should also be 0.593mm.

Plain-Text Association ID

In addition to a QR code (containing the Payload) each label is also required to contain a plain-text version of the Association ID. This can be used for manual-entry by a user in the case that the QR code is unusable (e.g., QR code is damaged, camera on phone is not working). The plain-text ID consists of the 24 characters of the hex-encoded Association ID broken up into six distinct four-character blocks. Each character block is separated by a hyphen.

  • Association ID (formatted for printing as plain-text): ABCD-EF12-3456-7890-ABCD-EF12
  • Font Type: Monospaced (such as Consolas or Courier) for all Association ID characters. A proportional font (such as Times New Roman) may be used for the hyphens.

Examples

Example QR Payload 1:ABCDEF1234567890ABCDEF12:1234567890ABCDEF
Example QR Code Example QR Code
Example Plain Text Association ID ABCD-EF12-3456-7890-ABCD-EF12
Example Label Example Label