circuitpython/shared-bindings/alarm/pin/PinAlarm.c

/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2020 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 "shared-bindings/board/__init__.h"
#include "shared-bindings/microcontroller/__init__.h"
#include "shared-bindings/microcontroller/Pin.h"
#include "shared-bindings/alarm/pin/PinAlarm.h"

#include "py/nlr.h"
#include "py/obj.h"
#include "py/objproperty.h"
#include "py/runtime.h"
#include "supervisor/shared/translate.h"

//| class PinAlarm:
//|     """Trigger an alarm when a pin changes state."""
//|
//|     def __init__(self, *pins: microcontroller.Pin, value: bool, all_same_value: bool = False, edge: bool = False, pull: bool = False) -> None:
//|         """Create an alarm triggered by a `microcontroller.Pin` level. The alarm is not active
//|         until it is passed to an `alarm`-enabling function, such as `alarm.sleep_until_alarms()` or
//|         `alarm.set_deep_sleep_alarms()`.
//|
//|         :param microcontroller.Pin \*pins: The pins to monitor. On some ports, the choice of pins
//|           may be limited due to hardware restrictions, particularly for deep-sleep alarms.
//|         :param bool value: When active, trigger when the pin value is high (``True``) or low (``False``).
//|           On some ports, multiple `PinAlarm` objects may need to have coordinated values
//|           for deep-sleep alarms.
//|         :param bool all_same_value: If ``True``, all pins listed must be at ``value`` to trigger the alarm.
//|           If ``False``, any one of the pins going to ``value`` will trigger the alarm.
//|         :param bool edge: If ``True``, trigger only when there is a transition to the specified
//|           value of ``value``. If ``True``, if the alarm becomes active when the pin value already
//|           matches ``value``, the alarm is not triggered: the pin must transition from ``not value``
//|           to ``value`` to trigger the alarm. On some ports, edge-triggering may not be available,
//|           particularly for deep-sleep alarms.
//|         :param bool pull: Enable a pull-up or pull-down which pulls the pin to the level opposite
//|           opposite that of ``value``. For instance, if ``value`` is set to ``True``, setting ``pull``
//|           to ``True`` will enable a pull-down, to hold the pin low normally until an outside signal
//|           pulls it high.
//|         """
//|         ...
//|
STATIC mp_obj_t alarm_pin_pin_alarm_make_new(const mp_obj_type_t *type, mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
    alarm_pin_pin_alarm_obj_t *self = m_new_obj(alarm_pin_pin_alarm_obj_t);
    self->base.type = &alarm_pin_pin_alarm_type;
    enum { ARG_value, ARG_all_same_value, ARG_edge, ARG_pull };
    static const mp_arg_t allowed_args[] = {
        { MP_QSTR_value, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_BOOL },
        { MP_QSTR_all_same_value, MP_ARG_KW_ONLY | MP_ARG_BOOL, {.u_bool = false} },
        { MP_QSTR_edge, MP_ARG_KW_ONLY | MP_ARG_BOOL, {.u_bool = false} },
        { MP_QSTR_pull, MP_ARG_KW_ONLY | MP_ARG_BOOL, {.u_bool = false} },
    };
    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
    mp_arg_parse_all(0, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);

    for (size_t i = 0; i < n_args; i ++) {
        validate_obj_is_free_pin(pos_args[i]);
    }

    common_hal_alarm_pin_pin_alarm_construct(
        self, pos_args, n_args,
        args[ARG_value].u_bool,
        args[ARG_all_same_value].u_bool,
        args[ARG_edge].u_bool,
        args[ARG_pull].u_bool);

    return MP_OBJ_FROM_PTR(self);
}

//|     pins: Tuple[microcontroller.pin]
//|     """The trigger pins."""
//|
STATIC mp_obj_t alarm_pin_pin_alarm_obj_get_pins(mp_obj_t self_in) {
    alarm_pin_pin_alarm_obj_t *self = MP_OBJ_TO_PTR(self_in);
    return common_hal_alarm_pin_pin_alarm_get_pins(self);
}
MP_DEFINE_CONST_FUN_OBJ_1(alarm_pin_pin_alarm_get_pins_obj, alarm_pin_pin_alarm_obj_get_pins);

const mp_obj_property_t alarm_pin_pin_alarm_pins_obj = {
    .base.type = &mp_type_property,
    .proxy = {(mp_obj_t)&alarm_pin_pin_alarm_get_pins_obj,
              (mp_obj_t)&mp_const_none_obj,
              (mp_obj_t)&mp_const_none_obj},
};

//|     value: Tuple[microcontroller.pin]
//|     """The value on which to trigger."""
//|
STATIC mp_obj_t alarm_pin_pin_alarm_obj_get_value(mp_obj_t self_in) {
    alarm_pin_pin_alarm_obj_t *self = MP_OBJ_TO_PTR(self_in);
    return mp_obj_new_bool(common_hal_alarm_pin_pin_alarm_get_value(self));
}
MP_DEFINE_CONST_FUN_OBJ_1(alarm_pin_pin_alarm_get_value_obj, alarm_pin_pin_alarm_obj_get_value);

const mp_obj_property_t alarm_pin_pin_alarm_value_obj = {
    .base.type = &mp_type_property,
    .proxy = {(mp_obj_t)&alarm_pin_pin_alarm_get_value_obj,
              (mp_obj_t)&mp_const_none_obj,
              (mp_obj_t)&mp_const_none_obj},
};

STATIC const mp_rom_map_elem_t alarm_pin_pin_alarm_locals_dict_table[] = {
    { MP_ROM_QSTR(MP_QSTR_pins), MP_ROM_PTR(&alarm_pin_pin_alarm_pins_obj) },
    { MP_ROM_QSTR(MP_QSTR_value), MP_ROM_PTR(&alarm_pin_pin_alarm_value_obj) },
};

STATIC MP_DEFINE_CONST_DICT(alarm_pin_pin_alarm_locals_dict, alarm_pin_pin_alarm_locals_dict_table);

const mp_obj_type_t alarm_pin_pin_alarm_type = {
    { &mp_type_type },
    .name = MP_QSTR_PinAlarm,
    .make_new = alarm_pin_pin_alarm_make_new,
    .locals_dict = (mp_obj_t)&alarm_pin_pin_alarm_locals_dict,
};