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

Changes per review

This commit is contained in:
latkinso42 2022-09-04 15:57:59 -04:00
parent 6fe2ea4513
commit d7a1db5b87
4 changed files with 35 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ports/raspberrypi/common-hal/adcbuffer/BufferedInput.c
View File

@ -62,7 +62,7 @@ void common_hal_adcbuffer_bufferedinput_construct(adcbuffer_bufferedinput_obj_t
self->buffer = buffer;
self->len = len;
// Set sample rate - used in readmultiple
// Set sample rate - used in read
self->bytes_per_sample = bytes_per_sample;
self->sample_rate = sample_rate;
@ -74,6 +74,13 @@ void common_hal_adcbuffer_bufferedinput_construct(adcbuffer_bufferedinput_obj_t
adc_gpio_init(pin->number);
adc_select_input(self->chan); // chan = pin - 26 ??
// RP2040 Implementation Detail
// Fills the supplied buffer with ADC values using DMA transfer.
// If the buffer is 8-bit, then values are 8-bit shifted and error bit is off.
// If buffer is 16-bit, then values are not shifted and error bit is present.
// Number of transfers is always the number of samples which is the array
// byte length divided by the bytes_per_sample.
// self->bytes_per_sample == 1
uint dma_size = DMA_SIZE_8;
bool show_error_bit = false;
@ -141,7 +148,7 @@ void common_hal_adcbuffer_bufferedinput_deinit(adcbuffer_bufferedinput_obj_t *se
dma_channel_unclaim(self->dma_chan);
}
void common_hal_adcbuffer_bufferedinput_readmultiple(adcbuffer_bufferedinput_obj_t *self) {
void common_hal_adcbuffer_bufferedinput_read(adcbuffer_bufferedinput_obj_t *self) {
uint32_t cdl = self->len / self->bytes_per_sample;

41
shared-bindings/adcbuffer/BufferedInput.c
View File

@ -38,15 +38,19 @@
#include "shared-bindings/util.h"
//| class BufferedInput:
//| """Input analog voltage level to supplied buffer using DMA Capture"""
//| """Capture multiple analog voltage levels to the supplied buffer"""
//|
//| def __init__(self, pin: microcontroller.Pin, buffer: WriteableBuffer, *, sample_rate: int = 500000) -> None:
//| """Use the BufferedInput on the given pin. Fill the given buffer from ADC read values at the supplied
//| sample_rate.
//| """Create a `BufferedInput` 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: The desired playback sample rate
//| :param ~int sample_rate: rate: sampling frequency, in samples per second
//|
//| Usage::
//|
@ -58,7 +62,7 @@
//| mybuffer = array.array("H", [0] * length)
//| rate = 500000
//| adcbuf = adcbuffer.BufferedInput(board.GP26, mybuffer, rate)
//| adcbuf.readmultiple()
//| adcbuf.read()
//| adcbuf.deinit()
//| for i in range(length):
//| print(i, mybuffer[i])
@ -93,7 +97,7 @@ STATIC mp_obj_t adcbuffer_bufferedinput_make_new(const mp_obj_type_t *type, size
if (bufinfo.typecode == 'h' || bufinfo.typecode == 'H') {
bytes_per_sample = 2;
} else if (bufinfo.typecode != 'b' && bufinfo.typecode != 'B' && bufinfo.typecode != BYTEARRAY_TYPECODE) {
mp_raise_ValueError(translate("sample_source buffer must be a bytearray or array of type 'h', 'H', 'b' or 'B'"));
mp_raise_ValueError_varg(translate("%q must`` be a bytearray or array of type 'h', 'H', 'b' or 'B'"), MP_QSTR_buffer);
}
// Validate sample rate here
@ -117,7 +121,7 @@ STATIC mp_obj_t adcbuffer_bufferedinput_make_new(const mp_obj_type_t *type, size
}
//| def deinit(self) -> None:
//| """Turn off the BufferedInput and release the pin for other use."""
//| """Shut down the `BufferedInput` and release the pin for other use."""
//| ...
//|
STATIC mp_obj_t adcbuffer_bufferedinput_deinit(mp_obj_t self_in) {
@ -147,26 +151,23 @@ STATIC mp_obj_t adcbuffer_bufferedinput___exit__(size_t n_args, const mp_obj_t *
}
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(adcbuffer_bufferedinput___exit___obj, 4, 4, adcbuffer_bufferedinput___exit__);
//| value: None
//| """Fills the supplied buffer with ADC values using DMA transfer.
//| If the buffer is 8-bit, then values are 8-bit shifted and error bit is off.
//| If buffer is 16-bit, then values are not shifted and error bit is present.
//| Number of transfers is always the number of samples which is the array
//| byte length divided by the bytes_per_sample."""
//|
//| def read(self) -> None:
//| """Fills the provided buffer with ADC voltage values."""
//|
STATIC mp_obj_t adcbuffer_bufferedinput_obj_readmultiple(mp_obj_t self_in) {
STATIC mp_obj_t adcbuffer_bufferedinput_obj_read(mp_obj_t self_in) {
adcbuffer_bufferedinput_obj_t *self = MP_OBJ_TO_PTR(self_in);
check_for_deinit(self);
common_hal_adcbuffer_bufferedinput_readmultiple(self);
common_hal_adcbuffer_bufferedinput_read(self);
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(adcbuffer_bufferedinput_readmultiple_obj, adcbuffer_bufferedinput_obj_readmultiple);
MP_DEFINE_CONST_FUN_OBJ_1(adcbuffer_bufferedinput_read_obj, adcbuffer_bufferedinput_obj_read);
STATIC const mp_rom_map_elem_t adcbuffer_bufferedinput_locals_dict_table[] = {
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&adcbuffer_bufferedinput_deinit_obj) },
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&adcbuffer_bufferedinput___exit___obj) },
{ MP_ROM_QSTR(MP_QSTR_readmultiple), MP_ROM_PTR(&adcbuffer_bufferedinput_readmultiple_obj)},
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&adcbuffer_bufferedinput_deinit_obj) },
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&adcbuffer_bufferedinput___exit___obj) },
{ MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&adcbuffer_bufferedinput_read_obj)},
};

