Merge pull request #1 from BlitzCityDIY/main

Adding library, example and docs

README.rst

@@ -21,7 +21,7 @@ Introduction
     :target: https://github.com/psf/black
     :alt: Code Style: Black
 
-Touchscreen driver for the FT5336 touch controller
+CircuitPython driver for the FT5336 touch controller
 
 
 Dependencies
@@ -38,19 +38,10 @@ This is easily achieved by downloading
 or individual libraries can be installed using
 `circup <https://github.com/adafruit/circup>`_.
 
-
-
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
-
 `Purchase one from the Adafruit shop <http://www.adafruit.com/products/5846>`_
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-ft5336/>`_.
@@ -101,8 +92,19 @@ Or the following command to update an existing version:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the
-examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+	import time
+	import board
+	import adafruit_ft5336
+
+	i2c = board.I2C()
+	touch = adafruit_ft5336.Adafruit_FT5336(i2c)
+
+	while True:
+		t = touch.points
+		print(t)
+		time.sleep(0.1)
 
 Documentation
 =============

adafruit_ft5336.py

@@ -1,12 +1,11 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2023 Liz Clark for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 """
 `adafruit_ft5336`
 ================================================================================
 
-Touchscreen driver for the FT5336 touch controller
+CircuitPython driver for the FT5336 touch screen controller
 
 
 * Author(s): Liz Clark
@@ -16,22 +15,129 @@
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s).
-  Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
+* `Adafruit 3.5" TFT 320x480 with Capacitive Touch Breakout: <https://adafruit.com/product/5846>`_
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
   https://circuitpython.org/downloads
 
-.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies
-  based on the library's use of either.
-
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
-# imports
+from adafruit_register.i2c_bits import ROBits
+from adafruit_bus_device.i2c_device import I2CDevice
+from micropython import const
+
+try:
+    from typing import List, Tuple
+except ImportError:
+    pass
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_FT5336.git"
+
+_DEFAULT_ADDR = const(0x38)
+_REG_VENDID = const(0xA3)
+_REG_CHIPID = const(0xA8)
+_VENDID = const(0x11)
+_CHIPID = const(0x79)
+_REG_NUMTOUCHES = const(0x02)
+_TD_STATUS = const(0x02)
+_TOUCH1_XH = const(0x03)
+_TOUCH1_XL = const(0x04)
+_TOUCH1_YH = const(0x05)
+_TOUCH1_YL = const(0x06)
+
+
+class Adafruit_FT5336:
+    """Adafruit FT5336 touch screen driver"""
+
+    # Define read-only register bits for vendor ID, chip ID, and number of touches.
+    _vend_id = ROBits(8, _REG_VENDID, 0)  # 8-bit read-only register for vendor ID
+    _chip_id = ROBits(8, _REG_CHIPID, 0)  # 8-bit read-only register for chip ID
+    _num_touches = ROBits(
+        8, _REG_NUMTOUCHES, 0
+    )  # 8-bit read-only register for number of touches
+
+    def __init__(
+        self, i2c, i2c_addr: int = _DEFAULT_ADDR, max_touches: int = 5
+    ) -> None:
+        """Initialization over I2C
+
+        :param int i2c_addr: I2C address (default 0x38)
+        :param int max_touches: Maximum number of touch points to track. Defaults to 5.
+        """
+        self.i2c_device = I2CDevice(i2c, i2c_addr)  # I2C device instance
+        self.i2c_addr = i2c_addr  # Store the I2C address
+        self._touches = 0  # Number of current touches
+        self.max_touches = max_touches  # Maximum number of touches to track
+
+        # Initialize touch point arrays
+        self._touch_x: List[int] = [0] * self.max_touches
+        self._touch_y: List[int] = [0] * self.max_touches
+        self._touch_id: List[int] = [0] * self.max_touches
+
+        # Verify device identity by checking the vendor and chip IDs
+        if self._vend_id != _VENDID:
+            raise ValueError("Incorrect vendor ID")
+        if self._chip_id != _CHIPID:
+            raise ValueError("Incorrect chip ID")
+
+    def _read_data(self):
+        buffer = bytearray(32)
+        with self.i2c_device as i2c:
+            i2c.write_then_readinto(bytearray([0]), buffer, in_end=32)
+
+        self._touches = buffer[_TD_STATUS]
+        if self._touches > self.max_touches or self._touches == 0:
+            self._touches = 0
+
+        for i in range(self._touches):
+            self._touch_x[i] = (buffer[_TOUCH1_XH + i * 6] & 0x0F) << 8 | buffer[
+                _TOUCH1_XL + i * 6
+            ]
+            self._touch_y[i] = (buffer[_TOUCH1_YH + i * 6] & 0x0F) << 8 | buffer[
+                _TOUCH1_YL + i * 6
+            ]
+            self._touch_id[i] = buffer[_TOUCH1_YH + i * 6] >> 4
+
+    @property
+    def touched(self) -> int:
+        """Count of touch inputs detected
+
+        :return: Count of touch inputs detected (0-max_touches)
+        :rtype: int
+        """
+        n = self._num_touches
+        return 0 if n > self.max_touches else n
+
+    @property
+    def points(self) -> List:
+        """X, Y and Z values from each available touch input
+
+        :return: X, Y and Z values in a list
+        :rtype: List
+        """
+        self._read_data()
+        points = []
+        for i in range(min(self._touches, self.max_touches)):
+            point = (self._touch_x[i], self._touch_y[i], 1)
+            points.append(point)
+
+        return points
+
+    def point(self, point_index: int) -> Tuple:
+        """X, Y and Z value from a specified touch input
+
+        :param int point_index: Touch input to read (0 - max_touches)
+        :return: X, Y and Z values
+        :rtype: Tuple
+        """
+        self._read_data()
+        if self._touches == 0 or point_index >= self._touches:
+            value = (0, 0, 0)
+        else:
+            value = (self._touch_x[point_index], self._touch_y[point_index], 1)
+        return value

