commonMain.com.divpundir.mavlink.definitions.common.EscInfo.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of definitions-jvm Show documentation
A modern MAVLink library for the JVM written in Kotlin.
The newest version!
package com.divpundir.mavlink.definitions.common

import com.divpundir.mavlink.api.GeneratedMavField
import com.divpundir.mavlink.api.GeneratedMavMessage
import com.divpundir.mavlink.api.MavEnumValue
import com.divpundir.mavlink.api.MavMessage
import com.divpundir.mavlink.api.WorkInProgress
import com.divpundir.mavlink.serialization.MavDataDecoder
import com.divpundir.mavlink.serialization.MavDataEncoder
import com.divpundir.mavlink.serialization.encodeEnumValue
import com.divpundir.mavlink.serialization.encodeInt16Array
import com.divpundir.mavlink.serialization.encodeUInt16
import com.divpundir.mavlink.serialization.encodeUInt16Array
import com.divpundir.mavlink.serialization.encodeUInt32Array
import com.divpundir.mavlink.serialization.encodeUInt64
import com.divpundir.mavlink.serialization.encodeUInt8
import com.divpundir.mavlink.serialization.safeDecodeEnumValue
import com.divpundir.mavlink.serialization.safeDecodeInt16Array
import com.divpundir.mavlink.serialization.safeDecodeUInt16
import com.divpundir.mavlink.serialization.safeDecodeUInt16Array
import com.divpundir.mavlink.serialization.safeDecodeUInt32Array
import com.divpundir.mavlink.serialization.safeDecodeUInt64
import com.divpundir.mavlink.serialization.safeDecodeUInt8
import com.divpundir.mavlink.serialization.truncateZeros
import kotlin.Byte
import kotlin.ByteArray
import kotlin.Int
import kotlin.Short
import kotlin.UByte
import kotlin.UInt
import kotlin.ULong
import kotlin.UShort
import kotlin.Unit
import kotlin.collections.List

/**
 * ESC information for lower rate streaming. Recommended streaming rate 1Hz. See ESC_STATUS for
 * higher-rate ESC data.
 *
 * @param index Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
 * @param timeUsec Timestamp (UNIX Epoch time or time since system boot). The receiving end can
 * infer timestamp format (since 1.1.1970 or since system boot) by checking for the magnitude the
 * number.
 * units = us
 * @param counter Counter of data packets received.
 * @param count Total number of ESCs in all messages of this type. Message fields with an index
 * higher than this should be ignored because they contain invalid data.
 * @param connectionType Connection type protocol for all ESC.
 * @param info Information regarding online/offline status of each ESC.
 * @param failureFlags Bitmap of ESC failure flags.
 * @param errorCount Number of reported errors by each ESC since boot.
 * @param temperature Temperature of each ESC. INT16_MAX: if data not supplied by ESC.
 * units = cdegC
 */
