Krill SDK/krill.zone.shared.krillapp.server.pin/PinMetaData

PinMetaData

@Serializable

data class PinMetaData(val name: String = "", val hardwareId: String = "", val mode: Mode = Mode.OUT, val state: DigitalState = DigitalState.OFF, val initialState: DigitalState = DigitalState.OFF, val shutdownState: DigitalState = DigitalState.OFF, val pinNumber: Int = 0, val hardwareType: HardwareType = HardwareType.GROUND, val isConfigurable: Boolean = false, val address: Int? = null, val color: String? = null, val error: String = "", val sources: List<NodeIdentity> = emptyList(), val snapshot: Snapshot = Snapshot(), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for a Server.Pin node.

Constructors

PinMetaData

constructor(name: String = "", hardwareId: String = "", mode: Mode = Mode.OUT, state: DigitalState = DigitalState.OFF, initialState: DigitalState = DigitalState.OFF, shutdownState: DigitalState = DigitalState.OFF, pinNumber: Int = 0, hardwareType: HardwareType = HardwareType.GROUND, isConfigurable: Boolean = false, address: Int? = null, color: String? = null, error: String = "", sources: List<NodeIdentity> = emptyList(), snapshot: Snapshot = Snapshot(), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, inputs: List<NodeIdentity> = emptyList())

Properties

address

val address: Int?

I²C / SPI bus address if the pin is part of a bus device — null for plain GPIO.

color

val color: String?

Optional CSS colour hint shown on the pin tile.

error

open override val error: String

Last known error message for this node, or empty string when healthy.

hardwareId

val hardwareId: String

Stable hardware identifier (typically "<host>:<header>:<pin>").

hardwareType

val hardwareType: HardwareType

Hardware capability of the assigned pin — see HardwareType.

initialState

val initialState: DigitalState

Level the pin is driven to immediately after configuration.

inputs

open override val inputs: List<NodeIdentity>

sets the nodes this node reads from to complete its work when invoked

invocationTriggers

open override val invocationTriggers: List<InvocationTrigger>

The set of InvocationTriggers configured to wake this node. The node processor checks the incoming event against this list before doing any work. An empty list means "never auto-fire" — only manual execution.

isConfigurable

val isConfigurable: Boolean

true if the user is allowed to change this pin's configuration in the editor.

isConfigured

val isConfigured: Boolean

true when the pin has been assigned a real header position and a non-default hardware id. Unconfigured defaults (pinNumber == 0 and empty hardwareId) should not be registered with the krill-pi4j daemon.

mode

val mode: Mode

Direction / capability — output, input, or PWM.

name

val name: String

Display name shown on the pin tile.

nodeAction

open override val nodeAction: NodeAction

The action this node performs when it fires. Defaults to NodeAction.EXECUTE on every concrete implementation so that deserialising a payload that predates this field yields the original behaviour unchanged.

pinNumber

val pinNumber: Int

GPIO pin number on the header (1-based). 0 means "not configured yet".

shutdownState

val shutdownState: DigitalState

Level the pin is driven to during graceful server shutdown.

snapshot

open override val snapshot: Snapshot

Stores the last result of when this node was invoked and is a source of data

sources

open override val sources: List<NodeIdentity>

Upstream nodes whose values feed this one. For a filter or executor this is the data being read; for a trigger it is the value being watched.

state

val state: DigitalState

Current observed pin level.