openc3-cosmos-tool-docs 5.12.0 → 5.13.0

data/tools/staticdocs/assets/js/9424f0b3.d0685f0f.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5390],{6796:(e,s,d)=>{d.r(s),d.d(s,{assets:()=>h,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var n=d(2322),r=d(5392);const t={sidebar_position:9,title:"Screens"},i=void 0,l={id:"configuration/telemetry-screens",title:"Screens",description:"This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application.",source:"@site/docs/configuration/telemetry-screens.md",sourceDirName:"configuration",slug:"/configuration/telemetry-screens",permalink:"/tools/staticdocs/docs/configuration/telemetry-screens",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/telemetry-screens.md",tags:[],version:"current",sidebarPosition:9,frontMatter:{sidebar_position:9,title:"Screens"},sidebar:"defaultSidebar",previous:{title:"Tables",permalink:"/tools/staticdocs/docs/configuration/table"},next:{title:"SSL-TLS",permalink:"/tools/staticdocs/docs/configuration/ssl-tls"}},h={},c=[{value:"Definitions",id:"definitions",level:2},{value:"Telemetry Screen Definition Files",id:"telemetry-screen-definition-files",level:2},{value:"New Widgets",id:"new-widgets",level:2},{value:"SCREEN",id:"screen",level:2},{value:"END",id:"end",level:2},{value:"STALE_TIME",id:"stale_time",level:2},{value:"GLOBAL_SETTING",id:"global_setting",level:2},{value:"GLOBAL_SUBSETTING",id:"global_subsetting",level:2},{value:"SETTING",id:"setting",level:2},{value:"WIDTH",id:"width",level:3},{value:"HEIGHT",id:"height",level:3},{value:"MARGIN",id:"margin",level:3},{value:"PADDING",id:"padding",level:3},{value:"BACKCOLOR",id:"backcolor",level:3},{value:"TEXTCOLOR",id:"textcolor",level:3},{value:"BORDERCOLOR",id:"bordercolor",level:3},{value:"RAW",id:"raw",level:3},{value:"SUBSETTING",id:"subsetting",level:2},{value:"NAMED_WIDGET",id:"named_widget",level:2},{value:"Layout Widgets",id:"layout-widgets",level:2},{value:"VERTICAL",id:"vertical",level:3},{value:"VERTICALBOX",id:"verticalbox",level:3},{value:"HORIZONTAL",id:"horizontal",level:3},{value:"HORIZONTALBOX",id:"horizontalbox",level:3},{value:"MATRIXBYCOLUMNS",id:"matrixbycolumns",level:3},{value:"SCROLLWINDOW",id:"scrollwindow",level:3},{value:"TABBOOK",id:"tabbook",level:3},{value:"TABITEM",id:"tabitem",level:3},{value:"IFRAME",id:"iframe",level:3},{value:"Decoration Widgets",id:"decoration-widgets",level:2},{value:"LABEL",id:"label",level:3},{value:"HORIZONTALLINE",id:"horizontalline",level:3},{value:"SECTIONHEADER",id:"sectionheader",level:3},{value:"TITLE",id:"title",level:3},{value:"SPACER",id:"spacer",level:3},{value:"Telemetry Widgets",id:"telemetry-widgets",level:2},{value:"ARRAY",id:"array",level:3},{value:"BLOCK",id:"block",level:3},{value:"FORMATVALUE",id:"formatvalue",level:3},{value:"LABELLED",id:"labelled",level:3},{value:"LED_COLOR",id:"led_color",level:4},{value:"LABELPROGRESSBAR",id:"labelprogressbar",level:3},{value:"LABELVALUE",id:"labelvalue",level:3},{value:"LABELVALUEDESC",id:"labelvaluedesc",level:3},{value:"LABELVALUELIMITSBAR",id:"labelvaluelimitsbar",level:3},{value:"LABELVALUELIMITSCOLUMN",id:"labelvaluelimitscolumn",level:3},{value:"LABELVALUERANGEBAR",id:"labelvaluerangebar",level:3},{value:"LED",id:"led",level:3},{value:"LED_COLOR",id:"led_color-1",level:4},{value:"LIMITSBAR",id:"limitsbar",level:3},{value:"LIMITSCOLUMN",id:"limitscolumn",level:3},{value:"LIMITSCOLOR",id:"limitscolor",level:3},{value:"VALUELIMITSBAR",id:"valuelimitsbar",level:3},{value:"VALUELIMITSCOLUMN",id:"valuelimitscolumn",level:3},{value:"VALUERANGEBAR",id:"valuerangebar",level:3},{value:"LINEGRAPH",id:"linegraph",level:3},{value:"ITEM",id:"item",level:4},{value:"STARTTIME",id:"starttime",level:4},{value:"HISTORY",id:"history",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed",level:4},{value:"POINTSSAVED",id:"pointssaved",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed",level:4},{value:"SIZE",id:"size",level:4},{value:"SPARKLINE",id:"sparkline",level:3},{value:"ITEM",id:"item-1",level:4},{value:"STARTTIME",id:"starttime-1",level:4},{value:"HISTORY",id:"history-1",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed-1",level:4},{value:"POINTSSAVED",id:"pointssaved-1",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed-1",level:4},{value:"SIZE",id:"size-1",level:4},{value:"LABELSPARKLINE",id:"labelsparkline",level:3},{value:"ITEM",id:"item-2",level:4},{value:"STARTTIME",id:"starttime-2",level:4},{value:"HISTORY",id:"history-2",level:4},{value:"SECONDSGRAPHED",id:"secondsgraphed-2",level:4},{value:"POINTSSAVED",id:"pointssaved-2",level:4},{value:"POINTSGRAPHED",id:"pointsgraphed-2",level:4},{value:"SIZE",id:"size-2",level:4},{value:"IMAGEVIEWER",id:"imageviewer",level:3},{value:"PROGRESSBAR",id:"progressbar",level:3},{value:"RANGEBAR",id:"rangebar",level:3},{value:"TEXTBOX",id:"textbox",level:3},{value:"VALUE",id:"value",level:3},{value:"Interactive Widgets",id:"interactive-widgets",level:2},{value:"BUTTON",id:"button",level:3},{value:"Button code can get rather complex so remember to use string concatenation\nto make things more readable. If you use <code>+</code> newlines are inserted automatically\nduring string concatenation. If you use `---\nsidebar_position: 9\ntitle: Screens",id:"button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens",level:2},{value:"Definitions",id:"definitions-1",level:2},{value:"Telemetry Screen Definition Files",id:"telemetry-screen-definition-files-1",level:2},{value:"New Widgets",id:"new-widgets-1",level:2},{value:"CHECKBUTTON",id:"checkbutton",level:3},{value:"COMBOBOX",id:"combobox",level:3},{value:"RADIOGROUP",id:"radiogroup",level:3},{value:"RADIOBUTTON",id:"radiobutton",level:3},{value:"TEXTFIELD",id:"textfield",level:3},{value:"Canvas Widgets",id:"canvas-widgets",level:2},{value:"CANVAS",id:"canvas",level:3},{value:"CANVASLABEL",id:"canvaslabel",level:3},{value:"CANVASLABELVALUE",id:"canvaslabelvalue",level:3},{value:"CANVASIMAGE",id:"canvasimage",level:3},{value:"SCREEN",id:"screen-1",level:4},{value:"CANVASIMAGEVALUE",id:"canvasimagevalue",level:3},{value:"IMAGE",id:"image",level:4},{value:"SCREEN",id:"screen-2",level:4},{value:"CANVASLINE",id:"canvasline",level:3},{value:"CANVASLINEVALUE",id:"canvaslinevalue",level:3},{value:"VALUE_EQ",id:"value_eq",level:4},{value:"CANVASDOT",id:"canvasdot",level:3},{value:"Example File",id:"example-file",level:2}];function a(e){const s={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.p,{children:"This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."}),"\n",(0,n.jsx)("div",{style:{clear:"both"}}),"\n",(0,n.jsx)(s.h2,{id:"definitions",children:"Definitions"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Definition"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget"}),(0,n.jsx)(s.td,{children:"A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task."})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen"}),(0,n.jsx)(s.td,{children:"A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion."})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen Definition File"}),(0,n.jsx)(s.td,{children:"A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them."})]})]})]}),"\n",(0,n.jsx)(s.h2,{id:"telemetry-screen-definition-files",children:"Telemetry Screen Definition Files"}),"\n",(0,n.jsx)(s.p,{children:"Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target's screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase."}),"\n",(0,n.jsx)(s.h2,{id:"new-widgets",children:"New Widgets"}),"\n",(0,n.jsxs)(s.p,{children:["When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the ",(0,n.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide."]}),"\n",(0,n.jsx)(s.h1,{id:"screen-keywords",children:"Screen Keywords"}),"\n",(0,n.jsx)(s.h2,{id:"screen",children:"SCREEN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Define a telemetry viewer screen"})}),"\n",(0,n.jsx)(s.p,{children:"The SCREEN keyword is the first keyword in any telemetry screen definition. It defines the name of the screen and parameters that affect the screen overall."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Polling Period"}),(0,n.jsx)(s.td,{children:"Number of seconds between screen updates"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 1.0 FIXED\n"})}),"\n",(0,n.jsx)(s.h2,{id:"end",children:"END"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Indicates the close of a layout widget"})}),"\n",(0,n.jsx)(s.p,{children:"All layout widgets must be closed to properly identify where they stop. For example, a VERTICALBOX keyword must be matched with an END keyword to indicate where the VERTICALBOX ends."}),"\n",(0,n.jsx)(s.h2,{id:"stale_time",children:"STALE_TIME"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.1.0)"}),(0,n.jsx)(s.strong,{children:"Values are marked stale if the packet time is more than Stale Time seconds in the past"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"value"}),(0,n.jsx)(s.td,{children:"Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale. The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions."}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"STALE_TIME 5 # Number of seconds to wait before marking data stale\n"})}),"\n",(0,n.jsx)(s.h2,{id:"global_setting",children:"GLOBAL_SETTING"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Applies a widget setting to all widgets of a certain type"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget Class Name"}),(0,n.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Name"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Value(s)"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK\n"})}),"\n",(0,n.jsx)(s.h2,{id:"global_subsetting",children:"GLOBAL_SUBSETTING"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Applies a widget subsetting to all widgets of a certain type"})}),"\n",(0,n.jsx)(s.p,{children:"Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget Class Name"}),(0,n.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABELVALUE."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Subwidget Index"}),(0,n.jsx)(s.td,{children:"Index to the desired subwidget"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Name"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Value(s)"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"# Set all text color to white for labelvaluelimitsbars\nGLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white\n"})}),"\n",(0,n.jsx)(s.h2,{id:"setting",children:"SETTING"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Applies a widget setting to the previously defined widget"})}),"\n",(0,n.jsx)(s.p,{children:"Settings allow for additional tweaks and options to be applied to widgets\nthat are not available in their parameters. These settings are all configured\nthrough the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords.\nSETTING and SUBSETTING applies only to the widget defined immediately before it.\nGLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets."}),"\n",(0,n.jsx)(s.p,{children:"Common wiget settings are defined here. Some widgets define their own\nunqiue settings which are documented under that specific widget."}),"\n",(0,n.jsx)(s.h3,{id:"width",children:"WIDTH"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Sets the widget width"})}),"\n",(0,n.jsxs)(s.p,{children:["WIDTH supports ",(0,n.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width in pixels or explicitly declared with units"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING WIDTH 50\nLABEL "THIS IS A TEST"\n  SETTING WIDTH 20em\n'})}),"\n",(0,n.jsx)(s.h3,{id:"height",children:"HEIGHT"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Sets the widget height"})}),"\n",(0,n.jsxs)(s.p,{children:["HEIGHT supports ",(0,n.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height in pixels or explicitly declared with units"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING BACKCOLOR BLUE\n  SETTING HEIGHT 50\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR GREY\n  SETTING HEIGHT 2em\n'})}),"\n",(0,n.jsx)(s.h3,{id:"margin",children:"MARGIN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Sets the widget margin"})}),"\n",(0,n.jsxs)(s.p,{children:["MARGIN supports ",(0,n.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Size"}),(0,n.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING BACKCOLOR BLUE\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR GREY\n  SETTING MARGIN 10\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR GREEN\n'})}),"\n",(0,n.jsx)(s.h3,{id:"padding",children:"PADDING"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Sets the widget padding"})}),"\n",(0,n.jsxs)(s.p,{children:["PADDING supports ",(0,n.jsx)(s.a,{href:"https://www.w3schools.com/cssref/css_units.php",children:"css units"})," with the default (no units) of px (pixels)"]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Size"}),(0,n.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING BACKCOLOR BLUE\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR GREY\n  SETTING PADDING 10\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR GREEN\n'})}),"\n",(0,n.jsx)(s.h3,{id:"backcolor",children:"BACKCOLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"The BACKCOLOR setting sets the background color for a widget"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color name or Red value"}),(0,n.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Green value"}),(0,n.jsx)(s.td,{children:"Green value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Blue value"}),(0,n.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING BACKCOLOR red\nLABEL "THIS IS A TEST"\n  SETTING BACKCOLOR 155 50 155\n'})}),"\n",(0,n.jsx)(s.h3,{id:"textcolor",children:"TEXTCOLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"The TEXTCOLOR setting sets the text color for a widget"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color name or Red value"}),(0,n.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Green value"}),(0,n.jsx)(s.td,{children:"Green value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Blue value"}),(0,n.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "THIS IS A TEST"\n  SETTING TEXTCOLOR red\nLABEL "THIS IS A TEST"\n  SETTING TEXTCOLOR 155 50 155\n'})}),"\n",(0,n.jsx)(s.h3,{id:"bordercolor",children:"BORDERCOLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"The BORDERCOLOR setting sets the border color for a layout widget"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color name or Red value"}),(0,n.jsx)(s.td,{children:"Common name for the color, e.g. 'black', 'red', etc. Alternatively if two more parameters are passed this is the Red value of the RGB value"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Green value"}),(0,n.jsx)(s.td,{children:"Green value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Blue value"}),(0,n.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'HORIZONTAL\n  LABEL "Label 1"\nEND\nSETTING BORDERCOLOR red\nVERTICAL\n  LABEL "Label 2"\nEND\nSETTING BORDERCOLOR 155 50 155\n'})}),"\n",(0,n.jsx)(s.h3,{id:"raw",children:"RAW"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Apply a raw CSS stylesheet key and value"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Key"}),(0,n.jsx)(s.td,{children:"CSS key like font-size, max-width, etc"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"CSS Value"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "Label 1"\n  SETTING RAW font-size 30px\n'})}),"\n",(0,n.jsx)(s.h2,{id:"subsetting",children:"SUBSETTING"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Applies a widget subsetting to the previously defined widget"})}),"\n",(0,n.jsx)(s.p,{children:"Subsettings are only valid for widgets that are made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing settings to specific subwidgets. Some widgets are made up of multiple subwidgets, e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget Index to first index the LABELVALUE and then the LABEL."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Subwidget Index"}),(0,n.jsx)(s.td,{children:"Index to the desired subwidget or 'ALL' to apply the setting to all the subwidgets of this composite widget."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Name"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Setting Value(s)"}),(0,n.jsx)(s.td,{children:"See SETTING for details."}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"VERTICALBOX\n  LABELVALUE INST HEALTH_STATUS TEMP1\n  SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue\n  LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1\n  SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green\nEND\n"})}),"\n",(0,n.jsx)(s.h2,{id:"named_widget",children:"NAMED_WIDGET"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Name a widget to allow access to it via the getNamedWidget method"})}),"\n",(0,n.jsx)(s.p,{children:"To programatically access parts of a telemetry screen you need to name the widget. This is useful when creating screens with buttons that read values from other widgets."}),"\n",(0,n.jsx)(s.admonition,{type:"warning",children:(0,n.jsx)(s.p,{children:"getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget Name"}),(0,n.jsx)(s.td,{children:"The unique name applied to the following widget instance. Names must be unique per screen."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget Type"}),(0,n.jsx)(s.td,{children:"One of the widget types listed in Widget Descriptions"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget Parameters"}),(0,n.jsx)(s.td,{children:"The unique parameters for the given widget type"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'NAMED_WIDGET DURATION TEXTFIELD\nBUTTON "Push" "screen.getNamedWidget(\'DURATION\').text()"\n'})}),"\n",(0,n.jsx)(s.h2,{id:"layout-widgets",children:"Layout Widgets"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.p,{children:"Layout widgets are used to position other widgets on the screen. For example, the HORIZONTAL layout widget places the widgets it encapsulates horizontally on the screen."}),"\n",(0,n.jsx)(s.h3,{id:"vertical",children:"VERTICAL"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically"})}),"\n",(0,n.jsx)(s.p,{children:"The screen defaults to a vertical layout, so if no layout widgets are specified, all widgets will be automatically placed within a VERTICAL layout widget. The VERTICAL widget sizes itself to fit its contents."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'VERTICAL 5px\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"verticalbox",children:"VERTICALBOX"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically inside a thin border"})}),"\n",(0,n.jsx)(s.p,{children:"The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Title"}),(0,n.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'VERTICALBOX Info\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"horizontal",children:"HORIZONTAL"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally"})}),"\n",(0,n.jsx)(s.p,{children:"The HORIZONTAL widget sizes itself to fit its contents"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'HORIZONTAL 100\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"horizontalbox",children:"HORIZONTALBOX"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally inside a thin border"})}),"\n",(0,n.jsx)(s.p,{children:"The HORIZONTALBOX widget sizes itself to fit its contents"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Title"}),(0,n.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'HORIZONTALBOX Info 10\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"matrixbycolumns",children:"MATRIXBYCOLUMNS"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets into a table-like matrix"})}),"\n",(0,n.jsx)(s.p,{children:"The MATRIXBYCOLUMNS widget sizes itself to fit its contents"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Columns"}),(0,n.jsx)(s.td,{children:"The number of columns to create"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'MATRIXBYCOLUMNS 3 10\n  LABEL "COL 1"\n  LABEL "COL 2"\n  LABEL "COL 3"\n  LABEL "100"\n  LABEL "200"\n  LABEL "300"\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"scrollwindow",children:"SCROLLWINDOW"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places the widgets inside of it into a scrollable area"})}),"\n",(0,n.jsx)(s.p,{children:"The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Maximum height of the scroll window in pixels (default = 200)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Margin"}),(0,n.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'SCROLLWINDOW 100 10\n  VERTICAL\n    LABEL "100"\n    LABEL "200"\n    LABEL "300"\n    LABEL "400"\n    LABEL "500"\n    LABEL "600"\n    LABEL "700"\n    LABEL "800"\n    LABEL "900"\n  END\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"tabbook",children:"TABBOOK"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Creates a tabbed area in which to place TABITEM widgets"})}),"\n",(0,n.jsx)(s.h3,{id:"tabitem",children:"TABITEM"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Creates a VERTICAL layout tab into which to place widgets"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Tab text"}),(0,n.jsx)(s.td,{children:"Text to diplay in the tab"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'TABBOOK\n  TABITEM "Tab 1"\n    LABEL "100"\n    LABEL "200"\n  END\n  TABITEM "Tab 2"\n    LABEL "300"\n    LABEL "400"\n  END\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"iframe",children:"IFRAME"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Open external tools in an Iframe within OpenC3"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"URL"}),(0,n.jsx)(s.td,{children:"The path to the page to display in the iframe"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the widget"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the widget"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"IFRAME https://openc3.com 900 450\n"})}),"\n",(0,n.jsx)(s.h2,{id:"decoration-widgets",children:"Decoration Widgets"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.p,{children:"Decoration widgets are used to enhance the appearance of the screen. They do not respond to input, nor does the output vary with telemetry."}),"\n",(0,n.jsx)(s.h3,{id:"label",children:"LABEL"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays text on the screen"})}),"\n",(0,n.jsx)(s.p,{children:"Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Text to display on the label"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABEL "Note: This is only a warning"\n'})}),"\n",(0,n.jsx)(s.h3,{id:"horizontalline",children:"HORIZONTALLINE"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Displays a horizontal line on the screen that can be used as a separator"})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABEL Over\nHORIZONTALLINE\nLABEL Under\n"})}),"\n",(0,n.jsx)(s.h3,{id:"sectionheader",children:"SECTIONHEADER"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"DEPRECATED - Displays a label that is underlined with a horizontal line"})}),"\n",(0,n.jsx)(s.p,{children:"Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Text to display"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"title",children:"TITLE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a large centered title on the screen"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Text to display"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'TITLE "Title"\nHORIZONTALLINE\nLABEL "Label"\n'})}),"\n",(0,n.jsx)(s.h3,{id:"spacer",children:"SPACER"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Places a fixed size spacer in between widgets"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the spacer in pixels"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the spacer in pixels"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'VERTICAL 3\n  LABEL "Spacer below"\n  SPACER 0 100\n  LABEL "Spacer above"\nEND\n'})}),"\n",(0,n.jsx)(s.h2,{id:"telemetry-widgets",children:"Telemetry Widgets"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.p,{children:"Telemetry widgets are used to display telemetry values. The first parameters to each of these widgets is a telemetry mnemonic. Depending on the type and purpose of the telemetry item, the screen designer may select from a wide selection of widgets to display the value in the most useful format."}),"\n",(0,n.jsx)(s.h3,{id:"array",children:"ARRAY"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays ARRAY data organized into rows and space separated"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Format string"}),(0,n.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Items per row"}),(0,n.jsx)(s.td,{children:"Number of array items per row (default = 4)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'ARRAY INST HEALTH_STATUS ARY 250 80 "0x%x" 6 FORMATTED\nARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS\n'})}),"\n",(0,n.jsx)(s.h3,{id:"block",children:"BLOCK"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays BLOCK data organized into rows and space separated"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Format string"}),(0,n.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Bytes per word"}),(0,n.jsx)(s.td,{children:"Number of bytes per word (default = 4)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Words per row"}),(0,n.jsx)(s.td,{children:"Number of words per row (default = 4"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Address format"}),(0,n.jsx)(s.td,{children:"Format for the address printed at the beginning of each line (default = nil which means do not print an address)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'BLOCK INST IMAGE IMAGE 400 130 "%02X" 4 4 "0x%08X:"\n'})}),"\n",(0,n.jsx)(s.h3,{id:"formatvalue",children:"FORMATVALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a box with a formatted value"})}),"\n",(0,n.jsx)(s.p,{children:"Data is formatted by the specified string rather than by a format string given in the telemetry definition files. The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits)."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Format string"}),(0,n.jsx)(s.td,{children:"Printf style format string to apply to the telemetry item"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20\n"})}),"\n",(0,n.jsx)(s.h3,{id:"labelled",children:"LABELLED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL followed by a LED"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Justification"}),(0,n.jsxs)(s.td,{children:["How to justify the label and LED together. The default of 'SPLIT' aligns the label to the left and the LED to the right with any additional space going between them. 'CENTER' pushes the label and LED together with any additional space to the left and right. 'LEFT' or 'RIGHT' pushes them to the respective side with the space going on the opposite.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"SPLIT, CENTER, LEFT, RIGHT"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELLED INST PARAMS VALUE1\n  SETTING LED_COLOR GOOD GREEN\n  SETTING LED_COLOR BAD RED\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to LABELLED. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"led_color",children:"LED_COLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"LED color"}),(0,n.jsx)(s.td,{children:"Color of the LED"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"labelprogressbar",children:"LABELPROGRESSBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a PROGRESSBAR"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Scale factor"}),(0,n.jsx)(s.td,{children:"Value to multiply the telemetry item by before displaying in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0."}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the progress bar (default = 80 pixels"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW\nLABELPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,n.jsx)(s.h3,{id:"labelvalue",children:"LABELVALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a VALUE"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELVALUE INST LATEST TIMESEC CONVERTED 18\nLABELVALUE INST LATEST COLLECT_TYPE\n"})}),"\n",(0,n.jsx)(s.h3,{id:"labelvaluedesc",children:"LABELVALUEDESC"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the items description followed by a VALUE"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Description"}),(0,n.jsx)(s.td,{children:"The description to display in the label (default is to display the description text associated with the telemetry item)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'LABELVALUEDESC INST HEALTH_STATUS TEMP1 "Temperature number 1" RAW 18\nLABELVALUEDESC INST HEALTH_STATUS COLLECT_TYPE\n'})}),"\n",(0,n.jsx)(s.h3,{id:"labelvaluelimitsbar",children:"LABELVALUELIMITSBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"labelvaluelimitscolumn",children:"LABELVALUELIMITSCOLUMN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nLABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"labelvaluerangebar",children:"LABELVALUERANGEBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Low Value"}),(0,n.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"High Value"}),(0,n.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40\nLABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120\n"})}),"\n",(0,n.jsx)(s.h3,{id:"led",children:"LED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LED which changes color based on telemetry values"})}),"\n",(0,n.jsx)(s.p,{children:"By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LED INST PARAMS VALUE5 RAW 25 20 # Ellipse\n  SETTING LED_COLOR 0 GREEN\n  SETTING LED_COLOR 1 RED\n  SETTING LED_COLOR ANY YELLOW\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to LED. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"led_color-1",children:"LED_COLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"LED color"}),(0,n.jsx)(s.td,{children:"Color of the LED"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"limitsbar",children:"LIMITSBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an item's current value within its colored limits horizontally"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50\nLIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"limitscolumn",children:"LIMITSCOLUMN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an item's current value within its colored limits vertically"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200\nLIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"limitscolor",children:"LIMITSCOLOR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a circle depicting the limits color of an item"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Radius"}),(0,n.jsx)(s.td,{children:"Radius of the circle (default is 10)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Full Item Name"}),(0,n.jsx)(s.td,{children:"Show the full item name (default is false)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE\nLIMITSCOLOR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"valuelimitsbar",children:"VALUELIMITSBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSBAR"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"valuelimitscolumn",children:"VALUELIMITSCOLUMN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSCOLUMN"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 8)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h3,{id:"valuerangebar",children:"VALUERANGEBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an item VALUE followed by RANGEBAR"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Low Value"}),(0,n.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"High Value"}),(0,n.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"VALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40\nVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120\n"})}),"\n",(0,n.jsx)(s.h3,{id:"linegraph",children:"LINEGRAPH"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a line graph of a telemetry item"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LINEGRAPH INST HEALTH_STATUS TEMP1\n  SETTING ITEM INST ADCS Q1 # Add additional item to graph\nLINEGRAPH INST HEALTH_STATUS TEMP2 RAW\nLINEGRAPH INST HEALTH_STATUS TEMP3 CONVERTED REDUCED_MINUTE MIN\n  SETTING SIZE 600 500 # width height\n  SETTING HISTORY 1h # load 1 hour of data into graph\nLINEGRAPH INST HEALTH_STATUS TEMP4\n  SETTING HISTORY 30m # load 30 minutes of data into graph\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to LINEGRAPH. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"item",children:"ITEM"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.h4,{id:"starttime",children:"STARTTIME"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start Time"}),(0,n.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"history",children:"HISTORY"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"secondsgraphed",children:"SECONDSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to display"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointssaved",children:"POINTSSAVED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to save"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointsgraphed",children:"POINTSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of points to graph"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"size",children:"SIZE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width in pixels"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height in pixels"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"sparkline",children:"SPARKLINE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a sparkline graph (no cursor, scale or legend) of a telemetry item"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"SPARKLINE INST HEALTH_STATUS TEMP1\n  SETTING SIZE 400 50\n  SETTING HISTORY 30s # Add 30 seconds of data into graph\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to SPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"item-1",children:"ITEM"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.h4,{id:"starttime-1",children:"STARTTIME"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start Time"}),(0,n.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"history-1",children:"HISTORY"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"secondsgraphed-1",children:"SECONDSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to display"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointssaved-1",children:"POINTSSAVED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to save"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointsgraphed-1",children:"POINTSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of points to graph"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"size-1",children:"SIZE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width in pixels"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height in pixels"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"labelsparkline",children:"LABELSPARKLINE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a SPARKLINE"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"LABELSPARKLINE INST HEALTH_STATUS TEMP1\n  SETTING HISTORY 5m # Add 5 minutes of data into graph\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"item-2",children:"ITEM"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced"}),(0,n.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Reduced Type"}),(0,n.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.h4,{id:"starttime-2",children:"STARTTIME"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start Time"}),(0,n.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"history-2",children:"HISTORY"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"secondsgraphed-2",children:"SECONDSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to display"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointssaved-2",children:"POINTSSAVED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of seconds to save"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"pointsgraphed-2",children:"POINTSGRAPHED"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Time"}),(0,n.jsx)(s.td,{children:"Number of points to graph"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.h4,{id:"size-2",children:"SIZE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width in pixels"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height in pixels"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"imageviewer",children:"IMAGEVIEWER"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Display a base64 image from a TLM packet"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Format"}),(0,n.jsx)(s.td,{children:"The image format of the base64 data (e.g. jpg, png, etc)"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the widget"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the widget"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"IMAGEVIEWER INST IMAGE IMAGE jpg\n"})}),"\n",(0,n.jsx)(s.h3,{id:"progressbar",children:"PROGRESSBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a progress bar that is useful for displaying percentages"})}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"PROGRESSBAR INST ADCS POSPROGRESS 0.5 200\nPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,n.jsx)(s.h3,{id:"rangebar",children:"RANGEBAR"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a custom range bar displaying the item value"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Low Value"}),(0,n.jsx)(s.td,{children:"Minimum value to display on the range bar. If the telemetry item goes below this value the bar is \u201cpegged\u201d on the low end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"High Value"}),(0,n.jsx)(s.td,{children:"Maximum value to display on the range bar. If the telemetry item goes above this value the bar is \u201cpegged\u201d on the high end."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the range bar (default = 100)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"RANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50\nRANGEBAR INST HEALTH_STATUS TEMP1 -100 100\n"})}),"\n",(0,n.jsx)(s.h3,{id:"textbox",children:"TEXTBOX"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Provides a large box for multiline text"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the textbox in px (default = 200)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the textbox in px (default = 200)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70\nTEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED\n"})}),"\n",(0,n.jsx)(s.h3,{id:"value",children:"VALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a box with a telemetry item value"})}),"\n",(0,n.jsx)(s.p,{children:"The white portion of the box darkens to gray while the value remains stagnant, then brightens to white each time the value changes. Additionally the value is colored based on the items limits state (Red for example if it is out of limits)."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Number of characters"}),(0,n.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUE INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,n.jsx)(s.h2,{id:"interactive-widgets",children:"Interactive Widgets"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.p,{children:"Interactive widgets are used to gather input from the user. Unlike all other widgets, which only output some graphical representation, interactive widgets permit input either from the keyboard or mouse."}),"\n",(0,n.jsx)(s.h3,{id:"button",children:"BUTTON"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a rectangular clickable button"})}),"\n",(0,n.jsxs)(s.p,{children:["Upon clicking, the button executes the Ruby code assigned. Buttons\ncan be used to send commands and perform other tasks. If you want your button\nto use values from other widgets, define them as named widgets and read their\nvalues using the ",(0,n.jsx)(s.code,{children:'screen.getNamedWidget("WIDGET_NAME").text()'})," method.\nSee the example in CHECKBUTTON."]}),"\n",(0,n.jsxs)(s.h2,{id:"button-code-can-get-rather-complex-so-remember-to-use-string-concatenationto-make-things-more-readable-if-you-use--newlines-are-inserted-automaticallyduring-string-concatenation-if-you-use----sidebar_position-9title-screens",children:["Button code can get rather complex so remember to use string concatenation\nto make things more readable. If you use ",(0,n.jsx)(s.code,{children:"+"})," newlines are inserted automatically\nduring string concatenation. If you use `---\nsidebar_position: 9\ntitle: Screens"]}),"\n",(0,n.jsx)(s.p,{children:"This document provides the information necessary to generate and use COSMOS Telemetry Screens, which are displayed by the COSMOS Telemetry Viewer application."}),"\n",(0,n.jsx)("div",{style:{clear:"both"}}),"\n",(0,n.jsx)(s.h2,{id:"definitions-1",children:"Definitions"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Name"}),(0,n.jsx)(s.th,{children:"Definition"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Widget"}),(0,n.jsx)(s.td,{children:"A widget is a graphical element on a COSMOS telemetry screen. It could display text, graph data, provide a button, or perform any other display/user input task."})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen"}),(0,n.jsx)(s.td,{children:"A screen is a single window that contains any number of widgets which are organized and layed-out in a useful fashion."})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen Definition File"}),(0,n.jsx)(s.td,{children:"A screen definition file is an ASCII file that tells Telemetry Viewer how to draw a screen. It is made up of a series of keyword/parameter lines that define the telemetry points that are displayed on the screen and how to display them."})]})]})]}),"\n",(0,n.jsx)(s.h2,{id:"telemetry-screen-definition-files-1",children:"Telemetry Screen Definition Files"}),"\n",(0,n.jsx)(s.p,{children:"Telemetry screen definition files define the the contents of telemetry screens. They take the general form of a SCREEN keyword followed by a series of widget keywords that define the telemetry screen. Screen definition files specific to a particular target go in that target's screens directory. For example: TARGET/screens/version.txt. Screen definition files must be lowercase."}),"\n",(0,n.jsx)(s.h2,{id:"new-widgets-1",children:"New Widgets"}),"\n",(0,n.jsxs)(s.p,{children:["When a telemetry screen definition is parsed and a keyword is encountered that is unrecognized, it is assumed that a file of the form widgetname_widget.rb exists, and contains a class called WidgetnameWidget. Because of this convention, new widgets can be added to the system without any change to the telemetry screen definition format. For more information about creating custom widgets please read the ",(0,n.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide."]}),"\n",(0,n.jsx)(s.h1,{id:"screen-keywords-1",children:"Screen Keywords"}),"\n",(0,n.jsxs)(s.p,{children:["you'll need to separate lines with a\nsingle semicolon ",(0,n.jsx)(s.code,{children:";"}),". COSMOS uses double semicolon ",(0,n.jsx)(s.code,{children:";;"})," to indicate lines should\nbe evaluated separately. Note that all OpenC3 commands (using api.cmd) must be\nseparated by ",(0,n.jsx)(s.code,{children:";;"}),"."]}),"\n",(0,n.jsx)(s.p,{children:"You can send commands with buttons using api.cmd(). The cmd() syntax looks exactly\nlike the standard COSMOS Ruby scripting syntax. You can also request and use\ntelemetry in screens using Javascript Promises."}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.code,{children:"api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE NORMAL, DURATION '+dur))\""})}),"\n",(0,n.jsx)(s.p,{children:"The api.tlm() function returns a Promise which is resolved with then()\nat which point we send the command with the telemetry value we received."}),"\n",(0,n.jsxs)(s.p,{children:["Scripts can be launched from a BUTTON using the ",(0,n.jsx)(s.code,{children:"runScript()"})," method. ",(0,n.jsx)(s.code,{children:"runScript()"})," takes three parameters,\nthe name of the script, whether to open the script in the foreground of Script Runner (default = true), and a hash of\nenvironment variables. For example: ",(0,n.jsx)(s.code,{children:"runScript('INST/procedures/script.rb', false, {'VAR': 'VALUE'})"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Button Text"}),(0,n.jsx)(s.td,{children:"Text displayed on the button"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Button Code"}),(0,n.jsx)(s.td,{children:"Javascript code to execute when the button is pressed"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"BUTTON 'Start Collect' 'api.cmd(\"INST COLLECT with TYPE NORMAL, DURATION 5\")'\nBUTTON 'Run Checks' 'runScript(\"INST/procedures/checks.rb\")'\n# More complex example with background checkbox and env vars\nNAMED_WIDGET SCRIPTNAME COMBOBOX collect.rb checks.rb\nNAMED_WIDGET BG CHECKBUTTON 'Background'\nBUTTON 'Run Script' \"var script=screen.getNamedWidget('SCRIPTNAME').text();\" \\\n  # Set an environment variable to be used by the script as ENV['TYPE']\n  \"var env = {}; env['TYPE'] = 'TEST';\" \\\n  \"runScript('INST/procedures/'+script, !screen.getNamedWidget('BG').checked(), env)\"\n"})}),"\n",(0,n.jsx)(s.h3,{id:"checkbutton",children:"CHECKBUTTON"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a check box"})}),"\n",(0,n.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Checkbox Text"}),(0,n.jsx)(s.td,{children:"Text displayed next to the checkbox"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks'\nBUTTON 'Send' 'screen.getNamedWidget(\"CHECK\").checked() ? ' \\\n  'api.cmd_no_hazardous_check(\"INST CLEAR\") : api.cmd(\"INST CLEAR\")'\n"})}),"\n",(0,n.jsx)(s.h3,{id:"combobox",children:"COMBOBOX"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a drop down list of text items"})}),"\n",(0,n.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Option Text 1"}),(0,n.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Option Text n"}),(0,n.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"BUTTON 'Start Collect' 'var type = screen.getNamedWidget(\"COLLECT_TYPE\").text();' +\n  'api.cmd(\"INST COLLECT with TYPE \"+type+\", DURATION 10.0\")'\nNAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL\n"})}),"\n",(0,n.jsx)(s.h3,{id:"radiogroup",children:"RADIOGROUP"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Creates a group of RADIOBUTTONs"})}),"\n",(0,n.jsx)(s.p,{children:"RADIOBUTTONs must be part of a group to enable selection logic"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Initial selected button"}),(0,n.jsx)(s.td,{children:"Selects a radio button at initialization (0-based)"}),(0,n.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,n.jsx)(s.h3,{id:"radiobutton",children:"RADIOBUTTON"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a radio button and text"})}),"\n",(0,n.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET. It must be contained by a RADIOGROUP to enable typical selection of a single RADIOBUTTON."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsx)(s.tbody,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Text to display next to the radio button"}),(0,n.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index\n  RADIOBUTTON 'Abort'\n  RADIOBUTTON 'Clear'\nEND\nBUTTON 'Send' \"screen.getNamedWidget('GROUP').selected() === 0 ? \" +\n  \"api.cmd('INST ABORT') : api.cmd('INST CLEAR')\"\n"})}),"\n",(0,n.jsx)(s.h3,{id:"textfield",children:"TEXTFIELD"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays a rectangular box where the user can enter text"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Characters"}),(0,n.jsx)(s.td,{children:"Width of the text field in characters (default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Default text to put in the text field (default is blank)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'NAMED_WIDGET DURATION TEXTFIELD 12 "10.0"\nBUTTON \'Start Collect\' \'var dur = screen.getNamedWidget("DURATION").text();\' +\n      \'api.cmd("INST COLLECT with TYPE NORMAL, DURATION "+dur+"")\'\n'})}),"\n",(0,n.jsx)(s.h2,{id:"canvas-widgets",children:"Canvas Widgets"}),"\n",(0,n.jsx)(s.hr,{}),"\n",(0,n.jsx)(s.p,{children:"Canvas Widgets are used to draw custom displays into telemetry screens. The canvas coordinate frame places (0,0) in the upper-left corner of the canvas."}),"\n",(0,n.jsx)(s.h3,{id:"canvas",children:"CANVAS"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Layout widget for the other canvas widgets"})}),"\n",(0,n.jsx)(s.p,{children:"All canvas widgets must be enclosed within a CANVAS widget."}),"\n",(0,n.jsx)(s.admonition,{type:"warning",children:(0,n.jsx)(s.p,{children:"The canvas coordinate frame places (0,0) in the upper-left corner of the canvas."})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Height"}),(0,n.jsx)(s.td,{children:"Height of the canvas"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"canvaslabel",children:"CANVASLABEL"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draws text onto the canvas"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Text"}),(0,n.jsx)(s.td,{children:"Text to draw onto the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Font Size"}),(0,n.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color"}),(0,n.jsx)(s.td,{children:"Color of the text"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'CANVAS 100 100\n  CANVASLABEL 5 34 "Label1" 24 red\n  CANVASLABEL 5 70 "Label2" 18 blue\nEND\n'})}),"\n",(0,n.jsx)(s.h3,{id:"canvaslabelvalue",children:"CANVASLABELVALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draws the text value of a telemetry item onto the canvas in an optional frame"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Font Size"}),(0,n.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color"}),(0,n.jsx)(s.td,{children:"Color of the text"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"CANVAS 200 100\n  CANVASLABELVALUE INST HEALTH_STATUS TEMP1 5 34 12 red\n  CANVASLABELVALUE INST HEALTH_STATUS TEMP2 5 70 10 blue WITH_UNITS\nEND\n"})}),"\n",(0,n.jsx)(s.h3,{id:"canvasimage",children:"CANVASIMAGE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an image on the canvas"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Image filename"}),(0,n.jsx)(s.td,{children:"Name of a image file. The file must be in the plugin's targets/TARGET/public directory."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'CANVAS 250 430\n  CANVASIMAGE "satellite.png" 10 10 200 200\n    SETTING SCREEN INST HS\n  CANVASIMAGE "https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=640&w=426" 0 250 250 150\nEND\n'})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"screen-1",children:"SCREEN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"Name of the target"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen name"}),(0,n.jsx)(s.td,{children:"Name of the screen"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"canvasimagevalue",children:"CANVASIMAGEVALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Displays an image on the canvas that changes with a telemetry value"})}),"\n",(0,n.jsx)(s.p,{children:'Use various SETTING values to indicate which images should be displayed based on telemetry. For example, SETTING IMAGE CONNECTED "ground_on.png" 400 100. See the DEMO for a complete example.'}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Default image filename"}),(0,n.jsx)(s.td,{children:"The default image to display. The file must be in the targets/TARGET/public directory."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Image width"}),(0,n.jsx)(s.td,{children:"Width of the image (default is 100%)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Image height"}),(0,n.jsx)(s.td,{children:"Height of the image (default is 100%)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:'CANVAS 230 230\n  CANVASIMAGEVALUE INST HEALTH_STATUS GROUND1STATUS CONVERTED "ground_error.png" 10 10 180 180\n    SETTING IMAGE CONNECTED "ground_on.png" 10 10\n    SETTING IMAGE UNAVAILABLE "ground_off.png" 10 10\n    SETTING SCREEN INST HS\nEND\n'})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"image",children:"IMAGE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Map an image to a state or value"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"State or value"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Image filename"}),(0,n.jsx)(s.td,{children:"Image to display. The file must be in the targets/TARGET/public directory."}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h4,{id:"screen-2",children:"SCREEN"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"Name of the target"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Screen name"}),(0,n.jsx)(s.td,{children:"Name of the screen"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"canvasline",children:"CANVASLINE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draws a line onto the canvas"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start X Position"}),(0,n.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"End X Position"}),(0,n.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"End Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color"}),(0,n.jsx)(s.td,{children:"Color of the line"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the line in pixels (default = 1)"}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"CANVAS 100 50\n  CANVASLINE 5 5 95 5\n  CANVASLINE 5 5 5 45 green 2\n  CANVASLINE 95 5 95 45 blue 3\nEND\n"})}),"\n",(0,n.jsx)(s.h3,{id:"canvaslinevalue",children:"CANVASLINEVALUE"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draws a color changing line onto the canvas"})}),"\n",(0,n.jsx)(s.p,{children:"The line is represented by one of two colors based on the value of the associated telemetry item"}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Target name"}),(0,n.jsx)(s.td,{children:"The target name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Packet name"}),(0,n.jsx)(s.td,{children:"The packet name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Item name"}),(0,n.jsx)(s.td,{children:"The item name"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start X Position"}),(0,n.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Start Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"End X Position"}),(0,n.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"End Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Width"}),(0,n.jsx)(s.td,{children:"Width of the line in pixels (default = 3)"}),(0,n.jsx)(s.td,{children:"False"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value type"}),(0,n.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED",(0,n.jsx)("br",{}),(0,n.jsx)("br",{}),"Valid Values: ",(0,n.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,n.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"CANVAS 120 50\n  CANVASLABELVALUE INST HEALTH_STATUS GROUND1STATUS 0 12 12 black\n  CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 25 115 25 5 RAW\n    SETTING VALUE_EQ 1 GREEN\n    SETTING VALUE_EQ 0 RED\n  CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 45 115 45\n    SETTING VALUE_EQ CONNECTED GREEN\n    SETTING VALUE_EQ UNAVAILABLE RED\nEND\n"})}),"\n",(0,n.jsx)(s.p,{children:"The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword."}),"\n",(0,n.jsx)(s.h4,{id:"value_eq",children:"VALUE_EQ"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,n.jsx)(s.strong,{children:"Map a value to a color"})]}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Value"}),(0,n.jsx)(s.td,{children:"State or value"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color"}),(0,n.jsx)(s.td,{children:"Color of the line"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.h3,{id:"canvasdot",children:"CANVASDOT"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draws a dot onto the canvas"})}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Parameter"}),(0,n.jsx)(s.th,{children:"Description"}),(0,n.jsx)(s.th,{children:"Required"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"X Position"}),(0,n.jsx)(s.td,{children:"X position of the dot"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Y Position"}),(0,n.jsx)(s.td,{children:"Y position of the dot"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Color"}),(0,n.jsx)(s.td,{children:"Color of the dot"}),(0,n.jsx)(s.td,{children:"True"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Radius"}),(0,n.jsx)(s.td,{children:"Radius of the dot in pixels"}),(0,n.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,n.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"CANVAS 50 50\n  CANVASDOT 10 15 BLUE 5\nEND\n"})}),"\n",(0,n.jsx)(s.h2,{id:"example-file",children:"Example File"}),"\n",(0,n.jsx)(s.p,{children:"Example File: TARGET/myscreen.txt"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 0.5\nVERTICAL\n  TITLE \"<%= target_name %> Commanding Examples\"\n  LABELVALUE INST HEALTH_STATUS COLLECTS\n  LABELVALUE INST HEALTH_STATUS COLLECT_TYPE\n  LABELVALUE INST HEALTH_STATUS DURATION\n  VERTICALBOX \"Send Collect Command:\"\n    HORIZONTAL\n      LABEL \"Type: \"\n      NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL\n    END\n    HORIZONTAL\n      LABEL \"  Duration: \"\n      NAMED_WIDGET DURATION TEXTFIELD 12 \"10.0\"\n    END\n    BUTTON 'Start Collect' \"api.cmd('INST COLLECT with TYPE '+screen.getNamedWidget('COLLECT_TYPE').text()+', DURATION '+screen.getNamedWidget('DURATION').text())\"\n  END\n  SETTING BACKCOLOR 163 185 163\n  VERTICALBOX \"Parameter-less Commands:\"\n    NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index\n      RADIOBUTTON 'Abort'\n      RADIOBUTTON 'Clear'\n    END\n    NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks' # No option is by default UNCHECKED\n    BUTTON 'Send' \"screen.getNamedWidget('GROUP').selected() === 0 ? api.cmd('INST ABORT') : (screen.getNamedWidget('CHECK').checked() ? api.cmd_no_hazardous_check('INST CLEAR') : api.cmd('INST CLEAR'))\"\n  END\n  SETTING BACKCOLOR 163 185 163\nEND\n"})})]})}function x(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},5392:(e,s,d)=>{d.d(s,{Z:()=>l,a:()=>i});var n=d(2784);const r={},t=n.createContext(r);function i(e){const s=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),n.createElement(t.Provider,{value:s},e.children)}}}]);

data/tools/staticdocs/assets/js/97535711.7354a61a.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[25],{3686:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>l,metadata:()=>o,toc:()=>a});var t=s(2322),i=s(5392);const l={title:"Testing COSMOS"},r=void 0,o={id:"development/testing",title:"Testing COSMOS",description:"Playwright",source:"@site/docs/development/testing.md",sourceDirName:"development",slug:"/development/testing",permalink:"/tools/staticdocs/docs/development/testing",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/testing.md",tags:[],version:"current",frontMatter:{title:"Testing COSMOS"},sidebar:"defaultSidebar",previous:{title:"Streaming API",permalink:"/tools/staticdocs/docs/development/streaming-api"},next:{title:"Meta",permalink:"/tools/staticdocs/docs/meta"}},c={},a=[{value:"Playwright",id:"playwright",level:2},{value:"Prerequesits",id:"prerequesits",level:3},{value:"Playwright Testing",id:"playwright-testing",level:3},{value:"Unit Tests",id:"unit-tests",level:2}];function d(e){const n={code:"code",em:"em",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"playwright",children:"Playwright"}),"\n",(0,t.jsx)(n.h3,{id:"prerequesits",children:"Prerequesits"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Install Yarn"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm install --global yarn\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Clone the COSMOS Playwright repo"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com/OpenC3/cosmos-playwright\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Install Playwright and dependencies"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos-playwright % yarn install\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"playwright-testing",children:"Playwright Testing"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Start COSMOS"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos % openc3.sh start\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:'Open COSMOS in your browser. At the login screen, set the password to "password".'}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run tests (Note the --headed option visually displays tests, leave it off to run in the background)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos-playwright % yarn playwright test --project=chromium --headed\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.em,{children:"[Optional]"})," Fix istanbul/nyc coverage source lookups (use ",(0,t.jsx)(n.code,{children:"fixwindows"})," if not on Linux)."]}),"\n",(0,t.jsx)(n.p,{children:"Tests will run successfully without this step and you will get coverage statistics, but line-by-line coverage won't work."}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos-playwright % yarn fixlinux\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Generate code coverage"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos-playwright % yarn coverage\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Code coverage reports can be viewed at ",(0,t.jsx)(n.code,{children:"openc3-playwright/coverage/index.html"})]}),"\n",(0,t.jsx)(n.h2,{id:"unit-tests",children:"Unit Tests"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Navigate to ",(0,t.jsx)(n.strong,{children:"cosmos/openc3"})," folder. Run the command:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"cosmos/openc3 % rake build\ncosmos/openc3 % bundle exec rspec\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Code coverage reports can be found at ",(0,t.jsx)(n.code,{children:"cosmos/openc3/coverage/index.html"})]})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},5392:(e,n,s)=>{s.d(n,{Z:()=>o,a:()=>r});var t=s(2784);const i={},l=t.createContext(i);function r(e){const n=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(l.Provider,{value:n},e.children)}}}]);

data/tools/staticdocs/assets/js/99581c43.d6c28a4e.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1513],{4141:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>r});var s=i(2322),o=i(5392);const n={title:"Custom Widgets"},l=void 0,c={id:"guides/custom-widgets",title:"Custom Widgets",description:"COSMOS allows you to build custom widgets which can be deployed with your plugin and used in Telemetry Viewer. Building custom widgets can utilitize any javascript frameworks but since COSMOS is written with Vue.js, we will use that framework in this tutorial.",source:"@site/docs/guides/custom-widgets.md",sourceDirName:"guides",slug:"/guides/custom-widgets",permalink:"/tools/staticdocs/docs/guides/custom-widgets",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/custom-widgets.md",tags:[],version:"current",frontMatter:{title:"Custom Widgets"},sidebar:"defaultSidebar",previous:{title:"COSMOS and NASA cFS",permalink:"/tools/staticdocs/docs/guides/cfs"},next:{title:"Little Endian Bitfields",permalink:"/tools/staticdocs/docs/guides/little-endian-bitfields"}},d={},r=[{value:"Custom Widgets",id:"custom-widgets",level:2},{value:"Helloworld Widget",id:"helloworld-widget",level:3}];function a(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["COSMOS allows you to build custom widgets which can be deployed with your ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins",children:"plugin"})," and used in ",(0,s.jsx)(t.a,{href:"/tools/staticdocs/docs/tools/tlm-viewer",children:"Telemetry Viewer"}),". Building custom widgets can utilitize any javascript frameworks but since COSMOS is written with Vue.js, we will use that framework in this tutorial."]}),"\n",(0,s.jsx)(t.h2,{id:"custom-widgets",children:"Custom Widgets"}),"\n",(0,s.jsxs)(t.p,{children:["We're basically going to follow the COSMOS ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo",children:"Demo"})," and explain how that custom widget was created."]}),"\n",(0,s.jsxs)(t.p,{children:["If you look at the bottom of the Demo's ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/plugin.txt",children:"plugin.txt"})," file you'll see we declare the widgets:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ruby",children:"WIDGET BIG\nWIDGET HELLOWORLD\n"})}),"\n",(0,s.jsxs)(t.p,{children:["When the plugin is deployed this causes COSMOS to look for the as-built widgets. For the BIG widget it will look for the widget at ",(0,s.jsx)(t.code,{children:"tools/widgets/BigWidget/BigWidget.umd.min.js"}),". Similarly it looks for HELLOWORLD at ",(0,s.jsx)(t.code,{children:"tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js"}),". These directories and file names may seem mysterious but it's all about how the widgets get built."]}),"\n",(0,s.jsx)(t.h3,{id:"helloworld-widget",children:"Helloworld Widget"}),"\n",(0,s.jsxs)(t.p,{children:["The Helloworld Widget source code is found in the plugin's src directory and is called ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/src/HelloworldWidget.vue",children:"HelloworldWidget.vue"}),". The basic structure is as follows:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-vue",children:'<template>\n  \x3c!-- Implement widget here --\x3e\n</template>\n\n<script>\nimport Widget from "@openc3/tool-common/src/components/widgets/Widget";\nexport default {\n  mixins: [Widget],\n  data() {\n    return {\n      // Reactive data items\n    };\n  },\n};\n<\/script>\n<style scoped>\n/* widget specific style */\n</style>\n'})}),"\n",(0,s.jsx)(t.admonition,{title:"Vue & Vuetify",type:"info",children:(0,s.jsxs)(t.p,{children:["For more information about how the COSMOS frontend is built (including all the Widgets) please check out ",(0,s.jsx)(t.a,{href:"https://vuejs.org",children:"Vue.js"})," and ",(0,s.jsx)(t.a,{href:"https://vuetifyjs.com",children:"Vuetify"}),"."]})}),"\n",(0,s.jsxs)(t.p,{children:["To build this custom widget we changed the Demo ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/Rakefile",children:"Rakefile"})," to call ",(0,s.jsx)(t.code,{children:"yarn run build"})," when the plugin is built. ",(0,s.jsx)(t.code,{children:"yarn run XXX"})," looks for 'scripts' to run in the ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/package.json",children:"package.json"})," file. If we open package.json we find the following:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-json",children:'  "scripts": {\n    "build": "vue-cli-service build --target lib --dest tools/widgets/HelloworldWidget --formats umd-min src/HelloworldWidget.vue --name HelloworldWidget && vue-cli-service build --target lib --dest tools/widgets/BigWidget --formats umd-min src/BigWidget.vue --name BigWidget"\n  },\n'})}),"\n",(0,s.jsxs)(t.p,{children:["This uses the ",(0,s.jsx)(t.code,{children:"vue-cli-service"})," to build the code found at ",(0,s.jsx)(t.code,{children:"src/HelloworldWidget.vue"})," and formats as ",(0,s.jsx)(t.code,{children:"umd-min"})," and puts it in the ",(0,s.jsx)(t.code,{children:"tools/widgets/HelloworldWidget"})," directory. So this is why the plugin looks for the plugin at ",(0,s.jsx)(t.code,{children:"tools/widgets/HelloworldWidget/HelloworldWidget.umd.min.js"}),". Click ",(0,s.jsx)(t.a,{href:"https://cli.vuejs.org/guide/cli-service.html#vue-cli-service-build",children:"here"})," for the ",(0,s.jsx)(t.code,{children:"vue-cli-service build"})," documentation."]}),"\n",(0,s.jsxs)(t.p,{children:["If you look at the Demo plugin's ",(0,s.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/plugins/packages/openc3-cosmos-demo/targets/INST/screens/simple.txt",children:"simple.txt"})," screen you'll see we're using the widgets:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 0.5\nLABELVALUE <%= target_name %> HEALTH_STATUS CCSDSSEQCNT\nHELLOWORLD\nBIG <%= target_name %> HEALTH_STATUS TEMP1\n"})}),"\n",(0,s.jsx)(t.p,{children:"Opening this screen in Telemetry Viewer results in the following:"}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{alt:"Simple Screen",src:i(2914).Z+"",width:"734",height:"212"})}),"\n",(0,s.jsx)(t.p,{children:"While this is a simple example the possibilities with custom widgets are limitless!"})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},2914:(e,t,i)=>{i.d(t,{Z:()=>s});const s=i.p+"assets/images/simple_screen-3c9d6d2366c716c03a301396a4ce0ea418532890f349d9bc9ebb8be90983a6e6.png"},5392:(e,t,i)=>{i.d(t,{Z:()=>c,a:()=>l});var s=i(2784);const o={},n=s.createContext(o);function l(e){const t=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:l(e.components),s.createElement(n.Provider,{value:t},e.children)}}}]);

data/tools/staticdocs/assets/js/99b59eea.56ab3bff.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7306],{6210:e=>{e.exports=JSON.parse('{"title":"Development","slug":"/development","permalink":"/tools/staticdocs/docs/development","navigation":{"previous":{"title":"Scripting API Guide","permalink":"/tools/staticdocs/docs/guides/scripting-api"},"next":{"title":"Testing with Curl","permalink":"/tools/staticdocs/docs/development/curl"}}}')}}]);

data/tools/staticdocs/assets/js/9d6e81d0.9a3ba2db.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[8155],{4771:(e,t,n)=>{n.r(t),n.d(t,{default:()=>g});n(2784);var s=n(6277),r=n(9817),a=n(7614),i=n(6091);const o={features:"features_t9lD",featureSvg:"featureSvg_GfXr"};var c=n(2322);const d=[{title:"Easy to Configure",description:(0,c.jsx)(c.Fragment,{children:"OpenC3 COSMOS was designed from the ground up to be easy to configure. Simply define the messages needed to talk to your hardware (commands and telemetry), and you are ready to go!"})},{title:"Modern Architecture",description:(0,c.jsx)(c.Fragment,{children:"Built with a modern design, cloud native, and ready to scale. OpenC3 COSMOS has a microservice architecture built to scale, and with fully maintained and up-to-date dependencies."})},{title:"Pick Your Favorite Language",description:(0,c.jsx)(c.Fragment,{children:"OpenC3 COSMOS supports both Ruby and Python for scripting and connecting to targets. Frontend applications can be written in Vue, React, Angular, or Svelte.  Whatever languages your team knows, we support."})}];function l(e){let{title:t,description:n}=e;return(0,c.jsx)("div",{className:(0,s.Z)("col col--4"),children:(0,c.jsxs)("div",{className:"text--center padding-horiz--md",children:[(0,c.jsx)("h3",{children:t}),(0,c.jsx)("p",{children:n})]})})}function u(){return(0,c.jsx)("section",{className:o.features,children:(0,c.jsx)("div",{className:"container",children:(0,c.jsx)("div",{className:"row",children:d.map(((e,t)=>(0,c.jsx)(l,{...e},t)))})})})}const h={heroBanner:"heroBanner_qdFl",buttons:"buttons_AeoN"};function m(){const{siteConfig:e}=(0,a.Z)();return(0,c.jsx)("header",{className:(0,s.Z)("hero hero--primary",h.heroBanner),children:(0,c.jsxs)("div",{className:"container",children:[(0,c.jsx)("img",{src:`${e.baseUrl}img/black_logo.svg`,width:"400px"}),(0,c.jsx)("h1",{className:"hero__title",children:e.title}),(0,c.jsx)("p",{className:"hero__subtitle",children:e.tagline}),(0,c.jsx)("div",{className:h.buttons,children:(0,c.jsx)(r.Z,{className:"button button--secondary button--lg",to:"/docs/getting-started",children:"Get Started"})})]})})}function g(){const{siteConfig:e}=(0,a.Z)();return(0,c.jsxs)(i.Z,{title:`Hello from ${e.title}`,description:"Description will go into a meta tag in <head />",children:[(0,c.jsx)(m,{}),(0,c.jsx)("main",{children:(0,c.jsx)(u,{})})]})}}}]);

