From 58d7a529a0f0016607f916c1c6bd81e6dfe94a19 Mon Sep 17 00:00:00 2001 From: Milanka Ringwald Date: Wed, 1 Nov 2017 15:35:16 +0100 Subject: [PATCH] update examples docu --- example/dut_mode_classic.c | 2 +- example/le_streamer.c | 6 +++--- example/panu_demo.c | 2 ++ example/pbap_client_demo.c | 4 ++++ example/spp_and_le_counter.c | 8 ++++++-- example/spp_and_le_streamer.c | 7 ++++++- example/spp_counter.c | 3 +++ example/spp_streamer.c | 7 +++++-- example/spp_streamer_client.c | 4 ++-- 9 files changed, 32 insertions(+), 11 deletions(-) diff --git a/example/dut_mode_classic.c b/example/dut_mode_classic.c index 3907fd95f..86d261b19 100644 --- a/example/dut_mode_classic.c +++ b/example/dut_mode_classic.c @@ -41,7 +41,7 @@ /* EXAMPLE_START(dut_mode_classic): Enable Device Under Test (DUT) Mode for BR/EDR * * @text DUT mode can be used for production testing. This example just configures - * the Bluetooth Controller for DUT mode + * the Bluetooth Controller for DUT mode. */ // ***************************************************************************** diff --git a/example/le_streamer.c b/example/le_streamer.c index 4d8fd12f1..a1782c8f1 100644 --- a/example/le_streamer.c +++ b/example/le_streamer.c @@ -38,7 +38,7 @@ #define __BTSTACK_FILE__ "le_streamer.c" // ***************************************************************************** -/* EXAMPLE_START(le_streamer): LE Peripheral - Stream data over GATT +/* EXAMPLE_START(le_streamer): LE Streamer - Stream data over GATT. * * @text All newer operating systems provide GATT Client functionality. * This example shows how to get a maximal throughput via BLE: @@ -49,8 +49,8 @@ * a connection interval of 30 ms and there's no public way to use a shorter * interval with iOS (if we're not implementing an HID device). * - * @text Note: To start the streaming, please run the le_streamer_client example - * on other device, or use some GATT Explorer, e.g. LightBlue, BLExplr. + * @text Note: To start the streaming, run the example. + * On remote device use some GATT Explorer, e.g. LightBlue, BLExplr to enable notifications. */ // ***************************************************************************** diff --git a/example/panu_demo.c b/example/panu_demo.c index bb97d1dcc..42f457a34 100644 --- a/example/panu_demo.c +++ b/example/panu_demo.c @@ -48,6 +48,8 @@ * sets up a BNEP server and registers a PANU SDP record and waits for incoming connections. * In client mode, it connects to a remote device, does an SDP Query to identify the PANU * service and initiates a BNEP connection. + * + * Note: currently supported only on Linux and Mac. */ #include "btstack_config.h" diff --git a/example/pbap_client_demo.c b/example/pbap_client_demo.c index 893833f01..22558a7dc 100644 --- a/example/pbap_client_demo.c +++ b/example/pbap_client_demo.c @@ -39,6 +39,10 @@ // ***************************************************************************** /* EXAMPLE_START(pbap_client_demo): Connect to Phonebook Server and get contacts. + * + * @text Note: The Bluetooth address of the remote Phonbook server is hardcoded. + * Change it before running example, then use the UI to connect to it, to set and + * query contacts. */ // ***************************************************************************** diff --git a/example/spp_and_le_counter.c b/example/spp_and_le_counter.c index f0c1db8c1..8af0a997b 100644 --- a/example/spp_and_le_counter.c +++ b/example/spp_and_le_counter.c @@ -43,8 +43,12 @@ * @text The SPP and LE Counter example combines the Bluetooth Classic SPP Counter * and the Bluetooth LE Counter into a single application. * - * In this Section, we only point out the differences to the individual examples - * and how how the stack is configured. + * @text In this Section, we only point out the differences to the individual examples + * and how the stack is configured. + * + * @text Note: To test, please run the example, and then: + * - for SPP pair from a remote device, and open the Virtual Serial Port, + * - for LE use some GATT Explorer, e.g. LightBlue, BLExplr, to enable notifications. */ // ***************************************************************************** diff --git a/example/spp_and_le_streamer.c b/example/spp_and_le_streamer.c index 853cfd4db..96f53f83f 100644 --- a/example/spp_and_le_streamer.c +++ b/example/spp_and_le_streamer.c @@ -41,8 +41,13 @@ * @text The SPP and LE Streamer example combines the Bluetooth Classic SPP Streamer * and the Bluetooth LE Streamer into a single application. * - * In this Section, we only point out the differences to the individual examples + * @text In this Section, we only point out the differences to the individual examples * and how how the stack is configured. + * + * @text Note: To test, please run the example, and then: + * - for SPP pair from a remote device, and open the Virtual Serial Port, + * - for LE use some GATT Explorer, e.g. LightBlue, BLExplr, to enable notifications. + * */ // ***************************************************************************** diff --git a/example/spp_counter.c b/example/spp_counter.c index fef7cf8d9..ee197463e 100644 --- a/example/spp_counter.c +++ b/example/spp_counter.c @@ -43,6 +43,9 @@ * @text The Serial port profile (SPP) is widely used as it provides a serial * port over Bluetooth. The SPP counter example demonstrates how to setup an SPP * service, and provide a periodic timer over RFCOMM. + * + * @text Note: To test, please run the spp_counter example, and then pair from + * a remote device, and open the Virtual Serial Port. */ // ***************************************************************************** diff --git a/example/spp_streamer.c b/example/spp_streamer.c index 4813e37c5..9d456e315 100644 --- a/example/spp_streamer.c +++ b/example/spp_streamer.c @@ -42,11 +42,14 @@ */ // ***************************************************************************** -/* EXAMPLE_START(spp_streamer): Send test data via SPP as fast as possible +/* EXAMPLE_START(spp_streamer): Send test data via SPP as fast as possible. * * @text After RFCOMM connections gets open, request a * RFCOMM_EVENT_CAN_SEND_NOW via rfcomm_request_can_send_now_event(). - * When we get the RFCOMM_EVENT_CAN_SEND_NOW, send data and request another one. + * @text When we get the RFCOMM_EVENT_CAN_SEND_NOW, send data and request another one. + * + * @text Note: To test, run the example, pair from a remote + * device, and open the Virtual Serial Port. */ // ***************************************************************************** diff --git a/example/spp_streamer_client.c b/example/spp_streamer_client.c index 173a0e95b..a9d2416c3 100644 --- a/example/spp_streamer_client.c +++ b/example/spp_streamer_client.c @@ -44,8 +44,8 @@ // ***************************************************************************** /* EXAMPLE_START(spp_streamer_client): Client for SPP Streamer * - * @text The SPP Streamer Clients connects to SPP Streamer and tracks the - * amount of received data + * @text Note: The SPP Streamer Client scans for and connects to SPP Streamer, + * and measures the throughput. */ // *****************************************************************************