Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ModuleRuntimeChannel

One live channel rendered beneath a linked module task.

Import

import type { ModuleRuntimeChannel } from "@dartwic/interface-sdk/ui";

Declaration

export interface ModuleRuntimeChannel {
    /** RAPID channel name used for live telemetry. */
    name: string;
    /** Optional shorter visible label; the channel name is used by default. */
    label?: string;
    /** Direction relative to the device. */
    direction?: "input" | "output" | "diagnostic";
    /** Optional register, address, or mapping detail. */
    detail?: string;
}

Members

NameTypeRequirementDescription
namestringRequiredRAPID channel name used for live telemetry.
labelstringOptionalOptional shorter visible label; the channel name is used by default.
direction"input" | "output" | "diagnostic"OptionalDirection relative to the device.
detailstringOptionalOptional register, address, or mapping detail.