data/tools/staticdocs/assets/js/9fb6059a.709498de.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[647],{1133:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var i=t(2322),n=t(5392);const r={title:"OpenC3, Inc. Privacy Policy"},s=void 0,a={id:"privacy",title:"OpenC3, Inc. Privacy Policy",description:"OpenC3 Inc. is strongly committed to protecting your privacy and complying with your choices. Both personal and non-personal information collected is safeguarded according to the highest privacy and data protection standards adopted worldwide. We have always had a robust and effective data protection program in place which complies with existing law and abides by the data protection principles. However, we recognise our obligations in updating and expanding this program to meet the demands of the GDPR.",source:"@site/docs/privacy.md",sourceDirName:".",slug:"/privacy",permalink:"/tools/staticdocs/docs/privacy",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/privacy.md",tags:[],version:"current",frontMatter:{title:"OpenC3, Inc. Privacy Policy"},sidebar:"defaultSidebar",previous:{title:"XTCE Support",permalink:"/tools/staticdocs/docs/meta/xtce"}},c={},l=[{value:"Our Commitment",id:"our-commitment",level:2},{value:"1. Notice",id:"1-notice",level:2},{value:"2. Usage",id:"2-usage",level:2},{value:"3. Consent",id:"3-consent",level:2},{value:"4. Access to your information",id:"4-access-to-your-information",level:2},{value:"5. Security of information",id:"5-security-of-information",level:2},{value:"6. Retention of information",id:"6-retention-of-information",level:2},{value:"7. EU and EEA Users\u2019 Rights",id:"7-eu-and-eea-users-rights",level:2},{value:"8. What we do with the Information you share",id:"8-what-we-do-with-the-information-you-share",level:2},{value:"9. How to opt-out",id:"9-how-to-opt-out",level:2},{value:"10. Does OpenC3 Inc's privacy policy apply to linked websites?",id:"10-does-openc3-incs-privacy-policy-apply-to-linked-websites",level:2},{value:"11. Changes to this policy",id:"11-changes-to-this-policy",level:2},{value:"12. Enforcement of policy",id:"12-enforcement-of-policy",level:2},{value:"13. Questions or comments",id:"13-questions-or-comments",level:2}];function d(e){const o={a:"a",h2:"h2",p:"p",...(0,n.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(o.p,{children:"OpenC3 Inc. is strongly committed to protecting your privacy and complying with your choices. Both personal and non-personal information collected is safeguarded according to the highest privacy and data protection standards adopted worldwide. We have always had a robust and effective data protection program in place which complies with existing law and abides by the data protection principles. However, we recognise our obligations in updating and expanding this program to meet the demands of the GDPR."}),"\n",(0,i.jsx)(o.h2,{id:"our-commitment",children:"Our Commitment"}),"\n",(0,i.jsx)(o.p,{children:"\u2022 Your information will not be shared, rented or sold to any third party.\n\u2022 We use state-of-the-art security measures to protect your information from unauthorized users.\n\u2022 We give you the possibility to control the information that you shared with us (opt-out)"}),"\n",(0,i.jsx)(o.p,{children:"OpenC3, Inc. is committed to processing data in accordance with its responsibilities under the GDPR.\nArticle 5 of the GDPR requires that personal data shall be:"}),"\n",(0,i.jsx)(o.p,{children:"a. processed lawfully, fairly and in a transparent manner in relation to individuals;"}),"\n",(0,i.jsx)(o.p,{children:"b. collected for specified, explicit and legitimate purposes and not further processed in a manner that is incompatible with those purposes; further processing for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes shall not be considered to be incompatible with the initial purposes;"}),"\n",(0,i.jsx)(o.p,{children:"c. adequate, relevant and limited to what is necessary in relation to the purposes for which they are processed;"}),"\n",(0,i.jsx)(o.p,{children:"d. accurate and, where necessary, kept up to date; every reasonable step must be taken to ensure that personal data that are inaccurate, having regard to the purposes for which they are processed, are erased or rectified without delay;"}),"\n",(0,i.jsx)(o.p,{children:"e. kept in a form which permits identification of data subjects for no longer than is necessary for the purposes for which the personal data are processed; personal data may be stored for longer periods insofar as the personal data will be processed solely for archiving purposes in the public interest, scientific or historical research purposes or statistical purposes subject to implementation of the appropriate technical and organisational measures required by the GDPR in order to safeguard the rights and freedoms of individuals; and"}),"\n",(0,i.jsx)(o.p,{children:"f. processed in a manner that ensures appropriate security of the personal data, including protection against unauthorised or unlawful processing and against accidental loss, destruction or damage, using appropriate technical or organisational measures.\u201d"}),"\n",(0,i.jsx)(o.h2,{id:"1-notice",children:"1. Notice"}),"\n",(0,i.jsx)(o.p,{children:'We will clearly inform you when information that personally identifies you ("personal information") is asked for and you will have the choice to provide it or not. Generally, this information is requested when you subscribe to product updates, newsletters or other online services.'}),"\n",(0,i.jsx)(o.h2,{id:"2-usage",children:"2. Usage"}),"\n",(0,i.jsx)(o.p,{children:"We use your personal information for the following purposes:\n\u2022 To provide you information that will allow you to use our services\n\u2022 To automatically customize your documents with your information\n\u2022 To alert you of software upgrades, updates, discounts or other services from OpenC3, Inc."}),"\n",(0,i.jsx)(o.p,{children:"We collect your email when you subscribe to our services or newsletter in order to send you informational communications about OpenC3 Inc's products, such as their purpose and the best use you can make of them. We also collect your email to send you our promotional offers."}),"\n",(0,i.jsx)(o.p,{children:"We may also collect your name, language, currency, operating system, document searched and country information for a better experience with our products/services."}),"\n",(0,i.jsx)(o.p,{children:"When you place your order with us, we collect your email in order to communicate with you. We also collect your phone number in order to contact you in case these emails bounce back because of a typo in your email address and if we cannot figure out what the correct email address is."}),"\n",(0,i.jsx)(o.p,{children:"We also contact the phone number that is provided if we suspect that the cardholder\u2019s credit card information has been compromised, i.e used in a fraudulent way."}),"\n",(0,i.jsx)(o.p,{children:"We also use our clients\u2019 email in order to notify of the release of updated versions of the software, new services or promotional offers."}),"\n",(0,i.jsx)(o.h2,{id:"3-consent",children:"3. Consent"}),"\n",(0,i.jsx)(o.p,{children:"When you provide your personal information, you consent that it can be used for the above purposes and that OpenC3, Inc. is an authorized holder of such information. If you choose not to register or provide personal information, you can still use our website but you will not be able to receive additional services or access certain areas that require registration. When you activate your account, you are providing your consent to occasionally receive information from us. In each communication from us you will have the opportunity to unsubscribe from further communications; alternatively, you may contact us to express your choices at the address provided at the bottom of this page."}),"\n",(0,i.jsx)(o.h2,{id:"4-access-to-your-information",children:"4. Access to your information"}),"\n",(0,i.jsx)(o.p,{children:"You are entitled to review the personal information you have provided us and ensure that it is accurate and current at all times. To review or update this information simply request that we send you this information."}),"\n",(0,i.jsx)(o.h2,{id:"5-security-of-information",children:"5. Security of information"}),"\n",(0,i.jsx)(o.p,{children:"OpenC3, Inc. is strongly committed to protecting your information and ensuring that your choices are honored. We have taken strong security measures to protect your data from loss, misuse, unauthorized access, disclosure, alteration, or destruction. All sensitive data is stored behind multiple firewalls on secure servers with restricted employee access."}),"\n",(0,i.jsx)(o.p,{children:"We guarantee that all e-commerce transactions follow the latest security measures and use the best available technologies. Secure Sockets Layer (SSL) technology is employed when you place online orders or transmit sensitive information. SSL is one of the safest methods of passing information over the Internet."}),"\n",(0,i.jsx)(o.h2,{id:"6-retention-of-information",children:"6. Retention of information"}),"\n",(0,i.jsx)(o.p,{children:"We retain information as long as it is necessary to provide the services requested by you and others, subject to any legal obligations to further retain such information. Information associated with your account will generally be kept until it is no longer necessary to provide the services or until you ask us to delete it or your account is deleted whichever comes first. Additionally, we may retain information from deleted accounts to comply with the law, prevent fraud, resolve disputes, troubleshoot problems, assist with investigations, enforce the Terms of Use, and take other actions permitted by law. The information we retain will be handled in accordance with this Privacy Policy. Finally, your data could also be stored for sales statistical purposes."}),"\n",(0,i.jsx)(o.h2,{id:"7-eu-and-eea-users-rights",children:"7. EU and EEA Users\u2019 Rights"}),"\n",(0,i.jsx)(o.p,{children:"If you are habitually located in the European Union or European Economic Area, you have the right to access, rectify, download or erase your information, as well as the right to restrict and object to certain processing of your information. While some of these rights apply generally, certain rights apply only in certain limited circumstances. We describe these rights below:"}),"\n",(0,i.jsx)(o.p,{children:"You have the right to access your personal data and, if necessary, have it amended or deleted or restricted. In certain instances, you may have the right to the portability of your data. You can also ask us to not send marketing communications and not to use your personal data when we carry out profiling for direct marketing purposes. You can opt out of receiving email newsletters and other marketing communications by following the opt-out instructions provided to you in those emails. Transactional account messages will be unaffected if you opt-out from marketing communications."}),"\n",(0,i.jsx)(o.h2,{id:"8-what-we-do-with-the-information-you-share",children:"8. What we do with the Information you share"}),"\n",(0,i.jsx)(o.p,{children:"Your information is never shared outside the company without your permission. Inside the company, data is stored behind multiple firewalls on secure servers with restricted user access."}),"\n",(0,i.jsx)(o.p,{children:"When you register to our website, you are asked to provide your contact information, including a valid email address. We use this information to send you updates about order confirmations and information about our services. When you order from us, we ask for your credit card number and billing address. We use this information only to bill you for the product(s) you ordered at that time."}),"\n",(0,i.jsx)(o.p,{children:"We may on occasion require the help of other companies to provide limited services on our behalf, such as packaging, shipping and delivery, customer support and processing event registrations. We will only provide such companies with the information required for them to perform these services; these service providers are bound by strict privacy policies and are prohibited from using your information for any other purpose."}),"\n",(0,i.jsx)(o.p,{children:"In very rare instances OpenC3, Inc. may disclose your personal information, without notice, only if required to do so by law or in the good faith belief that such action is necessary to: (a) conform to the edicts of the law or comply with legal process served on OpenC3, Inc. or the site; (b) protect and defend the rights or property of OpenC3, Inc. and its family of websites and properties; and (c) act in urgent circumstances to protect the personal safety of users of OpenC3, Inc., its websites, or the public."}),"\n",(0,i.jsx)(o.h2,{id:"9-how-to-opt-out",children:"9. How to opt-out"}),"\n",(0,i.jsx)(o.p,{children:"We provide users with the opportunity to opt-out from receiving updates on our products, newsletters and other communications from us. You can opt-out by clicking on the link provided in our electronic mailings or by contacting us at the address at the bottom of this page."}),"\n",(0,i.jsx)(o.h2,{id:"10-does-openc3-incs-privacy-policy-apply-to-linked-websites",children:"10. Does OpenC3 Inc's privacy policy apply to linked websites?"}),"\n",(0,i.jsx)(o.p,{children:"Our Privacy Policy applies solely to information collected on our website or through interactions with our company.\nThe Site contains links to web sites of third parties. OpenC3, Inc. is not responsible for the actions of these third parties, including their privacy practices and any content posted on their web sites. We encourage you to review their privacy policies to learn more about what, why and how they collect and use personal information. OpenC3, Inc. adheres to industry recognized standards to secure any personal information in our possession, and to secure it from unauthorized access and tampering."}),"\n",(0,i.jsx)(o.p,{children:"However, as is true with all online actions, it is possible that third parties may unlawfully intercept transmissions of personal information, or other users of the Site may misuse or abuse your personal information that they may collect from the Site."}),"\n",(0,i.jsx)(o.h2,{id:"11-changes-to-this-policy",children:"11. Changes to this policy"}),"\n",(0,i.jsx)(o.p,{children:"If we make changes to our Privacy Policy, we will post these changes here so that you are always aware of what information we collect, how we use it and under what circumstances, if any, we disclose it. If at any point we decide to use your information in a manner different from that stated at the time it was collected, we will notify you by email."}),"\n",(0,i.jsx)(o.h2,{id:"12-enforcement-of-policy",children:"12. Enforcement of policy"}),"\n",(0,i.jsx)(o.p,{children:"If for some reason you believe OpenC3, Inc. has not adhered to these principles, please notify us and we will do our best to promptly make corrections."}),"\n",(0,i.jsx)(o.h2,{id:"13-questions-or-comments",children:"13. Questions or comments"}),"\n",(0,i.jsxs)(o.p,{children:["If you have questions or comments about this privacy policy, please email us at: ",(0,i.jsx)(o.a,{href:"mailto:support@openc3.com",children:"support@openc3.com"})]}),"\n",(0,i.jsx)(o.p,{children:"For additional information about how to contact OpenC3, Inc. please visit our help page."}),"\n",(0,i.jsx)(o.p,{children:"Dated: August 11th, 2022"})]})}function u(e={}){const{wrapper:o}={...(0,n.a)(),...e.components};return o?(0,i.jsx)(o,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},5392:(e,o,t)=>{t.d(o,{Z:()=>a,a:()=>s});var i=t(2784);const n={},r=i.createContext(n);function s(e){const o=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function a(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),i.createElement(r.Provider,{value:o},e.children)}}}]);

data/tools/staticdocs/assets/js/a507c363.b04cc959.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[461],{4647:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>r,contentTitle:()=>l,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var s=t(2322),o=t(5392);const i={title:"Host Install"},l=void 0,a={id:"development/host-install",title:"Host Install",description:"Installing COSMOS Directly onto a Host (No Containers)",source:"@site/docs/development/host-install.md",sourceDirName:"development",slug:"/development/host-install",permalink:"/tools/staticdocs/docs/development/host-install",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/host-install.md",tags:[],version:"current",frontMatter:{title:"Host Install"},sidebar:"defaultSidebar",previous:{title:"Developing COSMOS",permalink:"/tools/staticdocs/docs/development/developing"},next:{title:"JSON API",permalink:"/tools/staticdocs/docs/development/json-api"}},r={},c=[{value:"Installing COSMOS Directly onto a Host (No Containers)",id:"installing-cosmos-directly-onto-a-host-no-containers",level:2}];function d(n){const e={a:"a",code:"code",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",...(0,o.a)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h2,{id:"installing-cosmos-directly-onto-a-host-no-containers",children:"Installing COSMOS Directly onto a Host (No Containers)"}),"\n",(0,s.jsx)(e.p,{children:"Note: THIS IS NOT A RECOMMENDED CONFIGURATION."}),"\n",(0,s.jsx)(e.p,{children:"COSMOS 5 is released as containers and intended to be run as containers. However, for various reasons someone might want to run COSMOS directly on a host. These instructions will walk through getting COSMOS 5 installed and running directly on RHEL 7 or Centos 7. This configuration will create a working install, but falls short of the ideal in that it does not setup the COSMOS processes as proper services on the host OS (that restart themselves on boot, and maintain themselves running in case of errors). Contributions that add that functionality are welcome."}),"\n",(0,s.jsx)(e.p,{children:"Let's get started."}),"\n",(0,s.jsxs)(e.ol,{children:["\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"The starting assumption is that you have a fresh install of either RHEL 7 or Centos 7. You are running as a normal user that has sudo permissions, and has git installed."}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"Start by downloading the latest working version of COSMOS from Github"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd ~\ngit clone https://github.com/openc3/cosmos.git\n"})}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"Run the COSMOS installation script"}),"\n",(0,s.jsx)(e.p,{children:"If you are feeling brave, you can run the one large installer script that installs everything in one step:"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd cosmos/examples/hostinstall/centos7\n./openc3_install.sh\n"})}),"\n",(0,s.jsx)(e.p,{children:"Or, you may want to break it down to the same steps that are in that script, and make sure each individual step is successful:"}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-bash",children:"cd cosmos/examples/hostinstall/centos7\n./openc3_install_packages.sh\n./openc3_install_ruby.sh\n./openc3_install_redis.sh\n./openc3_install_minio.sh\n./openc3_install_traefik.sh\n./openc3_install_openc3.sh\n./openc3_start_services.sh\n./openc3_first_init.sh\n"})}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsxs)(e.p,{children:["If all was successful, you should be able to open Firefox, and goto: ",(0,s.jsx)(e.a,{href:"http://localhost:2900",children:"http://localhost:2900"}),". Congrats you have COSMOS running directly on a host."]}),"\n"]}),"\n",(0,s.jsxs)(e.li,{children:["\n",(0,s.jsx)(e.p,{children:"As stated at the beginning, this is not currently a supported configuration. Contributions that help to improve it are welcome."}),"\n"]}),"\n"]})]})}function h(n={}){const{wrapper:e}={...(0,o.a)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(d,{...n})}):d(n)}},5392:(n,e,t)=>{t.d(e,{Z:()=>a,a:()=>l});var s=t(2784);const o={},i=s.createContext(o);function l(n){const e=s.useContext(i);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:l(n.components),s.createElement(i.Provider,{value:e},n.children)}}}]);

