26
26
*
27
27
* iBeacons are Bluetooth Low Energy (BLE) devices advertising an identification
28
28
* number generally used to determine the location of devices or physical objects
29
- * near to a mobile phone user.
29
+ * near a mobile phone user.
30
30
*
31
- * iOS scans for iBeacon devices in a background task and will notify Apps
31
+ * iOS scans for iBeacon devices in a background task and notifies Apps
32
32
* subscribed to a specific region when the area is entered or left. Apps may
33
33
* use this information to display context-aware content to users.
34
34
*
35
- * As an example a museum can deploy an apps which inform the user when one of
36
- * its exhibition is entered then display specific information about exposed
35
+ * As an example, a museum can deploy an app that informs the user when one of
36
+ * its exhibitions is entered and then displays specific information about exposed
37
37
* pieces of art when the user is sufficiently close to them.
38
38
*
39
39
* @par Positioning
42
42
* application and its deployment is used to identify a region. That region
43
43
* usually identifies an organization. The region is divided into subregions
44
44
* identified by a major ID. The subregion contains related points of interest
45
- * which are are distinguished by a minor ID.
45
+ * which a minor ID distinguishes .
46
46
*
47
- * As an example a city willing to improve tourists experience can deploy a fleet
47
+ * As an exampl,e a city willing to improve tourists' experience can deploy a fleet
48
48
* of iBeacons in relevant touristic locations it operates. The UUID may
49
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
50
+ * it can be a museum, a historic monument, a metro station and so on . The minor ID
51
51
* would locate a specific spot within a specific city place. It can be a
52
52
* piece of art, a ticket dispenser or a relevant point of interest.
53
53
*
57
57
* @par Proximity
58
58
*
59
59
* The beacon advertises the signal strength measured by an iOS device at a
60
- * distance of one meter. This information is used by iOS to approximate the
60
+ * distance of one meter. iOS uses this information to approximate the
61
61
* proximity to a given beacon:
62
62
* - Immediate: The beacon is less than one meter away from the user.
63
- * - Near: The beacon is one to three meter away from the user.
63
+ * - Near: The beacon is one to three meters away from the user.
64
64
* - Far: The user is not near the beacon; the distance highly depends on
65
65
* the physical environment.
66
66
*
67
- * Ideally beacons should be calibrated at their deployment location because the
67
+ * Ideally, beacons should be calibrated at their deployment location because the
68
68
* surrounding environment affects the strength of the advertised signal.
69
69
*
70
70
* @par Usage
71
71
*
72
72
* Mbed OS applications can use this class to configure a device to broadcast
73
- * advertising packets mimicking an iBeacon. The construction will automatically
74
- * create the payload identifying the beacon and register it as part of the
73
+ * advertising packets mimicking an iBeacon. The construction automatically
74
+ * creates the payload identifying the beacon and registers it as part of the
75
75
* advertising payload of the device.
76
76
*
77
77
* Beacon configuration and advertising commencement is left to the user.
@@ -145,16 +145,16 @@ class iBeacon
145
145
*
146
146
* @param[in] uuid Beacon network ID. iBeacon operators use this value
147
147
* to group their iBeacons into a single network, a single region and
148
- * identify their organization amongst others.
148
+ * identify their organization among others.
149
149
*
150
150
* @param[in] majNum Beacon major group ID. iBeacon exploitants may use
151
151
* this field to divide the region into subregions, their network into
152
- * sub networks .
152
+ * subnetworks .
153
153
*
154
154
* @param[in] minNum Identifier of the Beacon in its subregion.
155
155
*
156
156
* @param[in] transmitPower Measured transmit power of the beacon at 1
157
- * meter. This parameter is used by scanners to approximate the distance
157
+ * meter. Scanners use this parameter to approximate the distance
158
158
* to the beacon.
159
159
*
160
160
* @param[in] companyIDIn ID of the beacon manufacturer.
@@ -180,20 +180,20 @@ class iBeacon
180
180
/* *
181
181
* Construct an iBeacon::Payload and register it into Gap.
182
182
*
183
- * @param[in] _ble The ble interface to configure with the iBeacon payload.
183
+ * @param[in] _ble The BLE interface to configure with the iBeacon payload.
184
184
*
185
185
* @param[in] uuid Beacon network ID. iBeacon operators use this value
186
186
* to group their iBeacons into a single network, a single region and
187
- * identify their organization amongst others.
187
+ * identify their organization among others.
188
188
*
189
189
* @param[in] majNum Beacon major group ID. iBeacon exploitants may use
190
190
* this field to divide the region into subregions, their network into
191
- * sub networks .
191
+ * subnetworks .
192
192
*
193
193
* @param[in] minNum Identifier of the Beacon in its subregion.
194
194
*
195
195
* @param[in] txP Measured transmit power of the beacon at 1
196
- * meter. This parameter is used by scanners to approximate the distance
196
+ * meter. Scanners use this parameter to approximate the distance
197
197
* to the beacon.
198
198
*
199
199
* @param[in] compID ID of the beacon manufacturer.
0 commit comments