FlashLight Unit
================

.. include:: ../refs/unit.flash_light.ref


FlashLight UNIT is an I/O Unit with built-in flash, including AW3641 driver and
a white LED, with a color temperature of 5000-5700K. There is a mode selection
switch on the board, which can set the flash mode and the constant lighting
mode. The communication interface is GPIO. This Unit can be used as a flash or
lighting applications.


Support the following products:

    |FlashLightUnit|


Micropython Example:

    .. literalinclude:: ../../../examples/unit/flashlight/cores3_flashlight_example.py
        :language: python
        :linenos:


UIFLOW2 Example:

    |example.png|


.. only:: builder_html

    |cores3_flashlight_example.m5f2|


class FlashLightUnit
--------------------

Constructors
------------

.. class:: FlashLightUnit(port)

    Initialize the FlashLightUnit.

    :param port: The port to which the FlashLightUnit is connected. port[0]: adc pin, port[1]: pump pin.

    UIFLOW2:

        |init.png|


Methods
-------

.. method:: FlashLightUnit.flash(brightness: int, time: int, turn_off=False) -> None

    Flash the light.

    :param brightness: The brightness of the light.

        Options:

            - ``FlashLightUnit.BRIGHTNESS_100``: 100%
            - ``FlashLightUnit.BRIGHTNESS_90``: 90%
            - ``FlashLightUnit.BRIGHTNESS_80``: 80%
            - ``FlashLightUnit.BRIGHTNESS_70``: 70%
            - ``FlashLightUnit.BRIGHTNESS_60``: 60%
            - ``FlashLightUnit.BRIGHTNESS_50``: 50%
            - ``FlashLightUnit.BRIGHTNESS_40``: 40%
            - ``FlashLightUnit.BRIGHTNESS_30``: 30%

    :param time: The time of the light.

        Options:

            - ``FlashLightUnit.TIME_220MS``: 220ms
            - ``FlashLightUnit.TIME_1300MS``: 1300ms

    :param turn_off: Turn off the light after flash.

    UIFLOW2:

        |flash.png|