openc3-cosmos-tool-docs 5.17.1 → 5.18.0

data/tools/staticdocs/assets/js/6831b732.5714d508.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9527],{5867:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var n=i(1085),s=i(1184);const t={sidebar_position:2,title:"Plugins"},l=void 0,d={id:"configuration/plugins",title:"Plugins",description:"Introduction",source:"@site/docs/configuration/plugins.md",sourceDirName:"configuration",slug:"/configuration/plugins",permalink:"/tools/staticdocs/docs/configuration/plugins",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/plugins.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2,title:"Plugins"},sidebar:"defaultSidebar",previous:{title:"File Format",permalink:"/tools/staticdocs/docs/configuration/format"},next:{title:"Targets",permalink:"/tools/staticdocs/docs/configuration/target"}},c={},h=[{value:"Introduction",id:"introduction",level:2},{value:"Concepts",id:"concepts",level:2},{value:"Target",id:"target",level:3},{value:"Interface",id:"interface",level:3},{value:"Router",id:"router",level:3},{value:"Tool",id:"tool",level:3},{value:"Microservice",id:"microservice",level:3},{value:"Plugin Directory Structure",id:"plugin-directory-structure",level:2},{value:"plugin.txt Configuration File",id:"plugintxt-configuration-file",level:2},{value:"VARIABLE",id:"variable",level:2},{value:"NEEDS_DEPENDENCIES",id:"needs_dependencies",level:2},{value:"INTERFACE",id:"interface-1",level:2},{value:"INTERFACE Modifiers",id:"interface-modifiers",level:2},{value:"MAP_TARGET",id:"map_target",level:3},{value:"MAP_CMD_TARGET",id:"map_cmd_target",level:3},{value:"MAP_TLM_TARGET",id:"map_tlm_target",level:3},{value:"DONT_CONNECT",id:"dont_connect",level:3},{value:"DONT_RECONNECT",id:"dont_reconnect",level:3},{value:"RECONNECT_DELAY",id:"reconnect_delay",level:3},{value:"DISABLE_DISCONNECT",id:"disable_disconnect",level:3},{value:"LOG_RAW",id:"log_raw",level:3},{value:"LOG_STREAM",id:"log_stream",level:3},{value:"PROTOCOL",id:"protocol",level:3},{value:"OPTION",id:"option",level:3},{value:"SECRET",id:"secret",level:3},{value:"ENV",id:"env",level:3},{value:"WORK_DIR",id:"work_dir",level:3},{value:"PORT",id:"port",level:3},{value:"CMD",id:"cmd",level:3},{value:"CONTAINER",id:"container",level:3},{value:"ROUTE_PREFIX",id:"route_prefix",level:3},{value:"ROUTER",id:"router-1",level:2},{value:"TARGET",id:"target-1",level:2},{value:"TARGET Modifiers",id:"target-modifiers",level:2},{value:"CMD_BUFFER_DEPTH",id:"cmd_buffer_depth",level:3},{value:"CMD_LOG_CYCLE_TIME",id:"cmd_log_cycle_time",level:3},{value:"CMD_LOG_CYCLE_SIZE",id:"cmd_log_cycle_size",level:3},{value:"CMD_LOG_RETAIN_TIME",id:"cmd_log_retain_time",level:3},{value:"CMD_DECOM_LOG_CYCLE_TIME",id:"cmd_decom_log_cycle_time",level:3},{value:"CMD_DECOM_LOG_CYCLE_SIZE",id:"cmd_decom_log_cycle_size",level:3},{value:"CMD_DECOM_LOG_RETAIN_TIME",id:"cmd_decom_log_retain_time",level:3},{value:"TLM_BUFFER_DEPTH",id:"tlm_buffer_depth",level:3},{value:"TLM_LOG_CYCLE_TIME",id:"tlm_log_cycle_time",level:3},{value:"TLM_LOG_CYCLE_SIZE",id:"tlm_log_cycle_size",level:3},{value:"TLM_LOG_RETAIN_TIME",id:"tlm_log_retain_time",level:3},{value:"TLM_DECOM_LOG_CYCLE_TIME",id:"tlm_decom_log_cycle_time",level:3},{value:"TLM_DECOM_LOG_CYCLE_SIZE",id:"tlm_decom_log_cycle_size",level:3},{value:"TLM_DECOM_LOG_RETAIN_TIME",id:"tlm_decom_log_retain_time",level:3},{value:"REDUCED_MINUTE_LOG_RETAIN_TIME",id:"reduced_minute_log_retain_time",level:3},{value:"REDUCED_HOUR_LOG_RETAIN_TIME",id:"reduced_hour_log_retain_time",level:3},{value:"REDUCED_DAY_LOG_RETAIN_TIME",id:"reduced_day_log_retain_time",level:3},{value:"LOG_RETAIN_TIME",id:"log_retain_time",level:3},{value:"REDUCED_LOG_RETAIN_TIME",id:"reduced_log_retain_time",level:3},{value:"CLEANUP_POLL_TIME",id:"cleanup_poll_time",level:3},{value:"REDUCER_DISABLE",id:"reducer_disable",level:3},{value:"REDUCER_MAX_CPU_UTILIZATION",id:"reducer_max_cpu_utilization",level:3},{value:"TARGET_MICROSERVICE",id:"target_microservice",level:3},{value:"PACKET",id:"packet",level:3},{value:"DISABLE_ERB",id:"disable_erb",level:3},{value:"MICROSERVICE",id:"microservice-1",level:2},{value:"MICROSERVICE Modifiers",id:"microservice-modifiers",level:2},{value:"ENV",id:"env-1",level:3},{value:"WORK_DIR",id:"work_dir-1",level:3},{value:"PORT",id:"port-1",level:3},{value:"TOPIC",id:"topic",level:3},{value:"TARGET_NAME",id:"target_name",level:3},{value:"CMD",id:"cmd-1",level:3},{value:"OPTION",id:"option-1",level:3},{value:"CONTAINER",id:"container-1",level:3},{value:"SECRET",id:"secret-1",level:3},{value:"ROUTE_PREFIX",id:"route_prefix-1",level:3},{value:"DISABLE_ERB",id:"disable_erb-1",level:3},{value:"TOOL",id:"tool-1",level:2},{value:"TOOL Modifiers",id:"tool-modifiers",level:2},{value:"URL",id:"url",level:3},{value:"INLINE_URL",id:"inline_url",level:3},{value:"WINDOW",id:"window",level:3},{value:"ICON",id:"icon",level:3},{value:"CATEGORY",id:"category",level:3},{value:"SHOWN",id:"shown",level:3},{value:"POSITION",id:"position",level:3},{value:"DISABLE_ERB",id:"disable_erb-2",level:3},{value:"WIDGET",id:"widget",level:2},{value:"WIDGET Modifiers",id:"widget-modifiers",level:2},{value:"DISABLE_ERB",id:"disable_erb-3",level:3}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h2,{id:"introduction",children:"Introduction"}),"\n",(0,n.jsx)(r.p,{children:"This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS."}),"\n",(0,n.jsx)(r.p,{children:"Plugins are where you define targets (and their corresponding command and telemetry packet definitions), where you configure the interfaces needed to talk to targets, where you can define routers to stream raw data out of COSMOS, how you can add new tools to the COSMOS user interface, and how you can run additional microservices to provide new functionality."}),"\n",(0,n.jsx)(r.p,{children:"Each plugin is built as a Ruby gem and thus has a plugin.gemspec file which builds it. Plugins have a plugin.txt file which declares all the variables used by the plugin and how to interface to the target(s) it contains."}),"\n",(0,n.jsx)(r.h2,{id:"concepts",children:"Concepts"}),"\n",(0,n.jsx)(r.h3,{id:"target",children:"Target"}),"\n",(0,n.jsx)(r.p,{children:"Targets are the external pieces of hardware and/or software that COSMOS communicates with. These are things like Front End Processors (FEPs), ground support equipment (GSE), custom software tools, and pieces of hardware like satellites themselves. A target is anything that COSMOS can send commands to and receive telemetry from."}),"\n",(0,n.jsx)(r.h3,{id:"interface",children:"Interface"}),"\n",(0,n.jsx)(r.p,{children:"Interfaces implement the physical connection to one or more targets. They are typically ethernet connections implemented using TCP or UDP but can be other connections like serial ports. Interfaces send commands to targets and receive telemetry from targets."}),"\n",(0,n.jsx)(r.h3,{id:"router",children:"Router"}),"\n",(0,n.jsx)(r.p,{children:"Routers flow streams of telemetry packets out of COSMOS and receive streams of commands into COSMOS. The commands are forwarded by COSMOS to associated interfaces. Telemetry comes from associated interfaces."}),"\n",(0,n.jsx)(r.h3,{id:"tool",children:"Tool"}),"\n",(0,n.jsx)(r.p,{children:"COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts."}),"\n",(0,n.jsx)(r.h3,{id:"microservice",children:"Microservice"}),"\n",(0,n.jsx)(r.p,{children:"Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks."}),"\n",(0,n.jsx)(r.h2,{id:"plugin-directory-structure",children:"Plugin Directory Structure"}),"\n",(0,n.jsxs)(r.p,{children:["COSMOS plugins have a well-defined directory structure described in detail in the ",(0,n.jsx)(r.a,{href:"../getting-started/generators",children:"Code Generator"})," documentation."]}),"\n",(0,n.jsx)(r.h2,{id:"plugintxt-configuration-file",children:"plugin.txt Configuration File"}),"\n",(0,n.jsx)(r.p,{children:"A plugin.txt configuration file is required for any COSMOS plugin. It declares the contents of the plugin and provides variables that allow the plugin to be configured at the time it is initially installed or upgraded.\nThis file follows the standard COSMOS configuration file format of keywords followed by zero or more space separated parameters. The following keywords are supported by the plugin.txt config file:"}),"\n",(0,n.jsx)(r.h2,{id:"variable",children:"VARIABLE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a configurable variable for the plugin"})}),"\n",(0,n.jsx)(r.p,{children:"The VARIABLE keyword defines a variable that will be requested for the user to enter during plugin installation.   Variables can be used to handle details of targets that are user defined such as specific IP addresses and ports.  Variables should also be used to allow users to rename targets to whatever name they want and support multiple installations of the same target with different names. Variables can be used later in plugin.txt or in any other configuration file included in a plugin using Ruby ERB syntax.  The variables are assigned to accessible local variables in the file. At a high level, ERB allows you to run Ruby code in configuration files."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Variable Name"}),(0,n.jsx)(r.td,{children:"The name of the variable"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Default Value"}),(0,n.jsx)(r.td,{children:"Default value of the variable"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.h2,{id:"needs_dependencies",children:"NEEDS_DEPENDENCIES"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.0)"}),(0,n.jsx)(r.strong,{children:"Indicates the plugin needs dependencies and sets the GEM_HOME environment variable"})]}),"\n",(0,n.jsx)(r.p,{children:"If the plugin has a top level lib folder or lists runtime dependencies in the gemspec, NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod."}),"\n",(0,n.jsx)(r.h2,{id:"interface-1",children:"INTERFACE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a connection to a physical target"})}),"\n",(0,n.jsx)(r.p,{children:"Interfaces are what OpenC3 uses to talk to a particular piece of hardware. Interfaces require a Ruby file which implements all the interface methods necessary to talk to the hardware. OpenC3 defines many built in interfaces or you can define your own as long as it implements the interface protocol."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Interface Name"}),(0,n.jsx)(r.td,{children:"Name of the interface. This name will appear in the Interfaces tab of the Server and is also referenced by other keywords. The OpenC3 convention is to name interfaces after their targets with '_INT' appended to the name, e.g. INST_INT for the INST target."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Filename"}),(0,n.jsxs)(r.td,{children:["Ruby file to use when instantiating the interface.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb"})]}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsxs)(r.p,{children:["Additional parameters are required. Please see the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/interfaces",children:"Interfaces"})," documentation for more details."]}),"\n",(0,n.jsx)(r.h2,{id:"interface-modifiers",children:"INTERFACE Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a INTERFACE keyword."}),"\n",(0,n.jsx)(r.h3,{id:"map_target",children:"MAP_TARGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Maps a target name to an interface"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TARGET DATA\n"})}),"\n",(0,n.jsx)(r.h3,{id:"map_cmd_target",children:"MAP_CMD_TARGET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Maps a target name to an interface for commands only"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Command target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface\n"})}),"\n",(0,n.jsx)(r.h3,{id:"map_tlm_target",children:"MAP_TLM_TARGET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Maps a target name to an interface for telemetry only"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"Telemetry target name to map to this interface"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface\n"})}),"\n",(0,n.jsx)(r.h3,{id:"dont_connect",children:"DONT_CONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Server will not automatically try to connect to the interface at startup"})}),"\n",(0,n.jsx)(r.h3,{id:"dont_reconnect",children:"DONT_RECONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Server will not try to reconnect to the interface if the connection is lost"})}),"\n",(0,n.jsx)(r.h3,{id:"reconnect_delay",children:"RECONNECT_DELAY"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Reconnect delay in seconds"})}),"\n",(0,n.jsx)(r.p,{children:"If DONT_RECONNECT is not present the Server will try to reconnect to an interface if the connection is lost. Reconnect delay sets the interval in seconds between reconnect tries."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Delay"}),(0,n.jsx)(r.td,{children:"Delay in seconds between reconnect attempts. The default is 15 seconds."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_disconnect",children:"DISABLE_DISCONNECT"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Disable the Disconnect button on the Interfaces tab in the Server"})}),"\n",(0,n.jsx)(r.p,{children:"Use this keyword to prevent the user from disconnecting from the interface. This is typically used in a 'production' environment where you would not want the user to inadvertantly disconnect from a target."}),"\n",(0,n.jsx)(r.h3,{id:"log_raw",children:"LOG_RAW"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Deprecated, use LOG_STREAM"})}),"\n",(0,n.jsx)(r.h3,{id:"log_stream",children:"LOG_STREAM"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.2)"}),(0,n.jsx)(r.strong,{children:"Log all data on the interface exactly as it is sent and received"})]}),"\n",(0,n.jsx)(r.p,{children:"LOG_STREAM does not add any OpenC3 headers and thus can not be read by OpenC3 tools. It is primarily useful for low level debugging of an interface. You will have to manually parse these logs yourself using a hex editor or other application."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Time"}),(0,n.jsx)(r.td,{children:"Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Size"}),(0,n.jsx)(r.td,{children:"Amount of data to write before cycling the log file. Default is 50MB."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Hour"}),(0,n.jsx)(r.td,{children:"The time at which to cycle the log. Combined with Cycle Minute to cycle the log daily at the specified time. If nil, the log will be cycled hourly at the specified Cycle Minute. Only applies if Cycle Time is nil."}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Cycle Minute"}),(0,n.jsx)(r.td,{children:"See Cycle Hour."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE EXAMPLE example_interface.rb\n  # Override the default log time of 600\n  LOG_STREAM 60\n"})}),"\n",(0,n.jsx)(r.h3,{id:"protocol",children:"PROTOCOL"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 4.0.0)"}),(0,n.jsx)(r.strong,{children:"Protocols modify the interface by processing the data"})]}),"\n",(0,n.jsxs)(r.p,{children:["Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data received by the interface while write acts on the data before it is sent out. READ_WRITE applies the protocol to both reading and writing.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{})," For information on creating your own custom protocol please see ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/protocols",children:"Protocols"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsxs)(r.td,{children:["Whether to apply the protocol on incoming data, outgoing data, or both",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"READ, WRITE, READ_WRITE"})]}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol Filename or Classname"}),(0,n.jsx)(r.td,{children:"Ruby filename or class name which implements the protocol"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol specific parameters"}),(0,n.jsx)(r.td,{children:"Additional parameters used by the protocol"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil\n  MAP_TARGET DATA\n  # Rather than defining the LENGTH protocol on the INTERFACE line we define it here\n  PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11\nINTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TARGET DATA\n  PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets\n"})}),"\n",(0,n.jsx)(r.h3,{id:"option",children:"OPTION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set a parameter on an interface"})}),"\n",(0,n.jsx)(r.p,{children:"When an option is set the interface class calls the set_option method. Custom interfaces can override set_option to handle any additional options they want."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"The option to set. OpenC3 defines several options on the core provided interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS and DATA_BITS which changes the data bits of the serial interface. The TcpipServerInterface and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0)."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Parameters"}),(0,n.jsx)(r.td,{children:"Parameters to pass to the option"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil\n  OPTION FLOW_CONTROL RTSCTS\n  OPTION DATA_BITS 8\nROUTER SERIAL_ROUTER tcpip_server_interface.rb 2950 2950 10.0 nil BURST\n  ROUTE SERIAL_INT\n  OPTION LISTEN_ADDRESS 127.0.0.1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"secret",children:"SECRET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.3.0)"}),(0,n.jsx)(r.strong,{children:"Define a secret needed by this interface"})]}),"\n",(0,n.jsx)(r.p,{children:"Defines a secret for this interface and optionally assigns its value to an option"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Name"}),(0,n.jsx)(r.td,{children:"The name of the secret to retrieve"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Environment Variable or File Path"}),(0,n.jsx)(r.td,{children:"Environment variable name or file path to store secret"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Name"}),(0,n.jsx)(r.td,{children:"Interface option to pass the secret value"}),(0,n.jsx)(r.td,{children:"False"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Store Name"}),(0,n.jsx)(r.td,{children:"Name of the secret store for stores with multipart keys"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:'SECRET ENV USERNAME ENV_USERNAME USERNAME\nSECRET FILE KEY "/tmp/DATA/cert" KEY\n'})}),"\n",(0,n.jsx)(r.h3,{id:"env",children:"ENV"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Sets an environment variable in the microservice."})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Key"}),(0,n.jsx)(r.td,{children:"Environment variable name"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Value"}),(0,n.jsx)(r.td,{children:"Environment variable value"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"ENV COMPANY OpenC3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"work_dir",children:"WORK_DIR"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Set the working directory"})]}),"\n",(0,n.jsx)(r.p,{children:"Working directory to run the microservice CMD in.  Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Directory"}),(0,n.jsx)(r.td,{children:"Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"WORK_DIR '/openc3/lib/openc3/microservices'\n"})}),"\n",(0,n.jsx)(r.h3,{id:"port",children:"PORT"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Open port for the microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Number"}),(0,n.jsx)(r.td,{children:"Port number"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol"}),(0,n.jsx)(r.td,{children:"Port protocol. Default is TCP."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"PORT 7272\n"})}),"\n",(0,n.jsx)(r.h3,{id:"cmd",children:"CMD"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Command line to execute to run the microservice."})]}),"\n",(0,n.jsx)(r.p,{children:"Command line to execute to run the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"One or more arguments to exec to run the microservice."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"container",children:"CONTAINER"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Docker Container"})]}),"\n",(0,n.jsx)(r.p,{children:"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"Name of the container"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"route_prefix",children:"ROUTE_PREFIX"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.7.0)"}),(0,n.jsx)(r.strong,{children:"Prefix of route"})]}),"\n",(0,n.jsx)(r.p,{children:"Prefix of route to the microservice to expose externally with Traefik"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Route Prefix"}),(0,n.jsx)(r.td,{children:"Route prefix. Must be unique across all scopes. Something like /myprefix"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"ROUTE_PREFIX /interface\n"})}),"\n",(0,n.jsx)(r.h2,{id:"router-1",children:"ROUTER"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Create router to receive commands and output telemetry packets from one or more interfaces"})}),"\n",(0,n.jsx)(r.p,{children:"Creates an router which receives command packets from their remote clients and sends them to associated interfaces. They receive telemetry packets from their interfaces and send them to their remote clients. This allows routers to be intermediaries between an external client and an actual device."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"Name of the router"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Filename"}),(0,n.jsxs)(r.td,{children:["Ruby file to use when instantiating the interface.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb"})]}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsxs)(r.p,{children:["Additional parameters are required. Please see the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/configuration/interfaces",children:"Interfaces"})," documentation for more details."]}),"\n",(0,n.jsx)(r.h2,{id:"target-1",children:"TARGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a new target"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Folder Name"}),(0,n.jsx)(r.td,{children:"The target folder"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Name"}),(0,n.jsx)(r.td,{children:"The target name. While this is almost always the same as Folder Name it can be different to create multiple targets based on the same target folder."}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"TARGET INST INST\n"})}),"\n",(0,n.jsx)(r.h2,{id:"target-modifiers",children:"TARGET Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a TARGET keyword."}),"\n",(0,n.jsx)(r.h3,{id:"cmd_buffer_depth",children:"CMD_BUFFER_DEPTH"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Number of commands to buffer to ensure logged in order"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Buffer Depth"}),(0,n.jsx)(r.td,{children:"Buffer depth in packets (Default = 5)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_cycle_time",children:"CMD_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command binary logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_cycle_size",children:"CMD_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command binary logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_log_retain_time",children:"CMD_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep raw command logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep raw command logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_cycle_time",children:"CMD_DECOM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command decommutation logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_cycle_size",children:"CMD_DECOM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command decommutation logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cmd_decom_log_retain_time",children:"CMD_DECOM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep decom command logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep decom command logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_buffer_depth",children:"TLM_BUFFER_DEPTH"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Number of telemetry packets to buffer to ensure logged in order"})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Buffer Depth"}),(0,n.jsx)(r.td,{children:"Buffer depth in packets (Default = 60)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_cycle_time",children:"TLM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry binary logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_cycle_size",children:"TLM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry binary logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_log_retain_time",children:"TLM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep raw telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep raw telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_cycle_time",children:"TLM_DECOM_LOG_CYCLE_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry decommutation logs can be cycled on a time interval."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Maximum time between files in seconds (default = 600)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_cycle_size",children:"TLM_DECOM_LOG_CYCLE_SIZE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Telemetry decommutation logs can be cycled after a certain log file size is reached."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Size"}),(0,n.jsx)(r.td,{children:"Maximum file size in bytes (default = 50_000_000)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"tlm_decom_log_retain_time",children:"TLM_DECOM_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep decom telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep decom telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_minute_log_retain_time",children:"REDUCED_MINUTE_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced minute telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_hour_log_retain_time",children:"REDUCED_HOUR_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced hour telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_day_log_retain_time",children:"REDUCED_DAY_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep reduced day telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep reduced day telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"log_retain_time",children:"LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep all regular telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep all regular telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reduced_log_retain_time",children:"REDUCED_LOG_RETAIN_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How long to keep all reduced telemetry logs in seconds."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds to keep all reduced telemetry logs (default = nil = Forever)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"cleanup_poll_time",children:"CLEANUP_POLL_TIME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Period at which to run the cleanup process."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Time"}),(0,n.jsx)(r.td,{children:"Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"reducer_disable",children:"REDUCER_DISABLE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Disables the data reduction microservice for the target"})}),"\n",(0,n.jsx)(r.h3,{id:"reducer_max_cpu_utilization",children:"REDUCER_MAX_CPU_UTILIZATION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Maximum amount of CPU utilization to apply to data reduction"})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Percentage"}),(0,n.jsx)(r.td,{children:"0 to 100 percent (default = 30)"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"target_microservice",children:"TARGET_MICROSERVICE"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Breaks a target microservice out into its own process."})]}),"\n",(0,n.jsx)(r.p,{children:"Can be used to give more resources to processing that is falling behind. If defined multiple times for the same type, will create multiple processes. Each process can be given specific packets to process with the PACKET keyword."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"packet",children:"PACKET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.2.0)"}),(0,n.jsx)(r.strong,{children:"Packet Name to allocate to the current TARGET_MICROSERVICE."})]}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Packet Name"}),(0,n.jsx)(r.td,{children:"The packet name. Does not apply to REDUCER or CLEANUP target microservice types."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire target or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"microservice-1",children:"MICROSERVICE"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Defines a new microservice"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Microservice Folder Name"}),(0,n.jsx)(r.td,{children:"The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Microservice Name"}),(0,n.jsx)(r.td,{children:"The specific name of this instance of the microservice in the OpenC3 system"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n"})}),"\n",(0,n.jsx)(r.h2,{id:"microservice-modifiers",children:"MICROSERVICE Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a MICROSERVICE keyword."}),"\n",(0,n.jsx)(r.h3,{id:"env-1",children:"ENV"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Sets an environment variable in the microservice."})}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Key"}),(0,n.jsx)(r.td,{children:"Environment variable name"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Value"}),(0,n.jsx)(r.td,{children:"Environment variable value"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  ENV COMPANY OpenC3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"work_dir-1",children:"WORK_DIR"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set the working directory"})}),"\n",(0,n.jsx)(r.p,{children:"Working directory to run the microservice CMD in.  Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Directory"}),(0,n.jsx)(r.td,{children:"Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  WORK_DIR .\n"})}),"\n",(0,n.jsx)(r.h3,{id:"port-1",children:"PORT"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,n.jsx)(r.strong,{children:"Open port for the microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Number"}),(0,n.jsx)(r.td,{children:"Port number"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Protocol"}),(0,n.jsx)(r.td,{children:"Port protocol. Default is TCP."}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  PORT 7272\n"})}),"\n",(0,n.jsx)(r.h3,{id:"topic",children:"TOPIC"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Associate a Redis topic"})}),"\n",(0,n.jsx)(r.p,{children:"Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Topic Name"}),(0,n.jsx)(r.td,{children:"Redis Topic to associate with the microservice"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  # Manually assigning topics is an advanced topic and requires\n  # intimate knowledge of the internal COSMOS data structures.\n  TOPIC DEFAULT__openc3_log_messages\n  TOPIC DEFAULT__TELEMETRY__EXAMPLE__STATUS\n"})}),"\n",(0,n.jsx)(r.h3,{id:"target_name",children:"TARGET_NAME"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Associate a OpenC3 target"})}),"\n",(0,n.jsx)(r.p,{children:"OpenC3 target to associate with the microservice. For standard OpenC3 microservices such as decom_microservice this causes the target configuration to get loaded into the container for the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Target Name"}),(0,n.jsx)(r.td,{children:"OpenC3 target to associate with the microservice"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  TARGET_NAME EXAMPLE\n"})}),"\n",(0,n.jsx)(r.h3,{id:"cmd-1",children:"CMD"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Command line to execute to run the microservice."})}),"\n",(0,n.jsx)(r.p,{children:"Command line to execute to run the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"One or more arguments to exec to run the microservice."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE EXAMPLE openc3-example\n  CMD ruby example_target.rb\n"})}),"\n",(0,n.jsx)(r.h3,{id:"option-1",children:"OPTION"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Pass an option to the microservice"})}),"\n",(0,n.jsx)(r.p,{children:"Generic key/value(s) options to pass to the microservice. These take the form of KEYWORD/PARAMS like a line in a OpenC3 configuration file. Multiple OPTION keywords can be used to pass multiple options to the microservice."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Name"}),(0,n.jsx)(r.td,{children:"Name of the option"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Option Value(s)"}),(0,n.jsx)(r.td,{children:"One or more values to associate with the option"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.h3,{id:"container-1",children:"CONTAINER"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Docker Container"})}),"\n",(0,n.jsx)(r.p,{children:"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Args"}),(0,n.jsx)(r.td,{children:"Name of the container"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"secret-1",children:"SECRET"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.3.0)"}),(0,n.jsx)(r.strong,{children:"Define a secret needed by this microservice"})]}),"\n",(0,n.jsx)(r.p,{children:"Defines a secret for this microservice"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Type"}),(0,n.jsx)(r.td,{children:"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Name"}),(0,n.jsx)(r.td,{children:"The name of the secret to retrieve"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Environment Variable or File Path"}),(0,n.jsx)(r.td,{children:"Environment variable name or file path to store secret"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Secret Store Name"}),(0,n.jsx)(r.td,{children:"Name of the secret store for stores with multipart keys"}),(0,n.jsx)(r.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:'SECRET ENV USERNAME ENV_USERNAME\nSECRET FILE KEY "/tmp/DATA/cert"\n'})}),"\n",(0,n.jsx)(r.h3,{id:"route_prefix-1",children:"ROUTE_PREFIX"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.0)"}),(0,n.jsx)(r.strong,{children:"Prefix of route"})]}),"\n",(0,n.jsx)(r.p,{children:"Prefix of route to the microservice to expose externally with Traefik"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Route Prefix"}),(0,n.jsx)(r.td,{children:"Route prefix. Must be unique across all scopes. Something like /myprefix"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"MICROSERVICE CFDP CFDP\n  ROUTE_PREFIX /cfdp\n"})}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-1",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire microservice or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"tool-1",children:"TOOL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a tool"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a tool that the plugin adds to the OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Tool Folder Name"}),(0,n.jsx)(r.td,{children:"The exact name of the tool folder in the plugin. ie. tools/ToolFolderName"}),(0,n.jsx)(r.td,{children:"True"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Tool Name"}),(0,n.jsx)(r.td,{children:"Name of the tool that is displayed in the OpenC3 Navigation menu"}),(0,n.jsx)(r.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"TOOL DEMO Demo\n"})}),"\n",(0,n.jsx)(r.h2,{id:"tool-modifiers",children:"TOOL Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a TOOL keyword."}),"\n",(0,n.jsx)(r.h3,{id:"url",children:"URL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Url used to access the tool"})}),"\n",(0,n.jsx)(r.p,{children:'The relative url used to access the tool. Defaults to "/tools/ToolFolderName".'}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Url"}),(0,n.jsx)(r.td,{children:"The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"inline_url",children:"INLINE_URL"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Internal url to load a tool"})}),"\n",(0,n.jsx)(r.p,{children:'The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".'}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Url"}),(0,n.jsx)(r.td,{children:"The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename."}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"window",children:"WINDOW"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"How to display the tool when navigated to"})}),"\n",(0,n.jsx)(r.p,{children:"The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within OpenC3. NEW opens the tool in a new TAB."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Window Mode"}),(0,n.jsxs)(r.td,{children:["Tool display mode",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"INLINE, IFRAME, NEW"})]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"icon",children:"ICON"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Set tool icon"})}),"\n",(0,n.jsx)(r.p,{children:"Icon shown next to the tool name in the OpenC3 navigation menu."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Icon Name"}),(0,n.jsxs)(r.td,{children:["Icon to display next to the tool name. Icons come from Font Awesome, Material Design (",(0,n.jsx)(r.a,{href:"https://materialdesignicons.com/",children:"https://materialdesignicons.com/"}),"), and Astro."]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"category",children:"CATEGORY"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Category for the tool"})}),"\n",(0,n.jsx)(r.p,{children:"Associates the tool with a category which becomes a submenu in the Navigation menu."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Category Name"}),(0,n.jsx)(r.td,{children:"Category to associate the tool with"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"shown",children:"SHOWN"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Show the tool or not"})}),"\n",(0,n.jsx)(r.p,{children:"Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Shown"}),(0,n.jsxs)(r.td,{children:["Whether or not the tool is shown.  TRUE or FALSE",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"true, false"})]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"position",children:"POSITION"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.0.8)"}),(0,n.jsx)(r.strong,{children:"Position of the tool in the nav bar"})]}),"\n",(0,n.jsx)(r.p,{children:"Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Position"}),(0,n.jsx)(r.td,{children:"Numerical position"}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-2",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire tool or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(r.h2,{id:"widget",children:"WIDGET"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.strong,{children:"Define a custom widget"})}),"\n",(0,n.jsx)(r.p,{children:"Defines a custom widget that can be used in Telemetry Viewer screens."}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Widget Name"}),(0,n.jsxs)(r.td,{children:["The name of the widget wil be used to build a path to the widget implementation. For example, ",(0,n.jsx)(r.code,{children:"WIDGET HELLOWORLD"})," will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the ",(0,n.jsx)(r.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide for more details."]}),(0,n.jsx)(r.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(r.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ruby",children:"WIDGET HELLOWORLD\n"})}),"\n",(0,n.jsx)(r.h2,{id:"widget-modifiers",children:"WIDGET Modifiers"}),"\n",(0,n.jsx)(r.p,{children:"The following keywords must follow a WIDGET keyword."}),"\n",(0,n.jsx)(r.h3,{id:"disable_erb-3",children:"DISABLE_ERB"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.12.0)"}),(0,n.jsx)(r.strong,{children:"Disable ERB processing"})]}),"\n",(0,n.jsx)(r.p,{children:"Disable ERB processing for the entire widget or a set of regular expressions over its filenames"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Parameter"}),(0,n.jsx)(r.th,{children:"Description"}),(0,n.jsx)(r.th,{children:"Required"})]})}),(0,n.jsx)(r.tbody,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"Regex"}),(0,n.jsx)(r.td,{children:"Regex to match against filenames. If match, then no ERB processing"}),(0,n.jsx)(r.td,{children:"False"})]})})]})]})}function a(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},1184:(e,r,i)=>{i.d(r,{R:()=>l});var n=i(4041);const s={},t=n.createContext(s);function l(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}}}]);

data/tools/staticdocs/assets/js/6f92e431.300a9857.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9729],{5520:(e,s,t)=>{t.r(s),t.d(s,{assets:()=>r,contentTitle:()=>o,default:()=>m,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var n=t(1085),i=t(1184);const a={title:"Roadmap"},o=void 0,l={id:"development/roadmap",title:"Roadmap",description:"Key Features Still to Come in OpenC3 COSMOS 5.x:",source:"@site/docs/development/roadmap.md",sourceDirName:"development",slug:"/development/roadmap",permalink:"/tools/staticdocs/docs/development/roadmap",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/roadmap.md",tags:[],version:"current",frontMatter:{title:"Roadmap"},sidebar:"defaultSidebar",previous:{title:"Log Structure",permalink:"/tools/staticdocs/docs/development/log-structure"},next:{title:"Streaming API",permalink:"/tools/staticdocs/docs/development/streaming-api"}},r={},c=[{value:"Key Features Still to Come in OpenC3 COSMOS 5.x:",id:"key-features-still-to-come-in-openc3-cosmos-5x",level:2},{value:"OpenC3 COSMOS 6.0 (Summer 2024)",id:"openc3-cosmos-60-summer-2024",level:2},{value:"OpenC3 COSMOS 7.0 (Summer 2025)",id:"openc3-cosmos-70-summer-2025",level:2},{value:"Near-term Quarterly Roadmap",id:"near-term-quarterly-roadmap",level:2}];function d(e){const s={a:"a",h2:"h2",input:"input",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h2,{id:"key-features-still-to-come-in-openc3-cosmos-5x",children:"Key Features Still to Come in OpenC3 COSMOS 5.x:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Command Authority (Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Critical Commanding (Two Operators - Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Log Message Extractor Tool (Enterprise)"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","System Health Tool (Enterprise)"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"openc3-cosmos-60-summer-2024",children:"OpenC3 COSMOS 6.0 (Summer 2024)"}),"\n",(0,n.jsx)(s.p,{children:"Core Features:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",checked:!0,disabled:!0})," ","Python Support"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Upgrade Tools to Vue 3 / Vuetify 3"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Plugin App Store"]}),"\n"]}),"\n",(0,n.jsx)(s.p,{children:"Functionality For 6.1+:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Standardized Mission Planning Interface (aka Command Load Generator (CLG))"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","libCSP Interface"]}),"\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Standardized Interfaces for All Common Message Buses"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"openc3-cosmos-70-summer-2025",children:"OpenC3 COSMOS 7.0 (Summer 2025)"}),"\n",(0,n.jsx)(s.p,{children:"Core Features:"}),"\n",(0,n.jsxs)(s.ul,{className:"contains-task-list",children:["\n",(0,n.jsxs)(s.li,{className:"task-list-item",children:[(0,n.jsx)(s.input,{type:"checkbox",disabled:!0})," ","Super Bridge - This will enable SaaS COSMOS and provide a secure method to communicate from a cloud server to an intranet for hardware control"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"near-term-quarterly-roadmap",children:"Near-term Quarterly Roadmap"}),"\n",(0,n.jsx)(s.p,{children:"Our near-term product roadmap linking to specific tickets is a Github Project found at the link below."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.a,{href:"https://github.com/orgs/openc3/projects/2/views/1",children:"Roadmap"})}),"\n",(0,n.jsx)(s.p,{children:"If you would like to commit feature ideas for our roadmap, please do so with normal Github issues at the main repo."})]})}function m(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1184:(e,s,t)=>{t.d(s,{R:()=>o});var n=t(4041);const i={},a=n.createContext(i);function o(e){const s=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}}}]);

data/tools/staticdocs/assets/js/72c6d8a8.cfccace6.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1524],{3294:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>l,contentTitle:()=>d,default:()=>o,frontMatter:()=>n,metadata:()=>a,toc:()=>h});var t=r(1085),i=r(1184);const n={sidebar_position:4,title:"Commands"},d=void 0,a={id:"configuration/command",title:"Commands",description:"Command Definition Files",source:"@site/docs/configuration/command.md",sourceDirName:"configuration",slug:"/configuration/command",permalink:"/tools/staticdocs/docs/configuration/command",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/command.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Commands"},sidebar:"defaultSidebar",previous:{title:"Targets",permalink:"/tools/staticdocs/docs/configuration/target"},next:{title:"Telemetry",permalink:"/tools/staticdocs/docs/configuration/telemetry"}},l={},h=[{value:"Command Definition Files",id:"command-definition-files",level:2},{value:"COMMAND",id:"command",level:2},{value:"COMMAND Modifiers",id:"command-modifiers",level:2},{value:"PARAMETER",id:"parameter",level:3},{value:"PARAMETER Modifiers",id:"parameter-modifiers",level:3},{value:"FORMAT_STRING",id:"format_string",level:4},{value:"UNITS",id:"units",level:4},{value:"DESCRIPTION",id:"description",level:4},{value:"META",id:"meta",level:4},{value:"OVERLAP",id:"overlap",level:4},{value:"KEY",id:"key",level:4},{value:"REQUIRED",id:"required",level:4},{value:"MINIMUM_VALUE",id:"minimum_value",level:4},{value:"MAXIMUM_VALUE",id:"maximum_value",level:4},{value:"DEFAULT_VALUE",id:"default_value",level:4},{value:"STATE",id:"state",level:4},{value:"WRITE_CONVERSION",id:"write_conversion",level:4},{value:"POLY_WRITE_CONVERSION",id:"poly_write_conversion",level:4},{value:"SEG_POLY_WRITE_CONVERSION",id:"seg_poly_write_conversion",level:4},{value:"GENERIC_WRITE_CONVERSION_START",id:"generic_write_conversion_start",level:4},{value:"GENERIC_WRITE_CONVERSION_END",id:"generic_write_conversion_end",level:4},{value:"OVERFLOW",id:"overflow",level:4},{value:"APPEND_PARAMETER",id:"append_parameter",level:3},{value:"ID_PARAMETER",id:"id_parameter",level:3},{value:"APPEND_ID_PARAMETER",id:"append_id_parameter",level:3},{value:"ARRAY_PARAMETER",id:"array_parameter",level:3},{value:"APPEND_ARRAY_PARAMETER",id:"append_array_parameter",level:3},{value:"SELECT_PARAMETER",id:"select_parameter",level:3},{value:"DELETE_PARAMETER",id:"delete_parameter",level:3},{value:"HIDDEN",id:"hidden",level:3},{value:"DISABLED",id:"disabled",level:3},{value:"DISABLE_MESSAGES",id:"disable_messages",level:3},{value:"META",id:"meta-1",level:3},{value:"HAZARDOUS",id:"hazardous",level:3},{value:"ACCESSOR",id:"accessor",level:3},{value:"TEMPLATE",id:"template",level:3},{value:"TEMPLATE_FILE",id:"template_file",level:3},{value:"RESPONSE",id:"response",level:3},{value:"ERROR_RESPONSE",id:"error_response",level:3},{value:"RELATED_ITEM",id:"related_item",level:3},{value:"SCREEN",id:"screen",level:3},{value:"SELECT_COMMAND",id:"select_command",level:2},{value:"Example File",id:"example-file",level:2}];function c(e){const s={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.h2,{id:"command-definition-files",children:"Command Definition Files"}),"\n",(0,t.jsxs)(s.p,{children:["Command definition files define the command packets that can be sent to COSMOS targets. One large file can be used to define the command packets, or multiple files can be used at the user's discretion. Command definition files are placed in the target's cmd_tlm directory and are processed alphabetically. Therefore if you have some command files that depend on others, e.g. they override or extend existing commands, they must be named last. The easist way to do this is to add an extension to an existing file name. For example, if you already have cmd.txt you can create cmd_override.txt for commands that depends on the definitions in cmd.txt. Also note that due to the way the ",(0,t.jsx)(s.a,{href:"http://www.asciitable.com/",children:"ASCII Table"})," is structured, files beginning with capital letters are processed before lower case letters."]}),"\n",(0,t.jsx)(s.p,{children:"When defining command parameters you can choose from the following data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data. The only difference between a STRING and BLOCK is when COSMOS reads the binary command log it stops reading a STRING type when it encounters a null byte (0). This shows up in the text log produced by Data Extractor. Note that this does NOT affect the data COSMOS writes as it's still legal to pass null bytes (0) in STRING parameters."}),"\n",(0,t.jsx)("div",{style:{clear:"both"}}),"\n",(0,t.jsx)(s.h1,{id:"command-keywords",children:"Command Keywords"}),"\n",(0,t.jsx)(s.h2,{id:"command",children:"COMMAND"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a new command packet"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target"}),(0,t.jsx)(s.td,{children:"Name of the target this command is associated with"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Command"}),(0,t.jsx)(s.td,{children:"Name of this command. Also referred to as its mnemonic. Must be unique to commands to this target. Ideally will be as short and clear as possible."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description of this command which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'COMMAND INST COLLECT BIG_ENDIAN "Start collect"\n'})}),"\n",(0,t.jsx)(s.h2,{id:"command-modifiers",children:"COMMAND Modifiers"}),"\n",(0,t.jsx)(s.p,{children:"The following keywords must follow a COMMAND keyword."}),"\n",(0,t.jsx)(s.h3,{id:"parameter",children:"PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a command parameter in the current command packet"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Offset"}),(0,t.jsx)(s.td,{children:"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of this parameter",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Minimum Value"}),(0,t.jsx)(s.td,{children:"Minimum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Maximum Value"}),(0,t.jsx)(s.td,{children:"Maximum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,t.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"\nPARAMETER DATA 32 32 INT MIN MAX 0 "Data value"\nPARAMETER VALUE 64 32 FLOAT 0 10.5 2.5\nPARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"\nPARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"parameter-modifiers",children:"PARAMETER Modifiers"}),"\n",(0,t.jsx)(s.p,{children:"The following keywords must follow a PARAMETER keyword."}),"\n",(0,t.jsx)(s.h4,{id:"format_string",children:"FORMAT_STRING"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Adds printf style formatting"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Format"}),(0,t.jsx)(s.td,{children:"How to format using printf syntax. For example, '0x%0X' will display the value in hex."}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'FORMAT_STRING "0x%0X"\n'})}),"\n",(0,t.jsx)(s.h4,{id:"units",children:"UNITS"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Add displayed units"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Full Name"}),(0,t.jsx)(s.td,{children:"Full name of the units type, e.g. Celsius"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Abbreviated"}),(0,t.jsx)(s.td,{children:"Abbreviation for the units, e.g. C"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"UNITS Celsius C\nUNITS Kilometers KM\n"})}),"\n",(0,t.jsx)(s.h4,{id:"description",children:"DESCRIPTION"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Override the defined description"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Value"}),(0,t.jsx)(s.td,{children:"The new description"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"meta",children:"META"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Stores custom user metadata"})}),"\n",(0,t.jsx)(s.p,{children:"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Meta Name"}),(0,t.jsx)(s.td,{children:"Name of the metadata to store"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Meta Values"}),(0,t.jsx)(s.td,{children:"One or more values to be stored for this Meta Name"}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'META TEST "This parameter is for test purposes only"\n'})}),"\n",(0,t.jsx)(s.h4,{id:"overlap",children:"OVERLAP"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 4.4.1)"}),(0,t.jsx)(s.strong,{children:"This item is allowed to overlap other items in the packet"})]}),"\n",(0,t.jsx)(s.p,{children:"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message."}),"\n",(0,t.jsx)(s.h4,{id:"key",children:"KEY"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,t.jsx)(s.strong,{children:"Defines the key used to access this raw value in the packet."})]}),"\n",(0,t.jsx)(s.p,{children:"Keys are often JsonPath or XPath strings"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Key string"}),(0,t.jsx)(s.td,{children:"The key to access this item"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"KEY $.book.title\n"})}),"\n",(0,t.jsx)(s.h4,{id:"required",children:"REQUIRED"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Parameter is required to be populated in scripts"})}),"\n",(0,t.jsx)(s.p,{children:"When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition."}),"\n",(0,t.jsx)(s.h4,{id:"minimum_value",children:"MINIMUM_VALUE"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Override the defined minimum value"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Value"}),(0,t.jsx)(s.td,{children:"The new minimum value for the parameter"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"maximum_value",children:"MAXIMUM_VALUE"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Override the defined maximum value"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Value"}),(0,t.jsx)(s.td,{children:"The new maximum value for the parameter"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"default_value",children:"DEFAULT_VALUE"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Override the defined default value"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Value"}),(0,t.jsx)(s.td,{children:"The new default value for the parameter"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"state",children:"STATE"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a key/value pair for the current command parameter"})}),"\n",(0,t.jsx)(s.p,{children:"Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Key"}),(0,t.jsx)(s.td,{children:"The string state name"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Value"}),(0,t.jsx)(s.td,{children:"The numerical state value"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Hazardous / Disable Messages"}),(0,t.jsxs)(s.td,{children:["Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"HAZARDOUS"})]}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Hazardous Description"}),(0,t.jsx)(s.td,{children:"String describing why this state is hazardous"}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'APPEND_PARAMETER ENABLE 32 UINT 0 1 0 "Enable setting"\n  STATE FALSE 0\n  STATE TRUE 1\nAPPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"\n  STATE "NOOP" "NOOP" DISABLE_MESSAGES\n  STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"\n  STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"\n'})}),"\n",(0,t.jsx)(s.h4,{id:"write_conversion",children:"WRITE_CONVERSION"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Applies a conversion when writing the current command parameter"})}),"\n",(0,t.jsx)(s.p,{children:"Conversions are implemented in a custom Ruby file which should be\nlocated in the target's lib folder. The class must require 'openc3/conversions/conversion'\nand inherit from Conversion. It must implement the initialize method if it\ntakes extra parameters and must always implement the call method. The conversion\nfactor is applied to the value entered by the user before it is written into\nthe binary command packet and sent."}),"\n",(0,t.jsx)(s.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,t.jsx)(s.p,{children:"When a command is built, each item gets written (and write conversions are run)\nto set the default value. Then items are written (again write conversions are run)\nwith user provided values. Thus write conversions can be run twice. Also there are\nno guarantees which parameters have already been written. The packet itself has a\ngiven_values() method which can be used to retrieve a hash of the user provided\nvalues to the command. That can be used to check parameter values passed in."})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Class Filename"}),(0,t.jsx)(s.td,{children:"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Parameter"}),(0,t.jsx)(s.td,{children:"Additional parameter values for the conversion which are passed to the class constructor."}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"WRITE_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * multiplier\n    end\n  end\nend\n"})}),"\n",(0,t.jsx)(s.h4,{id:"poly_write_conversion",children:"POLY_WRITE_CONVERSION"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Adds a polynomial conversion factor to the current command parameter"})}),"\n",(0,t.jsx)(s.p,{children:"The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"C0"}),(0,t.jsx)(s.td,{children:"Coefficient"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Cx"}),(0,t.jsx)(s.td,{children:"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"POLY_WRITE_CONVERSION 10 0.5 0.25\n"})}),"\n",(0,t.jsx)(s.h4,{id:"seg_poly_write_conversion",children:"SEG_POLY_WRITE_CONVERSION"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Adds a segmented polynomial conversion factor to the current command parameter"})}),"\n",(0,t.jsx)(s.p,{children:"This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Lower Bound"}),(0,t.jsx)(s.td,{children:"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"C0"}),(0,t.jsx)(s.td,{children:"Coefficient"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Cx"}),(0,t.jsx)(s.td,{children:"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n"})}),"\n",(0,t.jsx)(s.h4,{id:"generic_write_conversion_start",children:"GENERIC_WRITE_CONVERSION_START"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Start a generic write conversion"})}),"\n",(0,t.jsx)(s.p,{children:"Adds a generic conversion function to the current command parameter.\nThis conversion factor is applied to the value entered by the user before it\nis written into the binary command packet and sent. The conversion is specified\nas ruby code that receives two implied parameters. 'value' which is the raw\nvalue being written and 'packet' which is a reference to the command packet\nclass (Note, referencing the packet as 'myself' is still supported for backwards\ncompatibility). The last line of ruby code given should return the converted\nvalue. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of\nruby code for the conversion have been given."}),"\n",(0,t.jsx)(s.admonition,{title:"Multiple write conversions on command parameters",type:"info",children:(0,t.jsx)(s.p,{children:"When a command is built, each item gets written (and write conversions are run)\nto set the default value. Then items are written (again write conversions are run)\nwith user provided values. Thus write conversions can be run twice. Also there are\nno guarantees which parameters have already been written. The packet itself has a\ngiven_values() method which can be used to retrieve a hash of the user provided\nvalues to the command. That can be used to check parameter values passed in."})}),"\n",(0,t.jsx)(s.admonition,{type:"warning",children:(0,t.jsx)(s.p,{children:"Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance."})}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n"})}),"\n",(0,t.jsx)(s.h4,{id:"generic_write_conversion_end",children:"GENERIC_WRITE_CONVERSION_END"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Complete a generic write conversion"})}),"\n",(0,t.jsx)(s.h4,{id:"overflow",children:"OVERFLOW"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Set the behavior when writing a value overflows the type"})}),"\n",(0,t.jsx)(s.p,{children:"By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be writen, e.g. you can successfully write 255 to a 8 bit signed value."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Behavior"}),(0,t.jsxs)(s.td,{children:["How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE"})]}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"OVERFLOW TRUNCATE\n"})}),"\n",(0,t.jsx)(s.h3,{id:"append_parameter",children:"APPEND_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a command parameter in the current command packet"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of this parameter",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Minimum Value"}),(0,t.jsx)(s.td,{children:"Minimum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Maximum Value"}),(0,t.jsx)(s.td,{children:"Maximum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,t.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"\nAPPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5\nAPPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"id_parameter",children:"ID_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines an identification command parameter in the current command packet"})}),"\n",(0,t.jsx)(s.p,{children:"ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Offset"}),(0,t.jsx)(s.td,{children:"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of this parameter",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Minimum Value"}),(0,t.jsx)(s.td,{children:"Minimum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Maximum Value"}),(0,t.jsx)(s.td,{children:"Maximum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"ID Value"}),(0,t.jsx)(s.td,{children:"Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,t.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"append_id_parameter",children:"APPEND_ID_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines an identification command parameter in the current command packet"})}),"\n",(0,t.jsx)(s.p,{children:"ID parameters are used to identify the binary block of data as a particular command. A command packet may have one or more ID_PARAMETERs and all must match the binary data for the command to be identified."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of this parameter",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, DERIVED, STRING, BLOCK"})]}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Minimum Value"}),(0,t.jsx)(s.td,{children:"Minimum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Maximum Value"}),(0,t.jsx)(s.td,{children:"Maximum allowed value for this parameter"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"ID Value"}),(0,t.jsx)(s.td,{children:"Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,t.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/little-endian-bitfields",children:"Little Endian Bitfields"}),".",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"When Data Type is STRING, BLOCK the remaining parameters are:"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Default Value"}),(0,t.jsx)(s.td,{children:"Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for this parameter which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"array_parameter",children:"ARRAY_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a command parameter in the current command packet that is an array"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Bit Offset"}),(0,t.jsx)(s.td,{children:"Bit offset into the command packet of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the packet. Always use a bit offset of 0 for derived parameters."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Item Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of each array item"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Item Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of each array item",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, STRING, BLOCK, DERIVED"})]}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Array Bit Size"}),(0,t.jsx)(s.td,{children:"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"append_array_parameter",children:"APPEND_ARRAY_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Defines a command parameter in the current command packet that is an array"})}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Name"}),(0,t.jsx)(s.td,{children:"Name of the parameter. Must be unique within the command."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Item Bit Size"}),(0,t.jsx)(s.td,{children:"Bit size of each array item"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Item Data Type"}),(0,t.jsxs)(s.td,{children:["Data Type of each array item",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"INT, UINT, FLOAT, STRING, BLOCK, DERIVED"})]}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Array Bit Size"}),(0,t.jsx)(s.td,{children:"Total Bit Size of the Array. Zero or Negative values may be used to indicate the array fills the packet up to the offset from the end of the packet specified by this value."}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Endianness"}),(0,t.jsxs)(s.td,{children:["Indicates if the data is to be sent in Big Endian or Little Endian format",(0,t.jsx)("br",{}),(0,t.jsx)("br",{}),"Valid Values: ",(0,t.jsx)("span",{class:"values",children:"BIG_ENDIAN, LITTLE_ENDIAN"})]}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"select_parameter",children:"SELECT_PARAMETER"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Selects an existing command parameter for editing"})}),"\n",(0,t.jsx)(s.p,{children:"Must be used in conjunction with SELECT_COMMAND to first select the packet. Typically used to override generated values or make specific changes to commands that only affect a particular instance of a target used multiple times."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Parameter"}),(0,t.jsx)(s.td,{children:"Name of the parameter to select for modification"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n"})}),"\n",(0,t.jsx)(s.h3,{id:"delete_parameter",children:"DELETE_PARAMETER"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 4.4.1)"}),(0,t.jsx)(s.strong,{children:"Deletes an existing command parameter from the packet definition"})]}),"\n",(0,t.jsx)(s.p,{children:'Deleting a parameter from the command definition does not remove the defined space for that parameter. Thus unless you redefine a new parameter, there will be a "hole" in the packet where the data is not accessible. You can use SELECT_COMMAND and then PARAMETER to define a new parameter.'}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Parameter"}),(0,t.jsx)(s.td,{children:"Name of the parameter to delete"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  DELETE_PARAMETER DURATION\n"})}),"\n",(0,t.jsx)(s.h3,{id:"hidden",children:"HIDDEN"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator"})}),"\n",(0,t.jsx)(s.p,{children:"Hidden commands do not appear in the Script Runner popup helper when writing scripts. The command still exists in the system and can be sent by scripts."}),"\n",(0,t.jsx)(s.h3,{id:"disabled",children:"DISABLED"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Disables this command from being sent"})}),"\n",(0,t.jsx)(s.p,{children:"Hides the command and also disables it from being sent by scripts. Attempts to send DISABLED commands result in an error message."}),"\n",(0,t.jsx)(s.h3,{id:"disable_messages",children:"DISABLE_MESSAGES"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Disable the Server from printing cmd(...) messages. Commands are still logged."})}),"\n",(0,t.jsx)(s.h3,{id:"meta-1",children:"META"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Stores metadata for the current command"})}),"\n",(0,t.jsx)(s.p,{children:"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Meta Name"}),(0,t.jsx)(s.td,{children:"Name of the metadata to store"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Meta Values"}),(0,t.jsx)(s.td,{children:"One or more values to be stored for this Meta Name"}),(0,t.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'META FSW_TYPE "struct command"\n'})}),"\n",(0,t.jsx)(s.h3,{id:"hazardous",children:"HAZARDOUS"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Designates the current command as hazardous"})}),"\n",(0,t.jsx)(s.p,{children:"Sending a hazardous command causes a dialog asking for confirmation before sending the command"}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Description"}),(0,t.jsx)(s.td,{children:"Description for why the command is hazardous which must be enclosed with quotes"}),(0,t.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"accessor",children:"ACCESSOR"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,t.jsx)(s.strong,{children:"Defines the class used to read and write raw values from the packet"})]}),"\n",(0,t.jsx)(s.p,{children:"Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor. Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Accessor Class Name"}),(0,t.jsx)(s.td,{children:"The name of the accessor class"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"template",children:"TEMPLATE"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,t.jsx)(s.strong,{children:"Defines a template string used to initialize the command before default values are filled in"})]}),"\n",(0,t.jsx)(s.p,{children:"Generally the template string is formatted in JSON or HTML and then values are filled in with command parameters. Must be UTF-8 encoded."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Template"}),(0,t.jsx)(s.td,{children:"The template string which should be enclosed in quotes"}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"template_file",children:"TEMPLATE_FILE"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.0.10)"}),(0,t.jsx)(s.strong,{children:"Defines a template file used to initialize the command before default values are filled in"})]}),"\n",(0,t.jsx)(s.p,{children:"Generally the template file is formatted in JSON or HTML and then values are filled in with command parameters. Can be binary or UTF-8."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Template File Path"}),(0,t.jsx)(s.td,{children:"The relative path to the template file. Filename should generally start with an underscore."}),(0,t.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,t.jsx)(s.h3,{id:"response",children:"RESPONSE"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,t.jsx)(s.strong,{children:"Indicates the expected telemetry packet response to this command"})]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target Name"}),(0,t.jsx)(s.td,{children:"Target Name of telemetry response packet"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Packet Name"}),(0,t.jsx)(s.td,{children:"Packet Name of telemetry response packet"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.h3,{id:"error_response",children:"ERROR_RESPONSE"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,t.jsx)(s.strong,{children:"Indicates the expected telemetry packet error response to this command"})]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target Name"}),(0,t.jsx)(s.td,{children:"Target Name of telemetry error response packet"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Packet Name"}),(0,t.jsx)(s.td,{children:"Packet Name of telemetry error response packet"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.h3,{id:"related_item",children:"RELATED_ITEM"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,t.jsx)(s.strong,{children:"Defines a related telemetry item to this command"})]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target Name"}),(0,t.jsx)(s.td,{children:"Target Name of related telemetry item"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Packet Name"}),(0,t.jsx)(s.td,{children:"Packet Name of related telemetry item"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Item Name"}),(0,t.jsx)(s.td,{children:"Item Name of related telemetry item"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.h3,{id:"screen",children:"SCREEN"}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)("div",{class:"right",children:"(Since 5.14.0)"}),(0,t.jsx)(s.strong,{children:"Defines a related telemetry screen to this command"})]}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target Name"}),(0,t.jsx)(s.td,{children:"Target Name of related telemetry screen"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Screen Name"}),(0,t.jsx)(s.td,{children:"Screen Name of related telemetry screen"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"select_command",children:"SELECT_COMMAND"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Selects an existing command packet for editing"})}),"\n",(0,t.jsx)(s.p,{children:"Typically used in a separate configuration file from where the original command is defined to override or add to the existing command definition. Must be used in conjunction with SELECT_PARAMETER to change an individual parameter."}),"\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"}),(0,t.jsx)(s.th,{children:"Required"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Target Name"}),(0,t.jsx)(s.td,{children:"Name of the target this command is associated with"}),(0,t.jsx)(s.td,{children:"True"})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"Command Name"}),(0,t.jsx)(s.td,{children:"Name of the command to select"}),(0,t.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,t.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:"SELECT_COMMAND INST COLLECT\n  SELECT_PARAMETER DURATION\n    # Add units\n    UNITS Seconds S\n"})}),"\n",(0,t.jsx)(s.h2,{id:"example-file",children:"Example File"}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Example File: TARGET/cmd_tlm/cmd.txt"})}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-ruby",children:'COMMAND TARGET COLLECT_DATA BIG_ENDIAN "Commands my target to collect data"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 100 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 4 4 4 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  PARAMETER ANGLE 48 32 FLOAT -180.0 180.0 0.0 "ANGLE OF INSTRUMENT IN DEGREES"\n  POLY_WRITE_CONVERSION 0 0.01745 0 0\n  PARAMETER MODE 80 8 UINT 0 1 0 "DATA COLLECTION MODE"\n    STATE NORMAL 0\n    STATE DIAG 1\nCOMMAND TARGET NOOP BIG_ENDIAN "Do Nothing"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 101 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  PARAMETER DUMMY 48 8 UINT 0 0 0 "DUMMY PARAMETER BECAUSE CCSDS REQUIRES 1 BYTE OF DATA"\nCOMMAND TARGET SETTINGS BIG_ENDIAN "Set the Settings"\n  PARAMETER CCSDSVER 0 3 UINT 0 0 0 "CCSDS PRIMARY HEADER VERSION NUMBER"\n  PARAMETER CCSDSTYPE 3 1 UINT 1 1 1 "CCSDS PRIMARY HEADER PACKET TYPE"\n  PARAMETER CCSDSSHF 4 1 UINT 0 0 0 "CCSDS PRIMARY HEADER SECONDARY HEADER FLAG"\n  ID_PARAMETER CCSDSAPID 5 11 UINT 0 2047 102 "CCSDS PRIMARY HEADER APPLICATION ID"\n  PARAMETER CCSDSSEQFLAGS 16 2 UINT 3 3 3 "CCSDS PRIMARY HEADER SEQUENCE FLAGS"\n  PARAMETER CCSDSSEQCNT 18 14 UINT 0 16383 0 "CCSDS PRIMARY HEADER SEQUENCE COUNT"\n  PARAMETER CCSDSLENGTH 32 16 UINT 0 0 0 "CCSDS PRIMARY HEADER PACKET LENGTH"\n  <% 5.times do |x| %>\n  APPEND_PARAMETER SETTING<%= x %> 16 UINT 0 5 0 "Setting <%= x %>"\n  <% end %>\n'})})]})}function o(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},1184:(e,s,r)=>{r.d(s,{R:()=>d});var t=r(4041);const i={},n=t.createContext(i);function d(e){const s=t.useContext(n);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}}}]);