JAALEEDevice Class Reference

Inherits from	NSObject
Declared in	JAALEEDevice.h

Overview

It allows to connect with JAALEE to read / change its configurtion.

Publicly available properties

`rssi`

rssi

@property (nonatomic,
                                        readonly) NSInteger rssi

Discussion

rssi

Received signal strength in decibels of the specified JAALEE device. This value is an average of the RSSI samples collected since this beacon was last reported.

Declared In

JAALEEDevice.h

`JAALEEID`

JAALEEID

@property (nonatomic,
                                        strong, readonly) NSString *JAALEEID

Discussion

JAALEEID

Discussion: ID of the JAALEE device.

Declared In

JAALEEDevice.h

`isConnectable`

isConnectable

@property (nonatomic,
                                        readonly) BOOL isConnectable

Discussion

isConnectable

Whether the JAALEE can be connected

Declared In

JAALEEDevice.h

`isConnected`

isConnected

@property (nonatomic,
                                        readonly) BOOL isConnected

Discussion

isConnected

Flag indicating connection status.

Declared In

JAALEEDevice.h

`name`

name

@property (nonatomic,
                                        readonly) NSString *name

Discussion

name

Discussion: name of the JAALEE.

Declared In

JAALEEDevice.h

`batteryLevel`

batteryLevel

@property (nonatomic,
                                        strong, readonly) NSNumber *batteryLevel

Discussion

batteryLevel

Battery strength in %. Battery level change from 100% - 0%. Value available after connection with the JAALEE

Declared In

JAALEEDevice.h

`firmwareVersion`

firmwareVersion

@property (nonatomic,
                                        strong, readonly) NSString *firmwareVersion

Discussion

firmwareVersion

Battery strength in %. Battery level change from 100% - 0%. Value available after connection with the JAALEE

Declared In

JAALEEDevice.h

`proximityUUID`

proximityUUID

@property (nonatomic,
                                        strong, readonly) NSString *proximityUUID

Discussion

proximityUUID

Proximity UUID identifier read from the JAALEE device.

Declared In

JAALEEDevice.h

`major`

major

@property (nonatomic,
                                        strong, readonly) NSNumber *major

Discussion

major

major value read from the JAALEE device.

Declared In

JAALEEDevice.h

`minor`

minor

@property (nonatomic,
                                        strong, readonly) NSNumber *minor

Discussion

minor

minor value read from the JAALEE device.

Declared In

JAALEEDevice.h

`measuredPower`

measuredPower

@property (nonatomic,
                                        strong, readonly) NSNumber *measuredPower

Discussion

measuredPower

Measured Power value read from the JAALEE device.

Declared In

JAALEEDevice.h

`txPower`

txPower

@property (nonatomic,
                                        readonly) JAALEETXPower txPower

Discussion

txPower

Power of signal in dBm. Value available after connection with the JAALEE. It takes one of the values represented by JAALEETXPower .

Declared In

JAALEEDevice.h

`advInterval`

advInterval

@property (nonatomic,
                                        strong, readonly) NSNumber *advInterval

Discussion

advInterval

Advertising interval of the JAALEE. Value change from 100ms to 10000ms. Value available after connection with the JAALEE

Declared In

JAALEEDevice.h

`alwaysBroadcastChannel`

alwaysBroadcastChannel

@property (nonatomic,
                                        readonly) JAALEE_CHANNEL_SELECT alwaysBroadcastChannel

Discussion

alwaysBroadcastChannel

The channel choose for always broadcast

Declared In

JAALEEDevice.h

`motionTriggerChannel`

motionTriggerChannel

@property (nonatomic,
                                        readonly) JAALEE_CHANNEL_SELECT motionTriggerChannel

Discussion

motionTriggerChannel

The channel choose for motion trigger broadcast

Declared In

JAALEEDevice.h

`buttonTouchTriggerChannel`

buttonTouchTriggerChannel

@property (nonatomic,
                                        readonly) JAALEE_CHANNEL_SELECT buttonTouchTriggerChannel

Discussion

buttonTouchTriggerChannel

The channel choose for button touch trigger broadcast

Declared In