2
shared-bindings/adcbuffer/BufferedInput.h
View File

@ -35,6 +35,6 @@ extern const mp_obj_type_t adcbuffer_bufferedinput_type;
void common_hal_adcbuffer_bufferedinput_construct(adcbuffer_bufferedinput_obj_t *self, const mcu_pin_obj_t *pin, uint8_t *buffer, uint32_t len, uint8_t bytes_per_sample, bool samples_signed, uint32_t sample_rate);
void common_hal_adcbuffer_bufferedinput_deinit(adcbuffer_bufferedinput_obj_t *self);
bool common_hal_adcbuffer_bufferedinput_deinited(adcbuffer_bufferedinput_obj_t *self);
void common_hal_adcbuffer_bufferedinput_readmultiple(adcbuffer_bufferedinput_obj_t *self);
void common_hal_adcbuffer_bufferedinput_read(adcbuffer_bufferedinput_obj_t *self);
#endif // __MICROPY_INCLUDED_SHARED_BINDINGS_ADCBUFFER_BUFFEREDINPUT_H__

10
shared-bindings/adcbuffer/__init__.c
View File

@ -48,15 +48,13 @@
//|
//| length = 5000000
//| mybuffer = array.array("H", [0] * length)
//| adcbuf_obj = adcbuffer.BufferedInput(GP26, mybuffer, length)
//| adcbuffer.readmultiple()
//| adc_in = adcbuffer.BufferedInput(GP26, mybuffer, length)
//| adcbuffer.read()
//| print(*mybuffer)
//| adcbuf_obj.deinit()
//| adc_in.deinit()
//|
//| This example will initialize the the device, read and fill
//| :py:data:`~adcbuffer.BufferedInPut` to mybuffer and then
//| :py:meth:`~adcbuffer.BufferedInPut.deinit` the hardware. The last step is optional
//| because CircuitPython will do it automatically after the program finishes.
//| :py:data:`~adcbuffer.BufferedInPut` to mybuffer
//|
//| TODO: For the essentials of `adcbuffer`, see the `CircuitPython Essentials
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-adcbuffer>`_