OYMBeacon Class Reference

Inherits from NSObject
Conforms to OYMJsonProtocol
Declared in OYMBeacon.h
OYMBeacon.m

Overview

This class includes all the information regarding the Beacon Items stored.

CLBeacon category to add proper iBeacon sorting.

Other Methods

  uuid

Automatically generated UUID

@property NSString *uuid

Declared In

OYMBeacon.h

  )

WGS84 Longitude

@property (nonatomic) NSNumber *DEPRECATED_MSG_ATTRIBUTE ( "Use longitude instead." )

Declared In

OYMBeacon.h

  longitude

WGS84 Longitude

@property NSNumber *longitude

Declared In

OYMBeacon.h

  latitude

WGS84 Latitude

@property NSNumber *latitude

Declared In

OYMBeacon.h

  major

Beacon major

@property NSNumber *major

Declared In

OYMBeacon.h

  minor

Beacon minor

@property NSNumber *minor

Declared In

OYMBeacon.h

  txPower

Transmission power at 1m

@property NSNumber *txPower

Declared In

OYMBeacon.h

  uuidBeacon

Beacon proximity UUID

@property NSString *uuidBeacon

Declared In

OYMBeacon.h

  building

Building ID

@property NSString *building

Declared In

OYMBeacon.h

  floor

Floor ID

@property NSString *floor

Declared In

OYMBeacon.h

  floorNumber

Floor number

@property NSNumber *floorNumber

Declared In

OYMBeacon.h

  type

String defining the Beacon type

@property NSString *type

Declared In

OYMBeacon.h

  scanDate

Scan Date

@property NSString *scanDate

Declared In

OYMBeacon.h

  status

Variable defining the Beacon status, if <1 can be used

@property int status

Declared In

OYMBeacon.h

  warningCounter

Warning counter

@property int warningCounter

Declared In

OYMBeacon.h

– initWithEddystone:

Eddystone Beacon partial constructor. Should not be used.

- (instancetype)initWithEddystone:(ESSBeaconInfo *)eddystone

Parameters

eddystone

Eddystone Beacon

Declared In

OYMBeacon.h

+ sort:

This methods sort an array of OYMBeacon according to its minor number.

+ (NSArray *)sort:(NSArray *)Beacons

Parameters

Beacons

Array of OYMBeacon

Return Value

A sorted array, nil if a problem arouse while sorting

Declared In

OYMBeacon.h

– getIdentifier

This method provides an identifier for the Beacon that can be used across the different platforms.

- (NSString *)getIdentifier

Return Value

A unique Beacon identifier

Declared In

OYMBeacon.h

Beacon Methods

  beacon

Core Location iBeacon

@property CLBeacon *beacon

Declared In

OYMBeacon+Beacon.h

  rssi

RSSI

@property NSNumber *rssi

Declared In

OYMBeacon+Beacon.h

– initWithCLBeacon:

OYMBeacon partial constructor. Should not be used.

- (instancetype)initWithCLBeacon:(CLBeacon *)beac

Parameters

beac

CLBeacon to be decoded

Declared In

OYMBeacon+Beacon.h

+ getMax:

This method returns the iBeacon(s) with the highest RSSI.

+ (NSArray *)getMax:(NSDictionary *)ibeaconsDict

Parameters

ibeacons

Dictionary containing the CLBeacon to be sorted

Return Value

The CLBeacon object(s) with the highest RSSI

Declared In

OYMBeacon+Beacon.h

– getAccuracy

This method returns the accuracy of the iBeacon.

- (double)getAccuracy

Declared In

OYMBeacon+Beacon.h