1.0.0

library/dev.mcarr.pgnc/PicoGpioNetClient

PicoGpioNetClient

class PicoGpioNetClient(ip: String, port: Int, autoFlush: Boolean = false) : Closeable

Client for interacting with the PGN daemon.

This is the class responsible for translating human-readable function names and variables to raw byte data, and transmitting that data back and forth over the socket.

To use this class, you must first call connect(), and you should remember to close the client after you've finished using it.

While connected, you can issue commands to the PGN daemon by calling the functions within this class.

Example usage:

val serverName = PicoGpioNetClient(ip, port).use{ client ->
    client.connect()
    val apiVersion = client.getApiVersion()
    if (apiVersion >= Command.CMD_GET_NAME.apiVersion)
        client.getName()
    else
        "Unknown device name"
}

Parameters

ip

IP address of the Pico device running PGN which we want to connect to.

port

Port on which PGN is running. This is usually port 8080.

autoFlush

If true, flush all writes to the PGN daemon automatically.

Constructors

PicoGpioNetClient

constructor(ip: String, port: Int, autoFlush: Boolean = false)

Types

object Companion

Functions

open override fun close()

suspend fun connect()

Attempts to establish a connection to the PGN daemon.

suspend fun delay(millis: Short)

Tells the Pico server to wait for a defined amount of time before moving onto the next request.

suspend fun flush(): List<Boolean>

Manually flushes the queue.

suspend fun getApiVersion(): Byte

Asks the Pico device which version of pico-gpio-net it is running.

suspend fun getName(): String

Asks the Pico device to identify itself.

suspend fun getPin(pin: Byte): Byte

Retrieves the value of a single pin.

suspend fun getPins(pins: ByteArray): ByteArray

Retrieves the value of multiple pins.

suspend fun read(length: Int): ByteArray

Reads the specified number of bytes from the socket.

suspend fun read(packet: Packet, length: Int): ByteArray

Performs a read request after flushing the queue, if needed.

suspend fun setPin(pin: Byte, value: Byte)

Sets the state of a single pin.

suspend fun setPins(pinsAndValues: List<Pair<Byte, Byte>>)

Sets the states of multiple pins.

suspend fun spiWrite(data: ByteArray)

Sends raw byte data to write over SPI.

suspend fun waitForPin(pin: Byte, value: Byte, millis: Short)

Waits for a given pin to reach a particular value before continuing execution.

suspend fun write(packet: Packet)

Queues up an arbitrary write request.