Document more classes that can be separately enabled
This commit is contained in:
parent
aca93d0ebb
commit
f15eceb24c
|
@ -69,9 +69,14 @@ ADDITIONAL_MODULES = {
|
|||
"array": "CIRCUITPY_ARRAY",
|
||||
# always available, so depend on something that's always 1.
|
||||
"builtins": "CIRCUITPY",
|
||||
"busio.SPI": "CIRCUITPY_BUSIO_SPI",
|
||||
"busio.UART": "CIRCUITPY_BUSIO_UART",
|
||||
"collections": "CIRCUITPY_COLLECTIONS",
|
||||
"fontio": "CIRCUITPY_DISPLAYIO",
|
||||
"io": "CIRCUITPY_IO",
|
||||
"keypad.KeyMatrix": "CIRCUITPY_KEYPAD_KEYMATRIX",
|
||||
"keypad.Keys": "CIRCUITPY_KEYPAD_KEYS",
|
||||
"keypad.ShiftRegisterKeys": "CIRCUITPY_KEYPAD_SHIFTREGISTERKEYS",
|
||||
"os.getenv": "CIRCUITPY_OS_GETENV",
|
||||
"select": "MICROPY_PY_USELECT_SELECT",
|
||||
"sys": "CIRCUITPY_SYS",
|
||||
|
|
|
@ -52,7 +52,22 @@
|
|||
//| `!MOSI`, `!MISO`. Its up to the client to manage the appropriate
|
||||
//| select line, often abbreviated `!CS` or `!SS`. (This is common because
|
||||
//| multiple secondaries can share the `!clock`, `!MOSI` and `!MISO` lines
|
||||
//| and therefore the hardware.)"""
|
||||
//| and therefore the hardware.)
|
||||
//|
|
||||
//| .. raw:: html
|
||||
//|
|
||||
//| <p>
|
||||
//| <details>
|
||||
//| <summary>Available on these boards</summary>
|
||||
//| <ul>
|
||||
//| {% for board in support_matrix_reverse["busio.SPI"] %}
|
||||
//| <li> {{ board }}
|
||||
//| {% endfor %}
|
||||
//| </ul>
|
||||
//| </details>
|
||||
//| </p>
|
||||
//|
|
||||
//| """
|
||||
//|
|
||||
//| def __init__(
|
||||
//| self,
|
||||
|
|
|
@ -44,7 +44,22 @@
|
|||
// #define STREAM_DEBUG(...) mp_printf(&mp_plat_print __VA_OPT__(,) __VA_ARGS__)
|
||||
|
||||
//| class UART:
|
||||
//| """A bidirectional serial protocol"""
|
||||
//| """A bidirectional serial protocol
|
||||
//|
|
||||
//| .. raw:: html
|
||||
//|
|
||||
//| <p>
|
||||
//| <details>
|
||||
//| <summary>Available on these boards</summary>
|
||||
//| <ul>
|
||||
//| {% for board in support_matrix_reverse["busio.UART"] %}
|
||||
//| <li> {{ board }}
|
||||
//| {% endfor %}
|
||||
//| </ul>
|
||||
//| </details>
|
||||
//| </p>
|
||||
//|
|
||||
//| """
|
||||
//|
|
||||
//| def __init__(
|
||||
//| self,
|
||||
|
|
|
@ -77,6 +77,8 @@
|
|||
//|
|
||||
//| Tutorial for UART:
|
||||
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-uart-serial
|
||||
//|
|
||||
//| .. jinja
|
||||
//| """
|
||||
|
||||
STATIC const mp_rom_map_elem_t busio_module_globals_table[] = {
|
||||
|
|
|
@ -35,7 +35,22 @@
|
|||
#include "shared-bindings/util.h"
|
||||
|
||||
//| class KeyMatrix:
|
||||
//| """Manage a 2D matrix of keys with row and column pins."""
|
||||
//| """Manage a 2D matrix of keys with row and column pins.
|
||||
//|
|
||||
//| .. raw:: html
|
||||
//|
|
||||
//| <p>
|
||||
//| <details>
|
||||
//| <summary>Available on these boards</summary>
|
||||
//| <ul>
|
||||
//| {% for board in support_matrix_reverse["keypad.KeyMatrix"] %}
|
||||
//| <li> {{ board }}
|
||||
//| {% endfor %}
|
||||
//| </ul>
|
||||
//| </details>
|
||||
//| </p>
|
||||
//|
|
||||
//| """
|
||||
//|
|
||||
//| def __init__(
|
||||
//| self,
|
||||
|
|
|
@ -35,7 +35,22 @@
|
|||
#include "shared-bindings/util.h"
|
||||
|
||||
//| class Keys:
|
||||
//| """Manage a set of independent keys."""
|
||||
//| """Manage a set of independent keys.
|
||||
//|
|
||||
//| .. raw:: html
|
||||
//|
|
||||
//| <p>
|
||||
//| <details>
|
||||
//| <summary>Available on these boards</summary>
|
||||
//| <ul>
|
||||
//| {% for board in support_matrix_reverse["keypad.Keys"] %}
|
||||
//| <li> {{ board }}
|
||||
//| {% endfor %}
|
||||
//| </ul>
|
||||
//| </details>
|
||||
//| </p>
|
||||
//|
|
||||
//| """
|
||||
//|
|
||||
//| def __init__(
|
||||
//| self,
|
||||
|
|
|
@ -35,7 +35,22 @@
|
|||
#include "shared-bindings/util.h"
|
||||
|
||||
//| class ShiftRegisterKeys:
|
||||
//| """Manage a set of keys attached to an incoming shift register."""
|
||||
//| """Manage a set of keys attached to an incoming shift register.
|
||||
//|
|
||||
//| .. raw:: html
|
||||
//|
|
||||
//| <p>
|
||||
//| <details>
|
||||
//| <summary>Available on these boards</summary>
|
||||
//| <ul>
|
||||
//| {% for board in support_matrix_reverse["keypad.ShiftRegisterKeys"] %}
|
||||
//| <li> {{ board }}
|
||||
//| {% endfor %}
|
||||
//| </ul>
|
||||
//| </details>
|
||||
//| </p>
|
||||
//|
|
||||
//| """
|
||||
//|
|
||||
//| def __init__(
|
||||
//| self,
|
||||
|
|
|
@ -89,6 +89,8 @@ const mp_obj_property_t keypad_generic_events_obj = {
|
|||
//|
|
||||
//| For more information about working with the `keypad` module in CircuitPython,
|
||||
//| see `this Learn guide <https://learn.adafruit.com/key-pad-matrix-scanning-in-circuitpython>`_.
|
||||
//|
|
||||
//| .. jinja
|
||||
//| """
|
||||
|
||||
STATIC mp_rom_map_elem_t keypad_module_globals_table[] = {
|
||||
|
|
Loading…
Reference in New Issue