Skip to content

Commit 2fcd28f

Browse files
committed
Merge pull request ARMmbed#69 from pan-/improve_documentation
Improve documentation.
2 parents 00535f4 + 10f6ebf commit 2fcd28f

File tree

8 files changed

+18
-13
lines changed

8 files changed

+18
-13
lines changed

BLE_BatteryLevel/readme.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ Building instructions for all samples are in the [main readme](https://github.co
2525

2626
1. Build the application and install it on your board as explained in the building instructions.
2727
1. Open the BLE scanner on your phone.
28-
1. Find your device.
29-
1. View the device's characteristics; the exact steps depend on which scanner you're using.
30-
1. The value of the battery level characteristic should be incrementing as explained above.
28+
1. Find your device; it should be named `BATTERY`.
29+
1. Establish a connection with your device.
30+
1. Discover the services and the characteristics on the device. The *Battery service* has the UUID 0x180F and includes the *Battery level* characteristic which has the UUID 0x2A19.
31+
1. Register for the notifications sent by the *Battery level* characteristic.
32+
1. You should see the battery level value change every half second. It begins at 50, goes up to 100 (in steps of 1), resets to 20 and so on.
3133

32-
If you can see the characteristic, and if its value incrementing correctly, the application worked properly.
34+
If you can see the characteristic, and if its value incrementing correctly, the application is working properly.
3335

BLE_Beacon/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Building instructions for all samples are in the [main readme](https://github.co
2424

2525
1. Build the application and install it on your board as explained in the building instructions.
2626
1. Open the BLE scanner on your phone.
27-
1. Find your device and observe its advertisements (there is no need to connect to the beacon).
27+
1. Find your device; it should be tagged as an `iBeacon` and observe its advertisements (there is no need to connect to the beacon).
2828
1. View the beacon's details; the exact steps depend on which scanner you're using.
2929

3030
**Tip:** If you are in an area with many BLE devices, it may be difficult to identify your beacon. The simplest solution is to turn your board off and on, initiate a new scan on your BLE scanner every time, and look for the beacon that appears only when your board is on.

BLE_Button/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Building instructions for all samples are in the [main readme](https://github.co
3232

3333
1. Build the application and install it on your board as explained in the building instructions.
3434
1. Open the BLE scanner on your phone.
35-
1. Find your device, it should appear with the name `Button` in the scanner.
35+
1. Find your device; it should appear with the name `Button` in the scanner.
3636
1. Establish a connection with the device.
3737
1. Discover the services and the characteristics on the device. The *Button service* has the UUID `0xA000` and includes the *Button state characteristic* which has the UUID `0xA001`.
3838
1. Register for the notifications sent by the button state characteristic then the scanner will automatically receive a notification containing the new state of the button every time the state of the button changes.

BLE_EddystoneObserver/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ To see the application's output:
3232

3333
1. Run a terminal program with the correct serial port and the baud rate set to 9600. For example, to use GNU Screen, run: ``screen /dev/tty.usbmodem1412 9600``.
3434

35-
1. The Eddystone Observer should start printing URLs to the terminal.
35+
1. The Eddystone Observer should start printing URLs of nearby Eddystone beacons to the terminal.

BLE_EddystoneService/readme.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Eddystone beacons broadcast a small amount of information, like URLs, to nearby BLE devices.
1+
Eddystone beacons broadcast a small amount of information, like URLs, to nearby BLE devices.
22

33
The Eddystone Beacon sample application runs in two stages:
44

@@ -48,8 +48,11 @@ By default, the beacon directs to the url ``http://mbed.org``. You can change th
4848

4949
1. Open the BLE scanner on your phone.
5050

51-
1. Find your device.
51+
1. Find your device; it should be tagged as `EDDYSTONE CONFIG` while the configuration service is running and it should be tagged as `Eddystone`once the device work as a beacon.
5252

53-
1. Check that the URL is correct.
53+
1. Once the device operate as a beacon, observe its advertisements packets:
54+
* UID frame are used to identify a beacon.
55+
* URL frame should report the URL advertised by the beacon.
56+
* TLM frames report telemetry informations such as battery level, temperature or the uptime of the beacon.
5457

5558
You can use the [Eddystone Observer](https://github.com/ARMmbed/ble-examples/tree/master/BLE_EddystoneObserver) sample instead of a phone application.

BLE_GAPButton/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Building instructions for all samples are in the [main readme](https://github.co
2828

2929
1. Open the BLE scanner on your phone.
3030

31-
1. Find your device and look at the advertisement broadcasted by your device (there is no need to connect to your device).
31+
1. Find your device; it should be named `GAPButton`; and look at the advertisement broadcasted by your device (there is no need to connect to your device).
3232

3333
1. The Service Data field of the advertisement packet broadcasted by your device reflects the button press count. The starting value is 0.
3434

BLE_LED/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Building instructions for all samples are in the [main readme](https://github.co
3333

3434
1. Build the application and install it on your board as explained in the building instructions.
3535
1. Open the BLE scanner on your phone.
36-
1. Find your device.
36+
1. Find your device; it should be named `LED`.
3737
1. Find the LED service; its UUID is `0xA000`. The exact instructions to do this depend on the scanner you're using.
3838
1. Find the LED characteristic; its UUID is `0xA001`. The exact instructions to do this depend on the scanner you're using.
3939
1. The characteristic accept a 1-bytes value:

BLE_URIBeacon/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Checking for Success
4949
====================
5050

5151
Your URI beacon should be detectable by BLE scanners (e.g. a smartphone) and by the
52-
Google Physical Web app.
52+
Google Physical Web app. By default, the application should point to `http://uribeacon.org`.
5353

5454
**Please note that the URIBeacon spec requires the URIBeacon app to remain in
5555
config mode for the first 60 seconds before switching to being a beacon. So if

0 commit comments

Comments
 (0)