QRCode Module 
============================

.. sku:  

.. include:: ../refs/module.qrcode.ref

This library is the driver for Module13.2 QRCode, and the module communicates via UART.

Support the following products:

    |Module13.2 QRCode|

UiFlow2 Example:
--------------------------

QRCode Scan in Continuous Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Open the |cores3_qrcode_continuous_mode_example.m5f2| project in UiFlow2.

In **Continuous Mode**, pressing the button once starts decoding, and pressing the button again stops decoding.

UiFlow2 Code Block:

    |cores3_qrcode_continuous_mode_example.png|

Example output:

    None

QRCode Scan in Auto Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Open the |cores3_qrcode_auto_mode_example.m5f2| project in UiFlow2.

In **Auto Mode**, the module starts decoding when powered on and cannot be stopped.

UiFlow2 Code Block:

    |cores3_qrcode_auto_mode_example.png|

Example output:

    None

QRCode Scan in Pulse Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Open the |cores3_qrcode_pulse_mode_example.m5f2| project in UiFlow2.

In **Pulse Mode**, set the TRIG pin to hold a low level for more than 20ms to trigger decoding once.

UiFlow2 Code Block:

    |cores3_qrcode_pulse_mode_example.png|

Example output:

    None

QRCode Scan in Motion Sensing Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Open the |cores3_qrcode_motion_sensing_mode_example.m5f2| project in UiFlow2.

In **Motion Sensing Mode**, the module automatically triggers decoding when it detects a change in the scene based on visual recognition information.

UiFlow2 Code Block:

    |cores3_qrcode_motion_sensing_mode_example.png|

Example output:

    None

MicroPython Example:
--------------------------

QRCode Scan in Continuous Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In **Continuous Mode**, pressing the button once starts decoding, and pressing the button again stops decoding.

MicroPython Code Block:

    .. literalinclude:: ../../../examples/module/qrcode/cores3_qrcode_continuous_mode_example.py
        :language: python
        :linenos:

Example output:

    None

QRCode Scan in Auto Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In **Auto Mode**, the module starts decoding when powered on and cannot be stopped.

MicroPython Code Block:

    .. literalinclude:: ../../../examples/module/qrcode/cores3_qrcode_auto_mode_example.py
        :language: python
        :linenos:

Example output:

    None

QRCode Scan in Pulse Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In **Pulse Mode**, set the TRIG pin to hold a low level for more than 20ms to trigger decoding once.

MicroPython Code Block:

    .. literalinclude:: ../../../examples/module/qrcode/cores3_qrcode_pulse_mode_example.py
        :language: python
        :linenos:

Example output:

    None

QRCode Scan in Motion Sensing Mode
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In **Motion Sensing Mode**, the module automatically triggers decoding when it detects a change in the scene based on visual recognition information.

MicroPython Code Block:

    .. literalinclude:: ../../../examples/module/qrcode/cores3_qrcode_motion_sensing_mode_example.py
        :language: python
        :linenos:

Example output:

    None

**API**
--------------------------

