compensate for newer (undocumented) firmware (#15)

# Breaking Change
The trackpad's DataReady (DR) is now a required parameter for the constructors. 

## Support for new trackpad firmware
Introduces a new property `PinnacleTouch.rev2025`. The following functionality is affected on the trackpads where this property returns `True`:
- `sample_rate` cannot exceed 100
- `detect_finger_stylus()` is non-operational
- `tune_edge_sensitivity()` is non-operational
- `calibration_matrix` is non-operational
- `set_adc_gain()` is non-operational

## Chores
Other changes involve house keeping chores like
- spelling fixes
- pre-commit hook updates
- formatting changes
- doc updates
- RTD config updates

Author: 2bndy5

.pre-commit-config.yaml

@@ -1,20 +1,19 @@
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.11.0
-    hooks:
-      - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.7
+    rev: v0.11.4
     hooks:
+      # Run the linter.
       - id: ruff
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.7.1
+    rev: v1.15.0
     hooks:
       - id: mypy
         name: mypy (library code)

.readthedocs.yml

@@ -1,9 +1,13 @@
 version: 2
 
+sphinx:
+  # Path to your Sphinx configuration file.
+  configuration: docs/conf.py
+
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "3.11"
+    python: "latest"
 
 python:
   install:

circuitpython_cirque_pinnacle.py

@@ -0,0 +1,23 @@
+version: "0.2"
+words:
+  - adafruit
+  - autoattribute
+  - autoclass
+  - automethod
+  - ANYMEAS
+  - ASIC
+  - baudrate
+  - busio
+  - circuitpython
+  - datasheet
+  - digitalio
+  - intellimouse
+  - micropython
+  - MOSI
+  - Muxing
+  - pipx
+  - seealso
+  - sparkfun
+  - tolower
+  - trackpad
+  - trackpads

cspell.config.yml

@@ -88,8 +88,8 @@ AnyMeas mode Control
 These constants control the number of measurements performed in `measure_adc()`.
 The number of measurements can range [0, 63].
 
-.. autodata:: circuitpython_cirque_pinnacle.PINNACLE_CRTL_REPEAT
+.. autodata:: circuitpython_cirque_pinnacle.PINNACLE_CTRL_REPEAT
    :no-value:
 
-.. autodata:: circuitpython_cirque_pinnacle.PINNACLE_CRTL_PWR_IDLE
+.. autodata:: circuitpython_cirque_pinnacle.PINNACLE_CTRL_PWR_IDLE
    :no-value:

docs/anymeas.rst

@@ -19,6 +19,7 @@ PinnacleTouch class
    :no-members:
 
    .. autoattribute:: circuitpython_cirque_pinnacle.PinnacleTouch.data_mode
+   .. autoattribute:: circuitpython_cirque_pinnacle.PinnacleTouch.rev2025
 
 SPI & I2C Interfaces
 --------------------

docs/api.rst

@@ -1,5 +1,6 @@
 # pylint: disable=invalid-name,too-few-public-methods
 """This file is for `sphinx-build` configuration"""
+
 import os
 import sys
 
@@ -86,6 +87,10 @@
    :language: python
    :class: highlight
 .. default-literal-role:: python
+
+.. |rev2025| replace:: not supported on trackpads manufactured on or after 2025.
+    Defer to :py:attr:`~circuitpython_cirque_pinnacle.PinnacleTouch.rev2025`.
+.. |rev2025-no-effect| replace:: on newer trackpads will have no effect
 """
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
@@ -112,6 +117,13 @@
     ],
     # Set the color and the accent color
     "palette": [
+        {
+            "media": "(prefers-color-scheme)",
+            "toggle": {
+                "icon": "material/brightness-auto",
+                "name": "Switch to light mode",
+            },
+        },
         {
             "media": "(prefers-color-scheme: light)",
             "scheme": "default",

docs/conf.py

@@ -1,6 +1,7 @@
 """
 A simple example of using the Pinnacle ASIC in absolute mode.
 """
+
 import math
 import sys
 import time
@@ -17,21 +18,18 @@
 
 print("Cirque Pinnacle absolute mode\n")
 
-# a HW ``dr_pin`` is more efficient, but not required for Absolute or Relative modes
-dr_pin = None
-if not input("Use SW Data Ready? [y/N] ").lower().startswith("y"):
-    print("-- Using HW Data Ready pin.")
-    dr_pin = DigitalInOut(board.D7 if not IS_ON_LINUX else board.D25)
+# the pin connected to the trackpad's DR pin.
+dr_pin = DigitalInOut(board.D7 if not IS_ON_LINUX else board.D25)
 
 if not input("Is the trackpad configured for I2C? [y/N] ").lower().startswith("y"):
     print("-- Using SPI interface.")
     spi = board.SPI()
     ss_pin = DigitalInOut(board.D2 if not IS_ON_LINUX else board.CE0)
-    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin=dr_pin)
+    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin)
 else:
     print("-- Using I2C interface.")
     i2c = board.I2C()
-    trackpad = PinnacleTouchI2C(i2c, dr_pin=dr_pin)
+    trackpad = PinnacleTouchI2C(i2c, dr_pin)
 
 trackpad.data_mode = PINNACLE_ABSOLUTE  # ensure Absolute mode is enabled
 trackpad.absolute_mode_config(z_idle_count=1)  # limit idle packet count to 1

examples/cirque_pinnacle_absolute_mode.py

@@ -1,6 +1,7 @@
 """
 A simple example of using the Pinnacle ASIC in anymeas mode.
 """
+
 import sys
 import time
 import board
@@ -15,18 +16,18 @@
 
 print("Cirque Pinnacle anymeas mode\n")
 
-# Using HW Data Ready pin as required for Anymeas mode
+# the pin connected to the trackpad's DR pin.
 dr_pin = DigitalInOut(board.D7 if not IS_ON_LINUX else board.D25)
 
 if not input("Is the trackpad configured for I2C? [y/N] ").lower().startswith("y"):
     print("-- Using SPI interface.")
     spi = board.SPI()
     ss_pin = DigitalInOut(board.D2 if not IS_ON_LINUX else board.CE0)
-    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin=dr_pin)
+    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin)
 else:
     print("-- Using I2C interface.")
     i2c = board.I2C()
-    trackpad = PinnacleTouchI2C(i2c, dr_pin=dr_pin)
+    trackpad = PinnacleTouchI2C(i2c, dr_pin)
 
 trackpad.data_mode = PINNACLE_ANYMEAS
 

examples/cirque_pinnacle_anymeas_mode.py

@@ -1,6 +1,7 @@
 """
 A simple example of using the Pinnacle ASIC in relative mode.
 """
+
 import sys
 import time
 import board
@@ -16,21 +17,18 @@
 
 print("Cirque Pinnacle relative mode\n")
 
-# a HW ``dr_pin`` is more efficient, but not required for Absolute or Relative modes
-dr_pin = None
-if not input("Use SW Data Ready? [y/N] ").lower().startswith("y"):
-    print("-- Using HW Data Ready pin.")
-    dr_pin = DigitalInOut(board.D7 if not IS_ON_LINUX else board.D25)
+# the pin connected to the trackpad's DR pin.
+dr_pin = DigitalInOut(board.D7 if not IS_ON_LINUX else board.D25)
 
 if not input("Is the trackpad configured for I2C? [y/N] ").lower().startswith("y"):
     print("-- Using SPI interface.")
     spi = board.SPI()
     ss_pin = DigitalInOut(board.D2 if not IS_ON_LINUX else board.CE0)
-    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin=dr_pin)
+    trackpad = PinnacleTouchSPI(spi, ss_pin, dr_pin)
 else:
     print("-- Using I2C interface.")
     i2c = board.I2C()
-    trackpad = PinnacleTouchI2C(i2c, dr_pin=dr_pin)
+    trackpad = PinnacleTouchI2C(i2c, dr_pin)
 
 trackpad.data_mode = PINNACLE_RELATIVE  # ensure mouse mode is enabled
 trackpad.relative_mode_config(True)  # enable tap detection