docs/conf.py

@@ -23,17 +23,19 @@
     "sphinx.ext.todo",
 ]
 
-# TODO: Please Read!
-# Uncomment the below if you use native CircuitPython modules such as
-# digitalio, micropython and busio. List the modules you use. Without it, the
-# autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+# autodoc_mock_imports = [
+#    "micropython",
+#    "busio",
+#    "adafruit_bus_device",
+#    "adafruit_register",
+# ]
 
 autodoc_preserve_defaults = True
 
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3", None),"BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
+    "python": ("https://docs.python.org/3", None),
+    "BusDevice": ("https://docs.circuitpython.org/projects/busdevice/en/latest/", None),
     "Register": ("https://docs.circuitpython.org/projects/register/en/latest/", None),
     "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
 }

docs/index.rst

@@ -24,14 +24,12 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+	Adafruit 3.5" 320x480 Color TFT Touchscreen Breakout Learn Guide <https://learn.adafruit.com/adafruit-3-5-color-320x480-tft-touchscreen-breakout>
 
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+	Adafruit 3.5" TFT 320x480 with Capacitive Touch Breakout Board - EYESPI <https://www.adafruit.com/product/5846>
 
 .. toctree::
     :caption: Other Links

examples/ft5336_simpletest.py

@@ -1,4 +1,18 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-# SPDX-FileCopyrightText: Copyright (c) 2023 Liz Clark for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
+# SPDX-FileCopyrightText: 2023 Liz Clark for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+"""
+Demo for the FT5336. Reads all available touch input coordinates.
+"""
+
+import time
+import board
+import adafruit_ft5336
+
+i2c = board.I2C()
+touch = adafruit_ft5336.Adafruit_FT5336(i2c)
+
+while True:
+    t = touch.points
+    print(t)
+    time.sleep(0.1)

requirements.txt

@@ -1,9 +1,7 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2023 Liz Clark for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
 Adafruit-Blinka
 adafruit-circuitpython-busdevice
 adafruit-circuitpython-register
-n