Package com.blukii.sdk.config.datatype

Class EventBeaconSettings

java.lang.Object

com.blukii.sdk.config.datatype.EventBeaconSettings

public final class EventBeaconSettings
extends Object

This class represents data type EventBeaconSettings

See Also:

• SmartBeacon.writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• SmartBeacon.readEventBeaconSettings(ResponseListener)
• BlukiiAction.SmartBeaconWriteEventBeaconSettings
• BlukiiAction.SmartBeaconReadEventBeaconSettings

Constructor Summary

Constructors

Constructor	Description
EventBeaconSettings()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getAdvertisingInterval()	Gets Event Beacon Setting "Advertising Interval".
int	getAdvertisingType()	Gets Event Beacon Setting "Advertising Type".
String	getEddystoneInstance()	Gets Event Beacon Setting "Eddystone Instance".
String	getEddystoneNamespace()	Gets Event Beacon Setting "Eddystone Namespace".
String	getEddystoneUrl()	Gets Event Beacon Setting "Eddystone Url".
int	getEventDuration()	Gets Event Beacon Setting "Event Duration"
int	getIBeaconAlternationMode()	Gets the iBeacon Alternation Mode of Event Beacon.
int	getIBeaconAlternationModulo()	Gets the iBeacon Alternation Modulo of Event Beacon.
int	getIBeaconMajor()	Gets Event Beacon Setting "iBeacon Major".
short	getIBeaconMeasuredPower()	Gets Event Beacon Setting "iBeacon Measured Power".
int	getIBeaconMinor()	Gets Event Beacon Setting "iBeacon Minor.
UUID	getIBeaconUuid()	Gets Event Beacon Setting "iBeacon UUID".
int	getSelectedFrames()	Gets Event Beacon Setting "Selected Frames".
int	getTimerInterval()	Gets Event Beacon Setting "Timer Interval"
int	getTrigger()	Gets Event Beacon Setting "Trigger".
boolean	isPrimaryAdvertisingDisabled()	Gets Event Beacon Setting "Primary Advertising Disabled".
void	setAdvertisingInterval(int advertisingInterval)	Sets the Advertising Interval of Event Beacon.
void	setAdvertisingType(int advertisingType)	Sets the Advertising Type of Event Beacon.
void	setEddystoneInstance(String eddystoneInstance)	Sets the Eddystone Instance of Event Beacon.
void	setEddystoneNamespace(String eddystoneNamespace)	Sets the Eddystone Namespace of Event Beacon.
void	setEddystoneUrl(String eddystoneUrl)	Sets the Eddystone Url of Event Beacon.
void	setEventDuration(int eventDuration)	Sets the Event Duration of Event Beacon
void	setIBeaconAlternationMode(int iBeaconAlternationMode)	Sets the iBeacon Alternation Mode of Event Beacon.
void	setIBeaconAlternationModulo(int iBeaconAlternationModulo)	Sets the iBeacon Alternation Modulo of Event Beacon.
void	setIBeaconMajor(int iBeaconMajor)	Sets the iBeacon Major of Event Beacon.
void	setIBeaconMeasuredPower(short iBeaconMeasuredPower)	Sets the iBeacon Measured Power of Event Beacon.
void	setIBeaconMinor(int iBeaconMinor)	Sets the iBeacon Minor of Event Beacon.
void	setIBeaconUuid(UUID iBeaconUuid)	Sets the iBeacon UUID of Event Beacon.
void	setPrimaryAdvertisingDisabled(boolean primaryAdvertisingDisabled)	Enables/Disables Primary Advertising.
void	setSelectedFrames(int selectedFrames)	Sets the Selected Frames of Event Beacon.
void	setTimerInterval(int timerInterval)	Sets the Timer Interval of Event Beacon
void	setTrigger(int trigger)	Sets the Trigger of Event Beacon.
String	toString()
int	validate()	Validates the values contained in this object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EventBeaconSettings

public EventBeaconSettings()

Method Details

getSelectedFrames

public int getSelectedFrames()

Gets Event Beacon Setting "Selected Frames".

Returns:

the selected frames of event beacon

setSelectedFrames

public void setSelectedFrames(int selectedFrames)

Sets the Selected Frames of Event Beacon.

Values: (Bitwise Set of following constants)

