:mod:`qrio`
===========

.. py:module:: qrio

.. autoapi-nested-parse::

   `qrio` module.

   Provides the `QRDecoder` object.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> ATMegaZero ESP32-S2
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit Feather RP2040
    <li> Adafruit FunHouse
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit KB2040
    <li> Adafruit Macropad RP2040
    <li> Adafruit MagTag
    <li> Adafruit Metro ESP32S2
    <li> Adafruit QT Py ESP32S2
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Arduino Nano RP2040 Connect
    <li> Artisense Reference Design RD00
    <li> BastWiFi
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> CrumpS2
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> ESP 12k NodeMCU
    <li> EncoderPad RP2040
    <li> Feather ESP32S2 without PSRAM
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> MORPHEANS MorphESP-240
    <li> Melopero Shake RP2040
    <li> MicroDev microS2
    <li> Oak Dev Tech BREAD2040
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyKey60
    <li> RP2040 Stamp
    <li> Raspberry Pi Pico
    <li> S2Mini
    <li> S2Pico
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Thing Plus - RP2040
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Thingz - Galaxia
    <li> TinyS2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    </ul>
    </details>
    </p>




.. py:class:: PixelPolicy

   .. py:attribute:: EVERY_BYTE
      :annotation: :PixelPolicy

      The input buffer to `QRDecoder.decode` consists of greyscale values in every byte


   .. py:attribute:: EVEN_BYTES
      :annotation: :PixelPolicy

      The input buffer to `QRDecoder.decode` consists of greyscale values in positions 0, 2, …, and ignored bytes in positions 1, 3, ….  This can decode directly from YUV images where the even bytes hold the Y (luminance) data.


   .. py:attribute:: ODD_BYTES
      :annotation: :PixelPolicy

      The input buffer to `QRDecoder.decode` consists of greyscale values in positions 1, 3, …, and ignored bytes in positions 0, 2, ….  This can decode directly from YUV images where the odd bytes hold the Y (luminance) data



.. py:class:: QRDecoder(width: int, height: int)

   
   Construct a QRDecoder object

   :param int width: The pixel width of the image to decode
   :param int height: The pixel height of the image to decode

   .. py:attribute:: width
      :annotation: :int

      The width of image the decoder expects


   .. py:attribute:: height
      :annotation: :int

      The height of image the decoder expects


   .. py:method:: decode(buffer: _typing.ReadableBuffer, pixel_policy: PixelPolicy = PixelPolicy.EVERY_BYTE) -> List[QRInfo]

      Decode zero or more QR codes from the given image.  The size of the buffer must be at least ``length``×``width`` bytes for `EVERY_BYTE`, and 2×``length``×``width`` bytes for `EVEN_BYTES` or `ODD_BYTES`.



.. py:class:: QRInfo

   Information about a decoded QR code

   .. py:attribute:: payload
      :annotation: :bytes

      The content of the QR code


   .. py:attribute:: data_type
      :annotation: :Union[str, int]

      The encoding of the payload as a string (if a standard encoding) or int (if not standard)