DARTWIC
Overview Docs Releases Downloads
Explore

Explore

  • Getting Started
    • Overview
    • First SessionSoon
    • DARTWIC Ecosystem
    • Examples and Use CasesSoon
    • Compatibility, Licensing, and TiersSoon
    • Tracking a Project in GitHub
  • Interface
    • Overview
    • Workspace and ResourcesSoon
    • Channel SearchSoon
    • SchematicsSoon
    • Managing TasksSoon
    • ARGUS EventsSoon
    • Telemetry ExporterSoon
    • DataFramesSoon
    • Cluster MapSoon
    • ChecklistsSoon
    • PluginsSoon
    • SettingsSoon
  • Engine
    • Overview
    • Channels
    • Commanding and Control
    • Deterministic Automation
    • Execution and Timing
    • DARTWIC Builder
    • Telemetry and History
    • Modules
    • Events and ARGUS
    • Using TEMPEST
    • DARTWIC Share
    • Reference
      • Engine Reference
      • TEMPEST
        • Operations
          • Argus
            • argus/delete-event
            • argus/get-active-event-firing-states
            • argus/get-active-events
            • argus/list-sessions
            • argus/query-events
            • argus/release-hold
            • argus/respond-to-prompt
            • argus/update-event-status
            • Query Events
              • argus/query-events/start
          • Channels and Persistence
          • Clients and Telemetry
          • Dartwic
            • Builder
              • dartwic/builder/get-report
            • dartwic/abort-timeline
            • dartwic/activate-script
            • dartwic/add-channel-to-telemetry
            • dartwic/add-channels-to-telemetry
            • dartwic/add-schematic-node
            • dartwic/call-function
            • dartwic/check-dcode-script
            • dartwic/create-task
            • dartwic/delete-console-message
            • dartwic/delete-file
            • dartwic/get-connected-clients
            • dartwic/get-dcode-api-autocomplete
            • dartwic/get-dcode-execution-lines
            • dartwic/get-directory-tree
            • dartwic/get-file
            • dartwic/get-function-list
            • dartwic/get-module-instances
            • dartwic/get-registered-tasks
            • dartwic/get-runtime-loops
            • dartwic/get-runtime-metadata
            • dartwic/get-script-build-report
            • dartwic/get-task-groups
            • dartwic/get-task-types
            • dartwic/get-tempest-client-data
            • dartwic/move-file
            • dartwic/preview-timeline-time
            • dartwic/release-hold
            • dartwic/remove-channel-from-telemetry
            • dartwic/remove-channels-from-telemetry
            • dartwic/remove-task
            • dartwic/rename-file
            • dartwic/reset-timeline
            • dartwic/respond-to-prompt
            • dartwic/save-file
            • dartwic/save-schematic-node
            • dartwic/schematic-nodes-query
            • dartwic/search-files
            • dartwic/search-schematic-node-instances
            • dartwic/set-timeline-time
            • dartwic/update-client-info
            • dartwic/update-console-message
            • Engine
              • dartwic/engine/restart
              • dartwic/engine/shutdown
            • Interface Ui
              • dartwic/interface-ui/complete-request
              • dartwic/interface-ui/get-request
              • dartwic/interface-ui/get-requests
              • dartwic/interface-ui/set-request-muted
            • Modules
              • Build Module Instance
                • dartwic/modules/build-module-instance/start
              • dartwic/modules/build-module-instance
              • dartwic/modules/delete-module-instance
              • dartwic/modules/provision-discovery-request
              • dartwic/modules/reload-module-instance
              • dartwic/modules/save-and-reload-module-instance
              • Reload Module Instance
                • dartwic/modules/reload-module-instance/start
              • Save And Reload Module Instance
                • dartwic/modules/save-and-reload-module-instance/start
            • Notifications
              • dartwic/notifications/get-muted
              • dartwic/notifications/set-muted
            • Plugins
              • dartwic/plugins/get-discovered-devices
              • dartwic/plugins/install-engine-plugin
              • dartwic/plugins/list-installed-engine-plugin-groups
              • dartwic/plugins/list-installed-engine-plugins
              • dartwic/plugins/read-module-icon
              • dartwic/plugins/uninstall-engine-plugin
              • Install Engine Plugin
                • dartwic/plugins/install-engine-plugin/start
              • Uninstall Engine Plugin
                • dartwic/plugins/uninstall-engine-plugin/start
            • Projects
              • dartwic/projects/check-portability
              • dartwic/projects/create
              • dartwic/projects/get-active
              • dartwic/projects/list
              • dartwic/projects/rename
              • dartwic/projects/select
            • Search Files
              • dartwic/search-files/start
            • Updates
              • dartwic/updates/apply
              • dartwic/updates/status
              • Stage
                • dartwic/updates/stage/start
          • DARTWIC Share
          • Dartwic Share
            • Argus
              • dartwic-share/argus/delete-event
              • dartwic-share/argus/get-active-events
              • dartwic-share/argus/query-events
              • dartwic-share/argus/release-hold
              • dartwic-share/argus/respond-to-prompt
              • dartwic-share/argus/update-event-status
            • dartwic-share/connect
            • dartwic-share/disconnect
            • dartwic-share/get-runtime-metadata
            • dartwic-share/list
            • dartwic-share/reconnect-remembered
            • dartwic-share/transports
            • Rapid
              • dartwic-share/rapid/get-channel
              • dartwic-share/rapid/list-channels
              • dartwic-share/rapid/upsert-channel-field
            • V2
              • dartwic-share/v2/frame
          • DCode
          • Engine Runtime
          • Engine Updates
          • Events
          • Interface UI and Notifications
          • Jobs
          • Modules
          • Plugins
          • Plugins and Modules
          • Projects and Files
          • Rapid
            • rapid/channel-export-start
            • rapid/delete-channel
            • rapid/delete-channel-dataframe
            • rapid/delete-channels
            • rapid/get-channel-field-config
            • rapid/get-channel-keys
            • rapid/get-channels-data
            • rapid/get-fixed-configuration
            • rapid/get-persistence-diagnostics
            • rapid/query-channel-last-recorded
            • rapid/query-channel-range
            • rapid/query-channel-range-start
            • rapid/search-channel-dataframes
            • rapid/search-channel-keys
            • rapid/set-fixed-configuration-sealed
            • rapid/upsert-channel-field
          • RAPID Share
          • Schematics
          • Tasks
          • Tempest
            • tempest/job-cancel
            • tempest/job-list
            • tempest/job-status
          • TEMPEST Operations
        • Telemetry
          • Channels telemetry
          • Client Relay telemetry
          • Clients telemetry
          • DARTWIC Share telemetry
          • Events telemetry
          • Projects telemetry
          • RAPID Share telemetry
          • Resource Collaboration telemetry
          • Runtime telemetry
          • TEMPEST Telemetry
          • Topics
            • Argus
              • Events
                • argus/events/created
                • argus/events/deleted
                • argus/events/snapshot
                • argus/events/updated
            • Dartwic
              • Clients
                • dartwic/clients/connected
                • dartwic/clients/disconnected
                • dartwic/clients/resource-activity
                • dartwic/clients/updated
              • dartwic/get-console-data
              • dartwic/node-health
              • dartwic/send-telemetry-to-clients
              • Engine
                • dartwic/engine/restarting
              • Projects
                • dartwic/projects/switching
              • Resources
                • {Resource Name}
                  • {Resource Path}
                    • dartwic/resources/{resource_name}/{resource_path}/on-live-resource-change
                    • dartwic/resources/{resource_name}/{resource_path}/on-live-resource-presence
                    • dartwic/resources/{resource_name}/{resource_path}/on-resource-sync-status
            • Dartwic Share
              • dartwic-share/updated
              • Rapid
                • dartwic-share/rapid/channel-updated
              • V2
                • dartwic-share/v2/frame
            • Rapid
              • Channels
                • rapid/channels/{channel_name}
              • rapid/channel-created
        • TEMPEST Reference
    • CAESAR Tasks
  • DCode
    • Overview
    • Getting Started
    • Channel Calculations
    • Events
    • Writing Periodic Tasks
    • Building State Machines
    • Sequences and Task Lifecycle
    • Modules and Native Functions
    • Native C++ Execution
    • Reference
      • Blocks
        • Blocks
        • do
        • elif
        • else
        • elseif
        • for
        • for each
        • function
        • if
        • once
        • once when
        • when
        • while
      • Context Variables
        • Context Variables
        • current_state
        • current_value
        • elapsed_seconds
        • lateness_ms
        • missed_count
        • new_value
        • state
        • states
        • target_state
        • value
      • DCode Functions
        • abort
        • callDcodeFunction
        • clamp
        • DCode Functions
        • error
        • hold
        • insertChannelReference
        • message
        • print
        • promptNumerical
        • promptOptions
        • promptString
        • promptYesNo
        • queryChannelReference
        • releaseHold
        • sleep
        • upsertChannelReference
        • warning
      • DCode Reference
      • Directives
        • Directives
        • import
        • params = yaml
        • template(params)
      • Event Metadata
        • auto_acknowledge
        • channels
        • description
        • Event Metadata
        • prompt metadata
        • resolution
        • system / subsystem
        • title
        • type
      • Lua Base
        • _G
        • _VERSION
        • and
        • assert
        • break
        • collectgarbage
        • coroutine
        • debug
        • dofile
        • false
        • getmetatable
        • goto
        • in
        • io
        • ipairs
        • load
        • loadfile
        • local
        • Lua Base
        • math
        • next
        • nil
        • not
        • or
        • os
        • package
        • pairs
        • pcall
        • rawequal
        • rawget
        • rawlen
        • rawset
        • repeat
        • require
        • return
        • select
        • setmetatable
        • string
        • table
        • tonumber
        • tostring
        • true
        • type
        • until
        • utf8
        • xpcall
      • Runtime Blocks
        • channel_calculation
        • event
        • loop
        • Runtime Blocks
        • task_group
        • task_periodic
        • task_sequence
        • task_state_machine
        • task_timeline
      • Runtime Sections
        • calculation body
        • depends_on
        • end
        • loop body
        • missed
        • on_event
        • on_firing
        • run
        • Runtime Sections
        • sequence body
        • start
        • state
        • states
        • task
        • trigger
      • Statements
        • automatic override
        • claim channel
        • command channel
        • free channel
        • pass
        • pipe write
        • set channel
        • sleep statement
        • Statements
        • transition
        • transition task
        • trigger event
        • wait for
        • wait until
      • Syntax
        • block comments
        • colon and indentation
        • dash comments
        • dynamic channel reference
        • hash comments
        • Lua expressions
        • Lua tables
        • pipe read
        • Syntax
  • Plugins
    • Overview
    • Engine Plugin
    • Building a Hardware Driver
    • Interface Plugin
    • Packaging and Installation
    • Reference
      • Engine
        • Channel Authority
          • Channel Authority
          • ControlPolicy
          • SDK_API::claimChannel
          • SDK_API::commandChannel
          • SDK_API::freeChannel
          • SDK_API::setChannel
        • Channels
          • ChannelField
          • Channels
          • ChannelValue
          • FixedChannelBatch
          • FixedChannelHandle
          • RecordMode
          • SDK_API::createFixedChannel
          • SDK_API::insertChannelField
          • SDK_API::queryChannelField
          • SDK_API::queryFixedChannelValues
          • SDK_API::removeChannel
          • SDK_API::resolveFixedChannels
          • SDK_API::upsertChannelField
          • SDK_API::upsertChannelValueBulk
          • SDK_API::upsertFixedChannelValues
        • DCode
          • DCode
          • DCodeFunctionArgument
          • DCodeFunctionHandler
          • SDK_API::callDCodeFunction
          • SDK_API::registerDCodeFunction
        • Engine Plugin SDK Reference
        • Events
          • Events
          • SDK_API::consoleError
          • SDK_API::recordEvent
        • Lifecycle
          • BasePlugin
          • Lifecycle
          • SDK_API
        • Modules
          • BaseModule
          • ModuleInstanceSummary
          • Modules
          • ModuleTypeDefinition
          • PluginModuleType
          • SDK_API::getModuleInstance
          • SDK_API::getModuleInstances
          • SDK_API::registerModuleType
        • Operations
          • OperationHandler
          • Operations
          • SDK_API::registerOperation
        • Share
          • SDK_API::registerShareTransport
          • Share
          • ShareTransportDefinition
        • Tasks And Loops
          • PluginLoopDefinition
          • SDK_API::registerLoop
          • SDK_API::registerTaskType
          • TaskCleanupFunction
          • TaskLifecycleFunction
          • TaskLoopFunction
          • TaskRuntime
          • Tasks and Loops
          • TaskStructure
          • TaskTypeDefinition
          • TaskTypeMetadata
      • Interface
        • DARTWIC UI Components
          • AbstractedButtonNodeConfig
          • buildChannelFieldPayload
          • buildControlDisplayNodeDefinitionFromChannel
          • buildParameterDisplayNodeDefinitionFromChannel
          • ChannelComboBox
          • ChannelComboBoxProps
          • ConfigurableInput
          • ConfigurableInputProps
          • ConsoleAlert
          • convertChannelReferenceToChannelName
          • DARTWIC UI Components
          • EmbeddedRemoteView
          • EmbeddedSchematicNode
          • getChannelValueFromChannels
          • getParticipantAccentColor
          • IfElseBlock
          • ifElseBlockCheck
          • ManualRefreshButton
          • ManualRefreshButtonProps
          • ModuleConnectionStatus
          • ModuleConnectionStatusProps
          • ModuleInstanceSelect
          • ModuleInstanceSelectProps
          • ModuleRuntimeChannel
          • ModuleRuntimeOverview
          • ModuleRuntimeOverviewProps
          • normalizeLegacyChannelFieldReference
          • ResourceParticipantsIcon
          • ResourceSyncStatusIcon
          • StaleChannelsTooltip
        • Hooks And Utilities
          • cn
          • Hooks and Utilities
          • useBottomContextPanel
          • useChannelDropTarget
          • useChannelStatusNames
          • useClientInfo
          • useConfigurableInput
          • useConnectedClients
          • useDartwic
          • useDartwicChannelValues
          • useIfElseBlock
          • useResourceNavigation
          • useResourceParticipantVisibility
        • Interface Plugin SDK Reference
        • Markdown
          • defineMarkdownChip
          • Markdown
          • MarkdownChannelDropContext
          • MarkdownChipDefinition
          • MarkdownChipParseResult
          • MarkdownChipRenderProps
          • MarkdownDropAction
          • MarkdownLineNumberMode
          • MarkdownMode
          • MarkdownRemoteParticipant
          • MarkdownRenderer
          • MarkdownRendererHandle
          • MarkdownRendererProps
          • MarkdownSelection
        • Module Configuration
          • defineModuleConfig
          • Module Configuration
          • ModuleConfigBridgeState
          • ModuleConfigDefinition
          • ModuleConfigProps
          • ModuleConfigRegistration
          • ModuleConnectionDefinition
          • ModuleConnectionPresentation
          • ModuleUiDefinition
          • useModuleConfigBridge
        • Plugin Registration
          • createInterfacePlugin
          • definePlugin
          • getInterfacePluginContributions
          • InterfaceContributionEntry
          • InterfaceContributions
          • InterfacePluginDefinition
          • InterfacePluginRegistrar
          • MaterializedInterfacePlugin
          • NamedContribution
          • Plugin Definition
          • Plugin Registration
          • PopupUiDefinition
          • ValueFormatDefinition
        • Plugin Settings
          • definePluginSettings
          • Plugin Settings
          • PluginSettingsDefinition
          • PluginSettingsProps
          • SettingsPanelDefinition
        • Resources
          • defineResource
          • ResourceComponentProps
          • ResourceContributionDefinition
          • ResourceDefinition
          • ResourceErrorState
          • Resources
          • ResourceType
          • SaveResourceContentOptions
        • Runtime
          • Host API
          • InterfacePluginHostApi
          • ReactProxy
          • registerPlugin
          • Runtime
        • Schematic Nodes
          • defineSchematicNode
          • Schematic Nodes
          • SchematicCommandAction
          • SchematicCommandContext
          • SchematicNodeConfigProps
          • SchematicNodeContributionDefinition
          • SchematicNodeDefinition
          • SchematicNodePaletteDefinition
          • SchematicNodeProps
        • Styling
          • dartwicTailwindPreset
          • Styling
        • Tasks
          • defineTaskCard
          • defineTaskConfig
          • TaskCardDefinition
          • TaskCardProps
          • TaskConfigBridgeState
          • TaskConfigDefinition
          • TaskConfigProps
          • TaskConfigRegistration
          • Tasks
          • TaskUiDefinition
          • useTaskConfigBridge
        • UI Components
          • Button
          • ButtonProps
          • Card
          • CardContent
          • CardContentProps
          • CardDescription
          • CardDescriptionProps
          • CardHeader
          • CardHeaderProps
          • CardProps
          • CardTitle
          • CardTitleProps
          • Checkbox
          • CheckboxProps
          • ContextMenu
          • ContextMenuContent
          • ContextMenuItem
          • ContextMenuSeparator
          • ContextMenuTrigger
          • DialogDescription
          • DialogDescriptionProps
          • DialogFooter
          • DialogFooterProps
          • DialogHeader
          • DialogHeaderProps
          • DialogTitle
          • DialogTitleProps
          • FormattedValueControl
          • FormattedValueInput
          • HostComponentProps
          • HostEventHandler
          • HostNode
          • Input
          • InputProps
          • Label
          • LabelProps
          • ScrollArea
          • ScrollAreaProps
          • ScrollBar
          • ScrollBarProps
          • Select
          • SelectContent
          • SelectContentProps
          • SelectItem
          • SelectItemProps
          • SelectProps
          • SelectTrigger
          • SelectTriggerProps
          • SelectValue
          • SelectValueProps
          • Separator
          • SeparatorProps
          • Switch
          • SwitchProps
          • Tabs
          • TabsContent
          • TabsContentProps
          • TabsList
          • TabsListProps
          • TabsProps
          • TabsTrigger
          • TabsTriggerProps
          • Tooltip
          • TooltipContent
          • TooltipContentProps
          • TooltipProps
          • TooltipTrigger
          • TooltipTriggerProps
          • UI Components
      • Plugin SDK Reference
      • Share
        • JSON Codec
          • argusEventFromJson
          • argusEventToJson
          • argusQueryFromJson
          • argusQueryToJson
          • decodeControl
          • decodeRequest
          • decodeResponse
          • decodeTelemetry
          • delivery
          • encodeControl
          • encodeRequest
          • encodeResponse
          • encodeTelemetry
          • fromJson
          • requestId
          • Share JSON Codec Reference
          • toJson
        • Protocol
          • ARGUS_DELETE_EVENT_OPERATION
          • ARGUS_RELEASE_HOLD_OPERATION
          • ARGUS_RESPOND_TO_PROMPT_OPERATION
          • ARGUS_UPDATE_EVENT_STATUS_OPERATION
          • ArgusAction
          • ArgusActionResult
          • ArgusEvent
          • ArgusEventTelemetry
          • ArgusHandlers
          • ArgusQuery
          • ArgusQueryResult
          • Capabilities
          • ChannelBulkUpsert
          • ChannelHandlers
          • ChannelQuery
          • ChannelQueryResult
          • ChannelRemove
          • ChannelSample
          • ChannelSnapshot
          • ChannelTelemetry
          • ChannelUpsert
          • Control
          • DARTWIC_SHARE_PROTOCOL_VERSION
          • DARTWICShareProtocol
          • DisconnectedError
          • FixedGenerationTelemetry
          • FixedGenerationWrite
          • Goodbye
          • Hello
          • normalizeArgusChannelReferenceForViewer
          • normalizeArgusEventForViewer
          • normalizeArgusQueryForTarget
          • RemoteError
          • RemoteOperationError
          • Request
          • RequestTimeoutError
          • Response
          • SessionIdentity
          • Share Protocol Reference
          • ShareError
          • ShareProtocolConfig
          • ShareTransportPtr
          • Success
          • Telemetry
          • TransportError
          • TransportState
          • Unsupported
          • ValidationError
          • Value
        • Share Protocol and Transport SDK Reference
        • Transport
          • Share Transport Reference
          • ShareTransport
          • TransportCallbacks
  • Clients
    • Overview
    • Python Client
    • Node.js Client
    • C++ Client
    • React Client
    • C++ Share Client
    • Reference
      • C++
        • C++ Client Reference
        • ClientConfig
        • DartwicClient
        • HistoryQuery
      • Client Reference
      • Node.Js
        • DartwicClient
        • Node.js Client Reference
      • Python
        • DartwicClient
        • Python Client Reference
        • Version Constants
      • React
        • DartwicContext
        • DartwicProvider
        • React Client Reference
        • useDartwic
        • useDartwicChannel
        • useDartwicChannels
        • useDartwicChannelValues
      • Share
        • C++ Share Client Reference
        • DARTWICShareClient
        • ShareClientConfig

No matching pages.

On this page

On this page

Overview Categories Back to top ↑
Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Interface Plugin SDK Reference

Public TypeScript exports for extending the DARTWIC interface.

Categories

CategoryEntries
DARTWIC UI Components29
Hooks and Utilities12
Markdown13
Module Configuration9
Plugin Registration11
Plugin Settings4
Resources7
Runtime3
Schematic Nodes8
Styling1
Tasks10
UI Components68
Kempton Burton

Engineering, software, and other things.

© 2026Top ↑

Areas

All areas DARTWICB-2 Spirit Maintenance PlatformDACS Box for Rocket Engine Testing

Recent

No posts yet

Elsewhere

About me LinkedIn ↗ All posts