JAALEEDevice.h

`fallTriggerChannel`

fallTriggerChannel

@property (nonatomic,
                                        readonly) JAALEE_CHANNEL_SELECT fallTriggerChannel

Discussion

fallTriggerChannel

The channel choose for fall trigger broadcast

Declared In

JAALEEDevice.h

`motionSensitive`

motionSensitive

@property (nonatomic,
                                        readonly) JAALEE_SENSOR_SENSITIVE motionSensitive

Discussion

motionSensitive

The sensitive of motion detect, @see JAALEE_BEACON_SENSOR_SENSITIVE

Declared In

JAALEEDevice.h

`fallSensitive`

fallSensitive

@property (nonatomic,
                                        readonly) JAALEE_SENSOR_SENSITIVE fallSensitive

Discussion

fallSensitive

The sensitive of fall detect, @see JAALEE_BEACON_SENSOR_SENSITIVE

Declared In

JAALEEDevice.h

`broadcastModeConnectable`

broadcastModeConnectable

@property (nonatomic,
                                        readonly) BOOL broadcastModeConnectable

Discussion

broadcastModeConnectable

The broadcast mode of JAALEE. true:Connectable false:Non-Connectable

Declared In

JAALEEDevice.h

Connection handling methods

`– connectJAALEE`

Connect to particular JAALEE using bluetooth. Connection is required to change values like UUID, Major, Minor, Power, Advertising interval and so on.

- (void)connectJAALEE

Return Value

void

Discussion

Connect to particular JAALEE using bluetooth. Connection is required to change values like UUID, Major, Minor, Power, Advertising interval and so on.

Declared In

JAALEEDevice.h

`– disconnectJAALEE`

Disconnect JAALEE device

-
                                        (void)disconnectJAALEE

Return Value

void

Discussion

Disconnect JAALEE device

Declared In

JAALEEDevice.h

Methods for writing JAALEE configuration

`– writeIBeaconChannelProximityUUID:withCompletion:`

Writes Proximity UUID param to bluetooth connected JAALEE.

-
                                        (void)writeIBeaconChannelProximityUUID:(NSString *)pUUID
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`pUUID`	new iBeacon channel Proximity UUID value
`completion`	block handling operation completion

Return Value

void

Discussion

Writes Proximity UUID param to bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– writeIBeaconChannelMajor:withCompletion:`

Writes major param to bluetooth connected JAALEE.

-
                                        (void)writeIBeaconChannelMajor:(unsigned short)major
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`major`	iBeacon channel major value
`completion`	block handling operation completion

Return Value

void

Discussion

Writes major param to bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– writeIBeaconChannelMinor:withCompletion:`

Writes minor param to bluetooth connected JAALEE.

-
                                        (void)writeIBeaconChannelMinor:(unsigned short)minor
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`minor`	iBeacon channel minor value
`completion`	block handling operation completion

Return Value

void

Discussion

Writes minor param to bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– writeIBeaconChannelMesauredPower:withCompletion:`

Writes measured power param to bluetooth connected JAALEE.

-
                                        (void)writeIBeaconChannelMesauredPower:(unsigned short)measuredPower
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`measuredPower`	iBeacon channel measured power value
`completion`	block handling operation completion

Return Value

void

Discussion

Writes measured power param to bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– writeAdvInterval:withCompletion:`

Writes advertising interval (in milisec) of connected JAALEE. Note that the value is valid only for the alwaysBroadcastMode

-
                                        (void)writeAdvInterval:(unsigned short)interval
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`completion`	block handling operation completion
`advertising`	interval of beacon (1000 - 10000 ms)

Return Value

void

Discussion

Writes advertising interval (in milisec) of connected JAALEE. Note that the value is valid only for the alwaysBroadcastMode

Declared In

JAALEEDevice.h

`– writeJAALEETxPower:withCompletion:`

Writes txPower of bluetooth connected JAALEE.

-
                                        (void)writeJAALEETxPower:(JAALEETXPower)txPower
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`txPower`	advertising JAALEE power (can take value from JAALEEBeaconPowerLevel1 / waak to JAALEEBeaconPowerLevel9 / strong)
`completion`	block handling operation completion

