Package io.heraldprox.herald.sensor.ble

Class BLEDevice

java.lang.Object

io.heraldprox.herald.sensor.Device

io.heraldprox.herald.sensor.ble.BLEDevice

public class BLEDevice
extends Device

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<PayloadData>	payloadSharingData
protected java.util.Queue<byte[]>	signalCharacteristicWriteQueue
protected byte[]	signalCharacteristicWriteValue

Fields inherited from class io.heraldprox.herald.sensor.Device

createdAt, identifier, lastUpdatedAt

Constructor Summary

Constructors

Constructor	Description
BLEDevice(TargetIdentifier identifier, BLEDeviceDelegate delegate)

Method Summary

Modifier and Type	Method	Description
Calibration	calibration()
java.lang.String	description()
java.lang.String	deviceName()
void	deviceName(java.lang.String deviceName)
android.bluetooth.BluetoothGattCharacteristic	deviceNameCharacteristic()
void	deviceNameCharacteristic(android.bluetooth.BluetoothGattCharacteristic deviceNameCharacteristic)
boolean	ignore()
Data	immediateSendData()
void	immediateSendData(Data immediateSendData)
void	invalidateCharacteristics()
android.bluetooth.BluetoothGattCharacteristic	legacyPayloadCharacteristic()
void	legacyPayloadCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)
java.lang.String	model()
void	model(java.lang.String model)
android.bluetooth.BluetoothGattCharacteristic	modelCharacteristic()
void	modelCharacteristic(android.bluetooth.BluetoothGattCharacteristic modelCharacteristic)
BLEDeviceOperatingSystem	operatingSystem()
void	operatingSystem(BLEDeviceOperatingSystem operatingSystem)
android.bluetooth.BluetoothGattCharacteristic	payloadCharacteristic()
void	payloadCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)
PayloadData	payloadData()
void	payloadData(PayloadData payloadData)
android.bluetooth.BluetoothDevice	peripheral()
void	peripheral(android.bluetooth.BluetoothDevice peripheral)
boolean	protocolIsHerald()
boolean	protocolIsOpenTrace()
PseudoDeviceAddress	pseudoDeviceAddress()
void	pseudoDeviceAddress(PseudoDeviceAddress pseudoDeviceAddress)
boolean	receiveOnly()
void	receiveOnly(boolean receiveOnly)
void	registerDiscovery()
void	registerWritePayload()
void	registerWritePayloadSharing()
void	registerWriteRssi()
RSSI	rssi()
void	rssi(RSSI rssi)
android.bluetooth.le.ScanRecord	scanRecord()
void	scanRecord(android.bluetooth.le.ScanRecord scanRecord)
android.bluetooth.BluetoothGattCharacteristic	signalCharacteristic()
void	signalCharacteristic(android.bluetooth.BluetoothGattCharacteristic characteristic)
BLEDeviceState	state()
void	state(BLEDeviceState state)
boolean	supportsDeviceNameCharacteristic()
boolean	supportsModelCharacteristic()
TimeInterval	timeIntervalSinceConnected()
TimeInterval	timeIntervalSinceLastPayloadDataUpdate()
TimeInterval	timeIntervalSinceLastUpdate()
TimeInterval	timeIntervalSinceLastWritePayload()
TimeInterval	timeIntervalSinceLastWritePayloadSharing()
TimeInterval	timeIntervalSinceLastWriteRssi()
TimeInterval	timeIntervalUntilIgnoreExpires()
java.lang.String	toString()
BLE_TxPower	txPower()
void	txPower(BLE_TxPower txPower)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

signalCharacteristicWriteValue

@Nullable
protected byte[] signalCharacteristicWriteValue

signalCharacteristicWriteQueue

@Nullable
protected java.util.Queue<byte[]> signalCharacteristicWriteQueue

payloadSharingData

protected final java.util.List<PayloadData> payloadSharingData

Constructor Detail

BLEDevice

public BLEDevice(@NonNull
                 TargetIdentifier identifier,
                 @NonNull
                 BLEDeviceDelegate delegate)

Method Detail

timeIntervalSinceConnected

@NonNull
public TimeInterval timeIntervalSinceConnected()

timeIntervalSinceLastUpdate

@NonNull
public TimeInterval timeIntervalSinceLastUpdate()

description

@NonNull
public java.lang.String description()

pseudoDeviceAddress

@Nullable
public PseudoDeviceAddress pseudoDeviceAddress()

pseudoDeviceAddress

