adafruit_miniqr

A non-hardware dependant miniature QR generator library. All native Python!

• Author(s): ladyada

Implementation Notes

Hardware:

• Any!

Software and Dependencies:

• Python 3

class adafruit_miniqr.QRBitBuffer

Storage class for a length of individual bits

get(index: int) → int

The bit value at a location

get_length_bits() → int

Size of bit buffer

put(num: int, length: int) → None

Add a number of bits from a single integer value

put_bit(bit: int) → None

Insert one bit at the end of the bit buffer

class adafruit_miniqr.QRBitMatrix(width: int, height: int)

A bit-packed storage class for matrices

class adafruit_miniqr.QRCode(*, qr_type: int | None = None, error_correct: int = 1)

The generator class for QR code matrices

add_data(data: bytes) → None

Add more data to the QR code, must be bytestring stype

make(*, test: bool = False, mask_pattern: int = 0) → None

Perform the actual generation of the QR matrix. To keep things small and speedy we don’t generate all 8 mask patterns and pick the best. Instead, please pass in a desired mask_pattern, the default mask is 0.

class adafruit_miniqr.QRPolynomial(num: int, shift: int)

Structure for creating and manipulating error code polynomials

get(index: int) → int

The exponent at the index location

get_length() → int

Length of the poly

multiply(other_polynomial: QRPolynomial) → QRPolynomial

Multiply two polynomials, returns a new one

class adafruit_miniqr.QRUtil

A selection of bit manipulation tools for QR generation and BCH encoding

static get_BCH_digit(data: int) → int

Count digits in data

static get_BCH_type_info(data: int) → int

Encode with G15 BCH mask

static get_BCH_type_number(data: int) → int

Encode with G18 BCH mask

static get_error_correct_polynomial(ecc_length: int) → QRPolynomial

Generate a ecc polynomial

static get_mask(mask: int, i: int, j: int) → int

Perform matching calculation on two vals for given pattern mask

static get_pattern_position(qr_type: int) → bytes

The mask pattern position array for this QR type