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.

supportedModels

abstract val supportedModels: List<String>

List of supported models

writeFlow

open val writeFlow: Flow<ByteArray>

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

Functions

canHandle

abstract fun canHandle(device: EUCDevice): Boolean

Check if this protocol can handle the given device

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.

getCommandSupport

open fun getCommandSupport(commandType: CommandType): CommandSupport

API-level command support check (used by framework and clients).

getDataCharacteristicUUID

abstract fun getDataCharacteristicUUID(): UUID

Get the UUID for the data characteristic

getPollingPlan

open fun getPollingPlan(): ProtocolPollingPlan

Optional polling/query plan consumed by BLEManager orchestration.

getServiceUUID

abstract fun getServiceUUID(): UUID

Get the UUID for the service

getWriteCharacteristicUUID

open fun getWriteCharacteristicUUID(): UUID

Get the UUID for the write characteristic (if different from data characteristic)

isDeviceReady

abstract fun isDeviceReady(data: EUCData): Boolean

Check if the device is ready for operation

looksLikeMyFrames

open fun looksLikeMyFrames(chunk: ByteArray): Boolean

Optional fast header check: returns true if chunk appears to contain frames belonging to this protocol, based on magic-byte patterns alone. The default returns false (opt-out). Protocols override this to enable frame-header-based routing without full decoding.

matchesQueryResponse

open fun matchesQueryResponse(query: ProtocolQuerySpec, data: ByteArray): Boolean

Optional query/response matcher used by BLEManager observability and retry loop.