adapter-coroutines/com.divpundir.mavlink.adapters.coroutines/CoroutinesMavConnection

CoroutinesMavConnection

interface CoroutinesMavConnection

Properties

mavFrame

abstract val mavFrame: SharedFlow<MavFrame<out MavMessage<*>>>

A stream of MavFrames.

streamState

abstract val streamState: StateFlow<StreamState>

The current state of the connection stream.

Functions

abstract suspend fun close()

Closes the underlying MavConnection and stops the reading process.

connect

abstract suspend fun connect(readerScope: CoroutineScope)

Connects the underlying MavConnection and start reading from it. This method will suspend till the connection is created and then the readerScope will be used to start the reading process in a new coroutine.

sendSignedV2

abstract suspend fun <T : MavMessage<T>> sendSignedV2(systemId: UByte, componentId: UByte, payload: T, linkId: UByte, timestamp: UInt, secretKey: ByteArray)

Sends the provided payload wrapped in a signed MAVLink v2 frame.

sendUnsignedV2

abstract suspend fun <T : MavMessage<T>> sendUnsignedV2(systemId: UByte, componentId: UByte, payload: T)

Sends the provided payload wrapped in an unsigned MAVLink v2 frame.

sendV1

abstract suspend fun <T : MavMessage<T>> sendV1(systemId: UByte, componentId: UByte, payload: T)

Sends the provided payload wrapped in a Mavlink v1 frame.

tryClose

suspend fun CoroutinesMavConnection.tryClose(): Boolean

A wrapper around CoroutinesMavConnection.close that returns true if no exception was thrown and false otherwise.

tryConnect

suspend fun CoroutinesMavConnection.tryConnect(readerScope: CoroutineScope): Boolean

A wrapper around CoroutinesMavConnection.connect that returns true if no exception was thrown and false otherwise.

trySendSignedV2

suspend fun <T : MavMessage<T>> CoroutinesMavConnection.trySendSignedV2(systemId: UByte, componentId: UByte, payload: T, linkId: UByte, timestamp: UInt, secretKey: ByteArray): Boolean

A wrapper around CoroutinesMavConnection.sendSignedV2 that returns true if no exception was thrown and false otherwise.

trySendUnsignedV2

suspend fun <T : MavMessage<T>> CoroutinesMavConnection.trySendUnsignedV2(systemId: UByte, componentId: UByte, payload: T): Boolean

A wrapper around CoroutinesMavConnection.sendUnsignedV2 that returns true if no exception was thrown and false otherwise.

trySendV1

suspend fun <T : MavMessage<T>> CoroutinesMavConnection.trySendV1(systemId: UByte, componentId: UByte, payload: T): Boolean

A wrapper around CoroutinesMavConnection.sendV1 that returns true if no exception was thrown and false otherwise.