NearBee SDK is an easy way to enable proximity marketing through an Eddystone-compliant BLE network.
Add the following to your Podfile in your project, we are supporting iOS 10.0+ make sure your pod has proper platform set.
platform :ios, '10.0'
target '<My-App-Target>''
pod 'NearBee'
end
Run pod install
in the project directory
Download or clone this repo on your system.
Drag and drop the NearBee.framework file into your Xcode project. Make sure that "Copy Items to Destination's Group Folder" is checked.
Add the NearBee.framework
m EddystoneScanner.framework
and Socket.IO-Client-Swift.framework
to the embedded binaries section of your destination app target.
In Build Phases under destination app target, add the following frameworks in Link Binary With Libraries section:
In Info.plist, add a new fields, NSLocationAlwaysUsageDescription
, NSLocationAlwaysAndWhenInUseUsageDescription
, NSLocationWhenInUseUsageDescription
, NSBluetoothPeripheralUsageDescription
, NSBluetoothAlwaysUsageDescription
with relevant values that you want to show to the user. This is mandatory for iOS 10 and above.
Enable Uses Bluetooth LE accessories
in the Background Modes under Capabilities section.
Location
The app should take care of handling the permissions as required by your set up to receive notifications on entring the beacon region.
Bluetooth
The app should take care of enabling the bluetooth to range beacons.
MY_DEVELOPER_TOKEN
The app should provide the developer token while initializing the SDK. Get it from Beaconstac Dashboard Account Page.
__MY_ORGANIZATION__
The app should provide the organization while initializing the SDK. Get it from Beaconstac Dashboard Account Page.
Monitoring Regions
If you are using the region monitoring API's from advanced location manager, make sure it won't affect the NearBee SDK.
Info.plist
add the below mentioned keys and the values <key>co.nearbee.api_key</key>
<string>__MY_DEVELOPER_TOKEN__</string>
<key>co.nearbee.organization_id</key>
<string>__MY_ORGANIZATION__</string>
import NearBee
import <NearBee/NearBee.h>
NearBee
using one-line initialization, the initialization starts scanning for beacons immediately.var nearBee = NearBee.initNearBee()
NearBee *nearBee = [NearBee initNearBee];
nearBee.startScanning() // Starts scanning for beacons...
nearBee.stopScanning() // Stops scanning for beacons...
[nearBee startScanning];
[nearBee stopScanning];
NearBeeDelegate
protocol methods to show the beacons either in UITableView
or UICollectionView
func didFindBeacons(_ beacons: [NearBeeBeacon]) {
// Display Beacons
}
func didLoseBeacons(_ beacons: [NearBeeBeacon]) {
// Display Beacons
}
func didUpdateBeacons(_ beacons: [NearBeeBeacon]) {
// Display Beacons
}
func didThrowError(_ error: Error) {
// Show Error
}
func didUpdateState(_ state: NearBeeState) {
// Update UI based on state
}
- (void)didFindBeacons:(NSArray<NearBeeBeacon *> * _Nonnull)beacons {
// Display Beacons
}
- (void)didLoseBeacons:(NSArray<NearBeeBeacon *> * _Nonnull)beacons {
// Display Beacons
}
- (void)didUpdateBeacons:(NSArray<NearBeeBeacon *> * _Nonnull)beacons {
// Display Beacons
}
- (void)didThrowError:(NSError * _Nonnull)error {
// Error
}
- (void)didUpdateState(NearBeeState state) {
// Update UI based on state
}
nearbee.enableBackgroundNotification(true)
[nearbee enableBackgroundNotification: true];
Please enable the notification sound by setting UserDefaults.standard.setValue(true, forKey: "NearBeeToggleSound")
if let alertSound = YOUR_URL {
let soundName = UNNotificationSoundName(rawValue: alertSound.lastPathComponent)
nearbee.notificationSound = soundName
}
NSURL *alertSound = YOUR_URL
if (alertSound != nil) {
UNNotificationSoundName *soundName = [UNNotificationSoundName soundNamed:alertSound.lastPathComponent];
nearbee.notificationSound = soundName
}
Note: Audio files must already be on the user’s device before they can be played. If you use a predefined set of sounds for your notifications, include the audio files in your app’s bundle. For all other sounds, place a copy of the audio file in the Library/Sounds folder of your app’s container directory. The UNNotificationSound object looks only in those two locations.
// In the class where you want to listen to notification events...
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
let nearBeeInstance = NearBee.initNearBee()
let isNearBeeNotification = nearBee.checkAndProcessNotification(response.notification)
if (isNearBeeNotification) {
completionHandler()
} else {
// Not a near bee notification, you need to handle
}
}
// In the class where you want to listen to notification events...
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
didReceiveNotificationResponse:(UNNotificationResponse *)response
withCompletionHandler:(void (^)(void))completionHandler {
NearBee *nearBeeInstance = [NearBee initNearBee];
BOOL isNearBeeNotification = [nearBee checkAndProcessNotification:response.notification];
if (isNearBeeNotification) {
completionHandler()
} else {
// Not a near bee notification, you need to handle
}
}
let nearbee = NearBee.initNearBee()
nearbee.delegate = self // If any error occurred in nearbee
nearbee.startMonitoringGeoFenceRegions { result in
}
NearBee *nearbee = [NearBee initNearBee];
nearbee.delegate = self; // If any error occurred in nearbee
[nearbee startMonitoringGeoFenceRegions:^(BOOL result) {
}];
let nearbee = NearBee.initNearBee()
nearbee.delegate = self
nearbee.stopMonitoringGeoFenceRegions()
NearBee *nearbee = [NearBee initNearBee];
nearbee.delegate = self;
[nearbee stopMonitoringGeoFenceRegions];
let nearbee = NearBee.initNearBee()
nearbee.geoFenceNotificationThreshold = 3600.0 // default is 3600.0
NearBee *nearbee = [NearBee initNearBee];
nearbee.geoFenceNotificationThreshold = 3600.0 // default is 3600.0
Implement the NearBeeDelegate protocol method to show the geofences either in UITableView or UICollectionView
func didEnterGeofence(_ geofence: NearBeeGeoFence, _ attachment: GeoFenceAttachment) {
// Display data related to geofence
}
- (void)didEnterGeofence:(NearBeeGeofence * _Nonnull)geofence _ (GeoFenceAttachment * _Nonnull)attachment {
// Display data releted to geofence
}
// Notification title
attachment.getTitle()
// Notification body
attachment.getDescription()
// URL of icon set for the Geofence notification
attachment.getIconURL()
// Final URL to which a click on the notification should redirect
attachment.getURL()
// Returns true if the url is currently active
attachment.isActive()
// Notification title
[attachment getTitle];
// Notification body
[attachment getDescription];
// URL of icon set for the Geofence notification
[attachment getIconURL];
// Final URL to which a click on the notification should redirect
[attachment getURL];
// Returns true if the url is currently active
[attachment isActive];
The Received Signal Strength Indication value can be used to determine the distance from a beacon.
// Returns the value of RSSI for the beacon found
beacon.getRSSI()
// returns the value of RSSI for the beacon found
[beacon getRSSI];
There are two types of attachments -
These are extracted from the physical web url of the beacon
beacon.attachment.physicalWeb
PhysicalWeb properties
// Title
physicalWeb.getTitle()
// Description
physicalWeb.getDescription()
// Url for the icon
physicalWeb.getIconURL()
// Physical web url
physicalWeb.getUrl()
// Returns true if the url is currently active
physicalWeb.isActive()
// Title
[physicalWeb getTitle];
// Description
[physicalWeb getDescription];
// Url for the icon
[physicalWeb getIconURL];
// Physical web url
[physicalWeb getUrl];
// Returns true if the url is currently active
[physicalWeb isActive];
This comes from Google Nearby attachment for a specific beacon
// returns a Set of ProximityAttachment objects
beacon.attachment.proximityAttachment
ProximityAttachment
properties
In addition to all the properties from physical web, ProximityAttachment
has extra properties
// Url for banner image
proximityAttachment.bannerImageURL
// Banner type, portrait = 1 or landscape = 2
proximityAttachment.bannerType
// ISO code for the language
proximityAttachment.language
Get the ProximityAttachment
for the current device locale language.
Will return null
if ProximityAttachment
is not available for that language
beacon.getAttachmentForCurrentDeviceLanguage()
[beacon getAttachmentForCurrentDeviceLanguage];
Returns a BeaconAttachment
protocol confirmed object, which will be a ProximityAttachment
if an attachment is found for the current language, or a PhysicalWeb
otherwise
Will return null
if no attachments are present for this beacon
beacon.getBestAvailableAttachment()
[beacon getBestAvailableAttachment];
Beacons may contain a Business object which is the Place
associated with the beacon
let business = beacon.business
NearBeeBusiness *business = beacon.business
They have following properties
// Color code associated with the place (Hex code), convert this accordingly
business.colorCode
// Cover image url
business.coverURL
// Google place id
business.googlePlaceID
// Place name
business.name
// Icon image url
business.iconURL