summaryrefslogtreecommitdiff
path: root/wasp/drivers
diff options
context:
space:
mode:
authorDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 20:36:09 (GMT)
committerDaniel Thompson <daniel@redfelineninja.org.uk>2020-05-14 20:36:09 (GMT)
commitd5c629a9acd430d198b1dc0509ef0ed708c08aeb (patch)
treeca50f5cc063a20aed7de8b840dc0e670781aef49 /wasp/drivers
parent85079c149b4e6b044d06e182a741fec7ef60401b (diff)
drivers: cst816s: Finalize docstrings
Diffstat (limited to 'wasp/drivers')
-rw-r--r--wasp/drivers/cst816s.py20
1 files changed, 10 insertions, 10 deletions
diff --git a/wasp/drivers/cst816s.py b/wasp/drivers/cst816s.py
index d0f3cd2..182afeb 100644
--- a/wasp/drivers/cst816s.py
+++ b/wasp/drivers/cst816s.py
@@ -1,23 +1,23 @@
# SPDX-License-Identifier: LGPL-3.0-or-later
# Copyright (C) 2020 Daniel Thompson
-"""Hynitron CST816S touch contoller driver for MicroPython.
-
-After modifying this file we can test the changes by replacing the
-frozen driver with the modified driver. The following command will
-upload the code and integrate it into the watch namespace::
-
- ./tools/wasptool\
- --exec wasp/drivers/cst816s.py\
- --eval "watch.touch = CST816S(watch.i2c)"`
+"""Hynitron CST816S touch contoller driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"""
import array
class CST816S:
- """Hynitron CST816S I2C touch controller driver."""
+ """Hynitron CST816S I2C touch controller driver.
+
+ .. automethod:: __init__
+ """
def __init__(self, bus):
+ """Specify the bus used by the touch controller.
+
+ :param machine.I2C bus: I2C bus for the CST816S.
+ """
self.i2c = bus
self.dbuf = bytearray(6)
self.event = array.array('H', (0, 0, 0))