Skip to content

Commit 94b8fb6

Browse files
authored
Merge pull request ARMmbed#36 from pan-/update_eddystone_service_instructions
Update instructions of the regarding the BLE Eddystone service.
2 parents 7e17526 + 5729819 commit 94b8fb6

File tree

16 files changed

+44
-32
lines changed

16 files changed

+44
-32
lines changed

BLE_EddystoneService/img/1.png

50 KB
Loading

BLE_EddystoneService/img/10.png

53.8 KB
Loading

BLE_EddystoneService/img/2.png

43.7 KB
Loading

BLE_EddystoneService/img/3.png

47.5 KB
Loading

BLE_EddystoneService/img/4.png

58.5 KB
Loading

BLE_EddystoneService/img/5.png

118 KB
Loading

BLE_EddystoneService/img/6.png

53 KB
Loading

BLE_EddystoneService/img/7.png

39.3 KB
Loading

BLE_EddystoneService/img/8.png

53.6 KB
Loading

BLE_EddystoneService/img/9.png

54.6 KB
Loading
-19.7 KB
Binary file not shown.

BLE_EddystoneService/img/edit_url.png

-23.7 KB
Binary file not shown.
Binary file not shown.

BLE_EddystoneService/img/result.png

-39.9 KB
Binary file not shown.

BLE_EddystoneService/img/save_url.png

-26.3 KB
Binary file not shown.

BLE_EddystoneService/readme.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,18 @@ The Eddystone Beacon sample application runs in two stages:
1212

1313
## Requirements
1414

15-
You should install the *Physical Web* application on your phone:
15+
The sample application can be seen on any BLE scanner on a smartphone. If you don't have a scanner on your phone, please install :
1616

17-
- [Android version](https://play.google.com/store/apps/details?id=physical_web.org.physicalweb)
18-
19-
- [iOS version](https://itunes.apple.com/us/app/physical-web/id927653608?mt=8)
20-
21-
22-
**Note:** It is also possible to use a regular scanner to interract with your Eddystone beacon but it requires
23-
knowledge about BLE and Eddystone beacon specification out of the scope of this document.
17+
- [nRF Master Control Panel](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp) for Android.
2418

19+
- [LightBlue](https://itunes.apple.com/gb/app/lightblue-bluetooth-low-energy/id557428110?mt=8) for iPhone.
2520

2621
Hardware requirements are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
2722

2823
## Building instructions
2924

3025
Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
3126

32-
### Working with nRF51-based 16K targets
33-
34-
Because of memory constraints, you can't use the SoftDevice 130 (S130) to build for nRF51-based 16K targets. If you are using these targets, then before building:
35-
36-
1. Open the ``config.json`` file in this sample.
37-
1. Change ``soft device`` to ``S110``.
38-
1. Save.
39-
40-
You can now build for nRF51-based 16K targets.
4127

4228
## Setting up the beacon
4329

@@ -51,40 +37,66 @@ By default, the beacon directs to the url ``http://mbed.org``. You can change th
5137

5238
1. Build the application and install it on your board as explained in the building instructions.
5339

54-
1. Open the *Physical Web* application on your phone. It will start to search for nearby beacons.
40+
1. Open the BLE scanner on your phone.
41+
42+
1. Start a scan.
5543

56-
![](img/app_start.png)
44+
![](img/1.png)
5745

58-
**figure 1** Start of the *Physical Web* application version 0.1.856 on Android
46+
**figure 1** Start of the *nRF Connect* application version 4.8.1 on Android
5947

60-
1. When the beacon starts up, the Configuration Service runs for 30 seconds.
48+
1. Find your device; it should be named `EDDYSTONE CONFIG`. When the beacon starts up, the Configuration Service runs for 30 seconds.
6149
During this time it is possible to change the URL advertised by the beacon.
6250
It is also important to note that during these 30 seconds, your device will not advertise any URL.
6351

64-
![](img/open_configuration.png)
52+
![](img/2.png)
53+
54+
**figure 2** Scan results using nRF Master Control Panel 4.8.1
55+
56+
57+
1. Establish a connection with your device while it is configurable.
58+
59+
![](img/3.png)
60+
61+
**figure 3** How to establish a connection using Master Control Panel 4.8.1
62+
63+
1. Discover the services and the characteristics on the device. The *Eddystone-URL Configuration Service* has the UUID `ee0c2080-8786-40ba-ab96-99b91ac981d8` and includes the *URI Data* characteristic which has the UUID `ee0c2085-8786-40ba-ab96-99b91ac981d8`.
64+
65+
![](img/4.png)
66+
67+
**figure 4** Minimized view of services using Master Control Panel 4.8.1
68+
69+
![](img/5.png)
70+
71+
**figure 5** Extended view of the *Eddystone-URL Configuration Service* using Master Control Panel 4.8.1
72+
73+
74+
1. Edit the URL advertised by your beacon. You can learn more about the encoding rule [here](https://github.com/google/eddystone/blob/a52406ee6053720f78fb0c63bfc38b38e6800824/eddystone-url/README.md#eddystone-url-http-url-encoding). For this example, we can set the URL to https://www.arm.com by setting the value to `0x0161726D00`.
6575

66-
**figure 2** How to open the beacon configuration view using the *Physical Web* application version 0.1.856 on Android
76+
![](img/6.png)
6777

78+
**figure 6** How to edit characteristic value using Master Control Panel 4.8.1
6879

69-
1. Edit the URL advertised by your beacon.
80+
![](img/7.png)
7081

71-
![](img/edit_url.png)
82+
**figure 7** Edition of the URL using Master Control Panel 4.8.1
7283

73-
**figure 3** How to edit the URL advertised by your beacon using the *Physical Web* application version 0.1.856 on Android
7484

85+
1. The URL is now set https://www.arm.com . It is mandatory to disconnect your phone from the beacon to let the beacon advertise the new URI.
7586

76-
1. Save the URL which will be advertised by your beacon.
87+
![](img/8.png)
7788

78-
![](img/save_url.png)
89+
**figure 8** URL updated using Master Control Panel 4.8.1.
7990

80-
**figure 4** How to save your beacon configuration and start advertising URL using the *Physical Web* application version 0.1.856 on Android.
91+
1. Enter the scanner mode and start a scan to see the URL advertised by the beacon.
8192

93+
![](img/9.png)
8294

83-
1. Find your device; it should advertise the URL you have set.
95+
**figure 9** How to enter reenter in the scanner command panel using Master Control Panel 4.8.1.
8496

85-
![](img/result.png)
97+
![](img/10.png)
8698

87-
**figure 5** Display of URL advertised by your beacon using the *Physical Web* application version 0.1.856 on Android.
99+
**figure 10** Eddystone beacon advertising.
88100

89101

90102
**Note:** You can use the [Eddystone Observer](https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_EddystoneObserver) sample instead of a phone application.

0 commit comments

Comments
 (0)