Add example exercising the GattClient API. #111

pan- · 2017-10-31T15:05:50Z

The example demonstrate uses of:

Service and characteristics discovery.
Descriptor discovery
Attribute read
Attribute write
CCCD subscription
Handling of server initiated event

TODO

Improve the documentation

pan- · 2017-10-31T15:10:16Z

@apalmieriGH @marcbonnici Could you review the code of this example.

It doesn't work on NRF based targets due to a timing issue and it works on Nucleo targets with the help of this patch: ARMmbed/ble-x-nucleo-idb0xa1#33

marcbonnici

The code itself looks fine to me.

marcbonnici · 2017-10-31T15:12:30Z

BLE_GattClient/README.md

@@ -0,0 +1,32 @@
+# BLE Gatt Client example
+
+This application demonstrate detailed uses of the GattClient APIs. 


"demonstrate" -> "demonstrates"

marcbonnici · 2017-10-31T15:12:45Z

BLE_GattClient/README.md

+
+This application demonstrate detailed uses of the GattClient APIs. 
+
+When the application is started it advertise itself to its environment with the 


"advertise" -> "advertises"

marcbonnici · 2017-10-31T15:13:14Z

BLE_GattClient/README.md

+This application demonstrate detailed uses of the GattClient APIs. 
+
+When the application is started it advertise itself to its environment with the 
+device name `GattClient`. Once you connected the device with your mobile phone, 


"you connected the" -> "you have connected to the" or "you connect to the" ?

marcbonnici · 2017-10-31T15:14:24Z

BLE_GattClient/README.md

+discovered and subscribes to the characteristics emitting notifications or 
+indications. 
+
+The device print the value of any indication or notification received from the 


"print" -> "prints"

marcbonnici · 2017-10-31T15:14:38Z

BLE_GattClient/README.md

+
+## Requirements
+
+You may us a generic BLE scanners:


"us" -> "use"
"scanners" -> "scanner"

marcbonnici · 2017-10-31T15:18:03Z

BLE_GattClient/main.cpp

