commonMain.com.divpundir.mavlink.api.MavFrame.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-jvm Show documentation
Show all versions of api-jvm Show documentation
A modern MAVLink library for the JVM written in Kotlin.
package com.divpundir.mavlink.api
/**
* An in-memory representation a basic MAVLink frame. It contains the [MavMessage] and other wire-format metadata.
*
* The contents of this class are sufficient for a MAVLinkV1 frame.
*
* @param T The type of this frame's payload.
*/
public interface MavFrame {
/**
* The sequence of this frame.
*/
public val sequence: UByte
/**
* The ID of the system that originated this frame.
*/
public val systemId: UByte
/**
* The ID of the component that originated this frame.
*/
public val componentId: UByte
/**
* The message/payload of this frame.
*/
public val message: T
/**
* The checksum of this frame.
*/
public val checksum: UShort
}