EUC BLE Library/io.github.tritbool.euc.ble.protocols/EUCProtocol

EUCProtocol

interface EUCProtocol : Closeable(source)

Base interface for EUC manufacturer protocols.

Protocol selection is performed by GATT fingerprint matching using EucFingerprintDatabase. If no fingerprint match is found, the caller is responsible for selecting a protocol manually.

Inheritors

Properties

dataFlow

abstract val dataFlow: Flow<EUCData>

manufacturer

abstract val manufacturer: String

Manufacturer name (used for display and logging).

rawFrameFlow

open val rawFrameFlow: Flow<ByteArray>

Flow that emits every raw BLE characteristic notification received by this protocol, as a defensive copy of the original byte array. Collectors can use this to write raw logs or perform any custom processing on the unmodified BLE data.

supportedCommandTypes

open val supportedCommandTypes: Set<CommandType>

Explicit command support matrix for this protocol. Commands outside this set are considered unsupported by design.

writeFlow

open val writeFlow: Flow<ByteArray>

Flow of commands or raw bytes that the protocol needs to write to the device automatically.

Functions

abstract fun close()

createCommand

abstract fun createCommand(commandType: CommandType, value: Any): ByteArray

Create a command for the EUC

decode

abstract fun decode(data: ByteArray): EUCData?

Decode raw BLE data into EUCData

getBMSData

open fun getBMSData(): List<BMSData>?

Get BMS (Battery Management System) data for this protocol. Returns null if this protocol does not support BMS data extraction. Protocols that support BMS data should override this method to return a list of BMSData objects representing the current state of all battery packs.

getCandidateDataCharacteristicUUIDs