SWRLBeacon Class Reference

Inherits from	SWRLSignal : SWRLObject : NSObject
Declared in	SWRLBeacon.h SWRLBeacon.m

Overview

A SWRLBeacon object defines a type of SWRLSignal that is based on the device’s proximity to a Bluetooth beacon, as opposed to a geographic location or wifi network. A beacon aggregates a set of SWRLBeaconAdvertisements from a specific beacon device and matches that device with logical location, placement, and custom attributes specified through the platform. When the beacon device comes in range, the SWRLBeaconManager will change the state of the beacon and will generate appropriate events through its delegate interface SWRLBeaconManagerDelegate.

Accessing Beacon Attributes

`state`

Current state of the beacon (uknown, outside, inside). See SWRLBeaconState.

@property (nonatomic, readonly) SWRLBeaconState state

Declared In

SWRLBeacon.h

`rssi`

Current average rssi

@property (nonatomic, readonly) int rssi

Declared In

SWRLBeacon.h

`– isOverlapping`

Is the Placement associated with this beacon set to allow overlapping beacons.

- (BOOL)isOverlapping

Declared In

SWRLBeacon.h

`– isEntered`

Is the mobile device currently within the beacon range

- (BOOL)isEntered

Declared In

SWRLBeacon.h

`– extraInfo`

Retrieve any additional non-identifier related data associated with the beacon advertisements. In the case of Eddystone beacons, this would include TLM data base-64 encoded.

- (NSString *)extraInfo

Declared In

SWRLBeacon.h

`– manufacturer`

Retrieve the manufacturer of the beacon device.

- (NSString *)manufacturer

Declared In

SWRLBeacon.h

`– model`

Retreive the model of the beacon device

- (NSString *)model

Declared In

SWRLBeacon.h

`– serial`

Retreive the serial number of the beacon device as recorded in the platform.

- (NSString *)serial

Declared In

SWRLBeacon.h

`– protocol`

Retreive the protocol of the underlying advertisements

- (int)protocol

Declared In

SWRLBeacon.h

`– protocolDescription`

Retreive the protocol description of the underlying advertisements

- (NSString *)protocolDescription

Declared In

SWRLBeacon.h

`– address`

Retreive the address of the beacon device

- (NSString *)address

Declared In

SWRLBeacon.h

`– isConnectable`

Is the beacon in a connectable state

- (BOOL)isConnectable

Declared In

SWRLBeacon.h

`– peripheral`

Retreive the peripheral of the beacon if possible.

- (SWRLPeripheral *)peripheral

Declared In

SWRLBeacon.h

`– partner`

Retreive the partner information for this beacon

- (SWRLObject *)partner

Declared In

SWRLBeacon.h

`– setRssiParameters:`

Customize RSSI smoothing parameters opt_sample_age - seconds to average over max_sample_age - max seconds to average over if not min samples min_samples - min samples required

- (void)setRssiParameters:(NSDictionary *)params

Parameters

`params`	Smoothing parameters

Declared In

SWRLBeacon.h

Other Methods

`– type`

Type of signal.

- (SWRLSignalType)type

Declared In

SWRLSignal.h

`– lastDetected`

Timestamp of last detection of this signal.

- (NSTimeInterval)lastDetected

Declared In

SWRLSignal.h

`– name`

A human readable name if available.

- (NSString *)name

Declared In

SWRLObject.h

`– range`

This is the approximate range to the beacon. This is a rough approximation.

- (double)range

Declared In

SWRLSignal.h