apidocs / com.nimmsta.core.android.bluetooth / BLEScanResult

BLEScanResult

class BLEScanResult : SearchScanResult

BLE Scan Result represents a scanned bluetooth device from an Android BLE Scanner, e.g. NIMMSTABLEScanner. It provides APIs to connect to the Device as a NIMMSTA Device: createDevice and then call NIMMSTADevice.connectAsync.

Parameters

mContext - the Android Context

mScanResult - the Android ScanResult

scanner - the NIMMSTADeviceScanner that found this device.

connectionCode - the ConnectionCode related to this device

timeFound - the time when the device was found

shouldCreateHidDevice - defines whether to create a connection as HIDDevice or as normal device, see NIMMSTAHidDeviceImpl for more details.

Author
NIMMSTA Team

Copyright
NIMMSTA GmbH & IBPG 2020

License
NIMMSTA GmbH

Constructors

<init>

BLE Scan Result represents a scanned bluetooth device from an Android BLE Scanner, e.g. NIMMSTABLEScanner. It provides APIs to connect to the Device as a NIMMSTA Device: createDevice and then call NIMMSTADevice.connectAsync.

BLEScanResult(mContext: Context, mScanResult: ScanResult, scanner: NIMMSTADeviceScanner, connectionCode: ConnectionCode? = null, timeFound: DateTime = DateTime.now())

Properties

address

Returns the DeviceAddress, e.g. bluetooth Mac Adress.

val address: DeviceAddress

connectionCode

var connectionCode: ConnectionCode?

connectionFactory

val connectionFactory: BLEConnectFactory

deviceName

Represents the public name of the found device, e.g. HS 50

val deviceName: String

isConnectable

Returns if device is connectable or not.

val isConnectable: Boolean

rssi

Defines the signal strength of the found device.

val rssi: Int

scanData

Represents the raw data of the scan, e.g. the BLE Advertisement data.

val scanData: ByteArray

scanRecord

Represents the Android ScanRecord, this is null on some platforms.

val scanRecord: ScanRecord?

scanResult

Represents the Android ScanResult.

val scanResult: ScanResult

timeFound

the time when the device was found

val timeFound: DateTime

Functions

copyWithCode

fun copyWithCode(code: ConnectionCode?): BLEScanResult

createDevice

fun createDevice(connectionManager: INIMMSTAConnectionManager): NIMMSTADevice

setScanResult

fun setScanResult(scanResult: ScanResult): Unit

toString

fun toString(): String