• SmartBeacon.SETTING_BEACON_FRAME_NONE
• SmartBeacon.SETTING_BEACON_FRAME_INFOBEACON_ENVIRONMENT
• SmartBeacon.SETTING_BEACON_FRAME_INFOBEACON_ACCELERATION
• SmartBeacon.SETTING_BEACON_FRAME_INFOBEACON_MAGNETOMETER
• SmartBeacon.SETTING_BEACON_FRAME_EDDYSTONE_UID
• SmartBeacon.SETTING_BEACON_FRAME_EDDYSTONE_URL
• SmartBeacon.SETTING_BEACON_FRAME_EDDYSTONE_TLM
• SmartBeacon.SETTING_BEACON_FRAME_SPECIAL
• SmartBeacon.SETTING_BEACON_FRAME_IBEACON
• SmartBeacon.SETTING_BEACON_FRAME_EVENTBEACON_SECURE

Parameters:

selectedFrames - a bitwise set of selected frames

getIBeaconUuid

public UUID getIBeaconUuid()

Gets Event Beacon Setting "iBeacon UUID".

Returns:

the iBeacon UUID of event beacon

setIBeaconUuid

public void setIBeaconUuid(@NonNull
 UUID iBeaconUuid)

Sets the iBeacon UUID of Event Beacon.

Parameters:

iBeaconUuid - the iBeacon UUID

getIBeaconMajor

public int getIBeaconMajor()

Gets Event Beacon Setting "iBeacon Major".

Returns:

the iBeacon Major of event beacon

setIBeaconMajor

public void setIBeaconMajor(int iBeaconMajor)

Sets the iBeacon Major of Event Beacon.

Value:

• 0 - 65535

Parameters:

iBeaconMajor - the iBeacon Major

getIBeaconMinor

public int getIBeaconMinor()

Gets Event Beacon Setting "iBeacon Minor.

Returns:

the iBeacon Minor of event beacon

setIBeaconMinor

public void setIBeaconMinor(int iBeaconMinor)

Sets the iBeacon Minor of Event Beacon.

Value:

• 0 - 65535

Parameters:

iBeaconMinor - the iBeacon Minor

getIBeaconAlternationMode

public int getIBeaconAlternationMode()

Gets the iBeacon Alternation Mode of Event Beacon.

Available modes:

• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_RESET
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET_LED

Note: for firmware version 002.014 and older value is SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_UNUSED. In this case Alternation Mode is equal to SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS and enabled by setting Alternation Count larger than 0.

Returns:

the iBeacon Alternation Mode

See Also:

• getIBeaconAlternationModulo()

setIBeaconAlternationMode

public void setIBeaconAlternationMode(int iBeaconAlternationMode)

Sets the iBeacon Alternation Mode of Event Beacon.

Available modes:

• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_RESET
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET
• SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET_LED

Note: for firmware version 002.014 and older value is SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_UNUSED. In this case Alternation Mode is equal to SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS and enabled by setting Alternation Modulo larger than 0.

Parameters:

iBeaconAlternationMode - the iBeacon Alternation Mode

See Also:

• getIBeaconAlternationModulo()

getIBeaconAlternationModulo

public int getIBeaconAlternationModulo()

Gets the iBeacon Alternation Modulo of Event Beacon.

Note: this only takes affect if alternation mode is not SmartBeacon.SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF.

Value:

• 2 .. 255 iBeacon Major or Minor is increasing up to Modulo - 1 and restarts with base Major or Minor value

Returns:

the iBeacon Alternation Modulo

See Also:

• getIBeaconAlternationMode()

setIBeaconAlternationModulo

public void setIBeaconAlternationModulo(int iBeaconAlternationModulo)

Sets the iBeacon Alternation Modulo of Event Beacon.

Note: this only takes affect if alternation setting is not OFF.

Value:

• 2 .. 255 iBeacon Major or Minor is increasing up to Modulo - 1 and restarts with base Major or Minor value

Parameters:

iBeaconAlternationModulo - the iBeacon Alternation Modulo

See Also:

• getIBeaconAlternationMode()

getIBeaconMeasuredPower

public short getIBeaconMeasuredPower()

Gets Event Beacon Setting "iBeacon Measured Power".

Returns:

the iBeacon Measured Power of event beacon

setIBeaconMeasuredPower

public void setIBeaconMeasuredPower(short iBeaconMeasuredPower)

Sets the iBeacon Measured Power of Event Beacon.

Value:

• -127 - 5

Parameters:

iBeaconMeasuredPower - the ibeacon Measured Power

getEddystoneNamespace

public String getEddystoneNamespace()

Gets Event Beacon Setting "Eddystone Namespace".

