Package com.blukii.sdk.config

Class SmartBeacon

java.lang.Object

com.blukii.sdk.config.Blukii

com.blukii.sdk.config.SmartBeacon

public final class SmartBeacon
extends Blukii

This class represents a blukii of type Smart Beacon and is the main controller class for connection based communication with blukii devices of that type.

This class contains additional requests that are specific for blukii Smart Beacons.

To quick start please follow the instructions of the quick start documentation of base class Blukii

Note: Sensor Beacons are also handled with this class. You can check the type via the type check methods: Blukii.isSmartBeacon() and Blukii.isSensorBeacon()

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET	Smart Beacon event alternation mode: MAJOR CONTINUOUS
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET_LED	Smart Beacon event alternation mode: MAJOR CONTINUOUS LED
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS	Smart Beacon event alternation mode: MINOR CONTINUOUS
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_RESET	Smart Beacon event alternation mode: MINOR RESET
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF	Smart Beacon event alternation mode: OFF
static final int	SETTING_BEACON_EVENT_ALTERNATION_MODE_UNUSED	Smart Beacon event alternation mode: UNUSED.
static final int	SETTING_BEACON_EVENT_TRIGGER_BUTTON	Smart Beacon event trigger: Button.
static final int	SETTING_BEACON_EVENT_TRIGGER_OFF	Smart Beacon event trigger: Off.
static final int	SETTING_BEACON_EVENT_TRIGGER_RIPLINE	Smart Beacon event trigger: Ripline.
static final int	SETTING_BEACON_EVENT_TRIGGER_SENSOR	Smart Beacon event trigger: Sensor.
static final int	SETTING_BEACON_EVENT_TRIGGER_TIMER	Smart Beacon event trigger: Timer.
static final int	SETTING_BEACON_FRAME_EDDYSTONE_TLM	Smart Beacon frame: Eddystone TLM.
static final int	SETTING_BEACON_FRAME_EDDYSTONE_UID	Smart Beacon frame: Eddystone UID.
static final int	SETTING_BEACON_FRAME_EDDYSTONE_URL	Smart Beacon frame: Eddystone URL.
static final int	SETTING_BEACON_FRAME_EVENTBEACON_SECURE	Smart Beacon frame: iBeacon secure (Event Beacon only).
static final int	SETTING_BEACON_FRAME_IBEACON	Smart Beacon frame: iBeacon.
static final int	SETTING_BEACON_FRAME_INFOBEACON_ACCELERATION	Smart Beacon frame: InfoBeacon Acceleration.
static final int	SETTING_BEACON_FRAME_INFOBEACON_ENVIRONMENT	Smart Beacon frame: InfoBeacon Environment.
static final int	SETTING_BEACON_FRAME_INFOBEACON_MAGNETOMETER	Smart Beacon frame: InfoBeacon Magnetometer.
static final int	SETTING_BEACON_FRAME_NONE	Smart Beacon frame: No frame.
static final int	SETTING_BEACON_FRAME_SPECIAL	Smart Beacon frame: Special
static final int	SETTING_BEACON_SELECTED_ADVERTISING_TYPE_CONNECTABLE_SCANRESPONSE	Smart Beacon frame advertising type: connectable.
static final int	SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_NOSCANRESPONSE	Smart Beacon frame advertising type: not connectable, no scan response.
static final int	SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_SCANRESPONSE	Smart Beacon frame advertising type: not connectable, with scan response.
static final int	SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_2G	SmartBeacon Accelerometer Range: 2g
static final int	SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_4G	SmartBeacon Accelerometer Range: 4g
static final int	SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_8G	SmartBeacon Accelerometer Range: 8g
static final int	SETTING_BEACON_SENSOR_MEASURE_STATE_NOFITY_CONNECTED	SmartBeacon Sensor Measure State: Notify if connected.
static final int	SETTING_BEACON_SENSOR_MEASURE_STATE_OFF	SmartBeacon Sensor Measure State: Off.
static final int	SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_CONNECTED	SmartBeacon Sensor Measure State: Recording if connected.
static final int	SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_DISCONNECTED	SmartBeacon Sensor Measure State: Recording if disconnected.
static final int	SETTING_BEACON_SENSOR_MODE_CONTINUOUS_ALWAYS	SmartBeacon Sensor Mode: Always continuous measurement.
static final int	SETTING_BEACON_SENSOR_MODE_INTERRUPT_ALWAYS	SmartBeacon Sensor Mode: Always measurement after interrupt.
static final int	SETTING_BEACON_SENSOR_MODE_INTERRUPT_CONNECTED	SmartBeacon Sensor Mode: Measurement after interrupt if connected.
static final int	SETTING_BEACON_SENSOR_MODE_INTERRUPT_DISCONNECTED	SmartBeacon Sensor Mode: Measurement after interrupt if disconnected.
static final int	SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA	SmartBeacon Transfer State: Data transfer is started or running
static final int	SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS	SmartBeacon Transfer State: Data header transfer is started or running
static final int	SETTING_BEACON_SENSOR_TRANSFER_STATE_OFF	SmartBeacon Transfer State: Data transfer is off or completed.
static final int	SETTING_BEACON_SENSOR_TRANSFER_STATE_RESET_DATA	SmartBeacon Transfer State: Data reset is started or running
static final int	SETTING_EDDYSTONE_TXPOWER_MODE_HIGH	Eddystone TxPower mode: High.
static final int	SETTING_EDDYSTONE_TXPOWER_MODE_LOW	Eddystone TxPower mode: Low.
static final int	SETTING_EDDYSTONE_TXPOWER_MODE_LOWEST	Eddystone TxPower mode: Lowest.
static final int	SETTING_EDDYSTONE_TXPOWER_MODE_MEDIUM	Eddystone TxPower mode: Medium.

Fields inherited from class com.blukii.sdk.config.Blukii

