ST / Mbed OS mbed-os-example-ble-EddystoneObserver

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@0:932f719b42d5, 2016-07-26 (annotated)

Committer:
Vincent Coubard
Date:
Tue Jul 26 14:38:37 2016 +0100
Revision:
0:932f719b42d5
Child:
1:d839eae15f56
Update example at tag mbed-os-5.0.1-rc1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 2
Vincent Coubard 0:932f719b42d5 3 # Running the application
Vincent Coubard 0:932f719b42d5 4
Vincent Coubard 0:932f719b42d5 5 ## Requirements
Vincent Coubard 0:932f719b42d5 6
Vincent Coubard 0:932f719b42d5 7 General hardware information is in the [main readme](https://github.com/ARMmbed/mbed-os-example-ble/blob/master/README.md).
Vincent Coubard 0:932f719b42d5 8
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 10
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 12
Vincent Coubard 0:932f719b42d5 13 * Tera Term for Windows.
Vincent Coubard 0:932f719b42d5 14
Vincent Coubard 0:932f719b42d5 15 * CoolTerm for Mac OS X.
Vincent Coubard 0:932f719b42d5 16
Vincent Coubard 0:932f719b42d5 17 * GNU Screen for Linux.
Vincent Coubard 0:932f719b42d5 18
Vincent Coubard 0:932f719b42d5 19 ## Building instructions
Vincent Coubard 0:932f719b42d5 20
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 22
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 24
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 26
Vincent Coubard 0:932f719b42d5 27 ## Checking console output
Vincent Coubard 0:932f719b42d5 28
Vincent Coubard 0:932f719b42d5 29 To see the application's output:
Vincent Coubard 0:932f719b42d5 30
Vincent Coubard 0:932f719b42d5 31 1. Check which serial port your Eddystone Observer is connected to.
Vincent Coubard 0:932f719b42d5 32
Vincent Coubard 0:932f719b42d5 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 0:932f719b42d5 34
Vincent Coubard 0:932f719b42d5 35 1. The Eddystone Observer should start printing URLs of nearby Eddystone beacons to the terminal.