@WorkInProgress
@GeneratedMavMessage(
  id = 290u,
  crcExtra = -5,
)
public data class EscInfo(
  /**
   * Index of the first ESC in this message. minValue = 0, maxValue = 60, increment = 4.
   */
  @GeneratedMavField(type = "uint8_t")
  public val index: UByte = 0u,
  /**
   * Timestamp (UNIX Epoch time or time since system boot). The receiving end can infer timestamp
   * format (since 1.1.1970 or since system boot) by checking for the magnitude the number.
   * units = us
   */
  @GeneratedMavField(type = "uint64_t")
  public val timeUsec: ULong = 0uL,
  /**
   * Counter of data packets received.
   */
  @GeneratedMavField(type = "uint16_t")
  public val counter: UShort = 0u,
  /**
   * Total number of ESCs in all messages of this type. Message fields with an index higher than
   * this should be ignored because they contain invalid data.
   */
  @GeneratedMavField(type = "uint8_t")
  public val count: UByte = 0u,
  /**
   * Connection type protocol for all ESC.
   */
  @GeneratedMavField(type = "uint8_t")
  public val connectionType: MavEnumValue = MavEnumValue.fromValue(0u),
  /**
   * Information regarding online/offline status of each ESC.
   */
  @GeneratedMavField(type = "uint8_t")
  public val info: UByte = 0u,
  /**
   * Bitmap of ESC failure flags.
   */
  @GeneratedMavField(type = "uint16_t[4]")
  public val failureFlags: List = emptyList(),
  /**
   * Number of reported errors by each ESC since boot.
   */
  @GeneratedMavField(type = "uint32_t[4]")
  public val errorCount: List = emptyList(),
  /**
   * Temperature of each ESC. INT16_MAX: if data not supplied by ESC.
   * units = cdegC
   */
  @GeneratedMavField(type = "int16_t[4]")
  public val temperature: List = emptyList(),
) : MavMessage {
  override val instanceCompanion: MavMessage.MavCompanion = Companion

  override fun serializeV1(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V1)
    encoder.encodeUInt64(timeUsec)
    encoder.encodeUInt32Array(errorCount, 16)
    encoder.encodeUInt16(counter)
    encoder.encodeUInt16Array(failureFlags, 8)
    encoder.encodeInt16Array(temperature, 8)
    encoder.encodeUInt8(index)
    encoder.encodeUInt8(count)
    encoder.encodeEnumValue(connectionType.value, 1)
    encoder.encodeUInt8(info)
    return encoder.bytes
  }

  override fun serializeV2(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V2)
    encoder.encodeUInt64(timeUsec)
    encoder.encodeUInt32Array(errorCount, 16)
    encoder.encodeUInt16(counter)
    encoder.encodeUInt16Array(failureFlags, 8)
    encoder.encodeInt16Array(temperature, 8)
    encoder.encodeUInt8(index)
    encoder.encodeUInt8(count)
    encoder.encodeEnumValue(connectionType.value, 1)
    encoder.encodeUInt8(info)
    return encoder.bytes.truncateZeros()
  }

  public companion object : MavMessage.MavCompanion {
    private const val SIZE_V1: Int = 46

    private const val SIZE_V2: Int = 46

    override val id: UInt = 290u

    override val crcExtra: Byte = -5

    override fun deserialize(bytes: ByteArray): EscInfo {
      val decoder = MavDataDecoder(bytes)

      val timeUsec = decoder.safeDecodeUInt64()
      val errorCount = decoder.safeDecodeUInt32Array(16)
      val counter = decoder.safeDecodeUInt16()
      val failureFlags = decoder.safeDecodeUInt16Array(8)
      val temperature = decoder.safeDecodeInt16Array(8)
      val index = decoder.safeDecodeUInt8()
      val count = decoder.safeDecodeUInt8()
      val connectionType = decoder.safeDecodeEnumValue(1).let { value ->
        val entry = EscConnectionType.getEntryFromValueOrNull(value)
        if (entry != null) MavEnumValue.of(entry) else MavEnumValue.fromValue(value)
      }
      val info = decoder.safeDecodeUInt8()

      return EscInfo(
        index = index,
        timeUsec = timeUsec,
        counter = counter,
        count = count,
        connectionType = connectionType,
        info = info,
        failureFlags = failureFlags,
        errorCount = errorCount,
        temperature = temperature,
      )
    }

    public operator fun invoke(builderAction: Builder.() -> Unit): EscInfo =
        Builder().apply(builderAction).build()
  }

  public class Builder {
    public var index: UByte = 0u

    public var timeUsec: ULong = 0uL

    public var counter: UShort = 0u

    public var count: UByte = 0u

    public var connectionType: MavEnumValue = MavEnumValue.fromValue(0u)

    public var info: UByte = 0u

    public var failureFlags: List = emptyList()

    public var errorCount: List = emptyList()

    public var temperature: List = emptyList()

    public fun build(): EscInfo = EscInfo(
      index = index,
      timeUsec = timeUsec,
      counter = counter,
      count = count,
      connectionType = connectionType,
      info = info,
      failureFlags = failureFlags,
      errorCount = errorCount,
      temperature = temperature,
    )
  }
}