Inherits from NSObject
Declared in BRTBeaconSDK.h
BRTBeaconSDK.m

Overview

BRTBeaconSDK类定义了快捷操作BrightBeacon方法.

Class Methods

BRTBeaconManager

BrightBeacon管理类,控制Beacon扫描、蓝牙扫描、区域检测、本地消息提醒

+ (BRTBeaconManager *)BRTBeaconManager

Return Value

BRTBeaconManager

Discussion

BrightBeacon管理类,控制Beacon扫描、蓝牙扫描、区域检测、本地消息提醒

Declared In

BRTBeaconSDK.h

BRTBeacons

BrightBeacon设备数组,设备的距离会及时更新

+ (NSArray *)BRTBeacons

Return Value

NSArray

Discussion

BrightBeacon设备数组,设备的距离会及时更新

Declared In

BRTBeaconSDK.h

BRTBeaconsDictionary

BrightBeacon设备集合,设备的距离会及时更新,以mac为key,如无mac以(Major+Minor)为key

+ (NSDictionary *)BRTBeaconsDictionary

Return Value

NSDictionary

Discussion

BrightBeacon设备集合,设备的距离会及时更新,以mac为key,如无mac以(Major+Minor)为key

Declared In

BRTBeaconSDK.h

isMonitoring:

请求监听状态,仅支持IOS7以上,IOS6始终返回nil

+ (NSDictionary *)isMonitoring:(NSDictionary *)dict

Parameters

dict

需要请求的区域标识,uuid必须传人,major或minor按实际情况选传 示例:{uuid:…,major:@0}

Return Value

区域监听状态 nil为无监听 示例:{in:@YES,out:@NO,display:@YES}

Discussion

请求监听状态,仅支持IOS7以上,IOS6始终返回nil

Declared In

BRTBeaconSDK.h

regionHander:

用于修改接收后台区域监听回调类,SDK默认已经设置回调到AppDelegate,如果需要改为其他handler,此handler实体必须与AppDelegate随同启动,否则无法接收到后台beacon推送

+ (id)regionHander:(id)handler

Parameters

handler

用于接收后台区域监听回调函数的类。传入的handler类用作接收回调(该类务必随程序的启动即初始化,否则无法接收到回调);若传人值为nil会返回当前使用的handler(默认为AppDelegate)

Return Value

handler 返回当前使用的handler,若从未设置,默认返回AppDelegate

Discussion

用于修改接收后台区域监听回调类,SDK默认已经设置回调到AppDelegate,如果需要改为其他handler,此handler实体必须与AppDelegate随同启动,否则无法接收到后台beacon推送

以下是在后台监听区域的回调函数,请拷贝需要的回调到AppDelegate或对应的handler类
监听失败回调
-(void)beaconManager:(BRTBeaconManager )manager monitoringDidFailForRegion:(BRTBeaconRegion )region withError:(NSError )error;
进入区域回调
-(void)beaconManager:(BRTBeaconManager
)manager didEnterRegion:(BRTBeaconRegion )region;
离开区域回调
-(void)beaconManager:(BRTBeaconManager
)manager didExitRegion:(BRTBeaconRegion )region;
锁屏区域检测、requestStateForRegions回调
-(void)beaconManager:(BRTBeaconManager
)manager didDetermineState:(CLRegionState)state forRegion:(BRTBeaconRegion )region;
- (void)peripheralManagerDidStartAdvertising:(CBPeripheralManager
)peripheral error:(NSError *)error;

Declared In

BRTBeaconSDK.h

registerApp:onCompletion:

注册并验证开发者appKey,申请地址:http://developer.brtbeacon.com

+ (void)registerApp:(NSString *)appKey onCompletion:(BRTCompletionBlock)completion

Parameters

appKey

BrightBeacon AppKey

completion

验证appKey有效性状态

Return Value

void

Discussion

注册并验证开发者appKey,申请地址:http://developer.brtbeacon.com

Declared In

BRTBeaconSDK.h

requestStateForRegions:

立即查询是否位于指定区域;状态会回调到appDelegate中:

+ (void)requestStateForRegions:(NSArray *)regions

Parameters

regions

@[region1,region2]

Return Value

void

Discussion

