Krill SDK/krill.zone.shared.krillapp.server.serialdevice/SerialDeviceMetaData

SerialDeviceMetaData

@Serializable

data class SerialDeviceMetaData(val name: String = "", val hardwareId: String = "", val hardwareType: HardwareType = HardwareType.SERIAL, val status: NodeState = NodeState.CREATE_OR_OVERWRITE, val interval: Long = 5000, val baudRate: Int = 9600, val readTimeout: Int = 1000, val writeTimeout: Int = 0, val operation: SerialDeviceOperation = SerialDeviceOperation.READ, val timestamp: Long = 0, val dataBits: SerialDataBits = SerialDataBits.EIGHT, val parity: SerialParity = SerialParity.NONE, val stopBits: SerialStopBits = SerialStopBits.ONE, val flowControl: SerialFlowControl = SerialFlowControl.NONE, val encoding: SerialEncoding = SerialEncoding.UTF_8, val terminator: SerialTerminator = SerialTerminator.CR, val sendCommand: String = "R", val sources: List<NodeIdentity> = listOf(NodeIdentity("", "")), val snapshot: Snapshot = Snapshot(), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val error: String = "", val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for a Server.SerialDevice node.

Constructors

constructor(name: String = "", hardwareId: String = "", hardwareType: HardwareType = HardwareType.SERIAL, status: NodeState = NodeState.CREATE_OR_OVERWRITE, interval: Long = 5000, baudRate: Int = 9600, readTimeout: Int = 1000, writeTimeout: Int = 0, operation: SerialDeviceOperation = SerialDeviceOperation.READ, timestamp: Long = 0, dataBits: SerialDataBits = SerialDataBits.EIGHT, parity: SerialParity = SerialParity.NONE, stopBits: SerialStopBits = SerialStopBits.ONE, flowControl: SerialFlowControl = SerialFlowControl.NONE, encoding: SerialEncoding = SerialEncoding.UTF_8, terminator: SerialTerminator = SerialTerminator.CR, sendCommand: String = "R", sources: List<NodeIdentity> = listOf(NodeIdentity("", "")), snapshot: Snapshot = Snapshot(), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, error: String = "", inputs: List<NodeIdentity> = emptyList())

Properties

baudRate

val baudRate: Int

Baud rate — 9600 is the safe default for unknown devices.

dataBits

val dataBits: SerialDataBits

Data bits per frame.

encoding

val encoding: SerialEncoding

Charset for decoding / encoding payloads.

error

open override val error: String

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

flowControl

val flowControl: SerialFlowControl

Flow-control mode.

hardwareId

val hardwareId: String

Stable hardware identifier (typically the device path or serial number).

hardwareType

val hardwareType: HardwareType

Hardware classification — always SERIAL for this node type.

inputs

open override val inputs: List<NodeIdentity>

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

interval

val interval: Long

Polling interval for READ operations, in milliseconds.

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.

name

val name: String

Display name shown on the device 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.

operation

val operation: SerialDeviceOperation

Whether this node reads from or writes to the device.

parity

val parity: SerialParity

Parity configuration.

readTimeout

val readTimeout: Int

Read timeout in milliseconds before the read coroutine gives up.

sendCommand

val sendCommand: String

Command sent on each poll when operation is READ — e.g. "R" for Atlas Scientific sensors. Empty string is allowed for devices that stream data without prompting.

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.

status

val status: NodeState

Lifecycle state of the underlying jSerialComm port.

stopBits

val stopBits: SerialStopBits

Stop bits per frame.