Merge pull request #1993 from dhalbert/ble-scanner5.0.0-alpha.0

bleio: add central and scanner functionality, cleanup bleio API, some code restructure

1 files changed, 107 insertions, 88 deletions

diff --git a/shared-bindings/bleio/Address.c b/shared-bindings/bleio/Address.c
index b7c76b7b2..37f01042c 100644
--- a/shared-bindings/bleio/Address.c
+++ b/shared-bindings/bleio/Address.c
@@ -3,6 +3,7 @@
  *
  * The MIT License (MIT)
  *
+ * Copyright (c) 2019 Dan Halbert for Adafruit Industries
  * Copyright (c) 2018 Artur Pacholec
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -33,13 +34,6 @@
 #include "shared-bindings/bleio/Address.h"
 #include "shared-module/bleio/Address.h"
 
-#define ADDRESS_BYTE_LEN 12
-
-STATIC uint8_t xdigit_8b_value(byte nibble1, byte nibble2) {
-    return unichar_xdigit_value(nibble1) | (unichar_xdigit_value(nibble2) << 4);
-}
-
-
 //| .. currentmodule:: bleio
 //|
 //| :class:`Address` -- BLE address
@@ -48,31 +42,20 @@ STATIC uint8_t xdigit_8b_value(byte nibble1, byte nibble2) {
 //| Encapsulates the address of a BLE device.
 //|
 
-//| .. class:: Address(address)
+//| .. class:: Address(address, address_type)
 //|
 //|   Create a new Address object encapsulating the address value.
 //|   The value itself can be one of:
 //|
-//|   - a `str` value in the format of 'XXXXXXXXXXXX' or 'XX:XX:XX:XX:XX:XX' (12 hex digits)
-//|   - a `bytes` or `bytearray` containing 6 bytes
-//|   - another Address object
-//|
-//|   :param address: The address to encapsulate
-//|
-
-//|   .. attribute:: type
-//|
-//|     The address type. One of:
-//|
-//|     - `bleio.AddressType.PUBLIC`
-//|     - `bleio.AddressType.RANDOM_STATIC`
-//|     - `bleio.AddressType.RANDOM_PRIVATE_RESOLVABLE`
-//|     - `bleio.AddressType.RANDOM_PRIVATE_NON_RESOLVABLE`
+//|   :param buf address: The address value to encapsulate. A buffer object (bytearray, bytes) of 6 bytes.
+//|   :param int address_type: one of the integer values: `PUBLIC`, `RANDOM_STATIC`,
+//|     `RANDOM_PRIVATE_RESOLVABLE`, or `RANDOM_PRIVATE_NON_RESOLVABLE`.
 //|
 STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
-    enum { ARG_address };
+    enum { ARG_address, ARG_address_type };
     static const mp_arg_t allowed_args[] = {
-        { MP_QSTR_address, MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
+        { MP_QSTR_address, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_address_type, MP_ARG_INT, {.u_int = BLEIO_ADDRESS_TYPE_PUBLIC } },
     };
 
     mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
@@ -80,83 +63,52 @@ STATIC mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args,
 
     bleio_address_obj_t *self = m_new_obj(bleio_address_obj_t);
     self->base.type = &bleio_address_type;
-    self->type = ADDRESS_PUBLIC;
 
     const mp_obj_t address = args[ARG_address].u_obj;
+    mp_buffer_info_t buf_info;
+    mp_get_buffer_raise(address, &buf_info, MP_BUFFER_READ);
+    if (buf_info.len != NUM_BLEIO_ADDRESS_BYTES) {
+        mp_raise_ValueError_varg(translate("Address must be %d bytes long"), NUM_BLEIO_ADDRESS_BYTES);
+    }
 
-    if (MP_OBJ_IS_STR(address)) {
-        GET_STR_DATA_LEN(address, str, str_len);
-
-        size_t value_index = 0;
-        int str_index = str_len;
-        bool error = false;
-
-        // Loop until fewer than two characters left.
-        while (str_index >= 1 && value_index < sizeof(self->value)) {
-            if (str[str_index] == ':') {
-                // Skip colon separators.
-                str_index--;
-                continue;
-            }
-
-            if (!unichar_isxdigit(str[str_index]) ||
-                !unichar_isxdigit(str[str_index-1])) {
-                error = true;
-                break;
-            }
-
-            self->value[value_index] = xdigit_8b_value(str[str_index],
-                                                       str[str_index-1]);
-            value_index += 1;
-            str_index -= 2;
-            }
-            // Check for correct number of hex digits and no parsing errors.
-        if (error || value_index != ADDRESS_BYTE_LEN || str_index != -1) {
-            mp_raise_ValueError_varg(translate("Address is not %d bytes long or is in wrong format"),
-                                     ADDRESS_BYTE_LEN);
-        }
-    } else if (MP_OBJ_IS_TYPE(address, &mp_type_bytearray) || MP_OBJ_IS_TYPE(address, &mp_type_bytes)) {
-            mp_buffer_info_t buf_info;
-            mp_get_buffer_raise(address, &buf_info, MP_BUFFER_READ);
-            if (buf_info.len != BLEIO_ADDRESS_BYTES) {
-                mp_raise_ValueError_varg(translate("Address must be %d bytes long"), BLEIO_ADDRESS_BYTES);
-            }
-
-            for (size_t b = 0; b < BLEIO_ADDRESS_BYTES; ++b) {
-                self->value[BLEIO_ADDRESS_BYTES - b - 1] = ((uint8_t*)buf_info.buf)[b];
-            }
-    } else if (MP_OBJ_IS_TYPE(address, &bleio_address_type)) {
-        // deep copy
-        bleio_address_obj_t *other = MP_OBJ_TO_PTR(address);
-        self->type = other->type;
-        memcpy(self->value, other->value, BLEIO_ADDRESS_BYTES);
+    const mp_int_t address_type = args[ARG_address_type].u_int;
+    if (address_type < BLEIO_ADDRESS_TYPE_MIN || address_type > BLEIO_ADDRESS_TYPE_MAX) {
+        mp_raise_ValueError(translate("Address type out of range"));
     }
 
+    common_hal_bleio_address_construct(self, buf_info.buf, address_type);
+
     return MP_OBJ_FROM_PTR(self);
 }
 
-STATIC void bleio_address_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
+//|   .. attribute:: address_bytes
+//|
+//|     The bytes that make up the device address (read-only)
+//|
+STATIC mp_obj_t bleio_address_get_address_bytes(mp_obj_t self_in) {
     bleio_address_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
-    mp_printf(print, "Address('%02x:%02x:%02x:%02x:%02x:%02x')",
-        self->value[5], self->value[4], self->value[3],
-        self->value[2], self->value[1], self->value[0]);
+    return common_hal_bleio_address_get_address_bytes(self);
 }
+MP_DEFINE_CONST_FUN_OBJ_1(bleio_address_get_address_bytes_obj, bleio_address_get_address_bytes);
+
+const mp_obj_property_t bleio_address_address_bytes_obj = {
+    .base.type = &mp_type_property,
+    .proxy = {(mp_obj_t)&bleio_address_get_address_bytes_obj,
+              (mp_obj_t)&mp_const_none_obj,
+              (mp_obj_t)&mp_const_none_obj},
+};
 
+//|   .. attribute:: type
+//|
+//|     The address type (read-only).
+//|       One of the integer values: `PUBLIC`, `RANDOM_STATIC`,
+//|       `RANDOM_PRIVATE_RESOLVABLE`, or `RANDOM_PRIVATE_NON_RESOLVABLE`.
+//|
 STATIC mp_obj_t bleio_address_get_type(mp_obj_t self_in) {
     bleio_address_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
-    if (self->type == ADDRESS_PUBLIC) {
-        return (mp_obj_t)&bleio_addresstype_public_obj;
-    } else if (self->type == ADDRESS_RANDOM_STATIC) {
-        return (mp_obj_t)&bleio_addresstype_random_static_obj;
-    } else if (self->type == ADDRESS_RANDOM_PRIVATE_RESOLVABLE) {
-        return (mp_obj_t)&bleio_addresstype_random_private_resolvable_obj;
-    } else if (self->type == ADDRESS_RANDOM_PRIVATE_NON_RESOLVABLE) {
-        return (mp_obj_t)&bleio_addresstype_random_private_non_resolvable_obj;
-    }
-
-    return mp_const_none;
+    return MP_OBJ_NEW_SMALL_INT(common_hal_bleio_address_get_type(self));
 }
 MP_DEFINE_CONST_FUN_OBJ_1(bleio_address_get_type_obj, bleio_address_get_type);
 
@@ -167,8 +119,74 @@ const mp_obj_property_t bleio_address_type_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
+//|   .. method:: __eq__(other)
+//|
+//|     Two Address objects are equal if their addresses and address types are equal.
+//|
+STATIC mp_obj_t bleio_address_binary_op(mp_binary_op_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
+    switch (op) {
+        // Two Addresses are equal if their address bytes and address_type are equal
+        case MP_BINARY_OP_EQUAL:
+            if (MP_OBJ_IS_TYPE(rhs_in, &bleio_address_type)) {
+                bleio_address_obj_t *lhs = MP_OBJ_TO_PTR(lhs_in);
+                bleio_address_obj_t *rhs = MP_OBJ_TO_PTR(rhs_in);
+                return mp_obj_new_bool(
+                    mp_obj_equal(common_hal_bleio_address_get_address_bytes(lhs),
+                                 common_hal_bleio_address_get_address_bytes(rhs)) &&
+                    common_hal_bleio_address_get_type(lhs) ==
+                    common_hal_bleio_address_get_type(rhs));
+
+            } else {
+                return mp_const_false;
+            }
+
+        default:
+            return MP_OBJ_NULL; // op not supported
+    }
+}
+
+STATIC void bleio_address_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
+    bleio_address_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    if (kind == PRINT_STR) {
+        mp_buffer_info_t buf_info;
+        mp_obj_t address_bytes = common_hal_bleio_address_get_address_bytes(self);
+        mp_get_buffer_raise(address_bytes, &buf_info, MP_BUFFER_READ);
+
+        const uint8_t *buf = (uint8_t *) buf_info.buf;
+        mp_printf(print,
+                  "%02x:%02x:%02x:%02x:%02x:%02x",
+                  buf[5], buf[4], buf[3], buf[2], buf[1], buf[0]);
+    } else {
+        mp_printf(print, "<Address>");
+    }
+}
+
+//|   .. data:: PUBLIC
+//|
+//|      A publicly known address, with a company ID (high 24 bits)and company-assigned part (low 24 bits).
+//|
+//|   .. data:: RANDOM_STATIC
+//|
+//|      A randomly generated address that does not change often. It may never change or may change after
+//|      a power cycle.
+//|
+//|   .. data:: RANDOM_PRIVATE_RESOLVABLE
+//|
+//|      An address that is usable when the peer knows the other device's secret Identity Resolving Key (IRK).
+//|
+//|   .. data:: RANDOM_PRIVATE_NON_RESOLVABLE
+//|
+//|      A randomly generated address that changes on every connection.
+//|
 STATIC const mp_rom_map_elem_t bleio_address_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_address_bytes), MP_ROM_PTR(&bleio_address_address_bytes_obj) },
     { MP_ROM_QSTR(MP_QSTR_type), MP_ROM_PTR(&bleio_address_type_obj) },
