https://github.com/igor-makarov/BeaconKit

iOS Beacon framework using BTLE
https://github.com/igor-makarov/BeaconKit

Last synced: 2 months ago
JSON representation

iOS Beacon framework using BTLE

• Host: GitHub
• URL: https://github.com/igor-makarov/BeaconKit
• Owner: igor-makarov
• License: mit
• Created: 2017-07-19T18:51:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-31T09:28:29.000Z (over 5 years ago)
• Last Synced: 2024-03-25T23:43:45.612Z (3 months ago)
• Language: Swift
• Size: 141 KB
• Stars: 27
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-beacon - BeaconKit - Beacon detection framework ns Swift using CoreBluetooth, supporting Eddystone-UID, Eddystone-URL, AltBeacon, iBeacon. (Stackoverflow Q&A)

README

        
# BeaconKit [![Build Status](https://travis-ci.org/igor-makarov/BeaconKit.svg?branch=master)](https://travis-ci.org/igor-makarov/BeaconKit) ![Current Version](https://img.shields.io/github/tag/igor-makarov/BeaconKit.svg?label=Current%20Version)

Beacon detection framework using CoreBluetooth written in Swift

## TL;DR

This is a framework that wraps around CoreBluetooth and detects beacons of different types.

Tested to compile with Swift 4.0 & 4.2 for iOS 9.0 & macOS 10.12

The currently supported types are: **Eddystone-UID**, **Eddystone-URL**, **AltBeacon**, **iBeacon**.

iBeacon detection is only available for macOS. It's not possible to detect iBeacons using CoreBluetooth on iOS (see [this explanation](http://developer.radiusnetworks.com/2013/10/21/corebluetooth-doesnt-let-you-see-ibeacons.html) for more info).

Only foreground operation is supported, but I plan on adding background detection of Eddystones (it's not possible to detect AltBeacons in the background).

## Usage

Activating:

```

BeaconScanner.shared.delegate = self

BeaconScanner.shared.start()

```

If you want to change the beacons detected, assign to `recognizedBeaconTypes` like so:

```

BeaconScanner.shared.recognizedBeaconTypes = [EddystoneUidBeacon.self, EddystoneUrlBeacon.self, AltBeacon.self] 

```

Deactivating:

```

BeaconScanner.shared.stop()

```

## Supported Beacon Types

* Eddystone-UID

* Eddystone-URL

* AltBeacon (foreground only on iOS)

* iBeacon (macOS only)

## Known Unsupported Beacon Types

* Eddystone-TLM (not an actual beacon)