commonMain.Spi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of konapi-jvm Show documentation

Kotlin Native for Raspberry Pi

The newest version!

@file:OptIn(ExperimentalUnsignedTypes::class)

package ch.softappeal.konapi

public const val SPI_MODE_0: UByte = 0x00U
public const val SPI_MODE_1: UByte = 0x01U
public const val SPI_MODE_2: UByte = 0x02U
public const val SPI_MODE_3: UByte = 0x03U
public const val SPI_MODE_LSB_FIRST: UByte = 0x08U
public const val SPI_MODE_MSB_FIRST: UByte = 0x00U
public const val SPI_MODE_3WIRE: UByte = 0x10U
public const val SPI_MODE_4WIRE: UByte = 0x00U

public interface SpiDevice : Closeable {
    public data class Config(
        public val speedHz: Int? = null,
        public val bitsPerWord: Int? = null,
        public val mode: UByte? = null,
    ) {
        init {
            require((speedHz ?: 1) > 0) { "speedHz=$speedHz must be > 0" }
            require((bitsPerWord ?: 1) > 0) { "bitsPerWord=$bitsPerWord must be > 0" }
        }
    }

    public val blockSize: Int
    public var config: Config
    public fun transfer(bytes: UByteArray)
    public fun write(bytes: UByteArray)
}

public expect fun SpiDevice(bus: Int, chipSelect: Int): SpiDevice