data/tools/staticdocs/assets/js/a677c089.759b7b09.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7216],{3333:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var n=r(2322),i=r(5392);const s={sidebar_position:6,title:"Interfaces"},o=void 0,c={id:"configuration/interfaces",title:"Interfaces",description:"Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level INTERFACE keyword in the plugin.txt file.",source:"@site/docs/configuration/interfaces.md",sourceDirName:"configuration",slug:"/configuration/interfaces",permalink:"/tools/staticdocs/docs/configuration/interfaces",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/interfaces.md",tags:[],version:"current",sidebarPosition:6,frontMatter:{sidebar_position:6,title:"Interfaces"},sidebar:"defaultSidebar",previous:{title:"Telemetry",permalink:"/tools/staticdocs/docs/configuration/telemetry"},next:{title:"Protocols",permalink:"/tools/staticdocs/docs/configuration/protocols"}},d={},a=[{value:"Provided Interfaces",id:"provided-interfaces",level:2},{value:"TCPIP Client Interface",id:"tcpip-client-interface",level:3},{value:"TCPIP Server Interface",id:"tcpip-server-interface",level:3},{value:"UDP Interface",id:"udp-interface",level:3},{value:"Serial Interface",id:"serial-interface",level:3},{value:"Streams",id:"streams",level:2},{value:"Protocols",id:"protocols",level:2}];function l(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.p,{children:["Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface-1",children:"INTERFACE"})," keyword in the plugin.txt file."]}),"\n",(0,n.jsxs)(t.p,{children:["Interface classes provide the code that COSMOS uses to receive real-time telemetry from targets and to send commands to targets. The interface that a target uses could be anything (TCP/IP, serial, GPIB, Firewire, etc.), therefore it is important that this is a customizable portion of any reusable Command and Telemetry System. Fortunately the most common form of interfaces are over TCP/IP sockets, and COSMOS provides interface solutions for these. This guide will discuss how to use these interface classes, and how to create your own. Note that in most cases you can extend interfaces with ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols",children:"Protocols"})," rather than implementing a new interface."]}),"\n",(0,n.jsx)(t.admonition,{title:"Interface and Routers Are Very Similar",type:"info",children:(0,n.jsx)(t.p,{children:"Note that Interfaces and Routers are very similar and share the same configuration parameters. Routers are simply Interfaces which route an existing Interface's telemetry data out to the connected target and routes the connected target's commands back to the original Interface's target."})}),"\n",(0,n.jsx)(t.p,{children:"Interfaces have the following methods that must be implemented:"}),"\n",(0,n.jsxs)(t.ol,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"connect"})," - Open the socket or port or somehow establish the connection to the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"connected?"})," - Return true or false depending on the connection state. Note: This method should return immediately."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"disconnect"})," - Close the socket or port of somehow disconnect from the target. Note: This method may not block indefinitely. Be sure to call super() in your implementation."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"read_interface"})," - Lowest level read of data on the interface. Note: This method should block until data is available or the interface disconnects. On a clean disconnect it should return nil."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"write_interface"})," - Lowest level write of data on the interface. Note: This method may not block indefinitely."]}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"Interfaces also have the following methods that exist and have default implementations. They can be overridden if necessary but be sure to call super() to allow the default implementation to be executed."}),"\n",(0,n.jsxs)(t.ol,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"read_interface_base"})," - This method should always be called from read_interface(). It updates interface specific variables that are displayed by CmdTLmServer including the bytes read count, the most recent raw data read, and it handles raw logging if enabled."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"write_interface_base"})," - This method should always be called from write_interface(). It updates interface specific variables that are displayed by CmdTLmServer including the bytes written count, the most recent raw data written, and it handles raw logging if enabled."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"read"})," - Read the next packet from the interface. COSMOS implements this method to allow the Protocol system to operate on the data and the packet before it is returned."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"write"})," - Send a packet to the interface. COSMOS implements this method to allow the Protocol system to operate on the packet and the data before it is sent."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"write_raw"})," - Send a raw binary string of data to the target. COSMOS implements this method by basically calling write_interface with the raw data."]}),"\n"]}),"\n",(0,n.jsx)(t.admonition,{title:"Naming Conventions",type:"warning",children:(0,n.jsx)(t.p,{children:'When creating your own interfaces, in most cases they will be subclasses of one of the built-in interfaces described below. It is important to know that both the filename and class name of the interface files must match with correct capitalization or you will receive "class not found" errors when trying to load your new interface. For example, an interface file called labview_interface.rb must contain the class LabviewInterface. If the class was named, LabVIEWInterface, for example, COSMOS would not be able to find the class because of the unexpected capitalization.'})}),"\n",(0,n.jsx)(t.h2,{id:"provided-interfaces",children:"Provided Interfaces"}),"\n",(0,n.jsxs)(t.p,{children:["COSMOS provides the following interfaces for use: TCPIP Client, TCPIP Server, UDP, and Serial. The interface to use is defined by the ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface",children:"INTERFACE"})," and ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#router",children:"ROUTER"})," keywords."]}),"\n",(0,n.jsx)(t.h3,{id:"tcpip-client-interface",children:"TCPIP Client Interface"}),"\n",(0,n.jsx)(t.p,{children:"The TCPIP client interface connects to a TCPIP socket to send commands and receive telemetry. This interface is used for targets which open a socket and wait for a connection. This is the most common type of interface."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Host"}),(0,n.jsx)(t.td,{children:"Machine name to connect to"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Port"}),(0,n.jsx)(t.td,{children:"Port to write commands to (can be the same as read port). Pass nil to make the interface read only."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Port"}),(0,n.jsx)(t.td,{children:"Port to read telemetry from (can be the same as write port). Pass nil to make the interface write only."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the write"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the read. Pass 'nil' to block on read."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Type"}),(0,n.jsx)(t.td,{children:"See Protocols."}),(0,n.jsx)(t.td,{children:"No"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Arguments"}),(0,n.jsx)(t.td,{children:"See Protocols for the arguments each stream protocol takes."}),(0,n.jsx)(t.td,{children:"No"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"plugin.txt Examples:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil LENGTH 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil BURST 4 0xDEADBEEF\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil FIXED 6 0 nil true\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 10.0 TERMINATED 0x0D0A 0x0D0A true 0 0xF005BA11\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 10.0 TEMPLATE 0xA 0xA\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil PREIDENTIFIED 0xCAFEBABE\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 10.0 # no built-in protocol\n"})}),"\n",(0,n.jsxs)(t.p,{children:["See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface",children:"INTERFACE"})," for a description of the INTERFACE keyword. See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface-modifiers",children:"Interface Modifiers"})," for a description of the keywords which can follow the INTERFACE keyword."]}),"\n",(0,n.jsx)(t.h3,{id:"tcpip-server-interface",children:"TCPIP Server Interface"}),"\n",(0,n.jsx)(t.p,{children:"The TCPIP server interface creates a TCPIP server which listens for incoming connections and dynamically creates sockets which communicate with the target. This interface is used for targets which open a socket and try to connect to a server."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Port"}),(0,n.jsx)(t.td,{children:"Port to write commands to (can be the same as read port)"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Port"}),(0,n.jsx)(t.td,{children:"Port to read telemetry from (can be the same as write port)"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the write"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the read. Pass 'nil' to block on read."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Type"}),(0,n.jsx)(t.td,{children:"See Protocols."}),(0,n.jsx)(t.td,{children:"No"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Arguments"}),(0,n.jsx)(t.td,{children:"See Protocols for the arguments each stream protocol takes."}),(0,n.jsx)(t.td,{children:"No"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"plugin.txt Examples:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME tcpip_server_interface.rb 8080 8081 10.0 nil LENGTH 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11\nINTERFACE INTERFACE_NAME tcpip_server_interface.rb 8080 8080 10.0 nil BURST 4 0xDEADBEEF\nINTERFACE INTERFACE_NAME tcpip_server_interface.rb 8080 8080 10.0 nil FIXED 6 0 nil true\nINTERFACE INTERFACE_NAME tcpip_server_interface.rb 8080 8080 10.0 10.0 TERMINATED 0x0D0A 0x0D0A true 0 0xF005BA11\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb 8080 8080 10.0 10.0 TEMPLATE 0xA 0xA\nINTERFACE INTERFACE_NAME tcpip_server_interface.rb 8080 8080 10.0 nil PREIDENTIFIED 0xCAFEBABE\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb 8080 8080 10.0 10.0 # no built-in protocol\n"})}),"\n",(0,n.jsxs)(t.p,{children:["See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface",children:"INTERFACE"})," for a description of the INTERFACE keyword. See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface-modifiers",children:"Interface Modifiers"})," for a description of the keywords which can follow the INTERFACE keyword. Note, TcpipServerInterface processes the ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#option",children:"OPTION"})," modifier."]}),"\n",(0,n.jsx)(t.h3,{id:"udp-interface",children:"UDP Interface"}),"\n",(0,n.jsx)(t.p,{children:"The UDP interface uses UDP packets to send and receive telemetry from the target."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Required"}),(0,n.jsx)(t.th,{children:"Default"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Host"}),(0,n.jsx)(t.td,{children:"Host name or IP address of the machine to send and receive data with"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Dest Port"}),(0,n.jsx)(t.td,{children:"Port on the remote machine to send commands to"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Port"}),(0,n.jsx)(t.td,{children:"Port on the remote machine to read telemetry from"}),(0,n.jsx)(t.td,{children:"Yes"}),(0,n.jsx)(t.td,{})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Source Port"}),(0,n.jsx)(t.td,{children:"Port on the local machine to send commands from"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"nil (socket is not bound to an outgoing port)"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Interface Address"}),(0,n.jsx)(t.td,{children:"If the remote machine supports multicast the interface address is used to configure the outgoing multicast address"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"nil (not used)"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"TTL"}),(0,n.jsx)(t.td,{children:"Time to Live. The number of intermediate routers allowed before dropping the packet."}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"128 (Windows)"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the write"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"10.0"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the read"}),(0,n.jsx)(t.td,{children:"No"}),(0,n.jsx)(t.td,{children:"nil (block on read)"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"plugin.txt Example:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME udp_interface.rb host.docker.internal 8080 8081 8082 nil 128 10.0 nil\n"})}),"\n",(0,n.jsxs)(t.p,{children:["See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface",children:"INTERFACE"})," for a description of the INTERFACE keyword. See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface-modifiers",children:"Interface Modifiers"})," for a description of the keywords which can follow the INTERFACE keyword."]}),"\n",(0,n.jsx)(t.h3,{id:"serial-interface",children:"Serial Interface"}),"\n",(0,n.jsx)(t.p,{children:"The serial interface connects to a target over a serial port. COSMOS provides drivers for both Windows and POSIX drivers for UNIX based systems."}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Description"}),(0,n.jsx)(t.th,{children:"Required"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Port"}),(0,n.jsx)(t.td,{children:"Name of the serial port to write, e.g. 'COM1' or '/dev/ttyS0'. Pass 'nil' to disable writing."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Port"}),(0,n.jsx)(t.td,{children:"Name of the serial port to read, e.g. 'COM1' or '/dev/ttyS0'. Pass 'nil' to disable reading."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Baud Rate"}),(0,n.jsx)(t.td,{children:"Baud rate to read and write"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Parity"}),(0,n.jsx)(t.td,{children:"Serial port parity. Must be 'NONE', 'EVEN', or 'ODD'."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Stop Bits"}),(0,n.jsx)(t.td,{children:"Number of stop bits, e.g. 1."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Write Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the write"}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Read Timeout"}),(0,n.jsx)(t.td,{children:"Number of seconds to wait before aborting the read. Pass 'nil' to block on read."}),(0,n.jsx)(t.td,{children:"Yes"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Type"}),(0,n.jsx)(t.td,{children:"See Protocols."}),(0,n.jsx)(t.td,{children:"No"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:"Protocol Arguments"}),(0,n.jsx)(t.td,{children:"See Protocols for the arguments each stream protocol takes."}),(0,n.jsx)(t.td,{children:"No"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"plugin.txt Examples:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME serial_interface.rb COM1 COM1 9600 NONE 1 10.0 nil LENGTH 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11\nINTERFACE INTERFACE_NAME serial_interface.rb /dev/ttyS1 /dev/ttyS1 38400 ODD 1 10.0 nil BURST 4 0xDEADBEEF\nINTERFACE INTERFACE_NAME serial_interface.rb COM2 COM2 19200 EVEN 1 10.0 nil FIXED 6 0 nil true\nINTERFACE INTERFACE_NAME serial_interface.rb COM4 COM4 115200 NONE 1 10.0 10.0 TERMINATED 0x0D0A 0x0D0A true 0 0xF005BA11\nINTERFACE INTERFACE_NAME serial_interface.rb COM4 COM4 115200 NONE 1 10.0 10.0 TEMPLATE 0xA 0xA\nINTERFACE INTERFACE_NAME serial_interface.rb /dev/ttyS0 /dev/ttyS0 57600 NONE 1 10.0 nil PREIDENTIFIED 0xCAFEBABE\nINTERFACE INTERFACE_NAME serial_interface.rb COM4 COM4 115200 NONE 1 10.0 10.0 # no built-in protocol\n"})}),"\n",(0,n.jsxs)(t.p,{children:["See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface",children:"INTERFACE"})," for a description of the INTERFACE keyword. See ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#interface-modifiers",children:"Interface Modifiers"})," for a description of the keywords which can follow the INTERFACE keyword. Note, SerialInterface processes the ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/plugins#option",children:"OPTION"})," modifier."]}),"\n",(0,n.jsx)(t.h2,{id:"streams",children:"Streams"}),"\n",(0,n.jsx)(t.p,{children:"Streams are low level classes that implement read, read_nonblock, write, connect, connected? and disconnect methods. The build-in Stream classes are SerialStream, TcpipSocketStream and TcpipClientStream and they are automatically used when creating a Serial Interface, TCP/IP Server Interface, or TCP/IP Client Interface."}),"\n",(0,n.jsx)(t.h2,{id:"protocols",children:"Protocols"}),"\n",(0,n.jsx)(t.p,{children:"Protocols define the behaviour of an Interface, including differentiating packet boundaries and modifying data as necessary. COSMOS defines the following built-in protocols which can be used with the above interfaces:"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#burst-protocol",children:"Burst"})}),(0,n.jsx)(t.td,{children:"Reads as much data as possible from the interface"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#fixed-protocol",children:"Fixed"})}),(0,n.jsx)(t.td,{children:"Processes fixed length packets with a known ID position"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#length-protocol",children:"Length"})}),(0,n.jsx)(t.td,{children:"Processes a length field at a fixed location and then reads the remainder of the data"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#terminated-protocol",children:"Terminated"})}),(0,n.jsx)(t.td,{children:"Delineates packets uses termination characters at the end of each packet"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#template-protocol",children:"Template"})}),(0,n.jsx)(t.td,{children:"Processes text based command / response data such as SCPI interfaces"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#preidentified-protocol",children:"Preidentified"})}),(0,n.jsx)(t.td,{children:"Internal COSMOS protocol used by COSMOS tools"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"These protocols are declared directly after the interface:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil BURST 4 0xDEADBEEF\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil FIXED 6 0 nil true\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil LENGTH 0 16 0 1 BIG_ENDIAN 4 INTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 10.0 TERMINATED 0x0D0A 0x0D0A true 0 0xF005BA11\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 10.0 TEMPLATE 0xA 0xA\nINTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil PREIDENTIFIED 0xCAFEBABE\n"})}),"\n",(0,n.jsx)(t.p,{children:"COSMOS also defines the following helper protocols:"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#crc-protocol",children:"CRC"})}),(0,n.jsx)(t.td,{children:"Adds CRCs to outgoing packets and verifies CRCs on incoming packets"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#ignore-packet-protocol",children:"Ignore"})}),(0,n.jsx)(t.td,{children:"Ignores the specified packet by dropping it"})]})]})]}),"\n",(0,n.jsx)(t.p,{children:"These protocols are declared after the INTERFACE:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ruby",children:"INTERFACE INTERFACE_NAME tcpip_client_interface.rb host.docker.internal 8080 8080 10.0 nil BURST 4 0xDEADBEEF\nTARGET TGT\nPROTOCOL WRITE CrcProtocol CRC # See the documentation for parameters\n"})}),"\n",(0,n.jsx)(t.p,{children:"Note the first parameter after the PROTOCOL keyword is how to apply the protocol: READ, WRITE, or READ_WRITE. Read applies the protocol on incoming packets (telemetry) and write on outgoing packets (commands). The next parameter is the protocol filename or class name. All other parameters are protocol specific."}),"\n",(0,n.jsxs)(t.p,{children:["In addition, you can define your own protocols which are declared like the COSMOS helper protocols after your interface. See the ",(0,n.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#custom-protocols",children:"Custom Protocols"})," documentation for more information."]}),"\n",(0,n.jsx)(t.admonition,{title:"Protocol Run Order",type:"info",children:(0,n.jsx)(t.p,{children:"Read protocols execute in the order specified (First specified runs first). Write protocols execute in the reverse order (Last specified executes first)."})})]})}function h(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},5392:(e,t,r)=>{r.d(t,{Z:()=>c,a:()=>o});var n=r(2784);const i={},s=n.createContext(i);function o(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]);