commonMain.dk.cachet.carp.common.application.devices.BLESerialNumberDeviceRegistration.kt Maven / Gradle / Ivy

Go to download

package dk.cachet.carp.common.application.devices

import dk.cachet.carp.common.infrastructure.serialization.NotSerializable
import kotlinx.serialization.Serializable


/**
 * A [DeviceRegistration] for Bluetooth Low Energy (BLE) devices which uses the serial number in the
 * Device Information Service GATT spec (https://www.bluetooth.com/specifications/gatt/services/)
 * to uniquely identify the device.
 */
@Serializable
data class BLESerialNumberDeviceRegistration( val serialNumber: String ) : DeviceRegistration()
{
    init
    {
        require( serialNumber.isNotBlank() )
    }

    override val deviceId: String = serialNumber
}


@Serializable( with = NotSerializable::class )
class BLESerialNumberDeviceRegistrationBuilder : DeviceRegistrationBuilder
{
    /**
     * The serial number as broadcast by the Device Information GATT service.
     *
     * This should not be blank.
     */
    var serialNumber: String = ""

    override fun build(): BLESerialNumberDeviceRegistration = BLESerialNumberDeviceRegistration( serialNumber )
}