New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BLE: Update iBeacon documentation. #5409

Merged
merged 5 commits into from Nov 2, 2017

Conversation

Projects
None yet
6 participants
@pan-
Member

pan- commented Oct 31, 2017

Description

Provide detailed description of iBeacons purpose, general concepts and usage.

Status

READY

Migrations

NO

BLE: Update iBeacon documentation.
Provide detailled description of the purpose, general concepts and usage.
@pan-

This comment has been minimized.

Member

pan- commented Oct 31, 2017

@marcbonnici @AnotherButler Could you review this PR ?

*
* iBeacons are Bluetooth Low Energy (BLE) devices advertising an identification
* number generally used to identify the location of devices or physical objects
* nearby a mobile phone user.

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"nearby a mobile phone user." -> "nearby." or "near to a mobile phone user"

* use this information to display context-aware content to users.
*
* As an example a museum can deploy an apps which inform the user when one of
* its exhibition is enterred then display specific information about exposed

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"enterred" -> "entered"

*
* Location information is hierarchically structured. A UUID specific to the
* application and its deployment is used to identify a region. That region
* usually identify an organization. The region is divided into subregions

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"identify" -> "identifies"

* application and its deployment is used to identify a region. That region
* usually identify an organization. The region is divided into subregions
* identified by a major ID. The subregion may contain related points of
* interrest. Finally specific points of interrest within a subregion are

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"interrest" -> "interest" x2

* it can be something such as a museum, an historic monument or a metro station.
* The minor ID would locate a specific spot within the city place. It can be a
* piece of art, a ticket dispenser or a relevant point of interrest. Each
* iBeacon device is physically attached to the spot it identify and advertise

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"identify" -> "identifies"
"advertise" -> "advertises"

* Location information is hierarchically structured. A UUID specific to the
* application and its deployment is used to identify a region. That region
* usually identify an organization. The region is divided into subregions
* identified by a major ID. The subregion contains related points of interrest

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"interrest" -> "interest"

*
* @par Proximity
*
* The beacon advertise the signal strength measured by an iOS device at a

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"advertise" -> "advertises"

* create the payload identifying the beacon and register it as part of the
* advertising payload of the device.
*
* Beacon configuration and advertising start is let to the user.

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"let" -> "left"
"advertising start is let to the user." -> "advertising commencement is left to the user"?

* would locate a specific spot within a specific city place. It can be a
* piece of art, a ticket dispenser or a relevant point of interrest.
*
* Each iBeacon device is physically attached to the spot it locate and advertise

This comment has been minimized.

@marcbonnici

marcbonnici Oct 31, 2017

"locate" -> "locates"
"advertise" -> "advertises"

@pan-

This comment has been minimized.

Member

pan- commented Oct 31, 2017

@marcbonnici Thank you for the review, I have updated the PR accordingly.

Copy edit iBeacon.h
Make minor copy edits.
@AnotherButler

Nice work on this 👍

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Nov 2, 2017

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Nov 2, 2017

Build : SUCCESS

Build number : 409
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5409/

Triggering tests

/morph test
/morph uvisor-test

@mbed-ci

This comment has been minimized.

@0xc0170 0xc0170 added ready for merge and removed needs: CI labels Nov 2, 2017

@theotherjimmy theotherjimmy merged commit 7583107 into ARMmbed:master Nov 2, 2017

5 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-test test completed
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@pan- pan- deleted the pan-:fix-ibeacon-doc branch Jul 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment