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

Go to download
package com.divpundir.mavlink.definitions.common

import com.divpundir.mavlink.api.GeneratedMavField
import com.divpundir.mavlink.api.GeneratedMavMessage
import com.divpundir.mavlink.api.MavMessage
import com.divpundir.mavlink.serialization.MavDataDecoder
import com.divpundir.mavlink.serialization.MavDataEncoder
import com.divpundir.mavlink.serialization.encodeUInt8
import com.divpundir.mavlink.serialization.encodeUInt8Array
import com.divpundir.mavlink.serialization.safeDecodeUInt8
import com.divpundir.mavlink.serialization.safeDecodeUInt8Array
import com.divpundir.mavlink.serialization.truncateZeros
import kotlin.Byte
import kotlin.ByteArray
import kotlin.Int
import kotlin.UByte
import kotlin.UInt
import kotlin.Unit
import kotlin.collections.List

/**
 * The autopilot is requesting a resource (file, binary, other type of data)
 *
 * @param requestId Request ID. This ID should be re-used when sending back URI contents
 * @param uriType The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
 * @param uri The requested unique resource identifier (URI). It is not necessarily a straight
 * domain name (depends on the URI type enum)
 * @param transferType The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary
 * stream.
 * @param storage The storage path the autopilot wants the URI to be stored in. Will only be valid
 * if the transfer_type has a storage associated (e.g. MAVLink FTP).
 */
@GeneratedMavMessage(
  id = 142u,
  crcExtra = 72,
)
public data class ResourceRequest(
  /**
   * Request ID. This ID should be re-used when sending back URI contents
   */
  @GeneratedMavField(type = "uint8_t")
  public val requestId: UByte = 0u,
  /**
   * The type of requested URI. 0 = a file via URL. 1 = a UAVCAN binary
   */
  @GeneratedMavField(type = "uint8_t")
  public val uriType: UByte = 0u,
  /**
   * The requested unique resource identifier (URI). It is not necessarily a straight domain name
   * (depends on the URI type enum)
   */
  @GeneratedMavField(type = "uint8_t[120]")
  public val uri: List = emptyList(),
  /**
   * The way the autopilot wants to receive the URI. 0 = MAVLink FTP. 1 = binary stream.
   */
  @GeneratedMavField(type = "uint8_t")
  public val transferType: UByte = 0u,
  /**
   * The storage path the autopilot wants the URI to be stored in. Will only be valid if the
   * transfer_type has a storage associated (e.g. MAVLink FTP).
   */
  @GeneratedMavField(type = "uint8_t[120]")
  public val storage: List = emptyList(),
) : MavMessage {
  override val instanceCompanion: MavMessage.MavCompanion = Companion

  override fun serializeV1(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V1)
    encoder.encodeUInt8(requestId)
    encoder.encodeUInt8(uriType)
    encoder.encodeUInt8Array(uri, 120)
    encoder.encodeUInt8(transferType)
    encoder.encodeUInt8Array(storage, 120)
    return encoder.bytes
  }

  override fun serializeV2(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V2)
    encoder.encodeUInt8(requestId)
    encoder.encodeUInt8(uriType)
    encoder.encodeUInt8Array(uri, 120)
    encoder.encodeUInt8(transferType)
    encoder.encodeUInt8Array(storage, 120)
    return encoder.bytes.truncateZeros()
  }

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

    private const val SIZE_V2: Int = 243

    override val id: UInt = 142u

    override val crcExtra: Byte = 72

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

      val requestId = decoder.safeDecodeUInt8()
      val uriType = decoder.safeDecodeUInt8()
      val uri = decoder.safeDecodeUInt8Array(120)
      val transferType = decoder.safeDecodeUInt8()
      val storage = decoder.safeDecodeUInt8Array(120)

      return ResourceRequest(
        requestId = requestId,
        uriType = uriType,
        uri = uri,
        transferType = transferType,
        storage = storage,
      )
    }

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

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

    public var uriType: UByte = 0u

    public var uri: List = emptyList()

    public var transferType: UByte = 0u

    public var storage: List = emptyList()

    public fun build(): ResourceRequest = ResourceRequest(
      requestId = requestId,
      uriType = uriType,
      uri = uri,
      transferType = transferType,
      storage = storage,
    )
  }
}