FIRMWARE, HARDWARE, SETTING_BLUETOOTH_TXPOWER_VALUES_003, SETTING_BLUETOOTH_TXPOWER_VALUES_007, SETTING_BLUKII_BATTERY_TYPE_3000, SETTING_BLUKII_BATTERY_TYPE_3300, SETTING_BLUKII_BATTERY_TYPE_3600, SETTING_BLUKII_LED_FLASH_1000, SETTING_BLUKII_LED_FLASH_300, SETTING_BLUKII_LED_FLASH_50, SETTING_BLUKII_LED_OFF, SETTING_BLUKII_LED_ON_MINUTES, SETTING_BLUKII_LED_ON_SECONDS, SETTING_BLUKII_SYSTEM_RESET_FACTORY_DATA_RESET, SETTING_BLUKII_SYSTEM_RESET_FACTORY_DATA_UPDATE, SETTING_BLUKII_SYSTEM_RESET_FACTORY_FLASH_RESET, SETTING_BLUKII_SYSTEM_RESET_FACTORY_IMAGE_RESET, SETTING_BLUKII_SYSTEM_RESET_REBOOT

Method Summary

Modifier and Type	Method	Description
void	readDeviceTracingRssiThreshold(ResponseListener responseListener)	Reads the Device Tracing Rssi Threshold.
void	readDeviceTracingScanDuration(ResponseListener responseListener)	Reads the Device Tracing Scan Duration.
void	readDeviceTracingScanInterval(ResponseListener responseListener)	Reads the Device Tracing Scan Interval.
void	readDeviceTracingScanPeriod(ResponseListener responseListener)	Reads the Device Tracing Scan Period.
void	readDeviceTracingScanWindow(ResponseListener responseListener)	Reads the Device Tracing Scan Window.
void	readEddystoneLockState(ResponseListener responseListener)	Reads the Eddystone locked state.
void	readEddystoneTxPowerMeasuredLevels(ResponseListener responseListener)	Reads the measured Eddystone TxPower Levels.
void	readEddystoneTxPowerMode(ResponseListener responseListener)	Reads the Eddystone TxPower Mode.
void	readEddystoneTxPowerPhysicalLevels(ResponseListener responseListener)	Reads the physical Eddystone TxPower Levels.
void	readEddystoneUID(ResponseListener responseListener)	Reads the Eddystone UID (namespace and instance ID).
void	readEddystoneUrl(ResponseListener responseListener)	Reads the Eddystone URL.
void	readEventBeaconSettings(ResponseListener responseListener)	Reads Event Beacon settings.
void	readFrames(ResponseListener responseListener)	Reads the Smart Beacon selected frames.
void	readIBeaconAdvertisement(ResponseListener responseListener)	Reads the iBeacon advertising data: UUID, Major, Minor and MeasuredPower.
void	readRepeaterSettings(ResponseListener responseListener)	Reads the Settings for iBeacon Repeater.
void	readSecureMode(ResponseListener responseListener)	Reads Secure Mode.
void	readSensorAccelerometerRange(ResponseListener responseListener)	Reads the Accelerometer sensor range.
void	readSensorInterruptSettings(ResponseListener responseListener)	Reads the Sensor Interrupt settings.
void	readSensorIntervals(ResponseListener responseListener)	Reads the Sensor Interval settings.
void	readSensorLimitedRecording(ResponseListener responseListener)	Reads the Sensor Limited Recording settings.
void	readSensorMeasureState(ResponseListener responseListener)	Reads the Sensor Measure State.
void	readSensorMode(ResponseListener responseListener)	Reads the the Sensor Mode.
void	readSensorTransferState(ResponseListener responseListener)	Reads the Sensor Transfer State.
void	readSettings(ResponseListener responseListener)	Reads the global Smart Beacon settings.
void	resetEddystone(ResponseListener responseListener)	Resets all Eddystone values to factory default settings.
void	syncSecureMode(ResponseListener responseListener)	Starts secure mode sync.
void	writeDeviceTracingRssiThreshold(int rssi, ResponseListener responseListener)	Writes the Device Tracing Rssi Threshold.
void	writeDeviceTracingScanDuration(int duration, ResponseListener responseListener)	Writes the Device Tracing Scan Duration.
void	writeDeviceTracingScanInterval(int interval, ResponseListener responseListener)	Writes the Device Tracing Scan Interval.
void	writeDeviceTracingScanPeriod(int period, ResponseListener responseListener)	Writes the Device Tracing Scan Period.
void	writeDeviceTracingScanWindow(int window, ResponseListener responseListener)	Writes the Device Tracing Scan Window.
void	writeEddystoneLock(UUID key, ResponseListener responseListener)	Locks the Eddystone settings against unauthorized changes.
void	writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels eddystoneTxPowerLevels, ResponseListener responseListener)	Writes the Eddystone TxPower Levels.
void	writeEddystoneTxPowerMode(int mode, ResponseListener responseListener)	Writes the Eddystone TxPower Mode.
void	writeEddystoneUID(EddystoneUID eddystoneUID, ResponseListener responseListener)	Writes the Eddystone UID (namespace and instance ID).
void	writeEddystoneUnlock(UUID key, ResponseListener responseListener)	Unlocks the Eddystone settings.
void	writeEddystoneUrl(String url, ResponseListener responseListener)	Writes the Eddystone URL.
void	writeEventBeaconSettings(EventBeaconSettings eventBeaconSettings, ResponseListener responseListener)	Write Event Beacon settings.
void	writeFrames(int selectedFrames, ResponseListener responseListener)	Writes the Smart Beacon selected frames.
void	writeIBeaconAdvertisement(IBeacon iBeacon, ResponseListener responseListener)	Writes the iBeacon advertising data: UUID, Major, Minor and MeasuredPower.
void	writeRepeaterSettings(RepeaterSettings repeaterSettings, ResponseListener responseListener)	Writes the Settings for iBeacon Repeater.
void	writeSecureMode(boolean mode, ResponseListener responseListener)	Enable/Disable Secure Mode.
void	writeSensorAccelerometerRange(int range, ResponseListener responseListener)	Writes the Accelerometer sensor range.
void	writeSensorInterruptSettings(SensorInterrupt interrupt, ResponseListener responseListener)	Writes the Sensor Interrupt settings.
void	writeSensorIntervals(SensorIntervals intervals, ResponseListener responseListener)	Writes the Sensor Interval settings.
void	writeSensorLimitedRecording(SensorLimitedRecording limitedRecording, ResponseListener responseListener)	Writes the Sensor Limited Recording settings.
void	writeSensorMeasureState(int state, ResponseListener responseListener)	Writes the Sensor Measure State.
void	writeSensorMode(int mode, ResponseListener responseListener)	Writes the Sensor Mode.
void	writeSensorTransferState(SensorTransferCommand transferParam, ResponseListener responseListener)	Writes the Sensor Transfer State.
void	writeSettings(SmartBeaconSettings smartBeaconSettings, ResponseListener responseListener)	Writes the global Smart Beacon settings.

