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

Attempt to fix Build-Docs and Pre-Commit

Browse Source
This commit is contained in:
latkinso42 2022-09-06 18:58:57 -04:00
parent 5498b3ac91
commit 25078a24a3
2 changed files with 44 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
shared-bindings/analogbufio/BufferedIn.c
View File

@ -38,19 +38,7 @@
#include "shared-bindings/util.h" #include "shared-bindings/util.h"
//| class BufferedIn: //| class BufferedIn:
//| """Capture multiple analog voltage levels to the supplied buffer""" //| """Capture multiple analog voltage levels to the supplied buffer
//|
//| def __init__(self, pin: microcontroller.Pin, buffer: WriteableBuffer, *, sample_rate: int = 500000) -> None:
//| """Create a `BufferedIn` on the given pin. ADC values will be read
//| into the given buffer at the supplied sample_rate. Depending on the
//| buffer typecode, 'b', 'B', 'h', 'H', samples are 8-bit byte-arrays or
//| 16-bit half-words and are signed or unsigned.
//| The ADC most significant bits of the ADC are kept. Please see:
//| `https://docs.circuitpython.org/en/latest/docs/library/array.html`
//|
//| :param ~microcontroller.Pin pin: the pin to read from
//| :param ~circuitpython_typing.WriteableBuffer buffer: buffer: A buffer for samples
//| :param ~int sample_rate: rate: sampling frequency, in samples per second
//| //|
//| Usage:: //| Usage::
//| //|
@ -70,6 +58,19 @@
//| (TODO) The reference voltage varies by platform so use //| (TODO) The reference voltage varies by platform so use
//| ``reference_voltage`` to read the configured setting. //| ``reference_voltage`` to read the configured setting.
//| (TODO) Provide mechanism to read CPU Temperature.""" //| (TODO) Provide mechanism to read CPU Temperature."""
//|
//| def __init__(self, pin: microcontroller.Pin, buffer: WriteableBuffer, *, sample_rate: int = 500000) -> None:
//| """Create a `BufferedIn` on the given pin. ADC values will be read
//| into the given buffer at the supplied sample_rate. Depending on the
//| buffer typecode, 'b', 'B', 'h', 'H', samples are 8-bit byte-arrays or
//| 16-bit half-words and are signed or unsigned.
//| The ADC most significant bits of the ADC are kept. (See
//| https://docs.circuitpython.org/en/latest/docs/library/array.html)
//|
//| :param ~microcontroller.Pin pin: the pin to read from
//| :param ~circuitpython_typing.WriteableBuffer buffer: buffer: A buffer for samples
//| :param ~int sample_rate: rate: sampling frequency, in samples per second"""
//| ... //| ...
//| //|
STATIC mp_obj_t analogbufio_bufferedin_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) { STATIC mp_obj_t analogbufio_bufferedin_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
@ -136,9 +137,12 @@ STATIC void check_for_deinit(analogbufio_bufferedin_obj_t *self) {
raise_deinited_error(); raise_deinited_error();
} }
} }
//| def __enter__(self) -> AnalogIn:
//| Provided by context manager helper. //| """No-op used by Context Managers."""
//| ...
//| //|
// Provided by context manager helper.
//| def __exit__(self) -> None: //| def __exit__(self) -> None:
//| """Automatically deinitializes the hardware when exiting a context. See //| """Automatically deinitializes the hardware when exiting a context. See
//| :ref:`lifetime-and-contextmanagers` for more info.""" //| :ref:`lifetime-and-contextmanagers` for more info."""
@ -151,9 +155,9 @@ STATIC mp_obj_t analogbufio_bufferedin___exit__(size_t n_args, const mp_obj_t *a
} }
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(analogbufio_bufferedin___exit___obj, 4, 4, analogbufio_bufferedin___exit__); STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(analogbufio_bufferedin___exit___obj, 4, 4, analogbufio_bufferedin___exit__);
//|
//| def read(self) -> None: //| def read(self) -> None:
//| """Fills the provided buffer with ADC voltage values.""" //| """Fills the provided buffer with ADC voltage values."""
//| ...
//| //|
STATIC mp_obj_t analogbufio_bufferedin_obj_read(mp_obj_t self_in) { STATIC mp_obj_t analogbufio_bufferedin_obj_read(mp_obj_t self_in) {
analogbufio_bufferedin_obj_t *self = MP_OBJ_TO_PTR(self_in); analogbufio_bufferedin_obj_t *self = MP_OBJ_TO_PTR(self_in);