Returns:

the Eddystone Namespace of event beacon

setEddystoneNamespace

public void setEddystoneNamespace(@NonNull
 String eddystoneNamespace)

Sets the Eddystone Namespace of Event Beacon.

Value:

• 20 byte hex string

Parameters:

eddystoneNamespace - the Eddystone Namespace

getEddystoneInstance

public String getEddystoneInstance()

Gets Event Beacon Setting "Eddystone Instance".

Returns:

the Eddystone Instance of event beacon

setEddystoneInstance

public void setEddystoneInstance(@NonNull
 String eddystoneInstance)

Sets the Eddystone Instance of Event Beacon.

Value:

• 12 byte hex string

Parameters:

eddystoneInstance - the Eddystone Instance

getEddystoneUrl

public String getEddystoneUrl()

Gets Event Beacon Setting "Eddystone Url".

Returns:

the Eddystone Url of event beacon

setEddystoneUrl

public void setEddystoneUrl(@NonNull
 String eddystoneUrl)

Sets the Eddystone Url of Event Beacon.

Parameters:

eddystoneUrl - the Eddystone Url

getAdvertisingInterval

public int getAdvertisingInterval()

Gets Event Beacon Setting "Advertising Interval".

Returns:

the Advertising Interval of event beacon

setAdvertisingInterval

public void setAdvertisingInterval(int advertisingInterval)

Sets the Advertising Interval of Event Beacon.

Value:

• 100 - 10000 ms

Parameters:

advertisingInterval - the Advertising Interval

getAdvertisingType

public int getAdvertisingType()

Gets Event Beacon Setting "Advertising Type".

Returns:

the Advertising Type of event beacon

setAdvertisingType

public void setAdvertisingType(int advertisingType)

Sets the Advertising Type of Event Beacon.

Since firmware version 006.001 Advertising type is not supported any more because Smart Beacon is sending connectable. Therefore Advertising type is set to SmartBeacon.SETTING_BEACON_SELECTED_ADVERTISING_TYPE_CONNECTABLE_SCANRESPONSE.

Values for firmware version 002.xxx:

• SmartBeacon.SETTING_BEACON_SELECTED_ADVERTISING_TYPE_CONNECTABLE_SCANRESPONSE
• SmartBeacon.SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_SCANRESPONSE
• SmartBeacon.SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_NOSCANRESPONSE

Parameters:

advertisingType - the Advertising Type

isPrimaryAdvertisingDisabled

public boolean isPrimaryAdvertisingDisabled()

Gets Event Beacon Setting "Primary Advertising Disabled".

Returns:

if Primary Advertising is Disabled

setPrimaryAdvertisingDisabled

public void setPrimaryAdvertisingDisabled(boolean primaryAdvertisingDisabled)

Enables/Disables Primary Advertising.

If disabled, the blukii only sends advertising defined in EventBeaconSettings

Parameters:

primaryAdvertisingDisabled - true to disable Primary advertising

getTrigger

public int getTrigger()

Gets Event Beacon Setting "Trigger".

Returns:

the Trigger of event beacon

setTrigger

public void setTrigger(int trigger)

Sets the Trigger of Event Beacon.

Value: (Bitwise set of following constants)

• SmartBeacon.SETTING_BEACON_EVENT_TRIGGER_OFF
• SmartBeacon.SETTING_BEACON_EVENT_TRIGGER_BUTTON
• SmartBeacon.SETTING_BEACON_EVENT_TRIGGER_RIPLINE
• SmartBeacon.SETTING_BEACON_EVENT_TRIGGER_TIMER

Parameters:

trigger - a bitwise set of triggers

getEventDuration

public int getEventDuration()

Gets Event Beacon Setting "Event Duration"

Returns:

the Event Duration of event beacon

setEventDuration

public void setEventDuration(int eventDuration)

Sets the Event Duration of Event Beacon

Value:

• 1 - 42940 s

Parameters:

eventDuration - the event duration

getTimerInterval

public int getTimerInterval()

Gets Event Beacon Setting "Timer Interval"

Returns:

the Timer Interval of event beacon

setTimerInterval

public void setTimerInterval(int timerInterval)

Sets the Timer Interval of Event Beacon

Value:

• 1 - 42940 s

Parameters:

timerInterval - the timer interval

validate

public int validate()

Validates the values contained in this object.

This can be used when you create an object, to verify the values set.

Returns:

a state from Validation

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object

toString

@NonNull
public String toString()

Overrides:

toString in class Object