bluetooth/pl.efento.mobile.bluetooth.model/Sensor

Sensor

data class Sensor(val id: String, val rssi: Int, val bluetoothMacAddress: BluetoothMacAddress, val name: String?, val softwareVersion: SoftwareVersion, val counter: Int, val measurementPeriod: MeasurementPeriod, val measurementsTimestamp: Long, val measurements: Map<Channel, Measurement<*>>, val features: Set<Sensor.Feature>, val calibrationDate: Long?, val connectivityStatus: Sensor.ConnectivityStatus, val encryptionStatus: Sensor.EncryptionStatus, val encryptionKey: String?, val externalPowerSupplyStatus: Sensor.ExternalPowerSupplyStatus?, val batteryStatus: Sensor.BatteryStatus, val operatingStatuses: Set<Sensor.OperatingStatus>, val cellularStatus: Sensor.CellularStatus?, val timeSynchronizationStatus: Sensor.TimeSynchronizationStatus?, val isLegacy: Boolean) : Device

Efento sensor device.

Constructors

constructor(id: String, rssi: Int, bluetoothMacAddress: BluetoothMacAddress, name: String?, softwareVersion: SoftwareVersion, counter: Int, measurementPeriod: MeasurementPeriod, measurementsTimestamp: Long, measurements: Map<Channel, Measurement<*>>, features: Set<Sensor.Feature>, calibrationDate: Long?, connectivityStatus: Sensor.ConnectivityStatus, encryptionStatus: Sensor.EncryptionStatus, encryptionKey: String?, externalPowerSupplyStatus: Sensor.ExternalPowerSupplyStatus?, batteryStatus: Sensor.BatteryStatus, operatingStatuses: Set<Sensor.OperatingStatus>, cellularStatus: Sensor.CellularStatus?, timeSynchronizationStatus: Sensor.TimeSynchronizationStatus?, isLegacy: Boolean)

Types

enum BatteryStatus : Enum<Sensor.BatteryStatus>

Status of the battery.

enum CellularStatus : Enum<Sensor.CellularStatus>

Device cellular status.

ConnectivityStatus

enum ConnectivityStatus : Enum<Sensor.ConnectivityStatus>

Device connectivity status.

EncryptionStatus

enum EncryptionStatus : Enum<Sensor.EncryptionStatus>

Device encryption status.

ExternalPowerSupplyStatus

enum ExternalPowerSupplyStatus : Enum<Sensor.ExternalPowerSupplyStatus>

Device external power supply status.

enum Feature : Enum<Sensor.Feature>

Device specific functionality.

OperatingStatus

enum OperatingStatus : Enum<Sensor.OperatingStatus>

Operating status.

TimeSynchronizationStatus

enum TimeSynchronizationStatus : Enum<Sensor.TimeSynchronizationStatus>

Device time synchronization status.

Properties

val batteryStatus: Sensor.BatteryStatus

Current battery status of the device

bluetoothMacAddress

val bluetoothMacAddress: BluetoothMacAddress

Bluetooth mac address of the device

calibrationDate

val calibrationDate: Long?

Date of last calibration in epoch seconds or null if date is not set or is not supported by the device

val cellularStatus: Sensor.CellularStatus?

Cellular status or null if not supported by the device

connectivityStatus

val connectivityStatus: Sensor.ConnectivityStatus

Connectivity status of the device

val counter: Int

Counter which indicates that new measurement occur For sensors with firmware 6.0 and newer, counter value is equal to the measurement timestamp in POSIX format. For older sensors, counter is a value in range 0..255 incremented each time new measurement occur.

val encryptionKey: String?

Valid encryption key or null if none was provided

encryptionStatus

val encryptionStatus: Sensor.EncryptionStatus

Current encryption status of the device

externalPowerSupplyStatus

val externalPowerSupplyStatus: Sensor.ExternalPowerSupplyStatus?

External power supply status or null if not supported by the device

val features: Set<Sensor.Feature>

Features supported by sensor

open override val id: String

Id of the device that is used when establishing a connection

val isLegacy: Boolean

legacy device.

measurementPeriod

val measurementPeriod: MeasurementPeriod

Measurement period of the device. Defines how often measurements are taken. If sensor is in binary mode, only period base is used. For continuous type sensors period is equal to period base multiplied by factor. The measurement in continuous sensor will be taken at random moment in first period base seconds and then the sensor will wait for next period.

val measurements: Map<Channel, Measurement<*>>

Map of Channel-Measurement pairs that are available for this device. Map only contains values for slots that contain sensors. Each measurement must be validated via Measurement.isValid or Measurement.status to check if its available for current device

measurementsTimestamp

val measurementsTimestamp: Long

Timestamp in epoch seconds when the measurements were taken. If measurement is type of MeasurementBundle then the timestamp refers to the first (most recent one) sample in bundle.

val name: String?

Name of the device or null if not available

operatingStatuses

val operatingStatuses: Set<Sensor.OperatingStatus>

Operating statuses reported by the device

open override val rssi: Int

Bluetooth rssi of the device

softwareVersion

val softwareVersion: SoftwareVersion

Software version of the device

timeSynchronizationStatus

val timeSynchronizationStatus: Sensor.TimeSynchronizationStatus?

Time synchronization status or null if not supported by the device