README.md

Parrot is a Swift framework for advertising an iOS device as an iBeacon and monitoring/ranging other iBeacons.

🎙 Broadcasting an iBeacon Signal

Parrot allows you to turn your device into an iBeacon by doing the following:

let uuid = UUID(string: "E621E1F8-C36C-495A-93FC-0C247A3E6E5F")!
let beaconAdvertiser = BeaconAdvertiser(uuid: uuid, identifier: "com.myCompany.BeaconIdentifier", params: .none)
beaconAdvertiser.startAdvertising { advertiser, state in 
  print("State: \(state) for \(advertiser)")
}

🔊 Determining the Proximity to an iBeacon

Parrot also allows you to very easily determine the proximity to an iBeacon by doing the following:

let uuid = UUID(string: "E621E1F8-C36C-495A-93FC-0C247A3E6E5F")!
let beaconMonitor = BeaconMonitor(uuid: uuid, identifier: "com.myCompany.BeaconIdentifier", params: .none)
beaconMonitor.startMonitoring(
  onProximityUpdate: { monitor, proximity in
    print("Proximity: \(proximity) for \(monitor)")
  },
  onError: { error in
    print("Error occured: \(error)")       
  }
)

📚 Example

To run the example project, clone the repo and run pod install from the Example directory first. If you'd like to advertise and monitor, you'll need two devices.

🛠 Installation

Parrot is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Parrot"

Parrot is also available through Carthage. Add this to your Cartfile:

github "carrot-ar/Parrot"