Skip to content

Commit 054a301

Browse files
pan-0xc0170
authored andcommitted
BLE: iBeacon minor edit.
1 parent fd603c7 commit 054a301

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

features/FEATURE_BLE/ble/services/iBeacon.h

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* @par Purpose
2626
*
2727
* iBeacons are Bluetooth Low Energy (BLE) devices advertising an identification
28-
* number generally used to identify the location of devices or physical objects
28+
* number generally used to determine the location of devices or physical objects
2929
* nearby a mobile phone user.
3030
*
3131
* iOS scans for iBeacon devices in a background task and will notify Apps
@@ -41,18 +41,18 @@
4141
* Location information is hierarchically structured. A UUID specific to the
4242
* application and its deployment is used to identify a region. That region
4343
* usually identify an organization. The region is divided into subregions
44-
* identified by a major ID. The subregion may contain related points of
45-
* interrest. Finally specific points of interrest within a subregion are
46-
* distinguished by a minor ID.
44+
* identified by a major ID. The subregion contains related points of interrest
45+
* which are are distinguished by a minor ID.
4746
*
4847
* As an example a city willing to improve tourists experience can deploy a fleet
4948
* of iBeacons in relevant touristic locations it operates. The UUID may
50-
* identify a place managed by the city. The major ID would identify the place
51-
* it can be something such as a museum, an historic monument or a metro station.
52-
* The minor ID would locate a specific spot within the city place. It can be a
53-
* piece of art, a ticket dispenser or a relevant point of interrest. Each
54-
* iBeacon device is physically attached to the spot it identify and advertise
55-
* those three location information.
49+
* identify a place managed by the city. The major ID would identify the place;
50+
* it can be a museum, an historic monument, a metro station, ... The minor ID
51+
* would locate a specific spot within a specific city place. It can be a
52+
* piece of art, a ticket dispenser or a relevant point of interrest.
53+
*
54+
* Each iBeacon device is physically attached to the spot it locate and advertise
55+
* the triplet UUID, major ID and minor ID.
5656
*
5757
* @par Proximity
5858
*
@@ -61,19 +61,21 @@
6161
* proximity to a given beacon:
6262
* - Immediate: The beacon is less than one meter away from the user.
6363
* - Near: The beacon is one to three meter away from the user.
64-
* - Far: The application is not near the device, distance highly depends on
64+
* - Far: The user is not near the beacon; the distance highly depends on
6565
* the physical environment.
6666
*
67-
* Ideally beacons should be calibrated at there deployment location because the
68-
* surrounding environment affect the strength of the advertised signal.
67+
* Ideally beacons should be calibrated at their deployment location because the
68+
* surrounding environment affects the strength of the advertised signal.
6969
*
7070
* @par Usage
7171
*
72-
* Mbed OS applications can use this class to set up a device to broadcast
72+
* Mbed OS applications can use this class to configure a device to broadcast
7373
* advertising packets mimicking an iBeacon. The construction will automatically
7474
* create the payload identifying the beacon and register it as part of the
7575
* advertising payload of the device.
7676
*
77+
* Beacon configuration and advertising start is let to the user.
78+
*
7779
* @important If you are interested in manufacturing iBeacons, you must obtain a
7880
* license from Apple. More information at https://developer.apple.com/ibeacon/.
7981
* The licence also grant access to the iBeacons technical specification.

0 commit comments

Comments
 (0)