diff options
| author | Radomir Dopieralski <openstack@sheep.art.pl> | 2019-03-01 16:36:29 +0100 |
|---|---|---|
| committer | Radomir Dopieralski <openstack@sheep.art.pl> | 2019-03-01 16:36:29 +0100 |
| commit | ea78417f7fe80cc870fd6bef24a4938bddfa4f37 (patch) | |
| tree | 5ec9340af9e49fd77bb45259593ba681b8bd24fb /shared-bindings | |
| parent | 5d85d5402613d2ec376dde1a7f3b9c77f54bd1e4 (diff) | |
Improve documentation
Diffstat (limited to 'shared-bindings')
| -rw-r--r-- | shared-bindings/_pew/PewPew.c | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/shared-bindings/_pew/PewPew.c b/shared-bindings/_pew/PewPew.c index 26b060188..50647488c 100644 --- a/shared-bindings/_pew/PewPew.c +++ b/shared-bindings/_pew/PewPew.c @@ -37,17 +37,30 @@ //| .. currentmodule:: _pew //| -//| :class:`PewPew` -- LED Matrix driver -//| ==================================== +//| :class:`PewPew` -- LED matrix and button driver +//| =============================================== +//| +//| This is an internal module to be used by the ``pew.py`` library from +//| https://github.com/pewpew-game/pew-pewpew-standalone-10.x to handle the +//| LED matrix display and buttons on the ``pewpew10`` board. //| //| Usage:: //| +//| This singleton class is instantiated by the ``pew`` library, and +//| used internally by it. All user-visible interactions are done through +//| that library. //| -//| .. class:: PewPew(buffer, rows, cols) +//| .. class:: PewPew(buffer, rows, cols, buttons) //| //| Initializes matrix scanning routines. //| +//| The ``buffer`` is a 64 byte long ``bytearray`` that stores what should +//| be displayed on the matrix. ``rows`` and ``cols`` are both lists of +//| eight ``DigitalInputOutput`` objects that are connected to the matrix +//| rows and columns. ``buttons`` is a ``DigitalInputOutput`` object that +//| is connected to the common side of all buttons (the other sides of the +//| buttons are connected to rows of the matrix). //| STATIC mp_obj_t pewpew_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) { |