serialization/com.divpundir.mavlink.serialization

Package-level declarations

Types

CrcX25

class CrcX25

X25 hash calculator used for computing the MAVLink frame checksums.

MavDataDecoder

interface MavDataDecoder

Reads primitives from a ByteArray according to the little-endian byte order.

MavDataEncoder

interface MavDataEncoder

Writes primitives to a ByteArray according to the little-endian byte order.

Functions

encodeBitmaskValue

fun MavDataEncoder.encodeBitmaskValue(value: UInt, dataSize: Int)

Encodes the given UInt MAVLink bitmask value into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeChar

fun MavDataEncoder.encodeChar(value: Char)

Writes the given Char/UInt64 to the array's current position, and then increments the position.

encodeDouble

fun MavDataEncoder.encodeDouble(value: Double)

Writes the given Double/Float64 to the array's current position, and then increments the position.

encodeDoubleArray

fun MavDataEncoder.encodeDoubleArray(arr: List<Double>, dataSize: Int)

Encodes the given List of Double/Float64 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeEnumValue

fun MavDataEncoder.encodeEnumValue(value: UInt, dataSize: Int)

Encodes the given UInt MAVLink enum value into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeFloat

fun MavDataEncoder.encodeFloat(value: Float)

Writes the given Float/Float32 to the array's current position, and then increments the position.

encodeFloatArray

fun MavDataEncoder.encodeFloatArray(arr: List<Float>, dataSize: Int)

Encodes the given List of Float/Float32 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeInt16

fun MavDataEncoder.encodeInt16(value: Short)

Writes the given Short/Int16 to the array's current position, and then increments the position.

encodeInt16Array

fun MavDataEncoder.encodeInt16Array(arr: List<Short>, dataSize: Int)

Encodes the given List of Short/Int16 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeInt32

fun MavDataEncoder.encodeInt32(value: Int)

Writes the given Int/Int32 to the array's current position, and then increments the position.

encodeInt32Array

fun MavDataEncoder.encodeInt32Array(arr: List<Int>, dataSize: Int)

Encodes the given List of Int/Int32 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeInt64

fun MavDataEncoder.encodeInt64(value: Long)

Writes the given Long/Int64 to the array's current position, and then increments the position.

encodeInt64Array

fun MavDataEncoder.encodeInt64Array(arr: List<Long>, dataSize: Int)

Encodes the given List of Long/Int64 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeInt8

fun MavDataEncoder.encodeInt8(value: Byte)

Writes the given Byte/Int8 to the array's current position, and then increments the position.

encodeInt8Array

fun MavDataEncoder.encodeInt8Array(arr: List<Byte>, dataSize: Int)

Encodes the given List of Byte/Int8 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeInteger

fun MavDataEncoder.encodeInteger(value: Long, dataSize: Int)

Encodes the given Long into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeString

fun MavDataEncoder.encodeString(value: String, length: Int)

Writes the given String to the array's current position, and then increments the position. If the encoded String is shorter than the length parameter then the remaining positions are filled with empty characters.

encodeUInt16

fun MavDataEncoder.encodeUInt16(value: UShort)

Writes the given UShort/UInt16 to the array's current position, and then increments the position.

encodeUInt16Array

fun MavDataEncoder.encodeUInt16Array(arr: List<UShort>, dataSize: Int)

Encodes the given List of UShort/UInt16 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeUInt32

fun MavDataEncoder.encodeUInt32(value: UInt)

Writes the given UInt/UInt32 to the array's current position, and then increments the position.

encodeUInt32Array

fun MavDataEncoder.encodeUInt32Array(arr: List<UInt>, dataSize: Int)

Encodes the given List of UInt/UInt32 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeUInt64

fun MavDataEncoder.encodeUInt64(value: ULong)

Writes the given ULong/UInt64 to the array's current position, and then increments the position.

encodeUInt64Array

fun MavDataEncoder.encodeUInt64Array(arr: List<ULong>, dataSize: Int)

Encodes the given List of ULong/UInt64 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

encodeUInt8

fun MavDataEncoder.encodeUInt8(value: UByte)

Writes the given UByte/UInt8 to the array's current position, and then increments the position.

encodeUInt8Array

fun MavDataEncoder.encodeUInt8Array(arr: List<UByte>, dataSize: Int)

