240 lines
11 KiB
C
240 lines
11 KiB
C
|
/*
|
||
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
||
|
|
*
|
||
|
|
* The MIT License (MIT)
|
||
|
|
*
|
||
|
|
* Copyright (c) 2021 Dan Halbert for Adafruit Industries
|
||
|
|
*
|
||
|
|
* 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 "lib/utils/context_manager_helpers.h"
|
||
|
|
#include "py/binary.h"
|
||
|
|
#include "py/objproperty.h"
|
||
|
|
#include "py/runtime.h"
|
||
|
|
#include "shared-bindings/keypad/Event.h"
|
||
|
|
#include "shared-bindings/keypad/ShiftRegisterKeys.h"
|
||
|
|
#include "shared-bindings/microcontroller/Pin.h"
|
||
|
|
#include "shared-bindings/util.h"
|
||
|
|
|
||
|
|
//| class ShiftRegisterKeys:
|
||
|
|
//| """Manage a set of keys attached to an incoming shift register."""
|
||
|
|
//|
|
||
|
|
//| def __init__(self, clock: microcontroller.Pin, data: microcontroller.Pin, latch: microcontroller.Pin, level_when_pressed: bool, max_events: int = 64) -> None:
|
||
|
|
//| """
|
||
|
|
//| Create a `Keys` object that will scan keys attached to a parallel-in serial-out shift register
|
||
|
|
//| like the 74HC165 or equivalent.
|
||
|
|
//| Note that you may chain shift registers to load in as many values as you need.
|
||
|
|
//|
|
||
|
|
//| Key number 0 is the first (or more properly, the zero-th) bit read. In the
|
||
|
|
//| 74HC165, this bit is labeled ``Q7``. Key number 1 will be the value of ``Q6``, etc.
|
||
|
|
//|
|
||
|
|
//| An `EventQueue` is created when this object is created and is available in the `events` attribute.
|
||
|
|
//|
|
||
|
|
//| The keys are debounced by waiting about 20 msecs before reporting a transition.
|
||
|
|
//|
|
||
|
|
//| :param microcontroller.Pin clock: The shift register clock pin.
|
||
|
|
//| The shift register should clock on a low-to-high transition.
|
||
|
|
//| :param microcontroller.Pin data: the incoming shift register data pin
|
||
|
|
//| :param microcontroller.Pin latch:
|
||
|
|
//| Pin used to trigger loading parallel data pins into the shift register.
|
||
|
|
//| Active low: pull low to load the data.
|
||
|
|
//| :param int num_keys: number of data lines to clock in
|
||
|
|
//| :param bool value_when_pressed: ``True`` if the pin reads high when the key is pressed.
|
||
|
|
//| ``False`` if the pin reads low (is grounded) when the key is pressed.
|
||
|
|
//| :param int max_events: maximum size of `events` `EventQueue`:
|
||
|
|
//| maximum number of key transition events that are saved.
|
||
|
|
//| Must be >= 1.
|
||
|
|
//| If a new event arrives when the queue is full, the oldest event is discarded.
|
||
|
|
//| """
|
||
|
|
//| ...
|
||
|
|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = m_new_obj(keypad_shiftregisterkeys_obj_t);
|
||
|
|
self->base.type = &keypad_shiftregisterkeys_type;
|
||
|
|
enum { ARG_clock, ARG_data, ARG_latch, ARG_num_keys, ARG_value_when_pressed, ARG_max_events };
|
||
|
|
static const mp_arg_t allowed_args[] = {
|
||
|
|
{ MP_QSTR_clock, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ },
|
||
|
|
{ MP_QSTR_data, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ },
|
||
|
|
{ MP_QSTR_latch, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ },
|
||
|
|
{ MP_QSTR_num_keys, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
|
||
|
|
{ MP_QSTR_value_when_pressed, MP_ARG_REQUIRED | MP_ARG_KW_ONLY | MP_ARG_BOOL },
|
||
|
|
{ MP_QSTR_max_events, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 64} },
|
||
|
|
};
|
||
|
|
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
|
||
|
|
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
|
||
|
|
|
||
|
|
mcu_pin_obj_t *clock = validate_obj_is_free_pin(args[ARG_clock].u_obj);
|
||
|
|
mcu_pin_obj_t *data = validate_obj_is_free_pin(args[ARG_data].u_obj);
|
||
|
|
mcu_pin_obj_t *latch = validate_obj_is_free_pin(args[ARG_latch].u_obj);
|
||
|
|
|
||
|
|
if (args[ARG_num_keys].u_int < 1) {
|
||
|
|
mp_raise_ValueError_varg(translate("%q must be >= 1"), MP_QSTR_num_keys);
|
||
|
|
}
|
||
|
|
const size_t num_keys = (size_t)args[ARG_num_keys].u_int;
|
||
|
|
|
||
|
|
const bool value_when_pressed = args[ARG_value_when_pressed].u_bool;
|
||
|
|
|
||
|
|
if (args[ARG_max_events].u_int < 1) {
|
||
|
|
mp_raise_ValueError_varg(translate("%q must be >= 1"), MP_QSTR_max_events);
|
||
|
|
}
|
||
|
|
const size_t max_events = (size_t)args[ARG_max_events].u_int;
|
||
|
|
|
||
|
|
common_hal_keypad_shiftregisterkeys_construct(
|
||
|
|
self, clock, data, latch, num_keys, value_when_pressed, max_events);
|
||
|
|
|
||
|
|
return MP_OBJ_FROM_PTR(self);
|
||
|
|
}
|
||
|
|
|
||
|
|
//| def deinit(self) -> None:
|
||
|
|
//| """Stop scanning and release the pins."""
|
||
|
|
//| ...
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_deinit(mp_obj_t self_in) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
||
|
|
|
||
|
|
common_hal_keypad_shiftregisterkeys_deinit(self);
|
||
|
|
return MP_ROM_NONE;
|
||
|
|
}
|
||
|
|
MP_DEFINE_CONST_FUN_OBJ_1(keypad_shiftregisterkeys_deinit_obj, keypad_shiftregisterkeys_deinit);
|
||
|
|
|
||
|
|
//| def __enter__(self) -> Keys:
|
||
|
|
//| """No-op used by Context Managers."""
|
||
|
|
//| ...
|
||
|
|
//|
|
||
|
|
// Provided by context manager helper.
|
||
|
|
|
||
|
|
//| def __exit__(self) -> None:
|
||
|
|
//| """Automatically deinitializes when exiting a context. See
|
||
|
|
//| :ref:`lifetime-and-contextmanagers` for more info."""
|
||
|
|
//| ...
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys___exit__(size_t n_args, const mp_obj_t *args) {
|
||
|
|
(void)n_args;
|
||
|
|
common_hal_keypad_shiftregisterkeys_deinit(args[0]);
|
||
|
|
return MP_ROM_NONE;
|
||
|
|
}
|
||
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(keypad_shiftregisterkeys___exit___obj, 4, 4, keypad_shiftregisterkeys___exit__);
|
||
|
|
|
||
|
|
STATIC void check_for_deinit(keypad_shiftregisterkeys_obj_t *self) {
|
||
|
|
if (common_hal_keypad_shiftregisterkeys_deinited(self)) {
|
||
|
|
raise_deinited_error();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//| num_keys: int
|
||
|
|
//| """The number of keys that are being scanned. (read-only)
|
||
|
|
//| """
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_get_num_keys(mp_obj_t self_in) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
||
|
|
return MP_OBJ_NEW_SMALL_INT(common_hal_keypad_shiftregisterkeys_get_num_keys(self));
|
||
|
|
}
|
||
|
|
MP_DEFINE_CONST_FUN_OBJ_1(keypad_shiftregisterkeys_get_num_keys_obj, keypad_shiftregisterkeys_get_num_keys);
|
||
|
|
|
||
|
|
const mp_obj_property_t keypad_shiftregisterkeys_num_keys_obj = {
|
||
|
|
.base.type = &mp_type_property,
|
||
|
|
.proxy = {(mp_obj_t)&keypad_shiftregisterkeys_get_num_keys_obj,
|
||
|
|
MP_ROM_NONE,
|
||
|
|
MP_ROM_NONE},
|
||
|
|
};
|
||
|
|
|
||
|
|
//| def pressed(self, key_num: int) -> None:
|
||
|
|
//| """Return ``True`` if the given key is pressed.
|
||
|
|
// This is a debounced read of the key state which bypasses the `events` `EventQueue`.
|
||
|
|
//| """
|
||
|
|
//| ...
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_pressed(mp_obj_t self_in, mp_obj_t key_num_in) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
||
|
|
check_for_deinit(self);
|
||
|
|
|
||
|
|
mp_int_t key_num = mp_obj_get_int(key_num_in);
|
||
|
|
if (key_num < 0 || (size_t)key_num >= common_hal_keypad_shiftregisterkeys_get_num_keys(self)) {
|
||
|
|
mp_raise_ValueError_varg(translate("%q out of range"), MP_QSTR_key_num);
|
||
|
|
}
|
||
|
|
|
||
|
|
return mp_obj_new_bool(common_hal_keypad_shiftregisterkeys_pressed(self, (mp_uint_t)key_num));
|
||
|
|
}
|
||
|
|
MP_DEFINE_CONST_FUN_OBJ_2(keypad_shiftregisterkeys_pressed_obj, keypad_shiftregisterkeys_pressed);
|
||
|
|
|
||
|
|
//| def store_states(self, states: _typing.WriteableBuffer) -> None:
|
||
|
|
//| """Write the states of all the keys into ``states``.
|
||
|
|
//| Write a ``1`` if pressed, and ``0`` if released.
|
||
|
|
//| The ``length`` of ``states`` must be `num_keys`.
|
||
|
|
//| This is a debounced read of the state of all the keys, and bypasses the `events` `EventQueue`.
|
||
|
|
//| The read is done atomically.
|
||
|
|
//| """
|
||
|
|
//| ...
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_store_states(mp_obj_t self_in, mp_obj_t pressed) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
||
|
|
check_for_deinit(self);
|
||
|
|
|
||
|
|
mp_buffer_info_t bufinfo;
|
||
|
|
mp_get_buffer_raise(pressed, &bufinfo, MP_BUFFER_WRITE);
|
||
|
|
if (bufinfo.typecode != 'b' && bufinfo.typecode != 'B' && bufinfo.typecode != BYTEARRAY_TYPECODE) {
|
||
|
|
mp_raise_ValueError_varg(translate("%q must store bytes"), MP_QSTR_pressed);
|
||
|
|
}
|
||
|
|
if (bufinfo.len != common_hal_keypad_shiftregisterkeys_get_num_keys(self)) {
|
||
|
|
mp_raise_ValueError_varg(translate("%q length must be %q"), MP_QSTR_pressed, MP_QSTR_num_keys);
|
||
|
|
}
|
||
|
|
|
||
|
|
common_hal_keypad_shiftregisterkeys_store_states(self, (uint8_t *)bufinfo.buf);
|
||
|
|
return MP_ROM_NONE;
|
||
|
|
}
|
||
|
|
MP_DEFINE_CONST_FUN_OBJ_2(keypad_shiftregisterkeys_store_states_obj, keypad_shiftregisterkeys_store_states);
|
||
|
|
|
||
|
|
//| events: EventQueue
|
||
|
|
//| """The `EventQueue` associated with this `Keys` object. (read-only)
|
||
|
|
//| """
|
||
|
|
//|
|
||
|
|
STATIC mp_obj_t keypad_shiftregisterkeys_get_events(mp_obj_t self_in) {
|
||
|
|
keypad_shiftregisterkeys_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
||
|
|
return common_hal_keypad_shiftregisterkeys_get_events(self);
|
||
|
|
}
|
||
|
|
MP_DEFINE_CONST_FUN_OBJ_1(keypad_shiftregisterkeys_get_events_obj, keypad_shiftregisterkeys_get_events);
|
||
|
|
|
||
|
|
const mp_obj_property_t keypad_shiftregisterkeys_events_obj = {
|
||
|
|
.base.type = &mp_type_property,
|
||
|
|
.proxy = {(mp_obj_t)&keypad_shiftregisterkeys_get_events_obj,
|
||
|
|
MP_ROM_NONE,
|
||
|
|
MP_ROM_NONE},
|
||
|
|
};
|
||
|
|
|
||
|
|
STATIC const mp_rom_map_elem_t keypad_shiftregisterkeys_locals_dict_table[] = {
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR_deinit), MP_ROM_PTR(&keypad_shiftregisterkeys_deinit_obj) },
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&default___enter___obj) },
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&keypad_shiftregisterkeys___exit___obj) },
|
||
|
|
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR_events), MP_ROM_PTR(&keypad_shiftregisterkeys_events_obj) },
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR_num_keys), MP_ROM_PTR(&keypad_shiftregisterkeys_num_keys_obj) },
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR_pressed), MP_ROM_PTR(&keypad_shiftregisterkeys_pressed_obj) },
|
||
|
|
{ MP_ROM_QSTR(MP_QSTR_store_states), MP_ROM_PTR(&keypad_shiftregisterkeys_store_states_obj) },
|
||
|
|
};
|
||
|
|
|
||
|
|
STATIC MP_DEFINE_CONST_DICT(keypad_shiftregisterkeys_locals_dict, keypad_shiftregisterkeys_locals_dict_table);
|
||
|
|
|
||
|
|
const mp_obj_type_t keypad_shiftregisterkeys_type = {
|
||
|
|
{ &mp_type_type },
|
||
|
|
.name = MP_QSTR_ShiftRegisterKeys,
|
||
|
|
.make_new = keypad_shiftregisterkeys_make_new,
|
||
|
|
.locals_dict = (mp_obj_t)&keypad_shiftregisterkeys_locals_dict,
|
||
|
|
};
|