Merge pull request #7797 from Neradoc/espnow-peer-arguments

espnow.Peer: fix argument types and default values
This commit is contained in:
Dan Halbert 2023-03-28 09:05:46 -04:00 committed by GitHub
commit 31f46f2460
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 20 deletions

View File

@ -53,7 +53,7 @@ static void espnow_check_for_deinit(espnow_obj_t *self) {
//| class ESPNow: //| class ESPNow:
//| """Provides access to the ESP-NOW protocol.""" //| """Provides access to the ESP-NOW protocol."""
//| //|
//| def __init__(self, buffer_size: Optional[int], phy_rate: Optional[int]) -> None: //| def __init__(self, buffer_size: int = 526, phy_rate: int = 0) -> None:
//| """Allocate and initialize `ESPNow` instance as a singleton. //| """Allocate and initialize `ESPNow` instance as a singleton.
//| //|
//| :param int buffer_size: The size of the internal ring buffer. Default: 526 bytes. //| :param int buffer_size: The size of the internal ring buffer. Default: 526 bytes.

View File

@ -40,10 +40,11 @@
//| def __init__( //| def __init__(
//| self, //| self,
//| mac: bytes, //| mac: bytes,
//| *,
//| lmk: Optional[bytes], //| lmk: Optional[bytes],
//| channel: int = 0, //| channel: int = 0,
//| interface: int = 0, //| interface: int = 0,
//| encrypt: bool = False, //| encrypted: bool = False,
//| ) -> None: //| ) -> None:
//| """Construct a new peer object. //| """Construct a new peer object.
//| //|
@ -51,17 +52,17 @@
//| :param bytes lmk: The Local Master Key (lmk) of the peer. //| :param bytes lmk: The Local Master Key (lmk) of the peer.
//| :param int channel: The peer's channel. Default: 0 ie. use the current channel. //| :param int channel: The peer's channel. Default: 0 ie. use the current channel.
//| :param int interface: The WiFi interface to use. Default: 0 ie. STA. //| :param int interface: The WiFi interface to use. Default: 0 ie. STA.
//| :param bool encrypt: Whether or not to use encryption. //| :param bool encrypted: Whether or not to use encryption.
//| """ //| """
//| ... //| ...
STATIC mp_obj_t espnow_peer_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 espnow_peer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
enum { ARG_mac, ARG_lmk, ARG_channel, ARG_interface, ARG_encrypt }; enum { ARG_mac, ARG_lmk, ARG_channel, ARG_interface, ARG_encrypted };
static const mp_arg_t allowed_args[] = { static const mp_arg_t allowed_args[] = {
{ MP_QSTR_mac, MP_ARG_OBJ | MP_ARG_REQUIRED }, { MP_QSTR_mac, MP_ARG_OBJ | MP_ARG_REQUIRED },
{ MP_QSTR_lmk, MP_ARG_OBJ, { .u_obj = mp_const_none } }, { MP_QSTR_lmk, MP_ARG_OBJ | MP_ARG_KW_ONLY, { .u_obj = mp_const_none } },
{ MP_QSTR_channel, MP_ARG_INT, { .u_obj = mp_const_none } }, { MP_QSTR_channel, MP_ARG_INT | MP_ARG_KW_ONLY, { .u_int = 0 } },
{ MP_QSTR_interface,MP_ARG_INT, { .u_obj = mp_const_none } }, { MP_QSTR_interface,MP_ARG_INT | MP_ARG_KW_ONLY, { .u_int = 0 } },
{ MP_QSTR_encrypt, MP_ARG_BOOL,{ .u_obj = mp_const_none } }, { MP_QSTR_encrypted,MP_ARG_BOOL | MP_ARG_KW_ONLY, { .u_bool = false } },
}; };
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)]; mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
@ -77,20 +78,11 @@ STATIC mp_obj_t espnow_peer_make_new(const mp_obj_type_t *type, size_t n_args, s
memcpy(self->peer_info.peer_addr, common_hal_espnow_get_bytes_len(args[ARG_mac].u_obj, ESP_NOW_ETH_ALEN), ESP_NOW_ETH_ALEN); memcpy(self->peer_info.peer_addr, common_hal_espnow_get_bytes_len(args[ARG_mac].u_obj, ESP_NOW_ETH_ALEN), ESP_NOW_ETH_ALEN);
const mp_obj_t channel = args[ARG_channel].u_obj; self->peer_info.channel = mp_arg_validate_int_range(args[ARG_channel].u_int, 0, 14, MP_QSTR_channel);
if (channel != mp_const_none) {
self->peer_info.channel = mp_arg_validate_int_range(mp_obj_get_int(channel), 0, 14, MP_QSTR_channel);
}
const mp_obj_t interface = args[ARG_interface].u_obj; self->peer_info.ifidx = (wifi_interface_t)mp_arg_validate_int_range(args[ARG_interface].u_int, 0, 1, MP_QSTR_interface);
if (interface != mp_const_none) {
self->peer_info.ifidx = (wifi_interface_t)mp_arg_validate_int_range(mp_obj_get_int(interface), 0, 1, MP_QSTR_interface);
}
const mp_obj_t encrypt = args[ARG_encrypt].u_obj; self->peer_info.encrypt = args[ARG_encrypted].u_bool;
if (encrypt != mp_const_none) {
self->peer_info.encrypt = mp_obj_is_true(encrypt);
}
const mp_obj_t lmk = args[ARG_lmk].u_obj; const mp_obj_t lmk = args[ARG_lmk].u_obj;
if (lmk != mp_const_none) { if (lmk != mp_const_none) {