Skip to content

Commit 756df3e

Browse files
Amanda Butler0xc0170
authored andcommitted
Copy edit iBeacon.h
Make minor copy edits.
1 parent e4ac455 commit 756df3e

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

features/FEATURE_BLE/ble/services/iBeacon.h

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
*
2727
* iBeacons are Bluetooth Low Energy (BLE) devices advertising an identification
2828
* 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.
3030
*
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
3232
* subscribed to a specific region when the area is entered or left. Apps may
3333
* use this information to display context-aware content to users.
3434
*
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
3737
* pieces of art when the user is sufficiently close to them.
3838
*
3939
* @par Positioning
@@ -42,12 +42,12 @@
4242
* application and its deployment is used to identify a region. That region
4343
* usually identifies an organization. The region is divided into subregions
4444
* 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.
4646
*
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
4848
* of iBeacons in relevant touristic locations it operates. The UUID may
4949
* 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
5151
* would locate a specific spot within a specific city place. It can be a
5252
* piece of art, a ticket dispenser or a relevant point of interest.
5353
*
@@ -57,21 +57,21 @@
5757
* @par Proximity
5858
*
5959
* 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
6161
* proximity to a given beacon:
6262
* - 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.
6464
* - 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 their deployment location because the
67+
* Ideally, beacons should be calibrated at their deployment location because the
6868
* surrounding environment affects the strength of the advertised signal.
6969
*
7070
* @par Usage
7171
*
7272
* 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
7575
* advertising payload of the device.
7676
*
7777
* Beacon configuration and advertising commencement is left to the user.
@@ -145,16 +145,16 @@ class iBeacon
145145
*
146146
* @param[in] uuid Beacon network ID. iBeacon operators use this value
147147
* to group their iBeacons into a single network, a single region and
148-
* identify their organization amongst others.
148+
* identify their organization among others.
149149
*
150150
* @param[in] majNum Beacon major group ID. iBeacon exploitants may use
151151
* this field to divide the region into subregions, their network into
152-
* sub networks.
152+
* subnetworks.
153153
*
154154
* @param[in] minNum Identifier of the Beacon in its subregion.
155155
*
156156
* @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
158158
* to the beacon.
159159
*
160160
* @param[in] companyIDIn ID of the beacon manufacturer.
@@ -180,20 +180,20 @@ class iBeacon
180180
/**
181181
* Construct an iBeacon::Payload and register it into Gap.
182182
*
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.
184184
*
185185
* @param[in] uuid Beacon network ID. iBeacon operators use this value
186186
* to group their iBeacons into a single network, a single region and
187-
* identify their organization amongst others.
187+
* identify their organization among others.
188188
*
189189
* @param[in] majNum Beacon major group ID. iBeacon exploitants may use
190190
* this field to divide the region into subregions, their network into
191-
* sub networks.
191+
* subnetworks.
192192
*
193193
* @param[in] minNum Identifier of the Beacon in its subregion.
194194
*
195195
* @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
197197
* to the beacon.
198198
*
199199
* @param[in] compID ID of the beacon manufacturer.

0 commit comments

Comments
 (0)