Return Value

void

Discussion

Writes txPower of bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– writeJAALEEName:withCompletion:`

Writes device name of bluetooth connected JAALEE.

-
                                        (void)writeJAALEEName:(NSString *)name
                                        withCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`name`	JAALEE device name (lenth <= 15), For example @“jaalee”.
`completion`	block handling operation completion

Return Value

void

Discussion

Writes device name of bluetooth connected JAALEE.

Declared In

JAALEEDevice.h

`– configureIBeaconChannel:Major:Minor:measuredPowerValue:WithCompletion:`

Configure JAALEE based iBeacon channel data with ProximityUUID,Major,Minor and so on, you can also change UUID use writeBeaconProximityUUID method;

-
                                        (void)configureIBeaconChannel:(NSString *)ProximityUUID Major:(short
                                        int)major Minor:(short int)minor measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`ProximityUUID`	new iBeacon channel Proximity UUID value.
`major`	new iBeacon channel major value.
`minor`	new iBeacon channel minor value.
`measuredPowerValue`	new iBeacon channel measured power value.
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE based iBeacon channel data with ProximityUUID,Major,Minor and so on, you can also change UUID use writeBeaconProximityUUID method;

Declared In

JAALEEDevice.h

`– configureCustomChannelOneAsIBeacon:Major:Minor:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel one’s data as iBeacon Data;

-
                                        (void)configureCustomChannelOneAsIBeacon:(NSString *)ProximityUUID
                                        Major:(short int)major Minor:(short int)minor
                                        measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`ProximityUUID`	new iBeacon channel Proximity UUID value.
`major`	new iBeacon channel major value.
`minor`	new iBeacon channel minor value.
`measuredPowerValue`	new iBeacon channel measured power value.
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel one’s data as iBeacon Data;

Declared In

JAALEEDevice.h

`– configureCustomChannelOneAsEddystone:InstanceID:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel one’s data as Eddystone-UID Data;

-
                                        (void)configureCustomChannelOneAsEddystone:(NSString *)namespaceID
                                        InstanceID:(NSString *)InstanceID measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`namespaceID`	Eddystone-UID namespace ID, Lenth = 10 bytes.example @“EBEFD08370A247C89837”
`InstanceID`	Eddystone-UID instance ID, Lenth = 6 bytes.example @“E7B5634DF524”
`measuredPowerValue`	Eddystone-UID measured power value. example 203
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel one’s data as Eddystone-UID Data;

Declared In

JAALEEDevice.h

`– configureCustomChannelOneAsEddystone:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel one’s data as Eddystone-URL Data;

-
                                        (void)configureCustomChannelOneAsEddystone:(NSURL *)URL
                                        measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`URL`	Eddystone-URL. example @“www.jaalee.com”
`measuredPowerValue`	Eddystone-URL measured power value. example 203
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel one’s data as Eddystone-URL Data;

Declared In

JAALEEDevice.h

`– configureCustomChannelTwoAsIBeacon:Major:Minor:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel two’s data as iBeacon Data;

-
                                        (void)configureCustomChannelTwoAsIBeacon:(NSString *)ProximityUUID
                                        Major:(short int)major Minor:(short int)minor
                                        measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`ProximityUUID`	new iBeacon channel Proximity UUID value.
`major`	new iBeacon channel major value.
`minor`	new iBeacon channel minor value.
`measuredPowerValue`	new iBeacon channel measured power value.
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel two’s data as iBeacon Data;

Declared In

JAALEEDevice.h

`– configureCustomChannelTwoAsEddystone:InstanceID:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel two’s data as Eddystone-UID Data;

-
                                        (void)configureCustomChannelTwoAsEddystone:(NSString *)namespaceID
                                        InstanceID:(NSString *)InstanceID measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`namespaceID`	Eddystone-UID namespace ID, Lenth = 10 bytes.example @“EBEFD08370A247C89837”
`InstanceID`	Eddystone-UID instance ID, Lenth = 6 bytes.example @“E7B5634DF524”
`measuredPowerValue`	Eddystone-UID measured power value. example 203
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel two’s data as Eddystone-UID Data;

