openc3-cosmos-tool-docs 5.12.0 → 5.13.0

data/tools/docs/assets/js/6831b732.735c11e9.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9227],{9685:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:2,title:"Plugins"},i=void 0,o={unversionedId:"configuration/plugins",id:"configuration/plugins",title:"Plugins",description:"Introduction",source:"@site/docs/configuration/plugins.md",sourceDirName:"configuration",slug:"/configuration/plugins",permalink:"/tools/docs/docs/configuration/plugins",draft:!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/docs/docs/configuration/format"},next:{title:"Targets",permalink:"/tools/docs/docs/configuration/target"}},p={},m=[{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}],d={toc:m},u="wrapper";function s(e){let{components:t,...a}=e;return(0,r.kt)(u,(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"This document provides the information necessary to configure a COSMOS plugin. Plugins are how you configure and extend COSMOS."),(0,r.kt)("p",null,"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."),(0,r.kt)("p",null,"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."),(0,r.kt)("h2",{id:"concepts"},"Concepts"),(0,r.kt)("h3",{id:"target"},"Target"),(0,r.kt)("p",null,"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."),(0,r.kt)("h3",{id:"interface"},"Interface"),(0,r.kt)("p",null,"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."),(0,r.kt)("h3",{id:"router"},"Router"),(0,r.kt)("p",null,"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."),(0,r.kt)("h3",{id:"tool"},"Tool"),(0,r.kt)("p",null,"COSMOS Tools are web-based applications the communicate with the COSMOS APIs to perform takes like displaying telemetry, sending commands, and running scripts."),(0,r.kt)("h3",{id:"microservice"},"Microservice"),(0,r.kt)("p",null,"Microservices are persistent running backend code that runs within the COSMOS environment. They can process data and perform other useful tasks."),(0,r.kt)("h2",{id:"plugin-directory-structure"},"Plugin Directory Structure"),(0,r.kt)("p",null,"COSMOS plugins have a well-defined directory structure as follows:"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Folder / File"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"plugin.txt"),(0,r.kt)("td",{parentName:"tr",align:null},"Configuration file for the plugin. This file is required and always named exactly plugin.txt. See later in this document for the format.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LICENSE.txt"),(0,r.kt)("td",{parentName:"tr",align:null},"License for the plugin. COSMOS Plugins should be licensed in a manner compatible with the AGPLv3, unless they are designed only for use with COSMOS Enterprise Edition (or only for use at Ball), in which case they can take on any license as desired.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"openc3-PLUGINNAME.gemspec"),(0,r.kt)("td",{parentName:"tr",align:null},"This file should have the name of the plugin with a .gemspec extension. For example openc3-cosmos-demo.gemspec. The name of this file is used in compiling the plugin contents into the final corresponding PluginName-Version.gem plugin file. ie. openc3-cosmos-demo-5.0.0.gem. COSMOS plugins should always begin with the openc3- prefix to make them easily identifiable in the Rubygems repository. The contents of this file take on the Rubygems spec format as documented at: ",(0,r.kt)("a",{parentName:"td",href:"https://guides.rubygems.org/specification-reference/"},"https://guides.rubygems.org/specification-reference/"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Rakefile"),(0,r.kt)("td",{parentName:"tr",align:null},'This is a helper ruby Rakefile used to build the plugin. In general, the exact same file as provided with the COSMOS demo plugins can be used, or other features can be added as necessary for your plugin project. This file is typically just used to support building the plugin by running "rake build VERSION=X.X.X" where X.X.X is the plugin version number. A working Ruby installation is required.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"README.md"),(0,r.kt)("td",{parentName:"tr",align:null},"Use this file to describe your plugin. It is typically a markdown file that supports nice formatting on Github.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder is required if any targets are defined by your plugin. All target configuration is included under this folder. It should contain one or more target configurations")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME"),(0,r.kt)("td",{parentName:"tr",align:null},"This is a folder that contains the configuration for a specific target named TARGETNAME. The name is always defined in all caps. For example: targets/INST. This is typically the default name of the target, but well-designed targets will allow themselves to be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/cmd_tlm"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder contains the command and telemetry definition files for the target. These files capture the format of the commands that can be sent to the target, and the telemetry packets that are expected to be received by COSMOS from the target. Note that the files in this folder are processed in alphabetical order by default. That can matter if you reference a packet in another file (it should already have been defined). See the Command and Telemetry Configuration Guides for more information.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/data"),(0,r.kt)("td",{parentName:"tr",align:null},"Use this folder to store any general data that is needed by the target excluding CANVAS image files.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/lib"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder contains any custom code required by the target. Good examples of custom code are custom Interface classes and protocols. See the Interface documentation for more information. Try to give any custom code a unique filename that starts with the name of the target. This can help avoid name conflicts that can occur if two different targets create a custom code file with the same filename.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/procedures"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder contains target specific procedures and helper methods which exercise functionality of the target. These procedures should be kept simple and only use the command and telemetry definitions associated with this target. See the Scripting Guide for more information.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/public"),(0,r.kt)("td",{parentName:"tr",align:null},"Put image files here for use in Telemetry Viewer Canvas Image widgets such as ",(0,r.kt)("a",{parentName:"td",href:"/tools/docs/docs/configuration/telemetry-screens#canvasimage"},"CANVASIMAGE")," and ",(0,r.kt)("a",{parentName:"td",href:"/tools/docs/docs/configuration/telemetry-screens#canvasimagevalue"},"CANVASIMAGEVALUE"),".")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/screens"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder contains telemetry screens for the target. See Screen Configuration for more information.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"targets/TARGETNAME/target.txt"),(0,r.kt)("td",{parentName:"tr",align:null},"This file contains target specific configuration such as which command parameters should be ignored by Command Sender. See Target Configuration for more information.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"microservices/"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder is required if any microservices are defined by your plugin. All microservice code and configuration is included in this folder. It should contain one or more MICROSERVICENAME subfolders")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"microservices/MICROSERVICENAME"),(0,r.kt)("td",{parentName:"tr",align:null},"This is a folder that contains the code and any necessary configuration for a specific microservice named MICROSERVICENAME. The name is always defined in all caps. For example: microservices/EXAMPLE. This is typically the default name of the microservice, but well-designed microservices will allow themselves to be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"tools/"),(0,r.kt)("td",{parentName:"tr",align:null},"This folder is required if any tools are defined by your plugin. All tool code and configuration is included in this folder. It should contain one or more toolname subfolders")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"tools/toolname"),(0,r.kt)("td",{parentName:"tr",align:null},"This is a folder that contains all the files necessary to serve a web-based tool named toolname. The name is always defined in all lowercase. For example: tools/base. Due to technical limitations, the toolname must be unique and cannot be renamed at installation. All subfolders and files below this folder are optional and should be added as needed.")))),(0,r.kt)("h2",{id:"plugintxt-configuration-file"},"plugin.txt Configuration File"),(0,r.kt)("p",null,"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:"),(0,r.kt)("h2",{id:"variable"},"VARIABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Define a configurable variable for the plugin")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Variable Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the variable"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Default Value"),(0,r.kt)("td",{parentName:"tr",align:null},"Default value of the variable"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"needs_dependencies"},"NEEDS_DEPENDENCIES"),(0,r.kt)("div",{class:"right"},"(Since 5.5.0)"),"**Indicates the plugin needs dependencies and sets the GEM_HOME environment variable**",(0,r.kt)("p",null,"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."),(0,r.kt)("h2",{id:"interface-1"},"INTERFACE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a connection to a physical target")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Interface Name"),(0,r.kt)("td",{parentName:"tr",align:null},"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,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Filename"),(0,r.kt)("td",{parentName:"tr",align:null},"Ruby file to use when instantiating the interface.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Additional parameters are required. Please see the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/interfaces"},"Interfaces")," documentation for more details."),(0,r.kt)("h2",{id:"interface-modifiers"},"INTERFACE Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a INTERFACE keyword."),(0,r.kt)("h3",{id:"map_target"},"MAP_TARGET"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Maps a target name to an interface")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Target name to map to this interface"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n  MAP_TARGET DATA\n")),(0,r.kt)("h3",{id:"map_cmd_target"},"MAP_CMD_TARGET"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Maps a target name to an interface for commands only**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Command target name to map to this interface"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"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")),(0,r.kt)("h3",{id:"map_tlm_target"},"MAP_TLM_TARGET"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Maps a target name to an interface for telemetry only**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry target name to map to this interface"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"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")),(0,r.kt)("h3",{id:"dont_connect"},"DONT_CONNECT"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Server will not automatically try to connect to the interface at startup")),(0,r.kt)("h3",{id:"dont_reconnect"},"DONT_RECONNECT"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Server will not try to reconnect to the interface if the connection is lost")),(0,r.kt)("h3",{id:"reconnect_delay"},"RECONNECT_DELAY"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Reconnect delay in seconds")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Delay"),(0,r.kt)("td",{parentName:"tr",align:null},"Delay in seconds between reconnect attempts. The default is 15 seconds."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"disable_disconnect"},"DISABLE_DISCONNECT"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Disable the Disconnect button on the Interfaces tab in the Server")),(0,r.kt)("p",null,"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."),(0,r.kt)("h3",{id:"log_raw"},"LOG_RAW"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Deprecated, use LOG_STREAM")),(0,r.kt)("h3",{id:"log_stream"},"LOG_STREAM"),(0,r.kt)("div",{class:"right"},"(Since 5.5.2)"),"**Log all data on the interface exactly as it is sent and received**",(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cycle Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Amount of time to wait before cycling the log file. Default is 10 min. If nil refer to Cycle Hour and Cycle Minute."),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cycle Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Amount of data to write before cycling the log file. Default is 50MB."),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cycle Hour"),(0,r.kt)("td",{parentName:"tr",align:null},"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,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cycle Minute"),(0,r.kt)("td",{parentName:"tr",align:null},"See Cycle Hour."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"INTERFACE EXAMPLE example_interface.rb\n  # Override the default log time of 600\n  LOG_STREAM 60\n")),(0,r.kt)("h3",{id:"protocol"},"PROTOCOL"),(0,r.kt)("div",{class:"right"},"(Since 4.0.0)"),"**Protocols modify the interface by processing the data**",(0,r.kt)("p",null,"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,r.kt)("br",null),(0,r.kt)("br",null)," For information on creating your own custom protocol please see ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/protocols"},"Protocols")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Whether to apply the protocol on incoming data, outgoing data, or both",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"READ, WRITE, READ_WRITE")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Protocol Filename or Classname"),(0,r.kt)("td",{parentName:"tr",align:null},"Ruby filename or class name which implements the protocol"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Protocol specific parameters"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional parameters used by the protocol"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"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")),(0,r.kt)("h3",{id:"option"},"OPTION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set a parameter on an interface")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"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 defines LISTEN_ADDRESS which is the IP address to accept connections on (default 0.0.0.0)."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameters"),(0,r.kt)("td",{parentName:"tr",align:null},"Parameters to pass to the option"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil\n  OPTION FLOW_CONTROL RTSCTS\n  OPTION DATA_BITS 8\n")),(0,r.kt)("h3",{id:"secret"},"SECRET"),(0,r.kt)("div",{class:"right"},"(Since 5.3.0)"),"**Define a secret needed by this interface**",(0,r.kt)("p",null,"Defines a secret for this interface and optionally assigns its value to an option"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Type"),(0,r.kt)("td",{parentName:"tr",align:null},"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Secret Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the secret to retrieve"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Environment Variable or File Path"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable name or file path to store secret"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Option Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Interface option to pass the secret value"),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Secret Store Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the secret store for stores with multipart keys"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'SECRET ENV USERNAME ENV_USERNAME USERNAME\nSECRET FILE KEY "/tmp/DATA/cert" KEY\n')),(0,r.kt)("h3",{id:"env"},"ENV"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Sets an environment variable in the microservice.**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable name"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable value"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"ENV COMPANY OpenC3\n")),(0,r.kt)("h3",{id:"work_dir"},"WORK_DIR"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Set the working directory**",(0,r.kt)("p",null,"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,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Directory"),(0,r.kt)("td",{parentName:"tr",align:null},"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,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"WORK_DIR '/openc3/lib/openc3/microservices'\n")),(0,r.kt)("h3",{id:"port"},"PORT"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Open port for the microservice**",(0,r.kt)("p",null,"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Number"),(0,r.kt)("td",{parentName:"tr",align:null},"Port number"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Protocol"),(0,r.kt)("td",{parentName:"tr",align:null},"Port protocol. Default is TCP."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"PORT 7272\n")),(0,r.kt)("h3",{id:"cmd"},"CMD"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Command line to execute to run the microservice.**",(0,r.kt)("p",null,"Command line to execute to run the microservice."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Args"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more arguments to exec to run the microservice."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1\n")),(0,r.kt)("h3",{id:"container"},"CONTAINER"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Docker Container**",(0,r.kt)("p",null,"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Args"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the container"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h3",{id:"route_prefix"},"ROUTE_PREFIX"),(0,r.kt)("div",{class:"right"},"(Since 5.7.0)"),"**Prefix of route**",(0,r.kt)("p",null,"Prefix of route to the microservice to expose externally with Traefik"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Route Prefix"),(0,r.kt)("td",{parentName:"tr",align:null},"Route prefix. Must be unique across all scopes. Something like /myprefix"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"ROUTE_PREFIX /interface\n")),(0,r.kt)("h2",{id:"router-1"},"ROUTER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Create router to receive commands and output telemetry packets from one or more interfaces")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the router"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Filename"),(0,r.kt)("td",{parentName:"tr",align:null},"Ruby file to use when instantiating the interface.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"tcpip_client_interface.rb, tcpip_server_interface.rb, udp_interface.rb, serial_interface.rb")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Additional parameters are required. Please see the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/interfaces"},"Interfaces")," documentation for more details."),(0,r.kt)("h2",{id:"target-1"},"TARGET"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a new target")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Folder Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The target folder"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"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,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"TARGET INST INST\n")),(0,r.kt)("h2",{id:"target-modifiers"},"TARGET Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a TARGET keyword."),(0,r.kt)("h3",{id:"cmd_buffer_depth"},"CMD_BUFFER_DEPTH"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Number of commands to buffer to ensure logged in order**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Buffer Depth"),(0,r.kt)("td",{parentName:"tr",align:null},"Buffer depth in packets (Default = 5)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_log_cycle_time"},"CMD_LOG_CYCLE_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Command binary logs can be cycled on a time interval.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum time between files in seconds (default = 600)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_log_cycle_size"},"CMD_LOG_CYCLE_SIZE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Command binary logs can be cycled after a certain log file size is reached.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum file size in bytes (default = 50_000_000)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_log_retain_time"},"CMD_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep raw command logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep raw command logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_decom_log_cycle_time"},"CMD_DECOM_LOG_CYCLE_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Command decommutation logs can be cycled on a time interval.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum time between files in seconds (default = 600)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_decom_log_cycle_size"},"CMD_DECOM_LOG_CYCLE_SIZE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Command decommutation logs can be cycled after a certain log file size is reached.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum file size in bytes (default = 50_000_000)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cmd_decom_log_retain_time"},"CMD_DECOM_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep decom command logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep decom command logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_buffer_depth"},"TLM_BUFFER_DEPTH"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Number of telemetry packets to buffer to ensure logged in order**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Buffer Depth"),(0,r.kt)("td",{parentName:"tr",align:null},"Buffer depth in packets (Default = 60)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_log_cycle_time"},"TLM_LOG_CYCLE_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Telemetry binary logs can be cycled on a time interval.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum time between files in seconds (default = 600)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_log_cycle_size"},"TLM_LOG_CYCLE_SIZE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Telemetry binary logs can be cycled after a certain log file size is reached.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum file size in bytes (default = 50_000_000)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_log_retain_time"},"TLM_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep raw telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep raw telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_decom_log_cycle_time"},"TLM_DECOM_LOG_CYCLE_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Telemetry decommutation logs can be cycled on a time interval.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum time between files in seconds (default = 600)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_decom_log_cycle_size"},"TLM_DECOM_LOG_CYCLE_SIZE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Telemetry decommutation logs can be cycled after a certain log file size is reached.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Maximum file size in bytes (default = 50_000_000)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"tlm_decom_log_retain_time"},"TLM_DECOM_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep decom telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep decom telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"reduced_minute_log_retain_time"},"REDUCED_MINUTE_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep reduced minute telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"reduced_hour_log_retain_time"},"REDUCED_HOUR_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep reduced hour telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"reduced_day_log_retain_time"},"REDUCED_DAY_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep reduced day telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep reduced day telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"log_retain_time"},"LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep all regular telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep all regular telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"reduced_log_retain_time"},"REDUCED_LOG_RETAIN_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How long to keep all reduced telemetry logs in seconds.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds to keep all reduced telemetry logs (default = nil = Forever)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"cleanup_poll_time"},"CLEANUP_POLL_TIME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Period at which to run the cleanup process.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Time"),(0,r.kt)("td",{parentName:"tr",align:null},"Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"reducer_disable"},"REDUCER_DISABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Disables the data reduction microservice for the target")),(0,r.kt)("h3",{id:"reducer_max_cpu_utilization"},"REDUCER_MAX_CPU_UTILIZATION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Maximum amount of CPU utilization to apply to data reduction")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Percentage"),(0,r.kt)("td",{parentName:"tr",align:null},"0 to 100 percent (default = 30)"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"target_microservice"},"TARGET_MICROSERVICE"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Breaks a target microservice out into its own process.**",(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Type"),(0,r.kt)("td",{parentName:"tr",align:null},"The target microservice type. Must be one of DECOM, COMMANDLOG, DECOMCMDLOG, PACKETLOG, DECOMLOG, REDUCER, or CLEANUP"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"packet"},"PACKET"),(0,r.kt)("div",{class:"right"},"(Since 5.2.0)"),"**Packet Name to allocate to the current TARGET_MICROSERVICE.**",(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Packet Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The packet name. Does not apply to REDUCER or CLEANUP target microservice types."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"disable_erb"},"DISABLE_ERB"),(0,r.kt)("div",{class:"right"},"(Since 5.12.0)"),"**Disable ERB processing**",(0,r.kt)("p",null,"Disable ERB processing for the entire target or a set of regular expressions over its filenames"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Regex"),(0,r.kt)("td",{parentName:"tr",align:null},"Regex to match against filenames. If match, then no ERB processing"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h2",{id:"microservice-1"},"MICROSERVICE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a new microservice")),(0,r.kt)("p",null,"Defines a microservice that the plugin adds to the OpenC3 system. Microservices are background software processes that perform persistent processing."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Microservice Folder Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The exact name of the microservice folder in the plugin. ie. microservices/MicroserviceFolderName"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Microservice Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The specific name of this instance of the microservice in the OpenC3 system"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n")),(0,r.kt)("h2",{id:"microservice-modifiers"},"MICROSERVICE Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a MICROSERVICE keyword."),(0,r.kt)("h3",{id:"env-1"},"ENV"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Sets an environment variable in the microservice.")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable name"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable value"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n  ENV COMPANY OpenC3\n")),(0,r.kt)("h3",{id:"work_dir-1"},"WORK_DIR"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set the working directory")),(0,r.kt)("p",null,"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,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Directory"),(0,r.kt)("td",{parentName:"tr",align:null},"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,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n  WORK_DIR .\n")),(0,r.kt)("h3",{id:"port-1"},"PORT"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Open port for the microservice**",(0,r.kt)("p",null,"Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Number"),(0,r.kt)("td",{parentName:"tr",align:null},"Port number"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Protocol"),(0,r.kt)("td",{parentName:"tr",align:null},"Port protocol. Default is TCP."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n  PORT 7272\n")),(0,r.kt)("h3",{id:"topic"},"TOPIC"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Associate a Redis topic")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Topic Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Redis Topic to associate with the microservice"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"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")),(0,r.kt)("h3",{id:"target_name"},"TARGET_NAME"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Associate a OpenC3 target")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target Name"),(0,r.kt)("td",{parentName:"tr",align:null},"OpenC3 target to associate with the microservice"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n  TARGET_NAME EXAMPLE\n")),(0,r.kt)("h3",{id:"cmd-1"},"CMD"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Command line to execute to run the microservice.")),(0,r.kt)("p",null,"Command line to execute to run the microservice."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Args"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more arguments to exec to run the microservice."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE EXAMPLE openc3-example\n  CMD ruby example_target.rb\n")),(0,r.kt)("h3",{id:"option-1"},"OPTION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Pass an option to the microservice")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Option Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the option"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Option Value(s)"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more values to associate with the option"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"container-1"},"CONTAINER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Docker Container")),(0,r.kt)("p",null,"Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Args"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the container"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h3",{id:"secret-1"},"SECRET"),(0,r.kt)("div",{class:"right"},"(Since 5.3.0)"),"**Define a secret needed by this microservice**",(0,r.kt)("p",null,"Defines a secret for this microservice"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Type"),(0,r.kt)("td",{parentName:"tr",align:null},"ENV or FILE.  ENV will mount the secret into an environment variable. FILE mounts the secret into a file."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Secret Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the secret to retrieve"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Environment Variable or File Path"),(0,r.kt)("td",{parentName:"tr",align:null},"Environment variable name or file path to store secret"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Secret Store Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the secret store for stores with multipart keys"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'SECRET ENV USERNAME ENV_USERNAME\nSECRET FILE KEY "/tmp/DATA/cert"\n')),(0,r.kt)("h3",{id:"route_prefix-1"},"ROUTE_PREFIX"),(0,r.kt)("div",{class:"right"},"(Since 5.5.0)"),"**Prefix of route**",(0,r.kt)("p",null,"Prefix of route to the microservice to expose externally with Traefik"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Route Prefix"),(0,r.kt)("td",{parentName:"tr",align:null},"Route prefix. Must be unique across all scopes. Something like /myprefix"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"MICROSERVICE CFDP CFDP\n  ROUTE_PREFIX /cfdp\n")),(0,r.kt)("h3",{id:"disable_erb-1"},"DISABLE_ERB"),(0,r.kt)("div",{class:"right"},"(Since 5.12.0)"),"**Disable ERB processing**",(0,r.kt)("p",null,"Disable ERB processing for the entire microservice or a set of regular expressions over its filenames"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Regex"),(0,r.kt)("td",{parentName:"tr",align:null},"Regex to match against filenames. If match, then no ERB processing"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h2",{id:"tool-1"},"TOOL"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Define a tool")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Tool Folder Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The exact name of the tool folder in the plugin. ie. tools/ToolFolderName"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Tool Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the tool that is displayed in the OpenC3 Navigation menu"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"TOOL DEMO Demo\n")),(0,r.kt)("h2",{id:"tool-modifiers"},"TOOL Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a TOOL keyword."),(0,r.kt)("h3",{id:"url"},"URL"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Url used to access the tool")),(0,r.kt)("p",null,'The relative url used to access the tool. Defaults to "/tools/ToolFolderName".'),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Url"),(0,r.kt)("td",{parentName:"tr",align:null},"The url. If not given defaults to tools/ToolFolderName. Generally should not be given unless linking to external tools."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"inline_url"},"INLINE_URL"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Internal url to load a tool")),(0,r.kt)("p",null,'The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".'),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Url"),(0,r.kt)("td",{parentName:"tr",align:null},"The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"window"},"WINDOW"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"How to display the tool when navigated to")),(0,r.kt)("p",null,"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."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Window Mode"),(0,r.kt)("td",{parentName:"tr",align:null},"Tool display mode",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INLINE, IFRAME, NEW")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"icon"},"ICON"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set tool icon")),(0,r.kt)("p",null,"Icon shown next to the tool name in the OpenC3 navigation menu."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Icon Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Icon to display next to the tool name. Icons come from Font Awesome, Material Design (",(0,r.kt)("a",{parentName:"td",href:"https://materialdesignicons.com/"},"https://materialdesignicons.com/"),"), and Astro."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"category"},"CATEGORY"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Category for the tool")),(0,r.kt)("p",null,"Associates the tool with a category which becomes a submenu in the Navigation menu."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Category Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Category to associate the tool with"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"shown"},"SHOWN"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Show the tool or not")),(0,r.kt)("p",null,"Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the openc3 base tool."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Shown"),(0,r.kt)("td",{parentName:"tr",align:null},"Whether or not the tool is shown.  TRUE or FALSE",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"true, false")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"position"},"POSITION"),(0,r.kt)("div",{class:"right"},"(Since 5.0.8)"),"**Position of the tool in the nav bar**",(0,r.kt)("p",null,"Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Position"),(0,r.kt)("td",{parentName:"tr",align:null},"Numerical position"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h3",{id:"disable_erb-2"},"DISABLE_ERB"),(0,r.kt)("div",{class:"right"},"(Since 5.12.0)"),"**Disable ERB processing**",(0,r.kt)("p",null,"Disable ERB processing for the entire tool or a set of regular expressions over its filenames"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Regex"),(0,r.kt)("td",{parentName:"tr",align:null},"Regex to match against filenames. If match, then no ERB processing"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h2",{id:"widget"},"WIDGET"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Define a custom widget")),(0,r.kt)("p",null,"Defines a custom widget that can be used in Telemetry Viewer screens."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Widget Name"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the widget wil be used to build a path to the widget implementation. For example, ",(0,r.kt)("inlineCode",{parentName:"td"},"WIDGET HELLOWORLD")," will find the as-built file tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js. See the ",(0,r.kt)("a",{parentName:"td",href:"/tools/docs/docs/guides/custom-widgets"},"Custom Widgets")," guide for more details."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"WIDGET HELLOWORLD\n")),(0,r.kt)("h2",{id:"widget-modifiers"},"WIDGET Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a WIDGET keyword."),(0,r.kt)("h3",{id:"disable_erb-3"},"DISABLE_ERB"),(0,r.kt)("div",{class:"right"},"(Since 5.12.0)"),"**Disable ERB processing**",(0,r.kt)("p",null,"Disable ERB processing for the entire widget or a set of regular expressions over its filenames"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Regex"),(0,r.kt)("td",{parentName:"tr",align:null},"Regex to match against filenames. If match, then no ERB processing"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))))}s.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>c});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),m=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=m(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",s={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),u=m(a),k=r,c=u["".concat(p,".").concat(k)]||u[k]||s[k]||l;return a?n.createElement(c,i(i({ref:t},d),{},{components:a})):n.createElement(c,i({ref:t},d))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[u]="string"==typeof e?e:r,i[1]=o;for(var m=2;m<l;m++)i[m]=a[m];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}k.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/696b4199.ff9185d0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6560],{6310:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>f,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(7896),a=(n(2784),n(876));const i={sidebar_position:10,title:"SSL-TLS"},o=void 0,l={unversionedId:"configuration/ssl-tls",id:"configuration/ssl-tls",title:"SSL-TLS",description:"COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik docs.",source:"@site/docs/configuration/ssl-tls.md",sourceDirName:"configuration",slug:"/configuration/ssl-tls",permalink:"/tools/docs/docs/configuration/ssl-tls",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/ssl-tls.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10,title:"SSL-TLS"},sidebar:"defaultSidebar",previous:{title:"Screens",permalink:"/tools/docs/docs/configuration/telemetry-screens"},next:{title:"Tools",permalink:"/tools/docs/docs/tools"}},c={},s=[{value:"Generate the certificate",id:"generate-the-certificate",level:3},{value:"Updating the openc3-traefik Dockerfile",id:"updating-the-openc3-traefik-dockerfile",level:3},{value:"Updating the Traefik config",id:"updating-the-traefik-config",level:3},{value:"Update docker-compose.yaml",id:"update-docker-composeyaml",level:3},{value:"Let&#39;s Encrypt",id:"lets-encrypt",level:2},{value:"KEY",id:"key",level:4},{value:"CRT",id:"crt",level:4},{value:"CRT/KEY Bundle",id:"crtkey-bundle",level:4},{value:"cert.pem",id:"certpem",level:4},{value:"chain.pem",id:"chainpem",level:4},{value:"Checking certs",id:"checking-certs",level:3},{value:"Extracting the certificate and keys from a .pfx file",id:"extracting-the-certificate-and-keys-from-a-pfx-file",level:2},{value:"Extract .crt and .key files from .pfx file",id:"extract-crt-and-key-files-from-pfx-file",level:3},{value:"Convert .pfx file to .pem format",id:"convert-pfx-file-to-pem-format",level:3},{value:"TLS1.2 INADEQUATE_SECURITY Errors",id:"tls12-inadequate_security-errors",level:2}],p={toc:s},u="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik ",(0,a.kt)("a",{parentName:"p",href:"https://doc.traefik.io/traefik/routing/entrypoints/#tls"},"docs"),"."),(0,a.kt)("h3",{id:"generate-the-certificate"},"Generate the certificate"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"Note: Self-signed certificates are considered insecure for the Internet. Firefox will treat the site as having an invalid certificate, while Chrome will act as if the connection was plain HTTP.")),(0,a.kt)("p",null,"To create a new Self-Signed SSL Certificate, use the openssl req command (run on linux from the cosmos-project root):"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"openssl req -newkey rsa:4096 \\\n            -x509 \\\n            -sha256 \\\n            -days 3650 \\\n            -nodes \\\n            -out ./openc3-traefik/cert.crt \\\n            -keyout ./openc3-traefik/cert.key\n\nCountry Name (2 letter code) [XX]:.\nState or Province Name (full name) []:.\nLocality Name (eg, city) [Default City]:.\nOrganization Name (eg, company) [Default Company Ltd]:.\nOrganizational Unit Name (eg, section) []:.\nCommon Name (eg, your name or your server hostname) []: \x3c!-- UPDATE WITH YOUR HOSTNAME HERE --\x3e\nEmail Address []:\n")),(0,a.kt)("p",null,"Let's breakdown the command and understand what each option means:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"newkey rsa:4096")," - Creates a new certificate request and 4096 bit RSA key. The default one is 2048 bits."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"x509")," - Creates a X.509 Certificate."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"sha256")," - Use 265-bit SHA (Secure Hash Algorithm)."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"days 3650")," - The number of days to certify the certificate for. 3650 is ten years. You can use any positive integer."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"nodes")," - Creates a key without a passphrase."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"out ./openc3-traefik/cert.crt")," - Specifies the filename to write the newly created certificate to. You can specify any file name."),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"keyout ./openc3-traefik/cert.key")," - Specifies the filename to write the newly created private key to. You can specify any file name.")),(0,a.kt)("p",null,"For more information about the ",(0,a.kt)("inlineCode",{parentName:"p"},"openssl req")," command options, visit the ",(0,a.kt)("a",{parentName:"p",href:"https://www.openssl.org/docs/man1.0.2/man1/openssl-req.html"},"OpenSSL req documentation page"),"."),(0,a.kt)("h3",{id:"updating-the-openc3-traefik-dockerfile"},"Updating the openc3-traefik Dockerfile"),(0,a.kt)("p",null,"Add the new cert to the traefik Docker container."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},"--- a/openc3-traefik/Dockerfile\n+++ b/openc3-traefik/Dockerfile\n@@ -1,3 +1,4 @@\n FROM traefik:2.4\n COPY ./traefik.yaml /etc/traefik/traefik.yaml\n+COPY ./cert.crt ./cert.key /etc/certs/\n EXPOSE 80\n")),(0,a.kt)("h3",{id:"updating-the-traefik-config"},"Updating the Traefik config"),(0,a.kt)("p",null,"Configure Traefik to use the new cert file."),(0,a.kt)("p",null,"openc3-traefik/traefik.yaml"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},'--- a/openc3-traefik/traefik.yaml\n+++ b/openc3-traefik/traefik.yaml\n@@ -3,6 +3,17 @@\n+tls:\n+  certificates:\n+   - certFile: "/etc/certs/cert.crt"\n+     keyFile: "/etc/certs/cert.key"\n# Listen for everything coming in on the standard HTTP port\nentrypoints:\n  web:\n    address: ":80"\n+    http:\n+      redirections:\n+        entryPoint:\n+          to: websecure\n+          scheme: https\n+  websecure:\n+    address: ":443"\n+    http:\n+      tls:\n+        domains:\n+          - main: "\x3c!-- UPDATE WITH YOUR HOSTNAME HERE --\x3e"\n')),(0,a.kt)("h3",{id:"update-docker-composeyaml"},"Update docker-compose.yaml"),(0,a.kt)("p",null,"Update traefik to use secure port 443 instead of port 80."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-diff"},'--- a/compose.yaml\n+++ b/compose.yaml\n services:\n   openc3-minio:\n@@ -70,7 +70,7 @@ services:\n   openc3-traefik:\n     image: "ballaerospace/openc3-traefik:${OPENC3_TAG}"\n     ports:\n-      - "2900:80"\n+      - "443:443"\n     restart: "unless-stopped"\n     depends_on:\n')),(0,a.kt)("p",null,"Now you can run ",(0,a.kt)("inlineCode",{parentName:"p"},"./openc3.sh start")," to rebuild the Traefik container and it should include your new cert file."),(0,a.kt)("h2",{id:"lets-encrypt"},"Let's Encrypt"),(0,a.kt)("h4",{id:"key"},"KEY"),(0,a.kt)("p",null,'privkey.pem is the "key" file'),(0,a.kt)("p",null,"Sometimes it is named as cert.key or example.com.key."),(0,a.kt)("h4",{id:"crt"},"CRT"),(0,a.kt)("p",null,'fullchain.pem is your "crt" file.'),(0,a.kt)("p",null,"Sometimes it is named as example.com.crt."),(0,a.kt)("h4",{id:"crtkey-bundle"},"CRT/KEY Bundle"),(0,a.kt)("p",null,"bundle.pem would be made like so: cat fullchain.pem privkey.pem > bundle.pem"),(0,a.kt)("p",null,"HAProxy is the only server that I know of that uses bundle.pem."),(0,a.kt)("h4",{id:"certpem"},"cert.pem"),(0,a.kt)("p",null,"cert.pem contains ONLY your certificate, which can only be used by itself if the browser already has the certificate which signed it, which may work in testing (which makes it seem like it may be the right file), but will actually fail for many of your users in production with a security error of untrusted certificate."),(0,a.kt)("p",null,"However, you don't generally use the cert.pem by itself. It's almost always coupled with chain.pem as fullchain.pem."),(0,a.kt)("h4",{id:"chainpem"},"chain.pem"),(0,a.kt)("p",null,"chain.pem is the intermediary signed authority, signed by the root authority - which is what all browsers are guaranteed to have in their pre-built cache."),(0,a.kt)("h3",{id:"checking-certs"},"Checking certs"),(0,a.kt)("p",null,"You can inspect the cert like so:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl x509 -in cert.pem -text -noout\n")),(0,a.kt)("h2",{id:"extracting-the-certificate-and-keys-from-a-pfx-file"},"Extracting the certificate and keys from a .pfx file"),(0,a.kt)("p",null,"The .pfx file, which is in a PKCS#12 format, contains the SSL certificate (public keys) and the corresponding private keys. You might have to import the certificate and private keys separately in an unencrypted plain text format to use it on another system. This topic provides instructions on how to convert the .pfx file to .crt and .key files."),(0,a.kt)("h3",{id:"extract-crt-and-key-files-from-pfx-file"},"Extract .crt and .key files from .pfx file"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"PREREQUISITE: Ensure OpenSSL is installed in the server that contains the SSL certificate.")),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Start OpenSSL from the OpenSSL\\bin folder.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Open the command prompt and go to the folder that contains your .pfx file.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Run the following command to extract the private key:"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl pkcs12 -in [yourfile.pfx] -nocerts -out [drlive.key]\n")),(0,a.kt)("p",null,"You will be prompted to type the import password. Type the password that you used to protect your keypair when you created the .pfx file. You will be prompted again to provide a new password to protect the .key file that you are creating. Store the password to your key file in a secure place to avoid misuse."),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Run the following command to extract the certificate:")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl pkcs12 -in [yourfile.pfx] -clcerts -nokeys -out [drlive.crt]\n")),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Run the following command to decrypt the private key:")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl rsa -in [drlive.key] -out [drlive-decrypted.key]\n")),(0,a.kt)("p",null,"Type the password that you created to protect the private key file in the previous step.\nThe .crt file and the decrypted and encrypted .key files are available in the path, where you started OpenSSL."),(0,a.kt)("h3",{id:"convert-pfx-file-to-pem-format"},"Convert .pfx file to .pem format"),(0,a.kt)("p",null,"There might be instances where you might have to convert the .pfx file into .pem format. Run the following command to convert it into PEM format."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"openssl rsa -in [keyfile-encrypted.key] -outform PEM -out [keyfile-encrypted-pem.key]\n")),(0,a.kt)("h2",{id:"tls12-inadequate_security-errors"},"TLS1.2 INADEQUATE_SECURITY Errors"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://doc.traefik.io/traefik/https/tls/#cipher-suites"},"https://doc.traefik.io/traefik/https/tls/#cipher-suites")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://pkg.go.dev/crypto/tls#pkg-constants"},"https://pkg.go.dev/crypto/tls#pkg-constants"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-yaml"},"tls:\n  options:\n    default:\n      cipherSuites:\n        - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\n        - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\n        - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\n        - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\n        - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\n        - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\n")))}f.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(2784);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},u="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=s(n),d=a,m=u["".concat(c,".").concat(d)]||u[d]||f[d]||i;return n?r.createElement(m,o(o({ref:t},p),{},{components:n})):r.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=d;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var s=2;s<i;s++)o[s]=n[s];return r.createElement.apply(null,o)}return r.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/6b210247.248680ef.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5120],{961:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>l,metadata:()=>o,toc:()=>m});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:4,title:"Requirements and Design"},i=void 0,o={unversionedId:"getting-started/requirements",id:"getting-started/requirements",title:"Requirements and Design",description:"OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations.",source:"@site/docs/getting-started/requirements.md",sourceDirName:"getting-started",slug:"/getting-started/requirements",permalink:"/tools/docs/docs/getting-started/requirements",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/requirements.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{sidebar_position:4,title:"Requirements and Design"},sidebar:"defaultSidebar",previous:{title:"Upgrading",permalink:"/tools/docs/docs/getting-started/upgrading"},next:{title:"Podman",permalink:"/tools/docs/docs/getting-started/podman"}},d={},m=[{value:"Terminology",id:"terminology",level:2},{value:"Overall Architecture and Context Diagram",id:"overall-architecture-and-context-diagram",level:2},{value:"Overall Requirements",id:"overall-requirements",level:2},{value:"Api Requirements",id:"api-requirements",level:2},{value:"Command and Telemetry Server",id:"command-and-telemetry-server",level:2},{value:"Limits Monitor",id:"limits-monitor",level:2},{value:"Command Sender",id:"command-sender",level:2},{value:"Script Runner",id:"script-runner",level:2},{value:"Packet Viewer",id:"packet-viewer",level:2},{value:"Telemetry Viewer",id:"telemetry-viewer",level:2},{value:"Telemetry Grapher",id:"telemetry-grapher",level:2},{value:"Data Extractor",id:"data-extractor",level:2},{value:"Data Viewer",id:"data-viewer",level:2},{value:"Calendar",id:"calendar",level:2},{value:"Admin",id:"admin",level:2}],p={toc:m},s="wrapper";function u(t){let{components:e,...a}=t;return(0,r.kt)(s,(0,n.Z)({},p,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,"OpenC3 COSMOS is a command and control system providing commanding, scripting, and data visualization capabilities for embedded systems and systems of systems. COSMOS is intended for use during all phases of testing (board, box, integrated system) and during operations."),(0,r.kt)("p",null,"COSMOS is currently made up of the following applications:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Command and Telemetry Server")," - Provides status of realtime commanding, telemetry reception, logging, limits monitoring, and packet routing."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Limits Monitor")," - Monitors telemetry with defined limits and shows items that currently are or have violated limits."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Command Sender")," - Provides a graphical interface for manually sending individual commands."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Script Runner")," - Executes scripts and provides highlighting of the currently executing line. Now also includes TestRunner functionality."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Packet Viewer")," - Provides realtime visualization of every telemetry packet that has been defined."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Telemetry Viewer")," - Provides custom telemetry screen functionality with advanced layout and visualization widgets."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Telemetry Grapher")," - Provides realtime and offline graphing of telemetry data."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Data Extractor")," - Extracts telemetry and command packet log files into CSV data."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Data Viewer")," - Provides text based telemetry visualization for items."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Bucket Explorer")," - Browse the COSMOS bucket storage in any cloud environment."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Table Manager")," - Binary file editor with Script Runner integration for upload / download."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Handbooks")," - Generate html page of the command and telemetry definitions."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Calendar")," - Provides scheduling of commands and scripts. Also provides a framework for reserving resources."),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("strong",{parentName:"li"},"Admin")," - Provides an administrative interface to COSMOS.")),(0,r.kt)("p",null,"More detailed descriptions, requirements, and design for each tool are found later in this document. Additionally, each of the above applications is built using COSMOS libraries that are available for use as a framework to develop custom program/project applications."),(0,r.kt)("h2",{id:"terminology"},"Terminology"),(0,r.kt)("p",null,"The COSMOS system uses several terms that are important to understand. The following table defines these terms."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Term"),(0,r.kt)("th",{parentName:"tr",align:null},"Definition"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Target"),(0,r.kt)("td",{parentName:"tr",align:null},"A COSMOS target is an embedded system that the COSMOS Command and Telemetry Server connects to using an interface in order to send commands to and/or receive telemetry from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Command"),(0,r.kt)("td",{parentName:"tr",align:null},"A packet of information telling a target to perform an action of some sort.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Packet"),(0,r.kt)("td",{parentName:"tr",align:null},"A packet of information providing status from a target.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Interface"),(0,r.kt)("td",{parentName:"tr",align:null},"A Ruby class that knows how to send commands to and/or receive telemetry from a target. COSMOS comes with interfaces that support TCP/IP, UDP, and serial connections. Custom interfaces are easy to add to the system.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Ruby"),(0,r.kt)("td",{parentName:"tr",align:null},"The powerful dynamic programming language used to write the COSMOS applications and libraries as well as COSMOS scripts and test procedures.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Configuration Files"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS uses simple plain text configuration files to define commands and telemetry packets, and to configure each COSMOS application. These files are easily human readable/editable and machine readable/editable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Packet Log Files"),(0,r.kt)("td",{parentName:"tr",align:null},"Binary files containing either logged commands or telemetry packets.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Message Log Files"),(0,r.kt)("td",{parentName:"tr",align:null},"Text files containing messages generated by the system.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Tool"),(0,r.kt)("td",{parentName:"tr",align:null},"Another name for a COSMOS application.")))),(0,r.kt)("h2",{id:"overall-architecture-and-context-diagram"},"Overall Architecture and Context Diagram"),(0,r.kt)("p",null,"The following diagram shows the COSMOS 5 architecture."),(0,r.kt)("p",null,"COSMOS Architecture /img/v5/architecture.png"),(0,r.kt)("p",null,"Key aspects of this architecture:"),(0,r.kt)("p",null,"COSMOS 5 is a cloud native, containerized, microservice oriented command and control system. All the COSMOS microservices are docker containers which is why Docker is shown containing the entire COSMOS system. The green boxes on the left represent external embedded systems (Targets) which COSMOS connects to. The Redis data store contains the configuration for all the microservices, the current value table, as well as data streams containing decommutated data. The Minio data store contains plugins, targets, configuration data, text logs as well as binary logs of all the raw, decommutated, and reduced data. Users interact with COSMOS from a web browser which routes through the internal Traefik load balancer."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"COSMOS can connect to many different kinds of targets. The examples include things like Flight software (FSW), Ground Support Equipment (GSE), Labview, and COTS targets such as an Agilent power supply. Any embedded system that provides a communication interface can be connected to COSMOS."),(0,r.kt)("li",{parentName:"ul"},"COSMOS ships with interfaces for connecting over TCP/IP, UDP, MQTT, and serial connections. This covers most systems, but custom interfaces can also be written to connect to anything."),(0,r.kt)("li",{parentName:"ul"},"All realtime communication with targets flows through the COSMOS system. This ensures all commands and telemetry are logged."),(0,r.kt)("li",{parentName:"ul"},"Every tool is configured with plain text configuration files."),(0,r.kt)("li",{parentName:"ul"},"Program specific tools can be written using the COSMOS libraries that can interact with the realtime command and telemetry streams and can process logged data.")),(0,r.kt)("h2",{id:"overall-requirements"},"Overall Requirements"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-1"),(0,r.kt)("td",{parentName:"tr",align:null},"All COSMOS core functionality shall be containerized."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify COSMOS is running in Docker")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS user interface shall be accessible from Chromium based web browsers"),(0,r.kt)("td",{parentName:"tr",align:null},"Open COSMOS in Chrome/Edge")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS user interface shall be accessible from the Firefox web browser"),(0,r.kt)("td",{parentName:"tr",align:null},"Open COSMOS in Firefox")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-4"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall log all commands sent"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-5"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall log all telemetry received"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-6"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall decommutate all telemetry packets recieved"),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-7"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall support autonomously attempting to connect to targets."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify targets are connected upon starting the CTS.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-8"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp telemetry packets upon receipt."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify logged packets are timestamped.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-9"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp telemetry packets to a resolution of 1 millisecond or better. Note: This requirement only refers to resolution. COSMOS does not run on real-time operating systems and accuracy cannot be guaranteed."),(0,r.kt)("td",{parentName:"tr",align:null},"View time stamps in log.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-10"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall time stamp received telemetry with a UTC timestamp."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify logged time stamps are as expected.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS-11"),(0,r.kt)("td",{parentName:"tr",align:null},"COSMOS shall maintain a timestamped log of commands received, limits violations, and errors encountered."),(0,r.kt)("td",{parentName:"tr",align:null},"View COSMOS message log.")))),(0,r.kt)("h2",{id:"api-requirements"},"Api Requirements"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted connection and disconnection of interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"Disconnect and connect an interface from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted connection and disconnection of routers."),(0,r.kt)("td",{parentName:"tr",align:null},"Disconnect and connect a router from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow scripted setting of the current limits set."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a different limits set from a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow commanding of targets"),(0,r.kt)("td",{parentName:"tr",align:null},"Send a command")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow reading the current value of any telemetry item"),(0,r.kt)("td",{parentName:"tr",align:null},"Read a telemetry point")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow streaming realtime and logged telemetry packets"),(0,r.kt)("td",{parentName:"tr",align:null},"Stream telemetry packets")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow streaming realtime and logged command packets"),(0,r.kt)("td",{parentName:"tr",align:null},"Stream command packets")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"API-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The COSMOS API shall allow starting COSMOS scripts"),(0,r.kt)("td",{parentName:"tr",align:null},"Start a script using the API")))),(0,r.kt)("h2",{id:"command-and-telemetry-server"},"Command and Telemetry Server"),(0,r.kt)("p",null,"The Command and Telemetry server provides status on the the overall COSMOS installation for a specific scope."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Interfaces tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manual connection and disconnection of interfaces."),(0,r.kt)("td",{parentName:"tr",align:null},"Press a GUI button to disconnect and connect an interface.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all targets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Targets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of known commands."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Cmd Packets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display raw command data for the most recent command received."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Cmd Packets tab and click the View Raw button for a command.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of known telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Tlm Packets tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display raw telemetry packet data for the most recent telemetry packet received."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Tlm Packets tab and click the View Raw button for a telemetry packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display a list of all routers."),(0,r.kt)("td",{parentName:"tr",align:null},"View the Routers tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-9"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manual connection and disconnection of routers."),(0,r.kt)("td",{parentName:"tr",align:null},"Press a GUI button to disconnect and connect a router.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-10"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall allow manually setting the current limits set."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a different limits set from the combobox.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-11"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall support opening telemetry packets in Packet Viewer."),(0,r.kt)("td",{parentName:"tr",align:null},"On the Tlm Packets tab click View in Packet Viewer for a telemetry packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CTS-12"),(0,r.kt)("td",{parentName:"tr",align:null},"The Command and Telemetry Server shall display time stamps in local time."),(0,r.kt)("td",{parentName:"tr",align:null},"View time stamps in log.")))),(0,r.kt)("h2",{id:"limits-monitor"},"Limits Monitor"),(0,r.kt)("p",null,"Limits Monitor displays all telemetry points that are currently out of limits and also shows any telemetry points that have gone out of limits since Limits Monitor was started."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall display all telemetry points currently out of limits."),(0,r.kt)("td",{parentName:"tr",align:null},"View displayed telemetry points.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support ignoring telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Click ignore on a telemetry point.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall keep a displayed log of limits violations."),(0,r.kt)("td",{parentName:"tr",align:null},"View the log tab.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall continue displaying a telemetry point that temporarily went out of limits."),(0,r.kt)("td",{parentName:"tr",align:null},"Watch until a telemetry points returns to green.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support saving its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Save the configuration.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"LM-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Limits Monitor shall support loading its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Load the configuration.")))),(0,r.kt)("h2",{id:"command-sender"},"Command Sender"),(0,r.kt)("p",null,"Command Sender provides an easy method to send single commands to targets. The graphical user interface provides simple dropdowns to quickly select the desired command to send organized by target name and command name. After the user has selected the command, they then fill in the desired command parameters and click send to send the command to the target."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow selection of a command by target name and packet name."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific command by target name and packet name in the drop down menus.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow sending the selected command."),(0,r.kt)("td",{parentName:"tr",align:null},"Send the selected command by pressing the Send button.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall display non-ignored parameters for the selected command."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific command and verify the expected parameters are shown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall provide a mechanism to select state values for command parameters with states."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific state value for a specific command with states.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow sending a manually entered value for a command parameter with states."),(0,r.kt)("td",{parentName:"tr",align:null},"Manually enter a value for a specific command with states.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall refuse to send commands if required parameters are not provided."),(0,r.kt)("td",{parentName:"tr",align:null},"Attempt to send a command with a required parameter not filled out.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall support sending commands while ignoring range checking."),(0,r.kt)("td",{parentName:"tr",align:null},"Enter Ignore Range Checking mode and then send a command with an out of range parameter.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall optionally display state values in hex."),(0,r.kt)("td",{parentName:"tr",align:null},'Enter "Display State Values in Hex" mode and verify state values are displayed as hex.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall optionally display ignored command parameters."),(0,r.kt)("td",{parentName:"tr",align:null},'Enter "Show Ignored Parameters" mode and verify ignored parameters are displayed.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall respect hazardous commands and notify the user before proceeding."),(0,r.kt)("td",{parentName:"tr",align:null},"Send a hazardous command and verify a dialog box appears before the command is sent. Verify both accepting the dialog and declining to send.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-11"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall keep a command history of each command sent."),(0,r.kt)("td",{parentName:"tr",align:null},"Send a command and verify that it shows up in the command history box.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"CMD-12"),(0,r.kt)("td",{parentName:"tr",align:null},"Command Sender shall allow resending of any command in the command history."),(0,r.kt)("td",{parentName:"tr",align:null},"Resend one of the commands in the command history box.")))),(0,r.kt)("h2",{id:"script-runner"},"Script Runner"),(0,r.kt)("p",null,"Script Runner provides a visual interface for editing and executing scripts/procedures. A full featured text editor provides syntax highlighting and code completion while developing scripts. During script execution, the currently executing line is highlighted and any logged messages are highlighted to the user. If any failure occurs, the script is paused and the user alerted. The user can then decide whether to stop the script, or ignore the failure and continue. The user can also retry the failed lines, or other nearby lines before proceeding."),(0,r.kt)("p",null,"Script Runner now also provides a structured methodology for designing system level scripting that mirrors the very successful pattern used in software unit tests (previously implemented in the Test Runner tool). System level tests/procedures are built up of cases that are organized into groups. For example, you might have one group that verified all of the requirements associated with a particular mechanism. Ideally you would break this down into individual cases for different scenarios. One perhaps for opening a shutter, another for closing it, etc. Cases are ideally small and independent tasks. A number of these groups are then combined into an overall suite which would be run to execute a major test such as EMI, or software FQT."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide a text editor for developing test scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Open Script Runner and create a simple test script. Perform all standard file operations including New, Open, Reload, Close, Save, and Save As. Perform all standard editing operations such as Cut, Copy, Paste, Undo, Redo, Select All, and Comment/Uncomment lines.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide search and replace functionality."),(0,r.kt)("td",{parentName:"tr",align:null},"Perform all standard search and replace functionality, including search, replace, find next, and find previous.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall provide code completion for cmd(), tlm(), and wait_check() COSMOS API methods. Note: Other methods may also be supported."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script and exercise code completion on the mentioned keywords.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall execute Ruby-based COSMOS scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Press start and execute a script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall highlight the currently executing line of the script."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify that lines are highlighted as a test script executes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall allow pausing an executing script."),(0,r.kt)("td",{parentName:"tr",align:null},"Press pause button and verify script is paused. Press start to resume.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall allow stopping an executing script."),(0,r.kt)("td",{parentName:"tr",align:null},"Press stop and verify script stops.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall pause an executing script upon the occurance of an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a statement that is guaranteed to fail and verify that the script is paused.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log commands sent."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that sends a command and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log text written to STDOUT. Note: Typically through the puts method."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that uses puts to write a message and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-11"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log wait times."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a script that includes a wait method and verify wait time is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-12"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log errors that occur while the script is executing."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a check statement that is guaranteed to fail and verify it is logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-13"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall log check statement success and failure."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a script with a check statement that is guaranteed to fail and one that is guaranteed to succeeed. Verify both the success and failure are logged.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-14"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support executing selected lines."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a set of lines and execute them using Script->Execute Selected Lines.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-15"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support executing selected lines while paused."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a set of lines and execute them from the right-click context menu.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-16"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support starting a script from any line."),(0,r.kt)("td",{parentName:"tr",align:null},"Place the mouse cursor at the desired first line and then select Script->Execute From Cursor.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-17"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a mnemonic checking function."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Mnemonic Check.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-18"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a syntax checking function."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Ruby Syntax Check.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-19"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support viewing the script instrumentation."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->View Instrumented Script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-20"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support an disconnected mode to allow for executing scripts without a connection to the Command and Telemetry Server."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Toggle Disconnect. Execute a script with commands and check statements and verify that it runs to completion.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-21"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a Debug terminal to aid in debugging scripts."),(0,r.kt)("td",{parentName:"tr",align:null},"Select Script->Toggle Debug.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-22"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support a step mode where the script will stop and wait for use interaction after each line."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Step to progress through the script.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-23"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner shall support breakpoint functionality."),(0,r.kt)("td",{parentName:"tr",align:null},"Create a breakpoint then execute the script and verify it stops at the specified line.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-25"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test suites."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test suite.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-26"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test groups."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test group.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-27"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing individual test cases."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute an individual test case.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-28"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing test group setup and teardown methods individually."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test group setup. Execute a test group teardown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-29"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support executing test suite setup and teardown methods individually."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test suite setup. Execute a test suite teardown.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-30"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall create a report after executing any suite test."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify a report is generated after executing a suite.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-31"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support pausing when an error occurs."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the pause on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-32"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support allowing the user to proceed on an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the Allow go/retry on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-33"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support aborting execution on an error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the abort on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-34"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support looping a test."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the loop testing box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-35"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support breaking the looping of a test on error."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the break loop on error box checked and without.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-36"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support a user readable flag indicating that loop testing is occurring."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script that checks the $loop_testing variable while looping and again while not looping.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"SR-37"),(0,r.kt)("td",{parentName:"tr",align:null},"Script Runner Suite Mode shall support a user readable flag indicating manual operations are desired."),(0,r.kt)("td",{parentName:"tr",align:null},"Execute a test script with the manual box checked and without.")))),(0,r.kt)("h2",{id:"packet-viewer"},"Packet Viewer"),(0,r.kt)("p",null,"Packet Viewer provides a simple tool to view the realtime contents of any telemetry packet defined in the system in a tabular, key-value format."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall allow selection of a telemetry packet by target name and packet name."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a specific telemetry packet by target name and packet name in the drop down menus.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall display the contents of the selected telemetry packet."),(0,r.kt)("td",{parentName:"tr",align:null},"Ensure all items of the selected telemetry packet are displayed and updating.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall provide a mechanism to get detailed information on a telemetry item."),(0,r.kt)("td",{parentName:"tr",align:null},'Right click on a telemetry item and select "Details" from the context menu.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall provide a mechanism to view a graph of any telemetry item."),(0,r.kt)("td",{parentName:"tr",align:null},'Right click on a telemetry item and select "Graph" from the context menu.')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall color telemetry values based upon limits state."),(0,r.kt)("td",{parentName:"tr",align:null},"View a packet with items containing limits and verify they are colored.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support a configurable polling rate."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Options and change the polling rate.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support a color-blind mode to allow distinguishing limits states for those who are color blind."),(0,r.kt)("td",{parentName:"tr",align:null},"Select View->Color Blind Mode and verify that items with limits are also displayed with a textual indication of limits state color.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"PV-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Packet Viewer shall support displaying telemetry in each of the four COSMOS value types (raw, converted, formatted, and formatted with units)"),(0,r.kt)("td",{parentName:"tr",align:null},"In the View menu, select each of the four value types and verify values are displayed accordingly.")))),(0,r.kt)("h2",{id:"telemetry-viewer"},"Telemetry Viewer"),(0,r.kt)("p",null,'Telemetry Viewer provides a way to organize telemetry points into custom "screens" that allow for the creation of unique and organized views of telemetry data. Screens are made up of widgets or small GUI components that display telemetry in unique ways.'),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall display user-defined telemetry screens."),(0,r.kt)("td",{parentName:"tr",align:null},"Open a telemetry")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall display realtime data."),(0,r.kt)("td",{parentName:"tr",align:null},"Verify telemetry screens show realtime data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Viewer shall support saving open telemetry screens and their positions."),(0,r.kt)("td",{parentName:"tr",align:null},"Open three telemetry screens and then select File->Save Configuration.")))),(0,r.kt)("h2",{id:"telemetry-grapher"},"Telemetry Grapher"),(0,r.kt)("p",null,"Telemetry Grapher performs graphing of telemetry points in both realtime and log file playback."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall provide line graphs of telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Add several housekeeping data objects to a plot.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support realtime graphing of telemetry."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Start to start realtime graphing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing data from logged telemetry."),(0,r.kt)("td",{parentName:"tr",align:null},"Select the menu option to graph data from a logged data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support multiple plots per browser tab."),(0,r.kt)("td",{parentName:"tr",align:null},"Add multiple plots.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support multiple telemetry points per plot."),(0,r.kt)("td",{parentName:"tr",align:null},"Add multiple data objects to one plot.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support saving a variable number of data points."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Points Saved.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing a variable duration of time."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Seconds Plotted.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support graphing a variable number of data points."),(0,r.kt)("td",{parentName:"tr",align:null},"Edit Points Plotted.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-9"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support saving its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Save the current configuration.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TG-10"),(0,r.kt)("td",{parentName:"tr",align:null},"Telemetry Grapher shall support loading its configuration."),(0,r.kt)("td",{parentName:"tr",align:null},"Load the previously saved configuration.")))),(0,r.kt)("h2",{id:"data-extractor"},"Data Extractor"),(0,r.kt)("p",null,"Data Extractor processes logged data and extracts data into a CSV format for analysis in Excel or other tools."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding individual telemetry points."),(0,r.kt)("td",{parentName:"tr",align:null},"Add an individual telemetry point.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding entire telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Add an entire packet.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support adding entire telemetry targets."),(0,r.kt)("td",{parentName:"tr",align:null},"Add all packets for a target.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support selecting the value type to extract for each telemetry point (RAW, CONVERTED, FORMATTED, WITH_UNITS)"),(0,r.kt)("td",{parentName:"tr",align:null},"Click an item and change the value type.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support saving configurations."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Save Config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support loading configurations."),(0,r.kt)("td",{parentName:"tr",align:null},"Select File->Load Config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DE-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Extractor shall support deleting items"),(0,r.kt)("td",{parentName:"tr",align:null},"Select an Item and press delete")))),(0,r.kt)("h2",{id:"data-viewer"},"Data Viewer"),(0,r.kt)("p",null,"Data Viewer provides for textual display of telemetry packets where other display methods are not a good fit. It is especially useful for memory dumps and for log message type data display."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support realtime processing of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Press Start to start realtime processing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support logged playback of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"Select a time range to playback.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support textual display of telemetry packets."),(0,r.kt)("td",{parentName:"tr",align:null},"View the display of data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support multiple tabs for data display."),(0,r.kt)("td",{parentName:"tr",align:null},"Switch between several tabs of data.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"DV-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Viewer shall support deleting tabs."),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a tab.")))),(0,r.kt)("h2",{id:"calendar"},"Calendar"),(0,r.kt)("p",null,"Calendar"),(0,r.kt)("p",null,"The Calendar tool provides a user interface and API for initiating scheduled actions in COSMOS"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-1"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow creating new timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Click the button and create a new timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-2"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow scheduling commands for future execection"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a command to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-3"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow scheduling scripts for future execution"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a script to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-4"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow for reserving a resource"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a reservation to a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-5"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall track success or failure of commands"),(0,r.kt)("td",{parentName:"tr",align:null},"Look at status from a completed command")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-6"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall track success or failure of scripts"),(0,r.kt)("td",{parentName:"tr",align:null},"Look at status from a completed script")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-7"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow deleting activities from timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a preexisting item from a timeline")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"TL-8"),(0,r.kt)("td",{parentName:"tr",align:null},"Calendar shall allow deleting timelines"),(0,r.kt)("td",{parentName:"tr",align:null},"Delete a timeline")))),(0,r.kt)("h2",{id:"admin"},"Admin"),(0,r.kt)("p",null,"Admin"),(0,r.kt)("p",null,"The Admin tool provides administrative functionality including managing plugins for the COSMOS system"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Reqt. ID"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Test Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-1"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall allow installing plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Upload and Install a Plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-2"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support upgrading plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Upgrade an installed plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-3"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support uninstalling plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Uninstall a plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-4"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall display information on installed plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"View info on Interfaces, Microservices, etc")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-5"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support editing microservices"),(0,r.kt)("td",{parentName:"tr",align:null},"Edit the settings for a microservice")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-6"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support discovery of plugins"),(0,r.kt)("td",{parentName:"tr",align:null},"Discover and download a plugin")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-7"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support adding links to external tools"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a link to Google")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-8"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support reordering tools"),(0,r.kt)("td",{parentName:"tr",align:null},"Reorder tools on the tools tab")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"AD-9"),(0,r.kt)("td",{parentName:"tr",align:null},"The Admin Tool shall support configuring a classification bar"),(0,r.kt)("td",{parentName:"tr",align:null},"Add a classification bar on the settings tab")))))}u.isMDXComponent=!0},876:(t,e,a)=>{a.d(e,{Zo:()=>p,kt:()=>g});var n=a(2784);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function l(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function i(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?l(Object(a),!0).forEach((function(e){r(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function o(t,e){if(null==t)return{};var a,n,r=function(t,e){if(null==t)return{};var a,n,r={},l=Object.keys(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),m=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):i(i({},e),t)),a},p=function(t){var e=m(t.components);return n.createElement(d.Provider,{value:e},t.children)},s="mdxType",u={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},c=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,d=t.parentName,p=o(t,["components","mdxType","originalType","parentName"]),s=m(a),c=r,g=s["".concat(d,".").concat(c)]||s[c]||u[c]||l;return a?n.createElement(g,i(i({ref:e},p),{},{components:a})):n.createElement(g,i({ref:e},p))}));function g(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var d in e)hasOwnProperty.call(e,d)&&(o[d]=e[d]);o.originalType=t,o[s]="string"==typeof t?t:r,i[1]=o;for(var m=2;m<l;m++)i[m]=a[m];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}c.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/6b65133b.2144fb1b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[6744],{7307:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var i=n(7896),r=(n(2784),n(876));const o={title:"Telemetry Viewer"},a=void 0,l={unversionedId:"tools/tlm-viewer",id:"tools/tlm-viewer",title:"Telemetry Viewer",description:"Introduction",source:"@site/docs/tools/tlm-viewer.md",sourceDirName:"tools",slug:"/tools/tlm-viewer",permalink:"/tools/docs/docs/tools/tlm-viewer",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/tlm-viewer.md",tags:[],version:"current",frontMatter:{title:"Telemetry Viewer"},sidebar:"defaultSidebar",previous:{title:"Telemetry Grapher",permalink:"/tools/docs/docs/tools/tlm-grapher"},next:{title:"Guides",permalink:"/tools/docs/docs/guides"}},c={},s=[{value:"Introduction",id:"introduction",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Open Configuration",id:"open-configuration",level:4},{value:"Save Configuration",id:"save-configuration",level:4},{value:"Selecting Screens",id:"selecting-screens",level:2},{value:"New Screen",id:"new-screen",level:2},{value:"Edit Screen",id:"edit-screen",level:2},{value:"Screen Window Management",id:"screen-window-management",level:2},{value:"Building Screens",id:"building-screens",level:2}],d={toc:s},u="wrapper";function p(e){let{components:t,...o}=e;return(0,r.kt)(u,(0,i.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"Telemetry Viewer is a live telemetry viewer which displays custom built screens. Screens are configured through simple text files which utilize numerous build-in widgets."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(1625).Z,width:"1064",height:"818"})),(0,r.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,r.kt)("img",{src:"/img/v5/telemetry_viewer/file_menu.png",alt:"File Menu",style:{float:"left","margin-right":"50px",height:"80px"}}),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Open a saved configuration"),(0,r.kt)("li",{parentName:"ul"},"Save the current configuration")),(0,r.kt)("h4",{id:"open-configuration"},"Open Configuration"),(0,r.kt)("p",null,"The Open and Save Configuration options deserve a little more explanation. When you select File Open the Open Configuration dialog appears. It displays a list of all saved configurations (TVAC in this example). You select a configuration and then click Ok to load it. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Open Config",src:n(2623).Z,width:"537",height:"249"})),(0,r.kt)("h4",{id:"save-configuration"},"Save Configuration"),(0,r.kt)("p",null,"When you select File Save the Save Configuration dialog appears. It displays a list of all saved configurations (TVAC in this example). You click the Configuration Name text field, enter the name of your new configuration, and click Ok to save. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Save Config",src:n(5341).Z,width:"537",height:"291"})),(0,r.kt)("h2",{id:"selecting-screens"},"Selecting Screens"),(0,r.kt)("p",null,"Selecting a target from the Select Target drop down automatically updates the available screens for that target in the Select Screen drop down. Clicking Show Screen causes that screen to display."),(0,r.kt)("h2",{id:"new-screen"},"New Screen"),(0,r.kt)("p",null,"Clicking New Screen brings up the new screen dialog."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(5148).Z,width:"536",height:"300"})),(0,r.kt)("p",null,"Screens are owned by Targets so Select Target chooses where the screen will be created. Screen names must be unique so all the existing screen names are listed for that target. Screens can be based on a Packet such that all the items in that particular packet will be generated in a simple vertical screen similar to Packet Viewer. This is a good starting point for customizing a screen."),(0,r.kt)("h2",{id:"edit-screen"},"Edit Screen"),(0,r.kt)("p",null,"Clicking the pencil icon in the title bar of the screen brings up the edit dialog."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Telemetry Viewer",src:n(6289).Z,width:"796",height:"673"})),(0,r.kt)("p",null,"The screen source is displayed in an editor with syntax highlighting and auto-completion. You can download the screen source using the download button in the upper right or delete the screen using the trash icon in the upper left. Click Save to save the screen edits at which point Telemetry Viewer will re-render the screen."),(0,r.kt)("h2",{id:"screen-window-management"},"Screen Window Management"),(0,r.kt)("p",null,"All screens can be moved around the browser window by clicking their title bar and moving them. Other screens will move around intelligently to fill the space. This allows you to order the screens no matter which order they were created in."),(0,r.kt)("p",null,"Each screen has buttons in the upper right of the title bar. The line button minimizes the screen to effectively hide it. This allows you to focus on a single screen without closing existing screens."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"Minimized",src:n(6179).Z,width:"537",height:"202"})),(0,r.kt)("p",null,"The X button closes the screen."),(0,r.kt)("h2",{id:"building-screens"},"Building Screens"),(0,r.kt)("p",null,"For documentation on how to build Telemetry Screens and how to configure the\nscreen widgets please see the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry-screens"},"Telemetry Screens"),"."))}p.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var i=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,i,r=function(e,t){if(null==e)return{};var n,i,r={},o=Object.keys(e);for(i=0;i<o.length;i++)n=o[i],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i<o.length;i++)n=o[i],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=i.createContext({}),s=function(e){var t=i.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},d=function(e){var t=s(e.components);return i.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},g=i.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=s(n),g=r,h=u["".concat(c,".").concat(g)]||u[g]||p[g]||o;return n?i.createElement(h,a(a({ref:t},d),{},{components:n})):i.createElement(h,a({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=g;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[u]="string"==typeof e?e:r,a[1]=l;for(var s=2;s<o;s++)a[s]=n[s];return i.createElement.apply(null,a)}return i.createElement.apply(null,n)}g.displayName="MDXCreateElement"},6289:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/edit_screen-5724ae13958c1631b3c187cf7cdb6dc9672ecd71f8b0786ac17c0266001edac3.png"},6179:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/minimized-59d0d8d8a179ff0475787e87237b77b24d59d78826d43dbc1a554a51380eb37f.png"},5148:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/new_screen-295720ec60219194c8c8dd64c755e8a188cc4a68c2b6cf66197b54514644d52a.png"},2623:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/open_config-2e61415a3c2d7a4ce427cf325f3708dd4a761092b7dd0c869279c4354dc34ae4.png"},5341:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/save_config-e748a338526ffd8f9e49def5c0d15f8a80cd987f40d210ff6c6d4b61b713555c.png"},1625:(e,t,n)=>{n.d(t,{Z:()=>i});const i=n.p+"assets/images/telemetry_viewer-be6ee576f1efceb39c2f744889deb4c18f571c4922c69d5d0e5f49a653776a46.png"}}]);

data/tools/docs/assets/js/6f92e431.608f28e7.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7476],{7475:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>p,toc:()=>l});var o=r(7896),n=(r(2784),r(876));const a={title:"Roadmap"},c=void 0,p={unversionedId:"development/roadmap",id:"development/roadmap",title:"Roadmap",description:"Our product roadmap is a Github Project found at the link below.",source:"@site/docs/development/roadmap.md",sourceDirName:"development",slug:"/development/roadmap",permalink:"/tools/docs/docs/development/roadmap",draft:!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/docs/docs/development/log-structure"},next:{title:"Streaming API",permalink:"/tools/docs/docs/development/streaming-api"}},i={},l=[],u={toc:l},s="wrapper";function d(e){let{components:t,...r}=e;return(0,n.kt)(s,(0,o.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"Our product roadmap is a Github Project found at the link below."),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/orgs/openc3/projects/2/views/1"},"Roadmap")),(0,n.kt)("p",null,"If you would like to commit feature ideas for our roadmap, please do so with normal Github issues at the main repo."))}d.isMDXComponent=!0},876:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});var o=r(2784);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function c(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?a(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):a(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function p(e,t){if(null==e)return{};var r,o,n=function(e,t){if(null==e)return{};var r,o,n={},a=Object.keys(e);for(o=0;o<a.length;o++)r=a[o],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o<a.length;o++)r=a[o],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=o.createContext({}),l=function(e){var t=o.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},u=function(e){var t=l(e.components);return o.createElement(i.Provider,{value:t},e.children)},s="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,a=e.originalType,i=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),s=l(r),m=n,f=s["".concat(i,".").concat(m)]||s[m]||d[m]||a;return r?o.createElement(f,c(c({ref:t},u),{},{components:r})):o.createElement(f,c({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var a=r.length,c=new Array(a);c[0]=m;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[s]="string"==typeof e?e:n,c[1]=p;for(var l=2;l<a;l++)c[l]=r[l];return o.createElement.apply(null,c)}return o.createElement.apply(null,r)}m.displayName="MDXCreateElement"}}]);