summaryrefslogtreecommitdiff
path: root/shared-bindings/rgbmatrix/RGBMatrix.c
diff options
context:
space:
mode:
authordherrada <dylan.herrada@gmail.com>2020-05-11 13:00:19 -0400
committerdherrada <dylan.herrada@gmail.com>2020-05-11 13:00:19 -0400
commitc7a9d49cba38499ec6701fdfef0c14e1dd5503a8 (patch)
tree93ce7fbdbed9cd3e5ed4707fdb52da26c5a9b008 /shared-bindings/rgbmatrix/RGBMatrix.c
parent838b6c56858fa3888c558e5640031b8764c313d7 (diff)
Did rgbmatrix, rotaryio, and RTC
Diffstat (limited to 'shared-bindings/rgbmatrix/RGBMatrix.c')
-rw-r--r--shared-bindings/rgbmatrix/RGBMatrix.c103
1 files changed, 50 insertions, 53 deletions
diff --git a/shared-bindings/rgbmatrix/RGBMatrix.c b/shared-bindings/rgbmatrix/RGBMatrix.c
index d758774d9..e2393eb61 100644
--- a/shared-bindings/rgbmatrix/RGBMatrix.c
+++ b/shared-bindings/rgbmatrix/RGBMatrix.c
@@ -38,10 +38,11 @@
#include "shared-module/framebufferio/__init__.h"
#include "shared-module/framebufferio/FramebufferDisplay.h"
-//| .. currentmodule:: rgbmatrix
+//| class RGBMatrix:
+//| """.. currentmodule:: rgbmatrix
//|
-//| :class:`RGBMatrix` -- Driver for HUB75-style RGB LED matrices
-//| ================================================================
+//| :class:`RGBMatrix` -- Driver for HUB75-style RGB LED matrices
+//| ================================================================
//|
extern Protomatter_core *_PM_protoPtr;
@@ -133,45 +134,45 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
}
}
-//| :class:`~rgbmatrix.RGBMatrix` displays an in-memory framebuffer to an LED matrix.
-//|
-//| .. class:: RGBMatrix(*, width, bit_depth, rgb_pins, addr_pins, clock_pin, latch_pin, output_enable_pin, doublebuffer=True, framebuffer=None, height=0)
+
+//| :class:`~rgbmatrix.RGBMatrix` displays an in-memory framebuffer to an LED matrix."""
//|
-//| Create a RGBMatrix object with the given attributes. The height of
-//| the display is determined by the number of rgb and address pins:
-//| len(rgb_pins) // 3 * 2 ** len(address_pins). With 6 RGB pins and 4
-//| address lines, the display will be 32 pixels tall. If the optional height
-//| parameter is specified and is not 0, it is checked against the calculated
-//| height.
+//| def __init__(self, *, width: Any, bit_depth: Any, rgb_pins: Any, addr_pins: Any, clock_pin: Any, latch_pin: Any, output_enable_pin: Any, doublebuffer: Any = True, framebuffer: Any = None, height: Any = 0):
+//| """Create a RGBMatrix object with the given attributes. The height of
+//| the display is determined by the number of rgb and address pins:
+//| len(rgb_pins) // 3 * 2 ** len(address_pins). With 6 RGB pins and 4
+//| address lines, the display will be 32 pixels tall. If the optional height
+//| parameter is specified and is not 0, it is checked against the calculated
+//| height.
//|
-//| Up to 30 RGB pins and 8 address pins are supported.
+//| Up to 30 RGB pins and 8 address pins are supported.
//|
-//| The RGB pins must be within a single "port" and performance and memory
-//| usage are best when they are all within "close by" bits of the port.
-//| The clock pin must also be on the same port as the RGB pins. See the
-//| documentation of the underlying protomatter C library for more
-//| information. Generally, Adafruit's interface boards are designed so
-//| that these requirements are met when matched with the intended
-//| microcontroller board. For instance, the Feather M4 Express works
-//| together with the RGB Matrix Feather.
+//| The RGB pins must be within a single "port" and performance and memory
+//| usage are best when they are all within "close by" bits of the port.
+//| The clock pin must also be on the same port as the RGB pins. See the
+//| documentation of the underlying protomatter C library for more
+//| information. Generally, Adafruit's interface boards are designed so
+//| that these requirements are met when matched with the intended
+//| microcontroller board. For instance, the Feather M4 Express works
+//| together with the RGB Matrix Feather.
//|
-//| The framebuffer is in "RGB565" format.
+//| The framebuffer is in "RGB565" format.
//|
-//| "RGB565" means that it is organized as a series of 16-bit numbers
-//| where the highest 5 bits are interpreted as red, the next 6 as
-//| green, and the final 5 as blue. The object can be any buffer, but
-//| `array.array` and `ulab.array` objects are most often useful.
-//| To update the content, modify the framebuffer and call refresh.
+//| "RGB565" means that it is organized as a series of 16-bit numbers
+//| where the highest 5 bits are interpreted as red, the next 6 as
+//| green, and the final 5 as blue. The object can be any buffer, but
+//| `array.array` and `ulab.array` objects are most often useful.
+//| To update the content, modify the framebuffer and call refresh.
//|
-//| If a framebuffer is not passed in, one is allocated and initialized
-//| to all black. In any case, the framebuffer can be retrieved
-//| by passing the RGBMatrix object to memoryview().
+//| If a framebuffer is not passed in, one is allocated and initialized
+//| to all black. In any case, the framebuffer can be retrieved
+//| by passing the RGBMatrix object to memoryview().
//|
-//| If doublebuffer is False, some memory is saved, but the display may
-//| flicker during updates.
+//| If doublebuffer is False, some memory is saved, but the display may
+//| flicker during updates.
//|
-//| A RGBMatrix is often used in conjunction with a
-//| `framebufferio.FramebufferDisplay`.
+//| A RGBMatrix is often used in conjunction with a
+//| `framebufferio.FramebufferDisplay`."""
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@@ -245,11 +246,11 @@ STATIC mp_obj_t rgbmatrix_rgbmatrix_make_new(const mp_obj_type_t *type, size_t n
return MP_OBJ_FROM_PTR(self);
}
-//| .. method:: deinit
-//|
-//| Free the resources (pins, timers, etc.) associated with this
-//| rgbmatrix instance. After deinitialization, no further operations
-//| may be performed.
+//| def deinit(self, ) -> Any:
+//| """Free the resources (pins, timers, etc.) associated with this
+//| rgbmatrix instance. After deinitialization, no further operations
+//| may be performed."""
+//| ...
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_deinit(mp_obj_t self_in) {
rgbmatrix_rgbmatrix_obj_t *self = (rgbmatrix_rgbmatrix_obj_t*)self_in;
@@ -265,10 +266,9 @@ static void check_for_deinit(rgbmatrix_rgbmatrix_obj_t *self) {
}
}
-//| .. attribute:: brightness
-//|
-//| In the current implementation, 0.0 turns the display off entirely
-//| and any other value up to 1.0 turns the display on fully.
+//| brightness: Any = ...
+//| """In the current implementation, 0.0 turns the display off entirely
+//| and any other value up to 1.0 turns the display on fully."""
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_get_brightness(mp_obj_t self_in) {
rgbmatrix_rgbmatrix_obj_t *self = (rgbmatrix_rgbmatrix_obj_t*)self_in;
@@ -297,10 +297,9 @@ const mp_obj_property_t rgbmatrix_rgbmatrix_brightness_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. method:: refresh()
-//|
-//| Transmits the color data in the buffer to the pixels so that
-//| they are shown.
+//| def refresh(self, ) -> Any: ...
+//| """Transmits the color data in the buffer to the pixels so that
+//| they are shown."""
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_refresh(mp_obj_t self_in) {
rgbmatrix_rgbmatrix_obj_t *self = (rgbmatrix_rgbmatrix_obj_t*)self_in;
@@ -310,9 +309,8 @@ STATIC mp_obj_t rgbmatrix_rgbmatrix_refresh(mp_obj_t self_in) {
}
MP_DEFINE_CONST_FUN_OBJ_1(rgbmatrix_rgbmatrix_refresh_obj, rgbmatrix_rgbmatrix_refresh);
-//| .. attribute:: width
-//|
-//| The width of the display, in pixels
+//| width: Any = ...
+//| """The width of the display, in pixels"""
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_get_width(mp_obj_t self_in) {
rgbmatrix_rgbmatrix_obj_t *self = (rgbmatrix_rgbmatrix_obj_t*)self_in;
@@ -327,9 +325,8 @@ const mp_obj_property_t rgbmatrix_rgbmatrix_width_obj = {
(mp_obj_t)&mp_const_none_obj},
};
-//| .. attribute:: height
-//|
-//| The height of the display, in pixels
+//| height: Any = ...
+//| """The height of the display, in pixels"""
//|
STATIC mp_obj_t rgbmatrix_rgbmatrix_get_height(mp_obj_t self_in) {
rgbmatrix_rgbmatrix_obj_t *self = (rgbmatrix_rgbmatrix_obj_t*)self_in;