立即查询是否位于指定区域;状态会回调到appDelegate中:

-(void)beaconManager:(BRTBeaconManager )manager didDetermineState:(CLRegionState)state forRegion:(BRTBeaconRegion )region;

Declared In

BRTBeaconSDK.h

rssiToDistance:

rssi 转换成 距离(米)

+ (float)rssiToDistance:(BRTBeacon *)beacon

Parameters

beacon

beacon设备,需要使用measured power值

Return Value

float 距离(米)

Discussion

rssi 转换成 距离(米)

Declared In

BRTBeaconSDK.h

startMonitoringForRegions:

开启区域监听要求IOS7以上系统; 如果需要程序退出后持续监听,需要提醒用户打开->应用程序后台刷新; IOS8另需请求允许后台定位,requestAlwaysAuthorization 检查状态:CLLocationManager.authorizationStatus==kCLAuthorizationStatusAuthorizedAlways. 注:SDK默认只请求运行时定位,可以通过BRTBeaconDefinitions.h中isLocationAlways=YES来配置

+ (void)startMonitoringForRegions:(NSArray *)regions

Parameters

regions

@[region1,region2]

Return Value

void

Discussion

开启区域监听要求IOS7以上系统; 如果需要程序退出后持续监听,需要提醒用户打开->应用程序后台刷新; IOS8另需请求允许后台定位,requestAlwaysAuthorization 检查状态:CLLocationManager.authorizationStatus==kCLAuthorizationStatusAuthorizedAlways. 注:SDK默认只请求运行时定位,可以通过BRTBeaconDefinitions.h中isLocationAlways=YES来配置

状态会默认回调到appDelegate中(或自定义的handler中{@link regionHandler:}):
-(void)beaconManager:(BRTBeaconManager )manager didEnterRegion:(BRTBeaconRegion )region;


-(void)beaconManager:(BRTBeaconManager )manager didExitRegion:(BRTBeaconRegion )region;


-(void)beaconManager:(BRTBeaconManager )manager didDetermineState:(CLRegionState)state forRegion:(BRTBeaconRegion )region;

Declared In

BRTBeaconSDK.h

startRangingBeaconsInRegions:onCompletion:

仅支持IOS7以上,感知区域中BrightBeacon设备,regions为BRTBeaconRegion数组(留空则启用默认的UUID)

+ (void)startRangingBeaconsInRegions:(NSArray *)regions onCompletion:(RangingBrightBeaconsCompletionBlock)completion

Parameters

regions

区域数组

completion

扫描Beacon回调(1秒/次)

Return Value

void

Discussion

仅支持IOS7以上,感知区域中BrightBeacon设备,regions为BRTBeaconRegion数组(留空则启用默认的UUID)

Declared In

BRTBeaconSDK.h

startRangingWithUuids:onCompletion:

扫描BrightBeacon设备,uuids为NSUUID数组:IOS6.x该参数无效;IOS7.x该参数用于构造区域BRTBeaconRegion来实现扫描、广播融合模式,提高RSSI精度(注:留空则只开启蓝牙扫描)

+ (void)startRangingWithUuids:(NSArray *)uuids onCompletion:(RangingBrightBeaconsCompletionBlock)completion

Parameters

uuids

uuid数组

completion

扫描Beacon回调(1秒/次)

Return Value

void

Discussion

扫描BrightBeacon设备,uuids为NSUUID数组:IOS6.x该参数无效;IOS7.x该参数用于构造区域BRTBeaconRegion来实现扫描、广播融合模式,提高RSSI精度(注:留空则只开启蓝牙扫描)

Declared In

BRTBeaconSDK.h

stopMonitoringForRegions:

停止扫描、监测,if(regions==nil)停止所有当前监听区域

+ (void)stopMonitoringForRegions:(NSArray *)regions

Parameters

regions

@[region1,region2]

Return Value

void

Discussion

停止扫描、监测,if(regions==nil)停止所有当前监听区域

Declared In

BRTBeaconSDK.h

stopRangingBrightBeacons

停止扫描BrightBeacon设备

+ (void)stopRangingBrightBeacons

Return Value

void

Discussion

停止扫描BrightBeacon设备

Declared In

BRTBeaconSDK.h