refactor code to module

Author: bablokb

README.rst

@@ -75,7 +75,7 @@ Of course, you must import the library to use it:
 .. code:: python
 
     import busio
-    import adafruit_pcf8563
+    from adafruit_pcf8563.pcf8563 import PCF8563
     import time
 
 All the Adafruit RTC libraries take an instantiated and active I2C object
@@ -98,7 +98,7 @@ the RTC object:
 
 .. code:: python
 
-    rtc = adafruit_pcf8563.PCF8563(i2c_bus)
+    rtc = PCF8563(i2c_bus)
 
 Date and time
 -------------

adafruit_pcf8563/clock.py

@@ -0,0 +1,93 @@
+# SPDX-FileCopyrightText: 2016 Philip R. Moyer and Radomir Dopieralski for Adafruit Industries.
+# SPDX-FileCopyrightText: Copyright (c) 2021 Jeff Epler for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2023 Bernhard Bablok
+#
+# SPDX-License-Identifier: MIT
+
+"""
+`clock` - PCF8563 Clock module
+==============================
+
+This class supports the clkout-feature of the PCF8563-based RTC in CircuitPython.
+
+Functions are included for reading and writing registers to configure
+clklout frequency.
+
+The class supports stand-alone usage. In this case, pass an i2-bus object
+to the constructor. If used together with the PCF8563 class (rtc), instantiate
+the rtc-object first and then pass the i2c_device attribute of the rtc
+to the constructor of the clock.
+
+Author(s): Bernhard Bablok
+Date: March 2023
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Seeeduino XIAO Expansion Board <https://www.adafruit.com/product/5033>`_
+  - Works With Adafruit QT Py (Product ID: 5033)
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware: https://github.com/adafruit/circuitpython/releases
+* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+
+**Notes:**
+
+#. Datasheet: http://cache.nxp.com/documents/data_sheet/PCF8563.pdf
+
+"""
+
+__version__ = "0.0.0+auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PCF8563.git"
+
+import time
+
+from adafruit_bus_device.i2c_device import I2CDevice
+from adafruit_register import i2c_bit
+from adafruit_register import i2c_bits
+from micropython import const
+
+try:
+    from typing import Union
+    from busio import I2C
+except ImportError:
+    pass
+
+
+class Clock:  # pylint: disable=too-few-public-methods
+    """Interface to the clkout of the PCF8563 RTC.
+
+    :param I2C i2c_bus: The I2C bus object
+    """
+
+    clockout_enabled = i2c_bit.RWBit(0x0D, 7)
+    """True if clockout is enabled (default). To disable clockout, set to False"""
+
+    clockout_frequency = i2c_bits.RWBits(2, 0x0D, 0)
+    """Clock output frequencies generated. Default is 32.768kHz.
+    Possible values are as shown (selection value - frequency).
+    00 - 32.768khz
+    01 - 1.024kHz
+    10 - 0.032kHz (32Hz)
+    11 - 0.001kHz (1Hz)
+    """
+
+    CLOCKOUT_FREQ_32KHZ = const(0b00)
+    """Clock frequency of 32 KHz"""
+    CLOCKOUT_FREQ_1KHZ = const(0b01)
+    """Clock frequency of  4 KHz"""
+    CLOCKOUT_FREQ_32HZ = const(0b10)
+    """Clock frequency of 32 Hz"""
+    CLOCKOUT_FREQ_1HZ = const(0b11)
+    """Clock frequency of 1 Hz"""
+
+    def __init__(self, i2c: Union[I2C, I2CDevice]) -> None:
+        if isinstance(i2c, I2CDevice):
+            self.i2c_device = i2c  # reuse i2c_device (from PCF8563-instance)
+        else:
+            time.sleep(0.05)
+            self.i2c_device = I2CDevice(i2c, 0x51)

adafruit_pcf8563/pcf8563.py

@@ -36,8 +36,9 @@ class is inherited by the chip-specific subclasses.
 
 #. Milliseconds are not supported by this RTC.
 #. The alarm does not support seconds. It will always fire on full minutes.
-#. This RTC has a single timer. The class PCF8563_Timer implements the
+#. This RTC has a single timer. The class Timer implements the
 interface to timer-specfic registers.
+#. The class Clock implements the configuration of the clkout-pin.
 #. Datasheet: http://cache.nxp.com/documents/data_sheet/PCF8563.pdf
 
 """

adafruit_pcf8563/timer.py

@@ -5,8 +5,8 @@
 # SPDX-License-Identifier: MIT
 
 """
-`adafruit_pcf8563_timer` - PCF8563 Timer module
-===============================================
+`timer` - PCF8563 Timer module
+==============================
 
 This class supports the timer of the PCF8563-based RTC in CircuitPython.
 
@@ -19,7 +19,7 @@
 to the constructor of the timer.
 
 Author(s): Bernhard Bablok
-Date: November 2023
+Date: March 2023
 
 Implementation Notes
 --------------------
@@ -58,7 +58,7 @@
     pass
 
 
-class PCF8563_Timer:  # pylint: disable=too-few-public-methods
+class Timer:  # pylint: disable=too-few-public-methods
     """Interface to the timer of the PCF8563 RTC.
 
     :param I2C i2c_bus: The I2C bus object

examples/pcf8563_simpletest.py

@@ -12,13 +12,13 @@
 import board
 import busio
 
-import adafruit_pcf8563
+from adafruit_pcf8563.pcf8563 import PCF8563
 
 # Change to the appropriate I2C clock & data pins here!
 i2c_bus = busio.I2C(board.SCL, board.SDA)
 
 # Create the RTC instance:
-rtc = adafruit_pcf8563.PCF8563(i2c_bus)
+rtc = PCF8563(i2c_bus)
 
 # Lookup table for names of days (nicer printing).
 days = ("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")

pyproject.toml

@@ -42,7 +42,7 @@ classifiers = [
 dynamic = ["dependencies", "optional-dependencies"]
 
 [tool.setuptools]
-py-modules = ["adafruit_pcf8563"]
+packages = ["adafruit_pcf8563"]
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}