diff options
| -rw-r--r-- | docs/wasp.rst | 2 | ||||
| -rw-r--r-- | wasp/boards/sphinx/watch.py | 40 |
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/wasp.rst b/docs/wasp.rst index 1017ca7..6ec18ef 100644 --- a/docs/wasp.rst +++ b/docs/wasp.rst @@ -12,6 +12,8 @@ System .. automodule:: wasp :members: +.. automodule:: watch + .. automodule:: draw565 :members: diff --git a/wasp/boards/sphinx/watch.py b/wasp/boards/sphinx/watch.py index f3f6502..343f47b 100644 --- a/wasp/boards/sphinx/watch.py +++ b/wasp/boards/sphinx/watch.py @@ -1,6 +1,46 @@ # SPDX-License-Identifier: LGPL-3.0-or-later # Copyright (C) 2020 Daniel Thompson +"""Watch driver instances +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. data:: watch.backlight + + Backlight driver, typically a board specific driver with a single + :py:meth:`set` method. + +.. data:: watch.battery + + Battery driver, typically the generic metering driver, + :py:class:`drivers.battery.Battery`. + +.. data:: watch.button + + An instance of machine.Pin (or a signal) that an application can use + to poll the state of the hardware button. + +.. data:: watch.display + + Display driver, typically :py:class:`drivers.st7789.ST7789_SPI`. + +.. data:: watch.drawable + + Drawing library for :py:data:`watch.display`. It will be adapted to match the + bit depth of the display, :py:class:`draw565.Draw565` for example. + +.. data:: watch.rtc + + RTC driver, typically :py:class:`drivers.nrf_rtc.RTC`. + +.. data:: watch.touch + + Touchscreen driver, for example :py:class:`drivers.cst816s.CST816S`. + +.. data:: watch.vibrator + + Vibration motor driver, typically :py:class:`drivers.vibrator.Vibrator`. +""" + import time def sleep_ms(ms): time.sleep(ms / 1000) |