djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation fixes 2

This commit is contained in:
gamblor21 2022-01-27 16:49:54 -06:00
parent dd729d8fef
commit d8a7fa025d
2 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
shared-bindings/is31fl3741/FrameBuffer.c
View File

@ -40,7 +40,8 @@
//| class IS31FL3741_FrameBuffer:
//| """Creates an in-memory framebuffer for a IS31FL3741 device."""
//|
//| def __init__(self, *, width: int) -> None:
//| def __init__(self, is31: ~is31fl3741.IS31FL3741, width: int, height: int, mapping: Tuple[int, ...], *,
//| framebuffer: Optional[WriteableBuffer] = None, scale: bool = false, gamma: bool = false) -> None:
//| """Create a IS31FL3741_FrameBuffer object with the given attributes.
//|
//| The framebuffer is in "RGB888" format using 4 bytes per pixel.
@ -51,7 +52,16 @@
//| by passing the Is31fl3741 object to memoryview().
//|
//| A Is31fl3741 is often used in conjunction with a
//| `framebufferio.FramebufferDisplay`."""
//| `framebufferio.FramebufferDisplay`.
//|
//| :param ~is31fl3741.IS31FL3741 is31: base IS31FL3741 instance to drive the framebuffer
//| :param int width: width of the display
//| :param int height: height of the display
//| :param Tuple[int, ...] mapping: mapping of matrix locations to LEDs
//| :param Optional[WriteableBuffer] framebuffer: Optional buffer to hold the display
//| :param bool scale: if True display is scaled down by 3 when displayed
//| :param bool gamma: if True apply gamma correction to all LEDs"""
//| ...
//|
STATIC mp_obj_t is31fl3741_FrameBuffer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
enum { ARG_is31, ARG_width, ARG_height, ARG_framebuffer, ARG_mapping, ARG_scale, ARG_gamma };

10
shared-bindings/is31fl3741/IS31FL3741.c
View File

@ -37,11 +37,15 @@
//| class IS31FL3741:
//| """Driver for an IS31FL3741 device."""
//|
//| def __init__(self, *, width: int) -> None:
//| def __init__(self, i2c: busio.I2C, *, addr: int = 0x30) -> None:
//| """Create a IS31FL3741 object with the given attributes.
//|
//| Designed to work low level or passed to and object such as
//| `is31fl3741.IS31FL3741_FrameBuffer`."""
//| :class:`~is31fl3741.IS31FL3741_FrameBuffer`.
//|
//| :param ~busio.I2C i2c: I2C bus the IS31FL3741 is on
//| :param int addr: device address"""
//| ...
//|
STATIC mp_obj_t is31fl3741_IS31FL3741_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
enum { ARG_i2c, ARG_addr };
@ -115,7 +119,7 @@ STATIC mp_obj_t is31fl3741_IS31FL3741_set_global_current(mp_obj_t self_in, mp_ob
MP_DEFINE_CONST_FUN_OBJ_2(is31fl3741_IS31FL3741_set_global_current_obj, is31fl3741_IS31FL3741_set_global_current);
//| def set_led(self, led: int, value: int, page: int) -> None:
//| """Resets the IS31FL3741 chip."""
//| """Resets the IS31FL3741 chip.
//|
//| :param int led: which LED to set
//| :param int value: value to set the LED to 0x00 to 0xFF