ST
BLE EddystoneObserver example
This example is a fork of the following mbed-os example:
https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-ble-EddystoneObserver/
Please read the documentation in this page.
readme.md@2:6a3a66fd3889, 2016-07-28 (annotated)
- Committer:
- Vincent Coubard
- Date:
- Thu Jul 28 23:29:23 2016 +0100
- Revision:
- 2:6a3a66fd3889
- Parent:
- 1:d839eae15f56
- Child:
- 3:b1e385adea43
Sync with mbed-os-5.1.0-rc3
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Vincent Coubard |
2:6a3a66fd3889 | 1 | The Eddystone Observer scans for Eddystone beacons that are running the [Eddystone Service example](https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_EddystoneService) (see there for general information about Eddystone beacons). It reads the advertising packets broadcast by these beacons, and prints a human-readable version of the advertised URLs to the serial console. |
| Vincent Coubard |
2:6a3a66fd3889 | 2 | |
| Vincent Coubard |
2:6a3a66fd3889 | 3 | # Running the application |
| Vincent Coubard |
2:6a3a66fd3889 | 4 | |
| Vincent Coubard |
2:6a3a66fd3889 | 5 | ## Requirements |
| Vincent Coubard |
2:6a3a66fd3889 | 6 | |
| Vincent Coubard |
2:6a3a66fd3889 | 7 | General hardware information is in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). |
| Vincent Coubard |
2:6a3a66fd3889 | 8 | |
| Vincent Coubard |
2:6a3a66fd3889 | 9 | This sample requires two devices - one to [broadcast the beacon](https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_EddystoneService) and one to scan for the broadcast. If you have more devices, you can use them as extra beacons. |
| Vincent Coubard |
2:6a3a66fd3889 | 10 | |
| Vincent Coubard |
2:6a3a66fd3889 | 11 | You need a terminal program to listen to the observer's output through a serial port. You can download one, for example: |
| Vincent Coubard |
2:6a3a66fd3889 | 12 | |
| Vincent Coubard |
2:6a3a66fd3889 | 13 | * Tera Term for Windows. |
| Vincent Coubard |
2:6a3a66fd3889 | 14 | |
| Vincent Coubard |
2:6a3a66fd3889 | 15 | * CoolTerm for Mac OS X. |
| Vincent Coubard |
2:6a3a66fd3889 | 16 | |
| Vincent Coubard |
2:6a3a66fd3889 | 17 | * GNU Screen for Linux. |
| Vincent Coubard |
2:6a3a66fd3889 | 18 | |
| Vincent Coubard |
2:6a3a66fd3889 | 19 | ## Building instructions |
| Vincent Coubard |
2:6a3a66fd3889 | 20 | |
| Vincent Coubard |
2:6a3a66fd3889 | 21 | Building instructions for all samples are in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md). |
| Vincent Coubard |
2:6a3a66fd3889 | 22 | |
| Vincent Coubard |
2:6a3a66fd3889 | 23 | 1. Build and run the [Eddystone beacon](https://github.com/ARMmbed/mbed-os-example-ble/tree/master/BLE_EddystoneService) on one or more other devices. |
| Vincent Coubard |
2:6a3a66fd3889 | 24 | |
| Vincent Coubard |
2:6a3a66fd3889 | 25 | 1. Build the Eddystone Observer application and install it on your board as explained in the building instructions. Leave the board connected to your computer. |
| Vincent Coubard |
2:6a3a66fd3889 | 26 | |
| Vincent Coubard |
2:6a3a66fd3889 | 27 | ## Checking console output |
| Vincent Coubard |
2:6a3a66fd3889 | 28 | |
| Vincent Coubard |
2:6a3a66fd3889 | 29 | To see the application's output: |
| Vincent Coubard |
2:6a3a66fd3889 | 30 | |
| Vincent Coubard |
2:6a3a66fd3889 | 31 | 1. Check which serial port your Eddystone Observer is connected to. |
| Vincent Coubard |
2:6a3a66fd3889 | 32 | |
| Vincent Coubard |
2:6a3a66fd3889 | 33 | 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``. |
| Vincent Coubard |
2:6a3a66fd3889 | 34 | |
| Vincent Coubard |
2:6a3a66fd3889 | 35 | 1. The Eddystone Observer should start printing URLs of nearby Eddystone beacons to the terminal. |