DigiClock Unit
===============

.. include:: ../refs/unit.digi_clock.ref

UNIT-Digi-Clock is a 2.1 inch 4-digit 7-segment display module. There are
decimal points on each digit and an extra wire for colon-dots in the center,
which can display Decimals and Clock. This module adopts TM1637 as the driver
IC, and STM32F030 as I2C communication. I2C address can be modified per 4-bit
dip switch. The red LED supports 8 brightness. And we have reserved 4 fixing
holes there.


Support the following products:

    |DigiClockUnit|


Micropython Example:

    .. literalinclude:: ../../../examples/unit/digi_clock/cores3_digi_clock_example.py
        :language: python
        :linenos:


UIFLOW2 Example:

    |example.png|


.. only:: builder_html

    |cores3_digi_clock_example.m5f2|


class DigiClockUnit
-------------------

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

.. class:: DigiClockUnit(i2c: I2C, address: int | list | tuple = 0x30)

    Initialize the DigiClockUnit.

    :param I2C i2c: I2C port to use.
    :param int | list | tuple address: I2C address of the DigiClockUnit.

    UIFLOW2:

        |init.png|


Methods
-------

.. method:: DigiClockUnit.clear() -> None

    Clear the display.

    UIFLOW2:

        |clear.png|


.. method:: DigiClockUnit.set_brightness(brightness: int) -> None

    Set the brightness of the display.

    :param int brightness: The brightness of the display, range from 0 to 8.

    UIFLOW2:

        |set_brightness.png|


.. method:: DigiClockUnit.set_raw(data: int, index: int) -> None

    Write raw data to the display.

    :param int data: The data to write.
    :param int index: The index of the data, range from 0 to 4.

    UIFLOW2:

        |set_raw.png|


.. method:: DigiClockUnit.set_char(char: str, index: int) -> None

    Write a character to the display.

    :param str char: The character to write.
    :param int index: The index of the character, range from 0 to 4.

    UIFLOW2:

        |set_char.png|


.. method:: DigiClockUnit.set_string(string: str) -> None

    Write a string to the display.

    :param str string: The string to write.

    UIFLOW2:

        |set_string.png|


.. method:: DigiClockUnit.get_fw_version() -> int

    Get the firmware version of the DigiClockUnit.

    :return: The firmware version.

    UIFLOW2:

        |get_fw_version.png|