Encodes the given List of UByte/UInt8 into a ByteArray of size dataSize, writes it to the array's current position, and then increments the position.

MavDataDecoder

expect fun MavDataDecoder(bytes: ByteArray): MavDataDecoder

Creates a new MavDataDecoder instance that uses the given bytes for the reading of data.

actual fun MavDataDecoder(bytes: ByteArray): MavDataDecoder

MavDataEncoder

expect fun MavDataEncoder(size: Int): MavDataEncoder

Creates a new MavDataEncoder instance that uses an array of the given size for the writing of data.

actual fun MavDataEncoder(size: Int): MavDataEncoder

safeDecodeBitmaskValue

fun MavDataDecoder.safeDecodeBitmaskValue(dataSize: Int): UInt

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a UInt representing the MAVLink bitmask value. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeChar

fun MavDataDecoder.safeDecodeChar(): Char

Reads a Char from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeDouble

fun MavDataDecoder.safeDecodeDouble(): Double

Reads a Double/Float64 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeDoubleArray

fun MavDataDecoder.safeDecodeDoubleArray(dataSize: Int): List<Double>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Double/Float64 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeEnumValue

fun MavDataDecoder.safeDecodeEnumValue(dataSize: Int): UInt

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a UInt representing the MAVLink enum value. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeFloat

fun MavDataDecoder.safeDecodeFloat(): Float

Reads a Float/Float32 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeFloatArray

fun MavDataDecoder.safeDecodeFloatArray(dataSize: Int): List<Float>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Float/Float32 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt16

fun MavDataDecoder.safeDecodeInt16(): Short

Reads a Short/Int16 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt16Array

fun MavDataDecoder.safeDecodeInt16Array(dataSize: Int): List<Short>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Short/Int16 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt32

fun MavDataDecoder.safeDecodeInt32(): Int

Reads a Int/Int32 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt32Array

fun MavDataDecoder.safeDecodeInt32Array(dataSize: Int): List<Int>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Int/Int32 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt64

fun MavDataDecoder.safeDecodeInt64(): Long

Reads a Long/Int64 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt64Array

fun MavDataDecoder.safeDecodeInt64Array(dataSize: Int): List<Long>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Long/Int64 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt8

fun MavDataDecoder.safeDecodeInt8(): Byte

Reads a Byte/Int8 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeInt8Array

fun MavDataDecoder.safeDecodeInt8Array(dataSize: Int): List<Byte>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded Byte/Int8 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeSignedInteger

fun MavDataDecoder.safeDecodeSignedInteger(dataSize: Int): Long

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns the signed value encoded as Long. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeString

fun MavDataDecoder.safeDecodeString(length: Int): String

Reads a String of the given length from the array's current position using the UTF-8 encoding, and then increments the position. If there are not enough bytes in the array, the remaining length is ignored.

safeDecodeUInt16

fun MavDataDecoder.safeDecodeUInt16(): UShort

Reads a UShort/UInt16 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt16Array

fun MavDataDecoder.safeDecodeUInt16Array(dataSize: Int): List<UShort>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded UShort/UInt16 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt32

fun MavDataDecoder.safeDecodeUInt32(): UInt

Reads a UInt/UInt32 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt32Array

fun MavDataDecoder.safeDecodeUInt32Array(dataSize: Int): List<UInt>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded UInt/UInt32 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt64

fun MavDataDecoder.safeDecodeUInt64(): ULong

Reads a ULong/UInt64 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt64Array

fun MavDataDecoder.safeDecodeUInt64Array(dataSize: Int): List<ULong>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded ULong/UInt64 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt8

fun MavDataDecoder.safeDecodeUInt8(): UByte

Reads a UByte/UInt8 from the array's current position, and then increments the position. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUInt8Array

fun MavDataDecoder.safeDecodeUInt8Array(dataSize: Int): List<UByte>

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns a List of the decoded UByte/UInt8 values. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

safeDecodeUnsignedInteger

fun MavDataDecoder.safeDecodeUnsignedInteger(dataSize: Int): Long

Reads dataSize number of bytes from the array's current position, and then increments the position. Returns the unsigned value encoded as a Long. If there are not enough bytes in the array, it assumes that the remaining length is padded with zeroes.

truncateZeros

fun ByteArray.truncateZeros(): ByteArray

Returns a new ByteArray with all the trailing zeros removed.