public void pseudoDeviceAddress(@Nullable
                                PseudoDeviceAddress pseudoDeviceAddress)

peripheral

@Nullable
public android.bluetooth.BluetoothDevice peripheral()

peripheral

public void peripheral(@Nullable
                       android.bluetooth.BluetoothDevice peripheral)

state

@NonNull
public BLEDeviceState state()

state

public void state(@NonNull
                  BLEDeviceState state)

operatingSystem

@NonNull
public BLEDeviceOperatingSystem operatingSystem()

operatingSystem

public void operatingSystem(@NonNull
                            BLEDeviceOperatingSystem operatingSystem)

ignore

public boolean ignore()

payloadData

@Nullable
public PayloadData payloadData()

payloadData

public void payloadData(@Nullable
                        PayloadData payloadData)

timeIntervalSinceLastPayloadDataUpdate

@NonNull
public TimeInterval timeIntervalSinceLastPayloadDataUpdate()

immediateSendData

public void immediateSendData(@Nullable
                              Data immediateSendData)

immediateSendData

@Nullable
public Data immediateSendData()

rssi

@Nullable
public RSSI rssi()

rssi

public void rssi(@Nullable
                 RSSI rssi)

legacyPayloadCharacteristic

public void legacyPayloadCharacteristic(@Nullable
                                        android.bluetooth.BluetoothGattCharacteristic characteristic)

legacyPayloadCharacteristic

@Nullable
public android.bluetooth.BluetoothGattCharacteristic legacyPayloadCharacteristic()

txPower

@Nullable
public BLE_TxPower txPower()

txPower

public void txPower(@Nullable
                    BLE_TxPower txPower)

calibration

@Nullable
public Calibration calibration()

receiveOnly

public boolean receiveOnly()

receiveOnly

public void receiveOnly(boolean receiveOnly)

invalidateCharacteristics

public void invalidateCharacteristics()

signalCharacteristic

@Nullable
public android.bluetooth.BluetoothGattCharacteristic signalCharacteristic()

signalCharacteristic

public void signalCharacteristic(@Nullable
                                 android.bluetooth.BluetoothGattCharacteristic characteristic)

payloadCharacteristic

@Nullable
public android.bluetooth.BluetoothGattCharacteristic payloadCharacteristic()

payloadCharacteristic

public void payloadCharacteristic(@Nullable
                                  android.bluetooth.BluetoothGattCharacteristic characteristic)

supportsModelCharacteristic

public boolean supportsModelCharacteristic()

modelCharacteristic

@Nullable
public android.bluetooth.BluetoothGattCharacteristic modelCharacteristic()

modelCharacteristic

public void modelCharacteristic(@Nullable
                                android.bluetooth.BluetoothGattCharacteristic modelCharacteristic)

supportsDeviceNameCharacteristic

public boolean supportsDeviceNameCharacteristic()

deviceNameCharacteristic

@Nullable
public android.bluetooth.BluetoothGattCharacteristic deviceNameCharacteristic()

deviceNameCharacteristic

public void deviceNameCharacteristic(@Nullable
                                     android.bluetooth.BluetoothGattCharacteristic deviceNameCharacteristic)

deviceName

@Nullable
public java.lang.String deviceName()

deviceName

public void deviceName(@Nullable
                       java.lang.String deviceName)

model

@Nullable
public java.lang.String model()

model

public void model(@Nullable
                  java.lang.String model)

registerDiscovery

public void registerDiscovery()

registerWritePayload

public void registerWritePayload()

timeIntervalSinceLastWritePayload

@NonNull
public TimeInterval timeIntervalSinceLastWritePayload()

registerWriteRssi

public void registerWriteRssi()

timeIntervalSinceLastWriteRssi

@NonNull
public TimeInterval timeIntervalSinceLastWriteRssi()

registerWritePayloadSharing

public void registerWritePayloadSharing()

timeIntervalSinceLastWritePayloadSharing

@NonNull
public TimeInterval timeIntervalSinceLastWritePayloadSharing()

timeIntervalUntilIgnoreExpires

@NonNull
public TimeInterval timeIntervalUntilIgnoreExpires()

protocolIsOpenTrace

public boolean protocolIsOpenTrace()

protocolIsHerald

public boolean protocolIsHerald()

scanRecord

public void scanRecord(@Nullable
                       android.bluetooth.le.ScanRecord scanRecord)

scanRecord

@Nullable
public android.bluetooth.le.ScanRecord scanRecord()

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object