182 lines
7.4 KiB
C
182 lines
7.4 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* SPDX-FileCopyrightText: Copyright (c) 2022 Lee Atkinson, MeanStride Technology, Inc.
|
|
*
|
|
* TODO: Based on analogio/AnalogIn.c from Scott Shaw
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include "shared/runtime/context_manager_helpers.h"
|
|
#include "py/binary.h"
|
|
#include "py/mphal.h"
|
|
#include "py/nlr.h"
|
|
#include "py/objproperty.h"
|
|
#include "py/runtime.h"
|
|
#include "shared-bindings/microcontroller/Pin.h"
|
|
#include "shared-bindings/analogbufio/BufferedIn.h"
|
|
#include "shared-bindings/util.h"
|
|
|
|
//| class BufferedIn:
|
|
//| """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::
|
|
//|
|
|
//| import board
|
|
//| import analogbufio
|
|
//| import array
|
|
//|
|
|
//| length = 1000
|
|
//| mybuffer = array.array("H", 0x0000 for i in range(length))
|
|
//| rate = 500000
|
|
//| adcbuf = analogbufio.BufferedIn(board.GP26, mybuffer, rate)
|
|
//| adcbuf.read()
|
|
//| adcbuf.deinit()
|
|
//| for i in range(length):
|
|
//| print(i, mybuffer[i])
|
|
//|
|
|
//| (TODO) The reference voltage varies by platform so use
|
|
//| ``reference_voltage`` to read the configured setting.
|
|
//| (TODO) Provide mechanism to read CPU Temperature."""
|
|
//| ...
|
|
//|
|
|
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) {
|
|
enum { ARG_pin, ARG_buffer, ARG_sample_rate };
|
|
static const mp_arg_t allowed_args[] = {
|
|
{ MP_QSTR_pin, MP_ARG_OBJ | MP_ARG_REQUIRED },
|
|
{ MP_QSTR_buffer, MP_ARG_OBJ | MP_ARG_REQUIRED },
|
|
{ MP_QSTR_sample_rate, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 500000} },
|
|
};
|
|
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
|
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
|
|
|
// Validate Pin
|
|
const mcu_pin_obj_t *pin = validate_obj_is_free_pin(args[ARG_pin].u_obj);
|
|
|
|
// Buffer Pointer defined and allocated by user
|
|
mp_buffer_info_t bufinfo;
|
|
mp_get_buffer_raise(args[ARG_buffer].u_obj, &bufinfo, MP_BUFFER_READ);
|
|
|
|
// signed or unsigned, byte per sample
|
|
bool signed_samples = bufinfo.typecode == 'b' || bufinfo.typecode == 'h';
|
|
uint8_t bytes_per_sample = 1;
|
|
|
|
// Bytes Per Sample
|
|
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_varg(translate("%q must`` be a bytearray or array of type 'h', 'H', 'b' or 'B'"), MP_QSTR_buffer);
|
|
}
|
|
|
|
// Validate sample rate here
|
|
uint32_t sample_rate = (uint32_t)mp_arg_validate_int_range(args[ARG_sample_rate].u_int, 1, 500000, MP_QSTR_sample_rate);
|
|
|
|
// Create local object
|
|
analogbufio_bufferedin_obj_t *self = m_new_obj(analogbufio_bufferedin_obj_t);
|
|
self->base.type = &analogbufio_bufferedin_type;
|
|
|
|
// Call local intereface in ports/common-hal/analogbufio
|
|
common_hal_analogbufio_bufferedin_construct(self,
|
|
pin,
|
|
((uint8_t *)bufinfo.buf),
|
|
bufinfo.len,
|
|
bytes_per_sample,
|
|
signed_samples,
|
|
sample_rate
|
|
);
|
|
|
|
return MP_OBJ_FROM_PTR(self);
|
|
}
|
|
|
|
//| def deinit(self) -> None:
|
|
//| """Shut down the `BufferedIn` and release the pin for other use."""
|
|
//| ...
|
|
//|
|
|
STATIC mp_obj_t analogbufio_bufferedin_deinit(mp_obj_t self_in) {
|
|
analogbufio_bufferedin_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
common_hal_analogbufio_bufferedin_deinit(self);
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(analogbufio_bufferedin_deinit_obj, analogbufio_bufferedin_deinit);
|
|
|
|
STATIC void check_for_deinit(analogbufio_bufferedin_obj_t *self) {
|
|
if (common_hal_analogbufio_bufferedin_deinited(self)) {
|
|
raise_deinited_error();
|
|
}
|
|
}
|
|
|
|
//| Provided by context manager helper.
|
|
//|
|
|
//| def __exit__(self) -> None:
|
|
//| """Automatically deinitializes the hardware when exiting a context. See
|
|
//| :ref:`lifetime-and-contextmanagers` for more info."""
|
|
//| ...
|
|
//|
|
|
STATIC mp_obj_t analogbufio_bufferedin___exit__(size_t n_args, const mp_obj_t *args) {
|
|
(void)n_args;
|
|
common_hal_analogbufio_bufferedin_deinit(args[0]);
|
|
return mp_const_none;
|
|
}
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(analogbufio_bufferedin___exit___obj, 4, 4, analogbufio_bufferedin___exit__);
|
|
|
|
//|
|
|
//| def read(self) -> None:
|
|
//| """Fills the provided buffer with ADC voltage values."""
|
|
//|
|
|
STATIC mp_obj_t analogbufio_bufferedin_obj_read(mp_obj_t self_in) {
|
|
analogbufio_bufferedin_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
check_for_deinit(self);
|
|
common_hal_analogbufio_bufferedin_read(self);
|
|
return mp_const_none;
|
|
}
|
|
MP_DEFINE_CONST_FUN_OBJ_1(analogbufio_bufferedin_read_obj, analogbufio_bufferedin_obj_read);
|
|
|
|
STATIC const mp_rom_map_elem_t analogbufio_bufferedin_locals_dict_table[] = {
|
|
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&analogbufio_bufferedin_deinit_obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&analogbufio_bufferedin___exit___obj) },
|
|
{ MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&analogbufio_bufferedin_read_obj)},
|
|
|
|
};
|
|
|
|
STATIC MP_DEFINE_CONST_DICT(analogbufio_bufferedin_locals_dict, analogbufio_bufferedin_locals_dict_table);
|
|
|
|
const mp_obj_type_t analogbufio_bufferedin_type = {
|
|
{ &mp_type_type },
|
|
.name = MP_QSTR_BufferedIn,
|
|
.make_new = analogbufio_bufferedin_make_new,
|
|
.locals_dict = (mp_obj_t)&analogbufio_bufferedin_locals_dict,
|
|
};
|