commonMain.com.divpundir.mavlink.definitions.common.CellularConfig.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.serialization.MavDataDecoder
import com.divpundir.mavlink.serialization.MavDataEncoder
import com.divpundir.mavlink.serialization.encodeEnumValue
import com.divpundir.mavlink.serialization.encodeString
import com.divpundir.mavlink.serialization.encodeUInt8
import com.divpundir.mavlink.serialization.safeDecodeEnumValue
import com.divpundir.mavlink.serialization.safeDecodeString
import com.divpundir.mavlink.serialization.safeDecodeUInt8
import com.divpundir.mavlink.serialization.truncateZeros
import kotlin.Byte
import kotlin.ByteArray
import kotlin.Int
import kotlin.String
import kotlin.UByte
import kotlin.UInt
import kotlin.Unit

/**
 * Configure cellular modems.
 *         This message is re-emitted as an acknowledgement by the modem.
 *         The message may also be explicitly requested using MAV_CMD_REQUEST_MESSAGE.
 *
 * @param enableLte Enable/disable LTE. 0: setting unchanged, 1: disabled, 2: enabled. Current
 * setting when sent back as a response.
 * @param enablePin Enable/disable PIN on the SIM card. 0: setting unchanged, 1: disabled, 2:
 * enabled. Current setting when sent back as a response.
 * @param pin PIN sent to the SIM card. Blank when PIN is disabled. Empty when message is sent back
 * as a response.
 * @param newPin New PIN when changing the PIN. Blank to leave it unchanged. Empty when message is
 * sent back as a response.
 * @param apn Name of the cellular APN. Blank to leave it unchanged. Current APN when sent back as a
 * response.
 * @param puk Required PUK code in case the user failed to authenticate 3 times with the PIN. Empty
 * when message is sent back as a response.
 * @param roaming Enable/disable roaming. 0: setting unchanged, 1: disabled, 2: enabled. Current
 * setting when sent back as a response.
 * @param response Message acceptance response (sent back to GS).
 */
@GeneratedMavMessage(
  id = 336u,
  crcExtra = -11,
)
public data class CellularConfig(
  /**
   * Enable/disable LTE. 0: setting unchanged, 1: disabled, 2: enabled. Current setting when sent
   * back as a response.
   */
  @GeneratedMavField(type = "uint8_t")
  public val enableLte: UByte = 0u,
  /**
   * Enable/disable PIN on the SIM card. 0: setting unchanged, 1: disabled, 2: enabled. Current
   * setting when sent back as a response.
   */
  @GeneratedMavField(type = "uint8_t")
  public val enablePin: UByte = 0u,
  /**
   * PIN sent to the SIM card. Blank when PIN is disabled. Empty when message is sent back as a
   * response.
   */
  @GeneratedMavField(type = "char[16]")
  public val pin: String = "",
  /**
   * New PIN when changing the PIN. Blank to leave it unchanged. Empty when message is sent back as
   * a response.
   */
  @GeneratedMavField(type = "char[16]")
  public val newPin: String = "",
  /**
   * Name of the cellular APN. Blank to leave it unchanged. Current APN when sent back as a
   * response.
   */
  @GeneratedMavField(type = "char[32]")
  public val apn: String = "",
  /**
   * Required PUK code in case the user failed to authenticate 3 times with the PIN. Empty when
   * message is sent back as a response.
   */
  @GeneratedMavField(type = "char[16]")
  public val puk: String = "",
  /**
   * Enable/disable roaming. 0: setting unchanged, 1: disabled, 2: enabled. Current setting when
   * sent back as a response.
   */
  @GeneratedMavField(type = "uint8_t")
  public val roaming: UByte = 0u,
  /**
   * Message acceptance response (sent back to GS).
   */
  @GeneratedMavField(type = "uint8_t")
  public val response: MavEnumValue = MavEnumValue.fromValue(0u),
) : MavMessage {
  override val instanceCompanion: MavMessage.MavCompanion = Companion

  override fun serializeV1(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V1)
    encoder.encodeUInt8(enableLte)
    encoder.encodeUInt8(enablePin)
    encoder.encodeString(pin, 16)
    encoder.encodeString(newPin, 16)
    encoder.encodeString(apn, 32)
    encoder.encodeString(puk, 16)
    encoder.encodeUInt8(roaming)
    encoder.encodeEnumValue(response.value, 1)
    return encoder.bytes
  }

  override fun serializeV2(): ByteArray {
    val encoder = MavDataEncoder(SIZE_V2)
    encoder.encodeUInt8(enableLte)
    encoder.encodeUInt8(enablePin)
    encoder.encodeString(pin, 16)
    encoder.encodeString(newPin, 16)
    encoder.encodeString(apn, 32)
    encoder.encodeString(puk, 16)
    encoder.encodeUInt8(roaming)
    encoder.encodeEnumValue(response.value, 1)
    return encoder.bytes.truncateZeros()
  }

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

    private const val SIZE_V2: Int = 84

    override val id: UInt = 336u

    override val crcExtra: Byte = -11

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

      val enableLte = decoder.safeDecodeUInt8()
      val enablePin = decoder.safeDecodeUInt8()
      val pin = decoder.safeDecodeString(16)
      val newPin = decoder.safeDecodeString(16)
      val apn = decoder.safeDecodeString(32)
      val puk = decoder.safeDecodeString(16)
      val roaming = decoder.safeDecodeUInt8()
      val response = decoder.safeDecodeEnumValue(1).let { value ->
        val entry = CellularConfigResponse.getEntryFromValueOrNull(value)
        if (entry != null) MavEnumValue.of(entry) else MavEnumValue.fromValue(value)
      }

      return CellularConfig(
        enableLte = enableLte,
        enablePin = enablePin,
        pin = pin,
        newPin = newPin,
        apn = apn,
        puk = puk,
        roaming = roaming,
        response = response,
      )
    }

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

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

    public var enablePin: UByte = 0u

    public var pin: String = ""

    public var newPin: String = ""

    public var apn: String = ""

    public var puk: String = ""

    public var roaming: UByte = 0u

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

    public fun build(): CellularConfig = CellularConfig(
      enableLte = enableLte,
      enablePin = enablePin,
      pin = pin,
      newPin = newPin,
      apn = apn,
      puk = puk,
      roaming = roaming,
      response = response,
    )
  }
}