https://github.com/access-company/ABFBeacon

ACCESS Beacon Framework Library
https://github.com/access-company/ABFBeacon

Last synced: about 2 months ago
JSON representation

ACCESS Beacon Framework Library

• Host: GitHub
• URL: https://github.com/access-company/ABFBeacon
• Owner: access-company
• Created: 2014-03-03T03:04:39.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-04-05T08:08:11.000Z (over 6 years ago)
• Last Synced: 2024-07-04T00:58:07.193Z (3 months ago)
• Language: Objective-C
• Size: 32.2 KB
• Stars: 32
• Watchers: 35
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ABFBeacon

ACCESS Beacon Framework Library is wrapper for iBeacon API.

# How to use it

#### Podfile

To integrate ABFBeacon into your Xcode project using CocoaPods, specify it in your `Podfile`:

```ruby

platform :ios, '7.1'

pod 'ABFBeacon', :git => 'https://github.com/access-company/ABFBeacon', :tag => '1.4.0'

```

Then, run the following command:

```bash

$ pod install

```

#### Installation to your project

Add iOS/ABFBeacon files to your project

* ABFBeacon.h

* ABFBeacon.m

* ABFBeaconRegion.h

* ABFBeaconRegion.m

Then

```

#import "ABFBeacon.h"

```

include all of necessary classes.

```

ABFBeacon *beacon = [ABFBeacon sharedManager];

```

will instanciate ABFBeacon singleton.

```

[beacon registerRegion:@"E02CC25E-0049-4185-832C-3A65DB755D01" identifier:@"ACCESS"];

[beacon startMonitoring];

```

Register specified Region and start monitoring on it.

You might need to inherit ABFBeaconDelegate to set delegation.

```

@interface MyClass : NSObject

```

Here are list of delegates defined in ABFBeaconDelegate.

```

@protocol ABFBeaconDelegate 

@optional

#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 100000

- (void)didUpdatePeripheralState:(CBManagerState)state;

#else

- (void)didUpdatePeripheralState:(CBPeripheralManagerState)state;

#endif

- (void)didUpdateAuthorizationStatus:(CLAuthorizationStatus)status;

- (void)didRangeBeacons:(ABFBeaconRegion *)region;

- (void)didUpdateRegionEnterOrExit:(ABFBeaconRegion *)region;

@end

```

# Licensing

ABFBeacon is distributed under MIT License.