Methods inherited from class com.blukii.sdk.config.Blukii

check, connect, connect, disconnect, getBluetoothDevice, getBluetoothDeviceName, getBlukiiData, getConnectionTimeout, getSubType, getType, initiatePairing, isReady, isSensorBeacon, isSmartBeacon, isSmartKey, readAdvertisingChannels, readAdvertisingUpdateDelay, readBatteryLevel, readBatteryType, readConnectionParameterDelay, readCurrentConnectionParameter, readDelayedAdvertisingInterval, readDelayedConnectionParameter, readDelayedDisconnect, readEnergySaveSettings, readInitialAdvertisingInterval, readLimitedAdvertising, readRssi, readRTC, readSecureConnect, readStateCounter, readTemperature, readTxPower, resetStateCounter, setConnectionTimeout, syncRTC, updateData, updateFirmware, updateFirmware, writeAdvertisingChannels, writeAdvertisingUpdateDelay, writeBatteryType, writeConnectionParameterDelay, writeCurrentConnectionParameter, writeDelayedAdvertisingInterval, writeDelayedConnectionParameter, writeDelayedDisconnect, writeEnergySaveSettings, writeInitialAdvertisingInterval, writeLEDMode, writeLimitedAdvertising, writeSecureConnect, writeSecureKey, writeSystemReset, writeTemperature, writeTxPower

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SETTING_BEACON_FRAME_NONE

public static final int SETTING_BEACON_FRAME_NONE

Smart Beacon frame: No frame.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_INFOBEACON_ENVIRONMENT

public static final int SETTING_BEACON_FRAME_INFOBEACON_ENVIRONMENT

Smart Beacon frame: InfoBeacon Environment.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_INFOBEACON_ACCELERATION

public static final int SETTING_BEACON_FRAME_INFOBEACON_ACCELERATION

Smart Beacon frame: InfoBeacon Acceleration.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_INFOBEACON_MAGNETOMETER

public static final int SETTING_BEACON_FRAME_INFOBEACON_MAGNETOMETER

Smart Beacon frame: InfoBeacon Magnetometer.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_EDDYSTONE_UID

public static final int SETTING_BEACON_FRAME_EDDYSTONE_UID

Smart Beacon frame: Eddystone UID.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_EDDYSTONE_URL

public static final int SETTING_BEACON_FRAME_EDDYSTONE_URL

Smart Beacon frame: Eddystone URL.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_EDDYSTONE_TLM

public static final int SETTING_BEACON_FRAME_EDDYSTONE_TLM

Smart Beacon frame: Eddystone TLM.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_SPECIAL

public static final int SETTING_BEACON_FRAME_SPECIAL

Smart Beacon frame: Special

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_IBEACON

public static final int SETTING_BEACON_FRAME_IBEACON

Smart Beacon frame: iBeacon.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_FRAME_EVENTBEACON_SECURE

public static final int SETTING_BEACON_FRAME_EVENTBEACON_SECURE

Smart Beacon frame: iBeacon secure (Event Beacon only).

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_SELECTED_ADVERTISING_TYPE_CONNECTABLE_SCANRESPONSE

public static final int SETTING_BEACON_SELECTED_ADVERTISING_TYPE_CONNECTABLE_SCANRESPONSE

Smart Beacon frame advertising type: connectable.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_SCANRESPONSE

public static final int SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_SCANRESPONSE

Smart Beacon frame advertising type: not connectable, with scan response.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_NOSCANRESPONSE

public static final int SETTING_BEACON_SELECTED_ADVERTISING_TYPE_NONCONNECTABLE_NOSCANRESPONSE

Smart Beacon frame advertising type: not connectable, no scan response.

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_UNUSED

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_UNUSED

Smart Beacon event alternation mode: UNUSED.

Because alternation mode is an new feature since version 002.015 this mode is set for all older versions.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_OFF

Smart Beacon event alternation mode: OFF

iBeacon Minor and Major base value will be constantly sent

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_CONTINUOUS

Smart Beacon event alternation mode: MINOR CONTINUOUS

iBeacon Minor will be increased each event until Modulo - 1 (see EventBeaconSettings.getIBeaconAlternationModulo())

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_RESET

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_MINOR_RESET

Smart Beacon event alternation mode: MINOR RESET

iBeacon Minor will be increased each event until Modulo - 1 (see EventBeaconSettings.getIBeaconAlternationModulo()).

After event duration (see EventBeaconSettings.getEventDuration()) iBeacon Minor is reset to base value.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET

Smart Beacon event alternation mode: MAJOR CONTINUOUS

iBeacon Major will be increased each event until Modulo - 1 (see EventBeaconSettings.getIBeaconAlternationModulo()).

After event duration (see EventBeaconSettings.getEventDuration()) iBeacon Major is reset to base value.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET_LED

public static final int SETTING_BEACON_EVENT_ALTERNATION_MODE_MAJOR_RESET_LED

Smart Beacon event alternation mode: MAJOR CONTINUOUS LED

iBeacon Major will be increased each event until Modulo - 1 (see EventBeaconSettings.getIBeaconAlternationModulo()).

After event duration (see EventBeaconSettings.getEventDuration()) iBeacon Major is reset to base value.

Red LED is visualising the alternation state for complete event duration:

• Major + 0: fast blink (interval 50ms)
• Major + 1: slow blink (interval 300ms)
• Major + 2: continuously on
• Major + >2: continuously off

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_TRIGGER_OFF