QRCodeModule
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
.. class:: module.qrcode.QRCodeModule

    Create an QRCodeModule object.

    :param int id: UART id.
    :param int tx: the UART TX pin.
    :param int rx: the UART RX pin.
    
    UiFlow2 Code Block:

        |init.png|

    MicroPython Code Block:

        .. code-block:: python

            from module import ModuleQRCode

            module_qrcode = ModuleQRCode(id = 1, tx = 17, rx = 18)

    .. method:: set_power(enable)

        Set power.  

        :param bool enable: 
        
            - ``True`` : power on.  
            - ``False`` : power off.  

        UiFlow2 Code Block:

            |set_power.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_power(enable) 
                
    .. method:: set_trig(value)

        Set trigger pin value.  

        :param int value: 
        
            - ``0`` : low level.  
            - ``1`` : high level.  

        UiFlow2 Code Block:

            |set_trig.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_trig(value) 

    .. method:: start_decode()

        Start decode. 

        UiFlow2 Code Block:

            |start_decode.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.start_decode() 

    .. method:: stop_decode()

        Stop decode. 

        UiFlow2 Code Block:

            |stop_decode.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.stop_decode() 

    .. method:: read()

        Read decode data.

        :returns: qrcode data.
        :rtype: None | bytes

        If no data is received, return None.

        UiFlow2 Code Block:

            |read.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.read()

    .. method:: set_trigger_mode(mode)

        Set trigger mode. 

        :param int mode: The trigger mode. Available options:

            - ``TRIGGER_MODE_KEY``: Key Mode, Triggers a single decode; decoding stops after a successful read.
            - ``TRIGGER_MODE_CONTINUOUS``: Continuous Mode, Triggers continuous decoding; decoding continues even after a successful read and stops only when triggered again.
            - ``TRIGGER_MODE_AUTO``: Auto Mode, Performs continuous decoding upon power-up and cannot be stopped.
            - ``TRIGGER_MODE_PULSE``: Pulse Mode, The Trig pin's low-level signal triggers decoding, which stops after a successful read or when the single read time limit is reached.
            - ``TRIGGER_MODE_MOTION_SENSING``: Motion Sensing Mode, Uses image recognition; decoding starts when a scene change is detected.

        UiFlow2 Code Block:

            |set_trigger_mode.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_trigger_mode(mode)

    .. method:: set_decode_delay(delay_ms)

        Set decode delay.  

        :param int delay_ms: decode delay time(ms), 0 means continuous decoding until success.

        UiFlow2 Code Block:

            |set_decode_delay.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_decode_delay(delay_ms)

    .. method:: set_trigger_timeout(timeout_ms) 

        Set trigger timeout. 

        :param timeout_ms: trigger timeout time(ms), Decoding will automatically stop when the duration exceeds this value.

        UiFlow2 Code Block:

            |set_trigger_timeout.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_trigger_timeout(timeout_ms)

    .. method:: set_motion_sensitivity(level)

        Set motion detection sensitivity. (in Motion Sensing Mode)

        :param int level: sensitivity level. Range: 1~5. The higher the level, the more sensitive it is to scene changes. 

        UiFlow2 Code Block:

            |set_motion_sensitivity.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_motion_sensitivity(level)

    .. method:: set_continuous_decode_delay(delay_100ms)  

        Set continuous decode delay. (in Motion Sensing Mode) 

        :param int delay_ms: delay time(unit: 100ms), 0 means continuous decoding until timeout.

        UiFlow2 Code Block:

            |set_continuous_decode_delay.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_continuous_decode_delay(delay_ms)

    .. method:: set_trigger_decode_delay(delay_ms):

        Set trigger decode delay. (in Motion Sensing Mode)  

        Sets the trigger decoding delay time. This is the delay between re-entering the scene change detection phase and starting recognition again after detecting a change.

        :param int delay_ms: Trigger decode delay time(unit: ms).

        UiFlow2 Code Block:

            |set_trigger_decode_delay.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_trigger_decode_delay(delay_ms)
 
    .. method:: set_same_code_interval(interval_ms)

        Set same code interval.  

        :param int interval_ms: The interval time for repeated recognition of the same code (unit: ms). 

        UiFlow2 Code Block:

            |set_same_code_interval.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_same_code_interval(interval_ms)

    .. method:: set_diff_code_interval(interval_ms)

        Set difference code interval.  

        :param int interval_ms: The interval time for repeated recognition of the difference code (unit: ms). 

        UiFlow2 Code Block:

            |set_diff_code_interval.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_diff_code_interval(interval_ms)

    .. method:: set_same_code_no_delay(enable)

        Set same code no delay.  

        :param bool enable: Whether to enable non-delay output for the same code. True means enabled, False means disabled. 

        UiFlow2 Code Block:

            |set_same_code_no_delay.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_same_code_no_delay(enable)
 
    .. method:: set_fill_light_mode(mode)

        Set fill light mode. 

        :param int mode: The fill light mode. Available options:

            - ``FILL_LIGHT_OFF``: Light off. 
            - ``FILL_LIGHT_ON``: Light on. 
            - ``FILL_LIGHT_ON_DECODE``: Light on during decoding.   

        UiFlow2 Code Block:

            |set_fill_light_mode.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_fill_light_mode(mode)

    .. method:: set_fill_light_brightness(brightness)

        Set fill light brightness.  

        :param int brightness: The fill light brightness. Range: 0~100. 

        UiFlow2 Code Block:

            |set_fill_light_brightness.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_fill_light_brightness(brightness)

    .. method:: set_pos_light_mode(mode) 

        Set positioning light mode. 

        :param int mode: The positioning light mode. Available options:

            - ``POS_LIGHT_OFF``: Light off.  
            - ``POS_LIGHT_ON_DECODE``: Light on during decoding.  
            - ``POS_LIGHT_FLASH_ON_DECODE``: Light flash during decoding.  

        UiFlow2 Code Block:

            |set_pos_light_mode.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_pos_light_mode(mode)

    .. method:: set_startup_tone(mode)

        Set startup tone. 

        :param int mode: 

            - ``0``: Disable startup tone.  
            - ``1``: Play 4 beeps. 
            - ``2``: Play 2 beeps.  

        UiFlow2 Code Block:

            |set_startup_tone.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_startup_tone(mode)

    .. method:: set_decode_success_beep(count)

        Set decode success beep.  

        :param int count: 

            - ``0``: No prompt sound.  
            - ``1``: Play prompt sound once.  
            - ``2``: Play prompt sound twice.  

        UiFlow2 Code Block:

            |set_decode_success_beep.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_decode_success_beep(count)
 
    .. method:: set_case_conversion(mode)

        Set case conversion.

        :param int mode:

            - ``0``: Off (Original data).
            - ``1``: Convert to uppercase. 
            - ``2``: Convert to lowercase. 

        UiFlow2 Code Block:

            |set_case_conversion.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_case_conversion(mode)
 
        .. method:: set_protocol_format(mode):

    .. method:: set_protocol_format(mode)

        :param int mode:

            - ``0``: No protocol
            - ``1``: Format 1: [0x03] + Data Length (2 bytes) + Data
            - ``2``: Format 2: [0x03] + Data Length + Number of Barcodes + Code 1 Data Length + Code 1 Data + ... + CRC
            - ``3``: Format 3: [0x03] + Data Length + Number of Barcodes + Code 1 ID + Code 1 Data Length + Code 1 Data + ... + CRC

        CRC generate reference program.

            .. code-block:: python

                def crc16_calc(data: bytes) -> int:
                    ca_crc = 0
                    for byte in data:
                        for i in range(7, -1, -1):  
                            if ca_crc & 0x8000:
                                ca_crc = (ca_crc << 1) ^ 0x18005
                            else:
                                ca_crc <<= 1
                            if (byte & (1 << i)) != 0:
                                ca_crc ^= 0x18005
                    return ca_crc & 0xFFFF   

        UiFlow2 Code Block:

            |set_protocol_format.png|

        MicroPython Code Block:

            .. code-block:: python

                module_qrcode.set_protocol_format(mode)