bleio: Move the Scanner class to a shared module

Author: arturo182

ports/nrf/Makefile

@@ -134,7 +134,6 @@ DRIVERS_SRC_C += $(addprefix modules/,\
 	ubluepy/ubluepy_characteristic.c \
 	ubluepy/ubluepy_delegate.c \
 	ubluepy/ubluepy_constants.c \
-	ubluepy/ubluepy_scanner.c \
 	)
 
 SRC_COMMON_HAL += \
@@ -167,6 +166,7 @@ SRC_COMMON_HAL += \
 	bleio/__init__.c \
 	bleio/Adapter.c \
 	bleio/Descriptor.c \
+	bleio/Scanner.c \
 	bleio/UUID.c
 endif
 

ports/nrf/common-hal/bleio/Scanner.c

@@ -0,0 +1,59 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Glenn Ruben Bakke
+ * Copyright (c) 2018 Artur Pacholec
+ *
+ * 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 "ble_drv.h"
+#include "py/mphal.h"
+#include "shared-bindings/bleio/Scanner.h"
+#include "shared-bindings/bleio/ScanEntry.h"
+
+STATIC void adv_event_handler(bleio_scanner_obj_t *self, ble_drv_adv_data_t *data) {
+    // TODO: Don't add new entry for each item, group by address and update
+    bleio_scanentry_obj_t *item = m_new_obj(bleio_scanentry_obj_t);
+    item->base.type = &bleio_scanentry_type;
+
+    item->rssi = data->rssi;
+    item->data = mp_obj_new_bytearray(data->data_len, data->p_data);
+
+    item->address.type = data->addr_type;
+    memcpy(item->address.value, data->p_peer_addr, BLEIO_ADDRESS_BYTES);
+
+    mp_obj_list_append(self->adv_reports, item);
+
+    ble_drv_scan_continue();
+}
+
+void common_hal_bleio_scanner_scan(bleio_scanner_obj_t *self, mp_int_t timeout) {
+    ble_drv_adv_report_handler_set(self, adv_event_handler);
+
+    ble_drv_scan_start(self->interval, self->window);
+
+    mp_hal_delay_ms(timeout);
+
+    ble_drv_scan_stop();
+}

ports/nrf/drivers/bluetooth/ble_drv.c

@@ -94,7 +94,7 @@ static volatile ble_drv_disc_add_service_callback_t disc_add_service_handler;
 static volatile ble_drv_disc_add_char_callback_t    disc_add_char_handler;
 static volatile ble_drv_gattc_char_data_callback_t  gattc_char_data_handle;
 
-static mp_obj_t mp_adv_observer;
+static bleio_scanner_obj_t *mp_adv_observer;
 static mp_obj_t mp_gattc_observer;
 static mp_obj_t mp_gattc_disc_service_observer;
 static mp_obj_t mp_gattc_disc_char_observer;
@@ -707,8 +707,8 @@ void ble_drv_gattc_event_handler_set(mp_obj_t obj, ble_drv_gattc_evt_callback_t
     gattc_event_handler = evt_handler;
 }
 
-void ble_drv_adv_report_handler_set(mp_obj_t obj, ble_drv_adv_evt_callback_t evt_handler) {
-    mp_adv_observer = obj;
+void ble_drv_adv_report_handler_set(bleio_scanner_obj_t *self, ble_drv_adv_evt_callback_t evt_handler) {
+    mp_adv_observer = self;
     adv_event_handler = evt_handler;
 }
 
@@ -760,15 +760,15 @@ void ble_drv_attr_c_write(uint16_t conn_handle, uint16_t handle, uint16_t len, u
         ;
     }
 }