public static final int SETTING_BEACON_EVENT_TRIGGER_OFF

Smart Beacon event trigger: Off.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_TRIGGER_BUTTON

public static final int SETTING_BEACON_EVENT_TRIGGER_BUTTON

Smart Beacon event trigger: Button.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_TRIGGER_RIPLINE

public static final int SETTING_BEACON_EVENT_TRIGGER_RIPLINE

Smart Beacon event trigger: Ripline.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_TRIGGER_TIMER

public static final int SETTING_BEACON_EVENT_TRIGGER_TIMER

Smart Beacon event trigger: Timer.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_BEACON_EVENT_TRIGGER_SENSOR

public static final int SETTING_BEACON_EVENT_TRIGGER_SENSOR

Smart Beacon event trigger: Sensor.

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• Constant Field Values

SETTING_EDDYSTONE_TXPOWER_MODE_LOWEST

public static final int SETTING_EDDYSTONE_TXPOWER_MODE_LOWEST

Eddystone TxPower mode: Lowest.

See Also:

• writeEddystoneTxPowerMode(int, ResponseListener)
• writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels, ResponseListener)
• Constant Field Values

SETTING_EDDYSTONE_TXPOWER_MODE_LOW

public static final int SETTING_EDDYSTONE_TXPOWER_MODE_LOW

Eddystone TxPower mode: Low.

See Also:

• writeEddystoneTxPowerMode(int, ResponseListener)
• writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels, ResponseListener)
• Constant Field Values

SETTING_EDDYSTONE_TXPOWER_MODE_MEDIUM

public static final int SETTING_EDDYSTONE_TXPOWER_MODE_MEDIUM

Eddystone TxPower mode: Medium.

See Also:

• writeEddystoneTxPowerMode(int, ResponseListener)
• writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels, ResponseListener)
• Constant Field Values

SETTING_EDDYSTONE_TXPOWER_MODE_HIGH

public static final int SETTING_EDDYSTONE_TXPOWER_MODE_HIGH

Eddystone TxPower mode: High.

See Also:

• writeEddystoneTxPowerMode(int, ResponseListener)
• writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MEASURE_STATE_OFF

public static final int SETTING_BEACON_SENSOR_MEASURE_STATE_OFF

SmartBeacon Sensor Measure State: Off.

See Also:

