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

KingsongProtocol

class KingsongProtocol(scope: CoroutineScope = CoroutineScope(Dispatchers.IO)) : EUCProtocol(source)

Improved KingSong protocol: tolerant parsing, header resync, header-aware frame reassembly using ByteByByteFrameParser, safe bounds checks, optional cell voltages parsing, and clamped command generation.

Supports frame types: 0xA9 (live telemetry), 0xB9 (distance/fan/temp2), 0xBB (name/model/version), 0xB3 (serial number), 0xF5 (CPU load/PWM), 0xF6 (speed limit), 0xA4/0xB5 (alarm speeds), 0xF1/0xF2 (Smart BMS data).

Constructors

KingsongProtocol

constructor(scope: CoroutineScope = CoroutineScope(Dispatchers.IO))

Types

Companion

object Companion

Properties

dataFlow

open override val dataFlow: Flow<EUCData>

manufacturer

open override val manufacturer: String

Manufacturer name

rawFrameFlow

open override 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 override val supportedCommandTypes: Set<CommandType>

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

supportedModels

open override val supportedModels: List<String>

List of supported models

writeFlow

open override val writeFlow: Flow<ByteArray>

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

Functions

canHandle

open override fun canHandle(device: EUCDevice): Boolean

Check if this protocol can handle the given device

open override fun close()

createCommand

open override fun createCommand(commandType: CommandType, value: Any): ByteArray

Create a command for the EUC

decode

open override fun decode(data: ByteArray): EUCData?

Decode raw BLE data into EUCData

getBMSData

open override fun getBMSData(): List<BMSData>

Returns the current BMS data snapshots for all detected battery packs. Each entry represents one BMS unit (typically 1 or 2 for dual-battery wheels). Data is accumulated from frame types 0xF1/0xF2 pages 0x00 (summary), 0x01 (temperatures), and 0x02-0x06 (cell voltages).

getCommandSupport

open fun getCommandSupport(commandType: CommandType): CommandSupport

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

getDataCharacteristicUUID

open override fun getDataCharacteristicUUID(): UUID

Get the UUID for the data characteristic

getPollingPlan

open override fun getPollingPlan(): ProtocolPollingPlan

Optional polling/query plan consumed by BLEManager orchestration.

getServiceUUID

open override 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

open override fun isDeviceReady(data: EUCData): Boolean

Check if the device is ready for operation

looksLikeMyFrames

open override 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 override fun matchesQueryResponse(query: ProtocolQuerySpec, data: ByteArray): Boolean

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