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

Documentation fixes

This commit is contained in:
gamblor21 2021-12-08 21:36:19 -06:00
parent 11ef0b48c0
commit 7c1afb070a
3 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
shared-bindings/is31fl3741/__init__.c
View File

@ -36,32 +36,19 @@
#include "shared-bindings/is31fl3741/IS31FL3741.h"
//| """Low-level neopixel implementation
//| """Low-level is31fl3741 implementation
//|
//| The `neopixel_write` module contains a helper method to write out bytes in
//| the 800khz neopixel protocol.
//| The `is31fl3741_write` module contains a helper method to write out bytes in
//| over the I2C bus.
//|
//| For example, to turn off a single neopixel (like the status pixel on Express
//| boards.)
//| def is31fl3741_write(i2c: busio.I2c, addr: int, mapping: Tuple[int, ...], buf: ReadableBuffer) -> None:
//| """Write buf out on the given I2C bus.
//|
//| .. code-block:: python
//|
//| import board
//| import neopixel_write
//| import digitalio
//|
//| pin = digitalio.DigitalInOut(board.NEOPIXEL)
//| pin.direction = digitalio.Direction.OUTPUT
//| pixel_off = bytearray([0, 0, 0])
//| neopixel_write.neopixel_write(pin, pixel_off)"""
//|
//| def neopixel_write(digitalinout: digitalio.DigitalInOut, buf: ReadableBuffer) -> None:
//| """Write buf out on the given DigitalInOut.
//|
//| :param ~digitalio.DigitalInOut digitalinout: the DigitalInOut to output with
//| :param ~busio.I2C i2c: the I2C bus to output with
//| :param ~int addr: the I2C address of the IS31FL3741 device
//| :param ~Tuple[int, ...] mapping: map the pixels in the buffer to the order addressed by the driver chip
//| :param ~_typing.ReadableBuffer buf: The bytes to clock out. No assumption is made about color order"""
//| ...
// STATIC mp_obj_t is31fl3741_is31fl3741_write(mp_obj_t i2c_obj, mp_obj_t device_addr_obj, mp_obj_t mapping, mp_obj_t buf) {
STATIC mp_obj_t is31fl3741_is31fl3741_write(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_i2c, ARG_addr, ARG_mapping, ARG_buffer };
static const mp_arg_t allowed_args[] = {
@ -92,6 +79,12 @@ STATIC mp_obj_t is31fl3741_is31fl3741_write(size_t n_args, const mp_obj_t *pos_a
}
MP_DEFINE_CONST_FUN_OBJ_KW(is31fl3741_is31fl3741_write_obj, 0, is31fl3741_is31fl3741_write);
//| def is31fl3741_init(i2c: busio.I2c, addr: int) -> None:
//| """Initialize the IS31FL3741 device.
//|
//| :param ~busio.I2C i2c: the I2C bus to output with
//| :param ~int addr: the I2C address of the IS31FL3741 device
//| ...
STATIC mp_obj_t is31fl3741_is31fl3741_init(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_i2c, ARG_addr };
static const mp_arg_t allowed_args[] = {

4
shared-bindings/is31fl3741/__init__.h
View File

@ -34,7 +34,7 @@
extern void common_hal_is31fl3741_init(busio_i2c_obj_t *i2c, uint8_t addr);
extern void common_hal_is31fl3741_write(busio_i2c_obj_t *i2c, uint8_t addr, const mp_obj_t *mapping, const uint8_t *pixels, size_t numBytes);
void begin_transaction(busio_i2c_obj_t *i2c);
void end_transaction(busio_i2c_obj_t *i2c);
void is31fl3741_begin_transaction(busio_i2c_obj_t *i2c);
void is31fl3741_end_transaction(busio_i2c_obj_t *i2c);
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_NEOPIXEL_WRITE_H

12
shared-module/is31fl3741/__init__.c
View File

@ -29,7 +29,7 @@
#include "shared-bindings/busio/I2C.h"
#include "shared-bindings/is31fl3741/IS31FL3741.h"
void begin_transaction(busio_i2c_obj_t *i2c) {
void is31fl3741_begin_transaction(busio_i2c_obj_t *i2c) {
while (!common_hal_busio_i2c_try_lock(i2c)) {
RUN_BACKGROUND_TASKS;
if (mp_hal_is_interrupted()) {
@ -38,12 +38,12 @@ void begin_transaction(busio_i2c_obj_t *i2c) {
}
}
void end_transaction(busio_i2c_obj_t *i2c) {
void is31fl3741_end_transaction(busio_i2c_obj_t *i2c) {
common_hal_busio_i2c_unlock(i2c);
}
void common_hal_is31fl3741_init(busio_i2c_obj_t *i2c, uint8_t addr) {
begin_transaction(i2c);
is31fl3741_begin_transaction(i2c);
uint8_t command = 0xFC; // device ID
common_hal_busio_i2c_write(i2c, addr, &command, 1, false);
@ -59,10 +59,12 @@ void common_hal_is31fl3741_init(busio_i2c_obj_t *i2c, uint8_t addr) {
is31fl3741_set_led(i2c, addr, i, 0xFF, 2);
}
end_transaction(i2c);
is31fl3741_end_transaction(i2c);
}
void common_hal_is31fl3741_write(busio_i2c_obj_t *i2c, uint8_t addr, const mp_obj_t *mapping, const uint8_t *pixels, size_t numBytes) {
is31fl3741_begin_transaction(i2c);
for (size_t i = 0; i < numBytes; i += 3) {
uint16_t ridx = mp_obj_get_int(mapping[i]);
if (ridx != 65535) {
@ -71,4 +73,6 @@ void common_hal_is31fl3741_write(busio_i2c_obj_t *i2c, uint8_t addr, const mp_ob
is31fl3741_set_led(i2c, addr, mp_obj_get_int(mapping[i + 2]), IS31GammaTable[pixels[i + 2]], 0); // blue
}
}
is31fl3741_end_transaction(i2c);
}