Declared In

JAALEEDevice.h

`– configureCustomChannelTwoAsEddystone:measuredPowerValue:WithCompletion:`

Configure JAALEE Custom channel two’s data as Eddystone-URL Data;

-
                                        (void)configureCustomChannelTwoAsEddystone:(NSURL *)URL
                                        measuredPowerValue:(int)measuredPowerValue
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`URL`	Eddystone-URL. example @“www.jaalee.com”
`measuredPowerValue`	Eddystone-URL measured power value. example 203
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE Custom channel two’s data as Eddystone-URL Data;

Declared In

JAALEEDevice.h

`– configureJAALEEBroadcastAlwaysConnectable:WithCompletion:`

Configure JAALEE broadcast mode

-
                                        (void)configureJAALEEBroadcastAlwaysConnectable:(BOOL)connectable
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`connectable`	connectable mode or non-connectable mode
`completion`	block handling operation completion.

Return Value

void

Discussion

Configure JAALEE broadcast mode

Declared In

JAALEEDevice.h

`– selectJAALEEalwaysBroadcastChannel:WithCompletion:`

Select a channel to broadcast always

-
                                        (void)selectJAALEEalwaysBroadcastChannel:(JAALEE_CHANNEL_SELECT)channel
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`channel`	the channel want to choose @see JAALEE_BEACON_CHANNEL_SELECT
`completion`	block handling operation completion.

Return Value

void

Discussion

Select a channel to broadcast always

Declared In

JAALEEDevice.h

`– selectJAALEEmotionTriggerChannel:WithCompletion:`

Select a channel to broadcast when JAALEE have a motion;

-
                                        (void)selectJAALEEmotionTriggerChannel:(JAALEE_CHANNEL_SELECT)channel
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`channel`	the channel want to choose @see JAALEE_BEACON_CHANNEL_SELECT
`completion`	block handling operation completion.

Return Value

void

Discussion

Select a channel to broadcast when JAALEE have a motion;

Declared In

JAALEEDevice.h

`– selectJAALEEbuttonTouchTriggerChannel:WithCompletion:`

Select a channel to broadcast when touched JAALEE button;

-
                                        (void)selectJAALEEbuttonTouchTriggerChannel:(JAALEE_CHANNEL_SELECT)channel
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`channel`	the channel want to choose @see JAALEE_BEACON_CHANNEL_SELECT
`completion`	block handling operation completion.

Return Value

void

Discussion

Select a channel to broadcast when touched JAALEE button;

Declared In

JAALEEDevice.h

`– selectJAALEEfallTriggerChannel:WithCompletion:`

Select a channel to broadcast when detect JAALEE droped;

-
                                        (void)selectJAALEEfallTriggerChannel:(JAALEE_CHANNEL_SELECT)channel
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`channel`	the channel want to choose @see JAALEE_BEACON_CHANNEL_SELECT
`completion`	block handling operation completion.

Return Value

void

Discussion

Select a channel to broadcast when detect JAALEE droped;

Declared In

JAALEEDevice.h

`– setJAALEEMotionSensitive:WithCompletion:`

set JAALEE motion sensitive;

-
                                        (void)setJAALEEMotionSensitive:(JAALEE_SENSOR_SENSITIVE)sensitive
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`sensitive`	the sensitive want to choose @see JAALEE_BEACON_SENSOR_SENSITIVE
`completion`	block handling operation completion.

Return Value

void

Discussion

set JAALEE motion sensitive;

Declared In

JAALEEDevice.h

`– setJAALEEFallSensitive:WithCompletion:`

set JAALEE fall sensitive;

-
                                        (void)setJAALEEFallSensitive:(JAALEE_SENSOR_SENSITIVE)sensitive
                                        WithCompletion:(JAALEEBoolCompletionBlock)completion

Parameters

`sensitive`	the sensitive want to choose @see JAALEE_BEACON_SENSOR_SENSITIVE
`completion`	block handling operation completion.

Return Value

void

Discussion

start notify motion, when JAALEE have a motion JAALEEDidMotionDetected method will be called.

Declared In

JAALEEDevice.h