+     */
+    void when_service_discovered(const DiscoveredService *discovered_service)
+    {
+        // print informations of the service discovered


"informations" -> "information"

marcbonnici · 2017-10-31T15:18:36Z

BLE_GattClient/main.cpp

+    /**
+     * Handle characteristics discovered.
+     *
+     * The GattClient invoke this function when a characteristic has been


"invoke" -> "invokes"

marcbonnici · 2017-10-31T15:19:24Z

BLE_GattClient/main.cpp

+    /**
+     * Handle termination of the service and characteristic discovery process.
+     *
+     * The GattClient invoke this function when a the service and characteristic


"invoke" -> "invokes"
Remove "a" from "a the service"

marcbonnici · 2017-10-31T15:34:31Z

BLE_GattClient/main.cpp

+};
+
+/**
+ * Handle initialization adn shutdown of the BLE Instance.


"adn" -> "and"

marcbonnici · 2017-10-31T15:44:13Z

BLE_GattClient/main.cpp

+    }
+
+    /**
+     * Stop the gatt client process when a the device is disconnected then


"when a the device disconnected" -> "when a device disconnects"

pan- · 2017-11-01T12:21:54Z

@marcbonnici Thanks for the review; I have addressed your comments.

apalmieriGH · 2017-11-02T15:36:14Z

@pan- very useful example, it is good for me.

pan- · 2017-11-06T13:46:54Z

@nvlsianpu There is some faillure on NRF targets with that example; the issue seems located in the client class. Could you look after those ?

pan- · 2017-11-23T15:58:49Z

@paul-szczepanek-arm Could you review this example ?

paul-szczepanek-arm · 2017-11-23T17:50:13Z

BLE_GattClient/main.cpp

+     */
+    void process_next_characteristic(void)
+    {
+        if (_it == 0) {


if (_it == NULL) {
alternatively reverse order of the if else to avoid comparing to NULL, I'm just complaining about using 0 for pointer comparison

I agree we have to be consistent; even if the meaning is exactly the same in C++ (NULL is an integer that evaluate to 0).

However we do not use the yoda notation in our code.

I didn't mean reverse the order of the variables in the if I meant reverse the if statements:
if (_it) {
_it = _it->next;
} else {
_it = _characteristics;
}
Yoda either I do not like.

paul-szczepanek-arm · 2017-11-24T10:33:38Z

BLE_GattClient/main.cpp

+
+    events::EventQueue &_event_queue;
+    BLE &_ble_interface;
+    GattClientProcess gatt_client_process;


missing _ prefix from private var

paul-szczepanek-arm · 2017-11-24T11:18:05Z

BLE_GattClient/main.cpp

+            return;
+        }
+
+        gap.setAdvertisingParams(make_advertising_params());


I'm getting mixed messages here, the API doc says: "It would be uncommon for this API to be used directly; there are other APIs to tweak advertisement parameters individually" yet we use it in examples?

That comment has been removed from the Gap class; unfortunatelly it is still present in the BLE class but the member function is deprecated.

paul-szczepanek-arm

review concluded offline with agreement to separate/hide the gap part

pan- · 2017-11-28T13:31:05Z

@nvlsianpu Any update ?

pan- · 2017-12-04T11:53:09Z

@paul-szczepanek-arm I've updated the PR accordingly to your comments; Could you review the changes ?

paul-szczepanek-arm

you appear to have reverted a few minor fixes in the last commit (diff with last)

paul-szczepanek-arm · 2017-12-05T17:09:58Z

BLE_GattClient/BLEProcess.h

+    }
+
+    /**
+     * Stop the gatt client process when a the device is disconnected then


"a the" -> "the"

pan- · 2018-06-25T17:00:44Z

I think this is good to go; @paul-szczepanek-arm @donatieng What do you think ?

paul-szczepanek-arm · 2018-06-26T08:33:36Z

merge

Add example exercising the GattClient API.

Add example exercising the GattClient API.

b170378

marcbonnici reviewed Oct 31, 2017

View reviewed changes

Fix GattClient example conjugation and typo.

d4fc996

paul-szczepanek-arm reviewed Nov 23, 2017

View reviewed changes

GattClient: improve code consistency

52eafbe

paul-szczepanek-arm reviewed Nov 24, 2017

View reviewed changes

GattClient: Split GAP handling fromn GattClient.

7983d8b

paul-szczepanek-arm approved these changes Dec 5, 2017

View reviewed changes

paul-szczepanek-arm reviewed Dec 5, 2017

View reviewed changes

pan- mentioned this pull request Dec 20, 2017

BLE: Nordic pal client implementation ARMmbed/mbed-os#5739

Merged

donatieng assigned pan- May 25, 2018

pan- added 5 commits June 25, 2018 17:48

Add project file into the root of the GattClient example.

65678b5

GattClient: Fix documentation typos.

0d6d566

GattClient: Improve test of the absence of iterator.

cdf8c83

GattClient: Update reference of the mbed lib to 5.9.1

c36d9c3

GattClient: Update reference of the bluenrg stack.

5d9ca80

donatieng merged commit 94ec493 into ARMmbed:master Jul 18, 2018

pan- pushed a commit to pan-/mbed-os-example-ble that referenced this pull request Sep 4, 2018

Merge pull request ARMmbed#111 from pan-/gatt-client-example

8faef82

Add example exercising the GattClient API.

		@@ -0,0 +1,32 @@
		# BLE Gatt Client example

		This application demonstrate detailed uses of the GattClient APIs.


		This application demonstrate detailed uses of the GattClient APIs.

		When the application is started it advertise itself to its environment with the

Add example exercising the GattClient API. #111

Add example exercising the GattClient API. #111

Uh oh!

Conversation

pan- commented Oct 31, 2017

TODO

Uh oh!

pan- commented Oct 31, 2017

Uh oh!

marcbonnici left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pan- commented Nov 1, 2017

Uh oh!

apalmieriGH commented Nov 2, 2017

Uh oh!

pan- commented Nov 6, 2017

Uh oh!

pan- commented Nov 23, 2017

Uh oh!

paul-szczepanek-arm Nov 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

paul-szczepanek-arm left a comment

Choose a reason for hiding this comment

Uh oh!

pan- commented Nov 28, 2017

Uh oh!

pan- commented Dec 4, 2017

Uh oh!

paul-szczepanek-arm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pan- commented Jun 25, 2018

Uh oh!

paul-szczepanek-arm commented Jun 26, 2018

Uh oh!

Uh oh!

paul-szczepanek-arm Nov 23, 2017 •

edited

Loading