-void ble_drv_scan_start(void) {
+void ble_drv_scan_start(uint16_t interval, uint16_t window) {
     SD_TEST_OR_ENABLE();
 
     ble_gap_scan_params_t scan_params;
     memset(&scan_params, 0, sizeof(ble_gap_scan_params_t));
 
     scan_params.active   = 1;
-    scan_params.interval = MSEC_TO_UNITS(100, UNIT_0_625_MS);
-    scan_params.window   = MSEC_TO_UNITS(100, UNIT_0_625_MS);
+    scan_params.interval = MSEC_TO_UNITS(interval, UNIT_0_625_MS);
+    scan_params.window   = MSEC_TO_UNITS(window, UNIT_0_625_MS);
 #if (BLUETOOTH_SD == 140)
     scan_params.scan_phys          = BLE_GAP_PHY_1MBPS;
 #endif
@@ -1003,10 +1003,9 @@ static void ble_evt_handler(ble_evt_t * p_ble_evt) {
 #endif
             };
 
-            // TODO: Fix unsafe callback to possible undefined callback...
-            adv_event_handler(mp_adv_observer,
-                              p_ble_evt->header.evt_id,
-                              &adv_data);
+            if (adv_event_handler != NULL) {
+                adv_event_handler(mp_adv_observer, &adv_data);
+            }
             break;
 
         case BLE_GAP_EVT_CONN_PARAM_UPDATE_REQUEST:

ports/nrf/drivers/bluetooth/ble_drv.h

@@ -32,6 +32,8 @@
 #include <stdint.h>
 #include <stdbool.h>
 
+#include "shared-module/bleio/Scanner.h"
+
 #include "modubluepy.h"
 
 typedef struct {
@@ -67,7 +69,7 @@ typedef struct {
 typedef void (*ble_drv_gap_evt_callback_t)(mp_obj_t self, uint16_t event_id, uint16_t conn_handle, uint16_t length, uint8_t * data);
 typedef void (*ble_drv_gatts_evt_callback_t)(mp_obj_t self, uint16_t event_id, uint16_t attr_handle, uint16_t length, uint8_t * data);
 typedef void (*ble_drv_gattc_evt_callback_t)(mp_obj_t self, uint16_t event_id, uint16_t attr_handle, uint16_t length, uint8_t * data);
-typedef void (*ble_drv_adv_evt_callback_t)(mp_obj_t self, uint16_t event_id, ble_drv_adv_data_t * data);
+typedef void (*ble_drv_adv_evt_callback_t)(bleio_scanner_obj_t *self, ble_drv_adv_data_t *data);
 typedef void (*ble_drv_disc_add_service_callback_t)(mp_obj_t self, ble_drv_service_data_t * p_service_data);
 typedef void (*ble_drv_disc_add_char_callback_t)(mp_obj_t self, ble_drv_char_data_t * p_desc_data);
 typedef void (*ble_drv_gattc_char_data_callback_t)(mp_obj_t self, uint16_t length, uint8_t * p_data);
@@ -106,13 +108,13 @@ void ble_drv_attr_s_notify(uint16_t conn_handle, uint16_t handle, uint16_t len,
 
 void ble_drv_attr_c_write(uint16_t conn_handle, uint16_t handle, uint16_t len, uint8_t * p_data, bool w_response);
 
-void ble_drv_scan_start(void);
+void ble_drv_scan_start(uint16_t interval, uint16_t window);
 
 void ble_drv_scan_continue(void);
 
 void ble_drv_scan_stop(void);
 
-void ble_drv_adv_report_handler_set(mp_obj_t obj, ble_drv_adv_evt_callback_t evt_handler);
+void ble_drv_adv_report_handler_set(bleio_scanner_obj_t *self, ble_drv_adv_evt_callback_t evt_handler);
 
 void ble_drv_connect(uint8_t * p_addr, uint8_t addr_type);
 

ports/nrf/modules/ubluepy/modubluepy.c

@@ -33,7 +33,6 @@ extern const mp_obj_type_t ubluepy_service_type;
 extern const mp_obj_type_t ubluepy_characteristic_type;
 extern const mp_obj_type_t ubluepy_delegate_type;
 extern const mp_obj_type_t ubluepy_constants_type;
-extern const mp_obj_type_t ubluepy_scanner_type;
 
 STATIC const mp_rom_map_elem_t mp_module_ubluepy_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__),        MP_ROM_QSTR(MP_QSTR_ubluepy) },
@@ -42,9 +41,6 @@ STATIC const mp_rom_map_elem_t mp_module_ubluepy_globals_table[] = {
 #endif
 #if 0 // MICROPY_PY_UBLUEPY_CENTRAL
     { MP_ROM_QSTR(MP_QSTR_Central),         MP_ROM_PTR(&ubluepy_central_type) },
-#endif
-#if MICROPY_PY_UBLUEPY_CENTRAL
-    { MP_ROM_QSTR(MP_QSTR_Scanner),         MP_ROM_PTR(&ubluepy_scanner_type) },
 #endif
     { MP_ROM_QSTR(MP_QSTR_DefaultDelegate), MP_ROM_PTR(&ubluepy_delegate_type) },
     { MP_ROM_QSTR(MP_QSTR_Service),         MP_ROM_PTR(&ubluepy_service_type) },

ports/nrf/modules/ubluepy/modubluepy.h

@@ -77,7 +77,6 @@ p.advertise(device_name="micr", services=[s])
 extern const mp_obj_type_t ubluepy_service_type;
 extern const mp_obj_type_t ubluepy_characteristic_type;
 extern const mp_obj_type_t ubluepy_peripheral_type;
-extern const mp_obj_type_t ubluepy_scanner_type;
 extern const mp_obj_type_t ubluepy_constants_type;
 extern const mp_obj_type_t ubluepy_constants_ad_types_type;
 
@@ -147,11 +146,6 @@ typedef struct _ubluepy_advertise_data_t {
     bool       connectable;
 } ubluepy_advertise_data_t;
 
-typedef struct _ubluepy_scanner_obj_t {
-    mp_obj_base_t base;
-    mp_obj_t      adv_reports;
-} ubluepy_scanner_obj_t;
-
 typedef enum _ubluepy_prop_t {
     UBLUEPY_PROP_BROADCAST      = 0x01,
     UBLUEPY_PROP_READ           = 0x02,

ports/nrf/modules/ubluepy/ubluepy_scanner.c

@@ -48,7 +48,7 @@
 //|   .. attribute:: address
 //|
 //|   The address of the device. (read-only)
-//|   This attribute is of type `bleio:Address`.
+//|   This attribute is of type `bleio.Address`.
 //|
 
 //|   .. attribute:: manufacturer_specific_data
@@ -75,7 +75,7 @@
 //|   .. attribute:: service_uuids
 //|
 //|   The address of the device. (read-only)
-//|   This attribute is a list of `bleio:UUID`.
+//|   This attribute is a list of `bleio.UUID`.
 //|   This attribute might be empty or incomplete, depending on the advertisement packet.
 //|   Currently only 16-bit UUIDS are listed.
 //|