Module: Toybox.ScanCode

Overview

The ScanCode module provides functionality to for generating machine readable code images.

Since:

API Level 6.0.0

Constant Summary

QrCodeEcc

Since:

API Level 6.0.0

Name	Value	Since	Description
QR_CODE_ECC_LOW	0	API Level 6.0.0	Tolerate up to 7% error
QR_CODE_ECC_MEDIUM	1	API Level 6.0.0	Tolerate up to 15% error
QR_CODE_ECC_QUARTILE	2	API Level 6.0.0	Tolerate up to 25% error
QR_CODE_ECC_HIGH	3	API Level 6.0.0	Tolerate up to 30% error

QrCodeMask

Since:

API Level 6.0.0

Name	Value	Since	Description
QR_CODE_MASK_AUTO	-1	API Level 6.0.0
QR_CODE_MASK_0	0	API Level 6.0.0
QR_CODE_MASK_1	1	API Level 6.0.0
QR_CODE_MASK_2	2	API Level 6.0.0
QR_CODE_MASK_3	3	API Level 6.0.0
QR_CODE_MASK_4	4	API Level 6.0.0
QR_CODE_MASK_5	5	API Level 6.0.0
QR_CODE_MASK_6	6	API Level 6.0.0
QR_CODE_MASK_7	7	API Level 6.0.0

Typedef Summary

• QrCodeOptions as { :minVersion as Lang.Number, :maxVersion as Lang.Number, :maskValue as ScanCode.QrCodeMask, :color as Graphics.ColorType, :backgroundColor as Graphics.ColorType }
• QrCodeValue as Lang.ByteArray or Lang.String or Lang.Array<Lang.ByteArray or Lang.String>

Instance Method Summary

• createQrCodeImage(value as ScanCode.QrCodeValue, ecc as ScanCode.QrCodeEcc, imageSize as Lang.Number, options as ScanCode.QrCodeOptions or Null) as Graphics.BufferedBitmap

  Create a Quick Response Code image.

Typedef Details

QrCodeOptions as { :minVersion as Lang.Number, :maxVersion as Lang.Number, :maskValue as ScanCode.QrCodeMask, :color as Graphics.ColorType, :backgroundColor as Graphics.ColorType }

Since:

API Level 6.0.0

QrCodeValue as Lang.ByteArray or Lang.String or Lang.Array<Lang.ByteArray or Lang.String>

Since:

API Level 6.0.0

Instance Method Details

createQrCodeImage(value as ScanCode.QrCodeValue, ecc as ScanCode.QrCodeEcc, imageSize as Lang.Number, options as ScanCode.QrCodeOptions or Null) as Graphics.BufferedBitmap

Create a Quick Response Code image

Parameters:

• value — (Lang.String, Lang.ByteArray, Lang.Array) —

  The value(s) to encode in the QR code image

• ecc — (ScanCode.QrCodeEcc) —

  The error correction level

• imageSize — (Lang.Number) —

  The width and height of the resulting QR code image in pixels.

• options — (Lang.Dictionary) —

  Dictionary of options.

  • :minVersion — (Lang.Number) —

    The minimum QR code version. Default is 1.

  • :maxVersion — (Lang.Number) —

    The maximum QR code version. Default is 40.

  • :maskValue — (ScanCode.QrCodeMask) —

    The mask value. Default is QR_CODE_MASK_AUTO.

  • :color — (Graphics.ColorType) —

    The foreground color. Default is COLOR_BLACK.

  • :backgroundColor — (Graphics.ColorType) —

    The background color. Default is COLOR_WHITE.

Returns:

• Graphics.BufferedBitmap —

  A bitmap containing the QR code image

Since:

API Level 6.0.0

Throws:

• (Lang.InvalidOptionsException) —

  Thrown if an option or parameter is invalid.

• (Lang.ValueOutOfBoundsException) —

  Thrown if an option or parameter value is out of bounds.

• (Lang.UnexpectedTypeException) —

  Thrown if an option or parameter is an unexpected type.

• (Graphics.OutOfGraphicsMemoryException) —

  Thrown if insufficient graphics memory is available for the resulting image.