nicktoumpelis / hibeacons Goto Github PK

View Code? Open in Web Editor NEW

1.1K 100.0 223.0 495 KB

An iBeacons example app for iOS 10, with Apple Watch (watchOS 3.0) support, written in Swift 3.

License: MIT License

Swift 100.00%

ibeacon ibeacon-support beacon-region apple-watch swift iphone bluetooth ios ibeacons

hibeacons's Introduction

HiBeacons

A Swift 3 demo app for the iBeacons API in iOS 10, with Apple Watch support (watchOS 3.0)

HiBeacons is a fully functional demo app for the iBeacons API in iOS 10, updated for Swift 3. The app can be used to demonstrate beacon region monitoring, advertising and ranging, simply by toggling on/off three switches in the UI, or the accompanying Apple Watch app.

The apps implement a basic interface for starting all the operations from the iPhone and the Apple Watch, but the state of the various beacon operation can only be seen in the phone. (The watch app acts as a simple* remote).

The source is easy to understand and modify. The structure of the app is based on a simple hierarchy of operation classes. There are three NATOperation subclasses, each responsible of a specific operation: NATMonitoringOperation, NATAdvertisingOperation, and NATRangingOperation. The app is easy to use with any given proximity UUID and identifier, which can be changed in NATOperation.

The app is fully documented, using the reStructuredText standard, which SourceKit can parse.

The main branch of the project is the swift branch, but you can still find the old Objective-C code at the obj-c branch. Note that the old branch has some bugs, that I have fixed in the new one.

The app is fully documented, and should work well with Xcode 8, iOS 10, and watchOS 3.

Screenshots

Notes

The UI shows only a small number of alerts, when major issues occur. To understand the process better, you can easily follow the Console logs.
Monitoring works also when the app is in the background. You will get a local notification when entering the specified beacon region.
The app can only monitor and range a single beacon region. (It can easily be extended for multiple, but not for any beacon region. Apple only allows for specific UUIDs to be monitored or ranged.)
With advertising turned on, the app will show itself as a beacon on other instances of the app, or other beacon apps, running on other devices. It cannot range or monitor itself. (It's how the iBeacon API works.)
Major and minor integers are generated randomly every time a new advertising session starts.
You can find and set the UUID and identifier for the region in NATOperation.swift.

* The Watch app can trigger actions on and can reflect the state of the app on the phone, but will not accept state change in the background. The same applies vice-versa, i.e. the Watch app will be unable to operate on the app when it's backgrounded.

Contact

Nick Toumpelis (@nicktoumpelis)

Licence

HiBeacons is available under the MIT licence. See the LICENCE file for more info.

hibeacons's People

Contributors

Stargazers

Watchers

Forkers

germc kunlqt bilby91 jonqth superbarracuda bsneed medelman rajdn bymenjil deivers walm marcelloceschia okitsutakatomo craigwatkinson cocoalab djbelieny greplytix fone4u ashton-w mrjustin7 jackieqi vinod1988 ethereal-engineer jjpmir woohyuknrg coderxl fusunlang iggym kerasking rjr weissazool karnlund pingazine forrestshi ardreasl unixcrh mayoita barrycug phaufe ryotarolab dharmbirchoudhary jigneshpatel do9iigane t2wu wedontpray myrual youngrui xczhanjun ethanblackburn xuantungsp davidwelborn macl0vin spiritae neoxen bhanubirani nineten dage1360 chinafather delort kelvinlaw637 lofdev karlcarlo ray-dong bradparks prarik codger maseli timshim ytrjp skyprayerstudio ginodecock jimmyking aquarius20th jacky-cyber wisetan imclab coolhomeuc joshuapekera jonathanrcarter bangslosan falkorichter aavesh mgerlach-klick sashayoon dagerman alexseverinov sanyaade-iot chengjunjian onurunal1 atchariya janantala gaecom istarlee wenh beanlook travelc easence mxxnsk lasse182 china-maid

hibeacons's Issues

<incorrect>

nil

UUID

I am not getting UUID. How to get UUID ?

let region = CLBeaconRegion(proximityUUID: NSUUID(UUIDString: "?")!, identifier: "Identifier")

First time crashes but never later

I turned on Ranging on iPod, and then turned Advertising on iPad.. . caused a crash on iPod (Ranging). This happened only on very first time, but never again.

Update the usage of WatchKit

Beacons don't show up

Setup

I want to build an audio guide application on iOS for an exhibition using iBeacons.

I am using the HiBeacons App from Github to test my iBeacons:

This works well and I can configure my iPad to show up as an iBeacon. So I can already start developing using my iPad as a dummy beacon.

The iBeacons

I did order a few iBeacons from Aliexpress.

I was expecting that the beacons show up in HiBeacons as soon as I turn them on. And when I press the button for some seconds the LED lights up either once or three times, but in both states the HiBeacons app does not show a new nearby device.

The Beacons all come with a label that shows the following information:

major: 10011
minor: 10011
wxid: 2976871
password: XXXXXXXX
ID: YYYYYYYYYYYYY

There is also a QR Code that contains the ID of the beacon.

Now I am left with these questions:

What do I need to do so that the beacons show up in HiBeacon
Are the wxid / password proprietary values or is this part of BLE spec