Skip to content
This repository was archived by the owner on Sep 16, 2024. It is now read-only.

Add Bluetooth.CHAR_SUBSCRIBE_EVENT #121

Merged
merged 3 commits into from
Jan 24, 2018
Merged

Add Bluetooth.CHAR_SUBSCRIBE_EVENT #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8bcdc9
Add Bluetooth.CHAR_SUBSCRIBE_EVENT
caylanlarson Jan 8, 2018
56b0713
mods/bt: Add Bluetooth.CHAR_SUBSCRIBE_EVENT
caylanlarson Jan 8, 2018
2dcdffe
Merge branch 'feature/ble-char-subscribe-callback' of github.com:semi…
caylanlarson Jan 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/library/network.Bluetooth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,12 +289,18 @@ Constants

Characteristic properties (bit values that can be combined)

.. data:: Bluetooth.CHAR_CONFIG_NOTIFY
Bluetooth.CHAR_CONFIG_INDICATE

Characteristic configurations representing the current value of the characteristic's configuration descriptor.

.. data:: Bluetooth.CHAR_READ_EVENT
Bluetooth.CHAR_WRITE_EVENT
Bluetooth.NEW_ADV_EVENT
Bluetooth.CLIENT_CONNECTED
Bluetooth.CLIENT_DISCONNECTED
Bluetooth.CHAR_NOTIFY_EVENT
Bluetooth.CHAR_SUBSCRIBE_EVENT

Charactertistic callback events

Expand Down Expand Up @@ -418,6 +424,12 @@ The following class allows you to manage characteristics from a **Client**.

characteristic.properties()

.. method:: characteristic.config()

Returns an integer indicating the client configuration of the characteristic. Configurations are represented by bit values that can be ORed together. The configuration is often updated when the CHAR_SUBSCRIBE_EVENT is generated. See the constants section for more details. ::

characteristic.config()

.. method:: characteristic.read()

Read the value of the characteristic. For now it always returns a bytes object representing the characteristic value. In the future a specific type (integer, string, bytes) will be returned depending on the characteristic in question. ::
Expand Down Expand Up @@ -491,7 +503,7 @@ The following class allows you to manage **Server** characteristics.

Creates a callback that will be executed when any of the triggers occurs. The arguments are:

- ``trigger`` can be either ``Bluetooth.CHAR_READ_EVENT`` or ``Bluetooth.CHAR_WRITE_EVENT``.
- ``trigger`` can be either ``Bluetooth.CHAR_READ_EVENT`` or ``Bluetooth.CHAR_WRITE_EVENT`` or ``Bluetooth.CHAR_SUBSCRIBE_EVENT``.
- ``handler`` is the function that will be executed when the callback is triggered.
- ``arg`` is the argument that gets passed to the callback. If nothing is given, the characteristic object that owns the callback will be used.

Expand Down
21 changes: 21 additions & 0 deletions esp32/mods/modbt.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
#define MOD_BT_GATTS_WRITE_EVT (0x0010)
#define MOD_BT_GATTC_NOTIFY_EVT (0x0020)
#define MOD_BT_GATTC_INDICATE_EVT (0x0040)
#define MOD_BT_GATTS_SUBSCRIBE_EVT (0x0080)

/******************************************************************************
DEFINE PRIVATE TYPES
Expand Down Expand Up @@ -197,6 +198,7 @@ typedef struct {
uint32_t events;
uint32_t trans_id;
bool read_request;
uint16_t config;
} bt_gatts_char_obj_t;

/******************************************************************************
Expand Down Expand Up @@ -566,6 +568,13 @@ static void gatts_event_handler(esp_gatts_cb_event_t event, esp_gatt_if_t gatts_
} else { // descriptor
if (attr_obj->uuid.len == ESP_UUID_LEN_16 && attr_obj->uuid.uuid.uuid16 == GATT_UUID_CHAR_CLIENT_CONFIG) {
uint16_t value = param->write.value[1] << 8 | param->write.value[0];
bt_gatts_char_obj_t *char_obj = (bt_gatts_char_obj_t *)attr_obj->parent;
char_obj->config = value;
char_obj->events |= MOD_BT_GATTS_SUBSCRIBE_EVT;
if (char_obj->trigger & MOD_BT_GATTS_SUBSCRIBE_EVT) {
Copy link
Contributor

@husigeza husigeza Jan 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this block be placed if the "value" checked and verified that it is the allowed range ? So the registered callback should be called/triggered if the configuration was successful which means the client successfully subscribed to the notify characteristic

Copy link
Author

@semireg semireg Jan 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is definitely some ambiguity here that I didn't fully understand. The design I was trying to achieve generates a MOD_BT_GATTS_SUBSCRIBE_EVT callback for both SUBSCRIBE/UNSUBSCRIBE. That way, app can turn on/off resources on client demand. So this means whenever the descriptor is written to, MOD_BT_GATTS_SUBSCRIBE_EVT is called.

Copy link
Contributor

@husigeza husigeza Jan 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay this makes sense if the aim was to trigger the callback when the client unsubscribes too.

mp_irq_queue_interrupt(gatts_char_callback_handler, char_obj);
}

if (value == 0x0001) { // notifications enabled
bt_gatts_char_obj_t *char_obj = (bt_gatts_char_obj_t *)attr_obj->parent;
// the size of value[] needs to be less than MTU size
Expand Down Expand Up @@ -1341,11 +1350,18 @@ STATIC mp_obj_t bt_characteristic_events(mp_obj_t self_in) {
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(bt_characteristic_events_obj, bt_characteristic_events);

STATIC mp_obj_t bt_characteristic_config(mp_obj_t self_in) {
bt_gatts_char_obj_t *self = self_in;
return mp_obj_new_int(self->config);
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(bt_characteristic_config_obj, bt_characteristic_config);

STATIC const mp_map_elem_t bt_gatts_char_locals_dict_table[] = {
// instance methods
{ MP_OBJ_NEW_QSTR(MP_QSTR_value), (mp_obj_t)&bt_characteristic_value_obj },
{ MP_OBJ_NEW_QSTR(MP_QSTR_callback), (mp_obj_t)&bt_characteristic_callback_obj },
{ MP_OBJ_NEW_QSTR(MP_QSTR_events), (mp_obj_t)&bt_characteristic_events_obj },
{ MP_OBJ_NEW_QSTR(MP_QSTR_config), (mp_obj_t)&bt_characteristic_config_obj },
};
STATIC MP_DEFINE_CONST_DICT(bt_gatts_char_locals_dict, bt_gatts_char_locals_dict_table);

Expand Down Expand Up @@ -1422,12 +1438,17 @@ STATIC const mp_map_elem_t bt_locals_dict_table[] = {
{ MP_OBJ_NEW_QSTR(MP_QSTR_PROP_AUTH), MP_OBJ_NEW_SMALL_INT(ESP_GATT_CHAR_PROP_BIT_AUTH) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_PROP_EXT_PROP), MP_OBJ_NEW_SMALL_INT(ESP_GATT_CHAR_PROP_BIT_EXT_PROP) },

// Defined at https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.descriptor.gatt.client_characteristic_configuration.xml
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_CONFIG_NOTIFY), MP_OBJ_NEW_SMALL_INT(1 << 0) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_CONFIG_INDICATE), MP_OBJ_NEW_SMALL_INT(1 << 1) },

{ MP_OBJ_NEW_QSTR(MP_QSTR_NEW_ADV_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTC_ADV_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CLIENT_CONNECTED), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTS_CONN_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CLIENT_DISCONNECTED), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTS_DISCONN_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_READ_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTS_READ_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_WRITE_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTS_WRITE_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_NOTIFY_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTC_NOTIFY_EVT) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_SUBSCRIBE_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTS_SUBSCRIBE_EVT) },
// { MP_OBJ_NEW_QSTR(MP_QSTR_CHAR_INDICATE_EVENT), MP_OBJ_NEW_SMALL_INT(MOD_BT_GATTC_INDICATE_EVT) },
};
STATIC MP_DEFINE_CONST_DICT(bt_locals_dict, bt_locals_dict_table);
Expand Down