+    // These match the BLE_GAP_ADDR_TYPES values used by the nRF library.
+    { MP_ROM_QSTR(MP_QSTR_PUBLIC), MP_OBJ_NEW_SMALL_INT(0) },
+    { MP_ROM_QSTR(MP_QSTR_RANDOM_STATIC), MP_OBJ_NEW_SMALL_INT(1) },
+    { MP_ROM_QSTR(MP_QSTR_RANDOM_PRIVATE_RESOLVABLE), MP_OBJ_NEW_SMALL_INT(2) },
+    { MP_ROM_QSTR(MP_QSTR_RANDOM_PRIVATE_NON_RESOLVABLE), MP_OBJ_NEW_SMALL_INT(3) },
+
 };
 
 STATIC MP_DEFINE_CONST_DICT(bleio_address_locals_dict, bleio_address_locals_dict_table);
@@ -176,7 +194,8 @@ STATIC MP_DEFINE_CONST_DICT(bleio_address_locals_dict, bleio_address_locals_dict
 const mp_obj_type_t bleio_address_type = {
     { &mp_type_type },
     .name = MP_QSTR_Address,
-    .print = bleio_address_print,
     .make_new = bleio_address_make_new,
+    .print = bleio_address_print,
+    .binary_op = bleio_address_binary_op,
     .locals_dict = (mp_obj_dict_t*)&bleio_address_locals_dict
 };