• writeSensorMeasureState(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MEASURE_STATE_NOFITY_CONNECTED

public static final int SETTING_BEACON_SENSOR_MEASURE_STATE_NOFITY_CONNECTED

SmartBeacon Sensor Measure State: Notify if connected.

See Also:

• writeSensorMeasureState(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_CONNECTED

public static final int SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_CONNECTED

SmartBeacon Sensor Measure State: Recording if connected.

See Also:

• writeSensorMeasureState(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_DISCONNECTED

public static final int SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_DISCONNECTED

SmartBeacon Sensor Measure State: Recording if disconnected.

See Also:

• writeSensorMeasureState(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MODE_CONTINUOUS_ALWAYS

public static final int SETTING_BEACON_SENSOR_MODE_CONTINUOUS_ALWAYS

SmartBeacon Sensor Mode: Always continuous measurement.

See Also:

• writeSensorMode(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MODE_INTERRUPT_CONNECTED

public static final int SETTING_BEACON_SENSOR_MODE_INTERRUPT_CONNECTED

SmartBeacon Sensor Mode: Measurement after interrupt if connected.

See Also:

• writeSensorMode(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MODE_INTERRUPT_DISCONNECTED

public static final int SETTING_BEACON_SENSOR_MODE_INTERRUPT_DISCONNECTED

SmartBeacon Sensor Mode: Measurement after interrupt if disconnected.

See Also:

• writeSensorMode(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_MODE_INTERRUPT_ALWAYS

public static final int SETTING_BEACON_SENSOR_MODE_INTERRUPT_ALWAYS

SmartBeacon Sensor Mode: Always measurement after interrupt.

See Also:

• writeSensorMode(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_TRANSFER_STATE_OFF

public static final int SETTING_BEACON_SENSOR_TRANSFER_STATE_OFF

SmartBeacon Transfer State: Data transfer is off or completed.

See Also:

• writeSensorTransferState(SensorTransferCommand, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA

public static final int SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA

SmartBeacon Transfer State: Data transfer is started or running

See Also:

• writeSensorTransferState(SensorTransferCommand, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_TRANSFER_STATE_RESET_DATA

public static final int SETTING_BEACON_SENSOR_TRANSFER_STATE_RESET_DATA

SmartBeacon Transfer State: Data reset is started or running

See Also:

• writeSensorTransferState(SensorTransferCommand, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS

public static final int SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS

SmartBeacon Transfer State: Data header transfer is started or running

See Also:

• writeSensorTransferState(SensorTransferCommand, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_2G

public static final int SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_2G

SmartBeacon Accelerometer Range: 2g

See Also:

• writeSensorAccelerometerRange(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_4G

public static final int SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_4G

SmartBeacon Accelerometer Range: 4g

See Also:

• writeSensorAccelerometerRange(int, ResponseListener)
• Constant Field Values

SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_8G

public static final int SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_8G

SmartBeacon Accelerometer Range: 8g

See Also:

• writeSensorAccelerometerRange(int, ResponseListener)
• Constant Field Values

Method Details

readFrames

public void readFrames(@NonNull
 ResponseListener responseListener)

Reads the Smart Beacon selected frames.

See writeFrames(int, ResponseListener) for more information.

Note: valid for Firmware versions: 006.xxx

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeFrames(int, ResponseListener)
• BlukiiAction.SmartBeaconReadFrames

writeFrames

public void writeFrames(int selectedFrames,
 @NonNull
 ResponseListener responseListener)

Writes the Smart Beacon selected frames.

Note: valid for Firmware versions: 006.xxx

Values: (Bitwise Set of following constants)

• SETTING_BEACON_FRAME_EDDYSTONE_UID
• SETTING_BEACON_FRAME_EDDYSTONE_URL
• SETTING_BEACON_FRAME_EDDYSTONE_TLM
• SETTING_BEACON_FRAME_SPECIAL
• SETTING_BEACON_FRAME_IBEACON

Parameters:

selectedFrames - a bitwise set of selected frames

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readFrames(ResponseListener)
• BlukiiAction.SmartBeaconWriteFrames

readSettings

public void readSettings(@NonNull
 ResponseListener responseListener)

Reads the global Smart Beacon settings.

See writeSettings(SmartBeaconSettings, ResponseListener) for more information.

Note: valid for Firmware versions: 002.xxx and 003.xxx

ResponseData: BlukiiDataItem Type - SmartBeaconSettings

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSettings(SmartBeaconSettings, ResponseListener)
• BlukiiAction.SmartBeaconReadSettings
• SmartBeaconSettings

writeSettings

public void writeSettings(SmartBeaconSettings smartBeaconSettings,
 @NonNull
 ResponseListener responseListener)

Writes the global Smart Beacon settings.

Use a SmartBeaconSettings object to define settings.

Note: valid for Firmware versions: 002.xxx and 003.xxx

ResponseData: BlukiiDataItem Type - SmartBeaconSettings

Parameters:

smartBeaconSettings - Set of global Smart Beacon settings

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSettings(ResponseListener)
• BlukiiAction.SmartBeaconReadSettings
• SmartBeaconSettings

readSecureMode

public void readSecureMode(@NonNull
 ResponseListener responseListener)

Reads Secure Mode.

If Secure Mode is enabled the beacon sends a random mac address and a encrypted iBeacon (major/minor) Advertising.

Note: This feature must be unlocked on blukii purchase.

ResponseData: BlukiiDataItem Type - SmartBeaconSecureMode

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSecureMode(boolean, ResponseListener)
• syncSecureMode(ResponseListener)
• BlukiiAction.SmartBeaconWriteSecureMode

writeSecureMode

public void writeSecureMode(boolean mode,
 @NonNull
 ResponseListener responseListener)

Enable/Disable Secure Mode.

If Secure Mode is enabled the beacon sends a random mac address and a encrypted iBeacon Advertising.

To finally activate secure mode you have to call syncSecureMode(ResponseListener). If you don't sync secure mode, the beacon sends a random mac address and a major and minor of 0. You also can't decrypt your beacon via blukii cloud if you haven't synced secure mode.

Values:

• true to enable
• false to disable

Note: This feature must be unlocked on blukii purchase.

ResponseData: BlukiiDataItem Type - SmartBeaconSecureMode

Parameters:

mode - true to enable secure mode, false to disable secure mode

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSecureMode(ResponseListener)
• syncSecureMode(ResponseListener)
• BlukiiAction.SmartBeaconWriteSecureMode

syncSecureMode

public void syncSecureMode(@NonNull
 ResponseListener responseListener)

Starts secure mode sync.

This finally activates secure mode on your blukii.

After the final activation the beacon sends a random mac address and a encrypted iBeacon (major/minor) advertising.

That you can encrypt your blukii via blukii cloud, this method sets the blukii real time clock to UTC time.

See readSecureMode(ResponseListener) and writeSecureMode(boolean, ResponseListener) for more information.

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSecureMode(ResponseListener)
• writeSecureMode(boolean, ResponseListener)
• BlukiiAction.SmartBeaconSyncSecureMode

readEventBeaconSettings

public void readEventBeaconSettings(@NonNull
 ResponseListener responseListener)

Reads Event Beacon settings.

Note: This feature must be unlocked on blukii purchase.

ResponseData: BlukiiDataItem Type - EventBeaconSettings

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEventBeaconSettings(EventBeaconSettings, ResponseListener)
• BlukiiAction.SmartBeaconWriteEventBeaconSettings
• EventBeaconSettings

writeEventBeaconSettings

public void writeEventBeaconSettings(EventBeaconSettings eventBeaconSettings,
 @NonNull
 ResponseListener responseListener)

Write Event Beacon settings.

ResponseData: BlukiiDataItem Type - EventBeaconSettings

Parameters:

eventBeaconSettings - EventBeaconSettings object which defines the settings

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEventBeaconSettings(ResponseListener)
• BlukiiAction.SmartBeaconWriteEventBeaconSettings
• EventBeaconSettings

readIBeaconAdvertisement

public void readIBeaconAdvertisement(@NonNull
 ResponseListener responseListener)

Reads the iBeacon advertising data: UUID, Major, Minor and MeasuredPower.

ResponseData: BlukiiDataItem Type - IBeacon

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeIBeaconAdvertisement(IBeacon, ResponseListener)
• BlukiiAction.SmartBeaconWriteIBeaconAdvertisement
• IBeacon

writeIBeaconAdvertisement

public void writeIBeaconAdvertisement(IBeacon iBeacon,
 @NonNull
 ResponseListener responseListener)

Writes the iBeacon advertising data: UUID, Major, Minor and MeasuredPower.

ResponseData: BlukiiDataItem Type - IBeacon

Parameters:

iBeacon - IBeacon object, which defines UUID, Major, Minor & MeasuredPower

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readIBeaconAdvertisement(ResponseListener)
• BlukiiAction.SmartBeaconWriteIBeaconAdvertisement
• IBeacon

readRepeaterSettings

public void readRepeaterSettings(@NonNull
 ResponseListener responseListener)

Reads the Settings for iBeacon Repeater.

ResponseData: BlukiiDataItem Type - RepeaterSettings

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeRepeaterSettings(RepeaterSettings, ResponseListener)
• BlukiiAction.SmartBeaconWriteRepeaterSettings
• RepeaterSettings

writeRepeaterSettings

public void writeRepeaterSettings(RepeaterSettings repeaterSettings,
 @NonNull
 ResponseListener responseListener)

Writes the Settings for iBeacon Repeater.

ResponseData: BlukiiDataItem Type - RepeaterSettings

Parameters:

repeaterSettings - IBeacon object, which defines Repeater Settings for primary and event advertising

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readRepeaterSettings(ResponseListener)
• BlukiiAction.SmartBeaconWriteRepeaterSettings
• RepeaterSettings

readEddystoneUID

public void readEddystoneUID(@NonNull
 ResponseListener responseListener)

Reads the Eddystone UID (namespace and instance ID).

ResponseData: BlukiiDataItem Type - EddystoneUID

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEddystoneUID(EddystoneUID, ResponseListener)
• BlukiiAction.SmartBeaconReadEddystoneUID
• EddystoneUID

writeEddystoneUID

public void writeEddystoneUID(EddystoneUID eddystoneUID,
 @NonNull
 ResponseListener responseListener)

Writes the Eddystone UID (namespace and instance ID).

ResponseData: BlukiiDataItem Type - EddystoneUID

Parameters:

eddystoneUID - EddystoneUID object, which defines Namespace & Instance

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneUID(ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneUID
• EddystoneUID

readEddystoneUrl

public void readEddystoneUrl(@NonNull
 ResponseListener responseListener)

Reads the Eddystone URL.

ResponseData: BlukiiDataItem Type - String

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEddystoneUrl(String, ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneUrl

writeEddystoneUrl

public void writeEddystoneUrl(String url,
 @NonNull
 ResponseListener responseListener)

Writes the Eddystone URL.

ResponseData: BlukiiDataItem Type - String

Parameters:

url - url string

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneUrl(ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneUrl

readEddystoneLockState

public void readEddystoneLockState(@NonNull
 ResponseListener responseListener)

Reads the Eddystone locked state.

Values:

• true: Eddystone is locked
• false: Eddystone is unlocked

ResponseData: BlukiiDataItem Type - Boolean

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEddystoneLock(UUID, ResponseListener)
• writeEddystoneUnlock(UUID, ResponseListener)
• BlukiiAction.SmartBeaconReadEddystoneLockState

writeEddystoneLock

public void writeEddystoneLock(UUID key,
 @NonNull
 ResponseListener responseListener)

Locks the Eddystone settings against unauthorized changes.

Note: Eddystone will be lock with a secret key. You can unlock (see writeEddystoneUnlock(UUID, ResponseListener)) with this key only.

ResponseData: BlukiiDataItem Type - null

Parameters:

key - secret lock key as UUID

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneLockState(ResponseListener)
• writeEddystoneUnlock(UUID, ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneLock

writeEddystoneUnlock

public void writeEddystoneUnlock(UUID key,
 @NonNull
 ResponseListener responseListener)

Unlocks the Eddystone settings.

Note: You only can unlock, if Eddystone is locked and if you know the secret key that is set by writeEddystoneLock(UUID, ResponseListener).

ResponseData: BlukiiDataItem Type - null

Parameters:

key - UUID as secret lock key

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneLockState(ResponseListener)
• writeEddystoneLock(UUID, ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneUnlock

readEddystoneTxPowerPhysicalLevels

public void readEddystoneTxPowerPhysicalLevels(@NonNull
 ResponseListener responseListener)

Reads the physical Eddystone TxPower Levels.

ResponseData: BlukiiDataItem Type - EddystoneTxPowerLevels

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• EddystoneTxPowerLevels

readEddystoneTxPowerMeasuredLevels

public void readEddystoneTxPowerMeasuredLevels(@NonNull
 ResponseListener responseListener)

Reads the measured Eddystone TxPower Levels.

ResponseData: BlukiiDataItem Type - EddystoneTxPowerLevels

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels, ResponseListener)
• EddystoneTxPowerLevels

writeEddystoneTxPowerMeasuredLevels

public void writeEddystoneTxPowerMeasuredLevels(EddystoneTxPowerLevels eddystoneTxPowerLevels,
 @NonNull
 ResponseListener responseListener)

Writes the Eddystone TxPower Levels.

You can define the measured TxPower strength for each Eddystone TxPower Mode (see writeEddystoneTxPowerMode(int, ResponseListener)) that is received at 0 meters from the device.

See also the Google definition for Tx Power Level.

ResponseData: BlukiiDataItem Type - EddystoneTxPowerLevels

Parameters:

eddystoneTxPowerLevels - EddystoneTxPowerLevels object, which defines the levels

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneTxPowerMeasuredLevels(ResponseListener)
• EddystoneTxPowerLevels

readEddystoneTxPowerMode

public void readEddystoneTxPowerMode(@NonNull
 ResponseListener responseListener)

Reads the Eddystone TxPower Mode.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeEddystoneTxPowerMode(int, ResponseListener)
• BlukiiAction.SmartBeaconReadEddystoneTxPowerMode

writeEddystoneTxPowerMode

public void writeEddystoneTxPowerMode(int mode,
 @NonNull
 ResponseListener responseListener)

Writes the Eddystone TxPower Mode.

This action sets the physical TxPower strength. You can choose between 4 modes that's physical power is defined by the blukii device.

Values:

• SETTING_EDDYSTONE_TXPOWER_MODE_LOWEST
• SETTING_EDDYSTONE_TXPOWER_MODE_LOW
• SETTING_EDDYSTONE_TXPOWER_MODE_MEDIUM
• SETTING_EDDYSTONE_TXPOWER_MODE_HIGH

See also the Google definition for Tx Power Mode.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

mode - TxPower mode, a constant value

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readEddystoneTxPowerMode(ResponseListener)
• BlukiiAction.SmartBeaconWriteEddystoneTxPowerMode

resetEddystone

public void resetEddystone(@NonNull
 ResponseListener responseListener)

Resets all Eddystone values to factory default settings.

Note: This action is only valid if Eddystone is not locked (see readEddystoneLockState(ResponseListener)).

ResponseData: BlukiiDataItem Type - null

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• BlukiiAction.SmartBeaconResetEddystone

readSensorMeasureState

public void readSensorMeasureState(@NonNull
 ResponseListener responseListener)

Reads the Sensor Measure State.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorMeasureState(int, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorMeasureState

writeSensorMeasureState

public void writeSensorMeasureState(int state,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Measure State.

The measure state is a combined value of the following operating states:

• SETTING_BEACON_SENSOR_MEASURE_STATE_NOFITY_CONNECTED: Sensor value notifications, if the beacon is connected.
• SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_CONNECTED: Sensor value recording, if the beacon is connected.
• SETTING_BEACON_SENSOR_MEASURE_STATE_RECORDING_DISCONNECTED: Sensor value recording, if the beacon is disconnected.

SETTING_BEACON_SENSOR_MEASURE_STATE_OFF: no notifications or recording

Note: If operating state SETTING_BEACON_SENSOR_MEASURE_STATE_NOFITY_CONNECTED is set then ResponseListener.onNotify(ResponseData) is called every Measure Interval (see writeSensorIntervals(SensorIntervals, ResponseListener)).

ResponseData:

• ResponseListener.onResponse(ResponseData): BlukiiDataItem Type - Integer
• ResponseListener.onNotify(ResponseData): BlukiiDataItem Type - AccelerometerValue

Parameters:

state - Combination of sensor measure operating states

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorMeasureState(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorMeasureState

readSensorMode

public void readSensorMode(@NonNull
 ResponseListener responseListener)

Reads the the Sensor Mode.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorMode(int, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorMode

writeSensorMode

public void writeSensorMode(int mode,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Mode.

The Sensor Mode defines if the measurement is done continuously or after interrupt during connected or disconnected state.

Values:

• SETTING_BEACON_SENSOR_MODE_CONTINUOUS_ALWAYS: Sensor measurement is done continuously if the beacon is connected or disconnected.
• SETTING_BEACON_SENSOR_MODE_INTERRUPT_CONNECTED: Sensor measurement is triggered by interrupt if the beacon is connected, continuously if disconnected.
• SETTING_BEACON_SENSOR_MODE_INTERRUPT_DISCONNECTED: Sensor measurement is triggered by interrupt if the beacon is disconnected, continuously if connected.
• SETTING_BEACON_SENSOR_MODE_INTERRUPT_ALWAYS: Sensor measurement is triggered by interrupt if the beacon is connected or disconnected.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

mode - Sensor mode

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorMode(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorMode

readSensorIntervals

public void readSensorIntervals(@NonNull
 ResponseListener responseListener)

Reads the Sensor Interval settings.

ResponseData: BlukiiDataItem Type - SensorIntervals

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorIntervals(SensorIntervals, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorInterval

writeSensorIntervals

public void writeSensorIntervals(SensorIntervals intervals,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Interval settings.

You have to set the following interval durations:

• SensorIntervals.setMeasureInterval(int) Interval (in ms) of sensor data measurement (see writeSensorMeasureState(int, ResponseListener)).
• SensorIntervals.setTransferInterval(int) Interval (in ms) of sensor data transfer (see writeSensorTransferState(SensorTransferCommand, ResponseListener)).

ResponseData: BlukiiDataItem Type - SensorIntervals

Parameters:

intervals - Sensor interval settings

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorIntervals(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorInterval
• SensorIntervals

readSensorTransferState

public void readSensorTransferState(@NonNull
 ResponseListener responseListener)

Reads the Sensor Transfer State.

The response contains the current running Transfer state (see writeSensorTransferState(SensorTransferCommand, ResponseListener)). After the action has been finished, the state automatically changes to SETTING_BEACON_SENSOR_TRANSFER_STATE_OFF.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorTransferState(SensorTransferCommand, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorTransfer

writeSensorTransferState

public void writeSensorTransferState(SensorTransferCommand transferParam,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Transfer State.

This write command starts a data transfer action:

• SETTING_BEACON_SENSOR_TRANSFER_STATE_OFF: Stops the data transfer action if running.
• SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA: Starts the transfer of recorded sensor data.
• SETTING_BEACON_SENSOR_TRANSFER_STATE_RESET_DATA: Resets all recorded sensor data in flash memory.
• SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS: Starts the transfer of data headers only.

Note: If transfer state SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA or SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS is active then then ResponseListener.onNotify(ResponseData) is called every Transfer Interval (see writeSensorIntervals(SensorIntervals, ResponseListener)).

Sensor datasets are transferred sequentially according to the following transfer protocol.

It consists of 3 types of notification packets (ResponseListener.onNotify(ResponseData)):

• Dataset header: BlukiiDataItem Type - SensorRecordingHeader
• Data value: BlukiiDataItem Type - AccelerometerValue
• Transfer finished: BlukiiDataItem Type - SensorTransferFinish

Protocol sequence:

• Dataset 1 header
• Data value 1 of dataset 1
• …
• Data value N1 of dataset 1
• Dataset 2 header
• Data value 1 of dataset 2
• …
• Data value N2 of dataset 2
• …
• Dataset M header
• Data value 1 of dataset M
• …
• Data value NM of dataset M
• Transfer finished

Note: If transfer state SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_DATA or SETTING_BEACON_SENSOR_TRANSFER_STATE_GET_HEADERS is active then then ResponseListener.onNotify(ResponseData) is called every Transfer Interval (see writeSensorIntervals(SensorIntervals, ResponseListener)).

ResponseData: for ResponseListener.onResponse(ResponseData): BlukiiDataItem Type - SensorTransferCommand

Parameters:

transferParam - Sensor Transfer State Command

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorTransferState(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorTransfer

readSensorAccelerometerRange

public void readSensorAccelerometerRange(@NonNull
 ResponseListener responseListener)

Reads the Accelerometer sensor range.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorAccelerometerRange(int, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorAccelerometerRange

writeSensorAccelerometerRange

public void writeSensorAccelerometerRange(int range,
 @NonNull
 ResponseListener responseListener)

Writes the Accelerometer sensor range.

Values:

• SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_2G: Range +2g...-2g).
• SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_4G: Range +4g...-4g).
• SETTING_BEACON_SENSOR_ACCELEROMETER_RANGE_8G: Range +8g...-8g).

ResponseData: BlukiiDataItem Type - Integer

Parameters:

range - Accelerometer Range

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorAccelerometerRange(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorAccelerometerRange

readSensorInterruptSettings

public void readSensorInterruptSettings(@NonNull
 ResponseListener responseListener)

Reads the Sensor Interrupt settings.

ResponseData: BlukiiDataItem Type - SensorInterrupt

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorInterruptSettings(SensorInterrupt, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorInterrupt

writeSensorInterruptSettings

public void writeSensorInterruptSettings(SensorInterrupt interrupt,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Interrupt settings.

You have to set the following values:

• SensorInterrupt.setActiveThreshold(int): Active threshold: must be exceeded by at least one accelerometer axis (relative to the idle value) in order to trigger an interrupt.
• SensorInterrupt.setInactiveThreshold(int): Inactive threshold: must be undercut (relative to the last idle value) after an interrupt in order to allow a new interrupt.
• SensorInterrupt.setMeasureCount(int): Measure count: amount of sensor values that are measured after an interrupt.

ResponseData: BlukiiDataItem Type - SensorInterrupt

Parameters:

interrupt - Sensor interrupt settings

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorInterruptSettings(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorInterrupt
• SensorInterrupt

readSensorLimitedRecording

public void readSensorLimitedRecording(@NonNull
 ResponseListener responseListener)

Reads the Sensor Limited Recording settings.

ResponseData: BlukiiDataItem Type - SensorLimitedRecording

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeSensorLimitedRecording(SensorLimitedRecording, ResponseListener)
• BlukiiAction.SmartBeaconReadSensorLimitedRecording

writeSensorLimitedRecording

public void writeSensorLimitedRecording(SensorLimitedRecording limitedRecording,
 @NonNull
 ResponseListener responseListener)

Writes the Sensor Limited Recording settings.

You have to set the following values:

• SensorLimitedRecording.setMaxCount(int): Limited amount of recorded sensor values in defined timespan (max 511, 0: no limit).
• SensorLimitedRecording.setTimespan(int): Duration in seconds for limited amount of recorded sensor values.

ResponseData: BlukiiDataItem Type - SensorLimitedRecording

Parameters:

limitedRecording - Sensor Limited Recording settings

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readSensorLimitedRecording(ResponseListener)
• BlukiiAction.SmartBeaconWriteSensorLimitedRecording
• SensorLimitedRecording

readDeviceTracingScanPeriod

public void readDeviceTracingScanPeriod(@NonNull
 ResponseListener responseListener)

Reads the Device Tracing Scan Period.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeDeviceTracingScanPeriod(int, ResponseListener)
• BlukiiAction.SmartBeaconReadDeviceTracingScanPeriod

writeDeviceTracingScanPeriod

public void writeDeviceTracingScanPeriod(int period,
 @NonNull
 ResponseListener responseListener)

Writes the Device Tracing Scan Period.

Scan Period: Period (in seconds) of collecting other Device Tracing frames, until the own Device Tracing frame is updated.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

period - Device Tracing Scan Period

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readDeviceTracingScanPeriod(ResponseListener)
• BlukiiAction.SmartBeaconWriteDeviceTracingScanPeriod

readDeviceTracingScanDuration

public void readDeviceTracingScanDuration(@NonNull
 ResponseListener responseListener)

Reads the Device Tracing Scan Duration.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeDeviceTracingScanDuration(int, ResponseListener)
• BlukiiAction.SmartBeaconReadDeviceTracingScanDuration

writeDeviceTracingScanDuration

public void writeDeviceTracingScanDuration(int duration,
 @NonNull
 ResponseListener responseListener)

Writes the Device Tracing Scan Duration.

Scan Duration: Duration (in ms) after the internal BLE scan is restarted.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

duration - Device Tracing Scan Duration

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readDeviceTracingScanDuration(ResponseListener)
• BlukiiAction.SmartBeaconWriteDeviceTracingScanDuration

readDeviceTracingScanInterval

public void readDeviceTracingScanInterval(@NonNull
 ResponseListener responseListener)

Reads the Device Tracing Scan Interval.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeDeviceTracingScanInterval(int, ResponseListener)
• BlukiiAction.SmartBeaconReadDeviceTracingScanInterval

writeDeviceTracingScanInterval

public void writeDeviceTracingScanInterval(int interval,
 @NonNull
 ResponseListener responseListener)

Writes the Device Tracing Scan Interval.

Scan Interval: Interval (in ms) after the BLE channel (37, 38, 39) is alternated.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

interval - Device Tracing Scan Interval

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readDeviceTracingScanInterval(ResponseListener)
• BlukiiAction.SmartBeaconWriteDeviceTracingScanInterval

readDeviceTracingScanWindow

public void readDeviceTracingScanWindow(@NonNull
 ResponseListener responseListener)

Reads the Device Tracing Scan Window.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeDeviceTracingScanWindow(int, ResponseListener)
• BlukiiAction.SmartBeaconReadDeviceTracingScanWindow

writeDeviceTracingScanWindow

public void writeDeviceTracingScanWindow(int window,
 @NonNull
 ResponseListener responseListener)

Writes the Device Tracing Scan Window.

Scan Window: Time window (in ms) as part of the Scan Interval in which the BLE unit is listening for advertising packets.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

window - Device Tracing Scan Interval

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readDeviceTracingScanWindow(ResponseListener)
• BlukiiAction.SmartBeaconWriteDeviceTracingScanWindow

readDeviceTracingRssiThreshold

public void readDeviceTracingRssiThreshold(@NonNull
 ResponseListener responseListener)

Reads the Device Tracing Rssi Threshold.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• writeDeviceTracingRssiThreshold(int, ResponseListener)
• BlukiiAction.SmartBeaconReadDeviceTracingScanPeriod

writeDeviceTracingRssiThreshold

public void writeDeviceTracingRssiThreshold(int rssi,
 @NonNull
 ResponseListener responseListener)

Writes the Device Tracing Rssi Threshold.

Rssi Threshold: Advertising packets are only received if the RSSI value is higher than or equal to the threshold.

ResponseData: BlukiiDataItem Type - Integer

Parameters:

rssi - Device Tracing Rssi Threshold

responseListener - ResponseListener on which callbacks onResponse, onError or onNotify are called

See Also:

• readDeviceTracingRssiThreshold(ResponseListener)
• BlukiiAction.SmartBeaconWriteDeviceTracingRssiThreshold