openc3-cosmos-tool-docs 5.15.1 → 5.16.0

data/tools/staticdocs/assets/js/9424f0b3.66b19930.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4909],{3902:(e,s,d)=>{d.r(s),d.d(s,{assets:()=>h,contentTitle:()=>i,default:()=>x,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=d(1085),n=d(1184);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,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.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,r.jsx)("div",{style:{clear:"both"}}),"\n",(0,r.jsx)(s.h2,{id:"definitions",children:"Definitions"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Definition"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget"}),(0,r.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,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen"}),(0,r.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,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen Definition File"}),(0,r.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,r.jsx)(s.h2,{id:"telemetry-screen-definition-files",children:"Telemetry Screen Definition Files"}),"\n",(0,r.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,r.jsx)(s.h2,{id:"new-widgets",children:"New Widgets"}),"\n",(0,r.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,r.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide."]}),"\n",(0,r.jsx)(s.h1,{id:"screen-keywords",children:"Screen Keywords"}),"\n",(0,r.jsx)(s.h2,{id:"screen",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Define a telemetry viewer screen"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels or AUTO to let Telemetry Viewer automatically layout the screen"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Polling Period"}),(0,r.jsx)(s.td,{children:"Number of seconds between screen updates"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"SCREEN AUTO AUTO 1.0 FIXED\n"})}),"\n",(0,r.jsx)(s.h2,{id:"end",children:"END"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Indicates the close of a layout widget"})}),"\n",(0,r.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,r.jsx)(s.h2,{id:"stale_time",children:"STALE_TIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.1.0)"}),(0,r.jsx)(s.strong,{children:"Values are marked stale if the packet time is more than Stale Time seconds in the past"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"STALE_TIME 5 # Number of seconds to wait before marking data stale\n"})}),"\n",(0,r.jsx)(s.h2,{id:"global_setting",children:"GLOBAL_SETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget setting to all widgets of a certain type"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Class Name"}),(0,r.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABEL or BUTTON."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK\n"})}),"\n",(0,r.jsx)(s.h2,{id:"global_subsetting",children:"GLOBAL_SUBSETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget subsetting to all widgets of a certain type"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Class Name"}),(0,r.jsx)(s.td,{children:"The name of the class of widgets that this setting will be applied to. For example, LABELVALUE."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Subwidget Index"}),(0,r.jsx)(s.td,{children:"Index to the desired subwidget"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h2,{id:"setting",children:"SETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget setting to the previously defined widget"})}),"\n",(0,r.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,r.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,r.jsx)(s.h3,{id:"width",children:"WIDTH"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget width"})}),"\n",(0,r.jsxs)(s.p,{children:["WIDTH supports ",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"height",children:"HEIGHT"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget height"})}),"\n",(0,r.jsxs)(s.p,{children:["HEIGHT supports ",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"margin",children:"MARGIN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget margin"})}),"\n",(0,r.jsxs)(s.p,{children:["MARGIN supports ",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Size"}),(0,r.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"padding",children:"PADDING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Sets the widget padding"})}),"\n",(0,r.jsxs)(s.p,{children:["PADDING supports ",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Size"}),(0,r.jsx)(s.td,{children:"Size in pixels or explicitly declared with units"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"backcolor",children:"BACKCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The BACKCOLOR setting sets the background color for a widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"textcolor",children:"TEXTCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The TEXTCOLOR setting sets the text color for a widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"bordercolor",children:"BORDERCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"The BORDERCOLOR setting sets the border color for a layout widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color name or Red value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Green value"}),(0,r.jsx)(s.td,{children:"Green value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Blue value"}),(0,r.jsx)(s.td,{children:"Blue value of the RGB value"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"raw",children:"RAW"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Apply a raw CSS stylesheet key and value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Key"}),(0,r.jsx)(s.td,{children:"CSS key like font-size, max-width, etc"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"CSS Value"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "Label 1"\n  SETTING RAW font-size 30px\n'})}),"\n",(0,r.jsx)(s.h2,{id:"subsetting",children:"SUBSETTING"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Applies a widget subsetting to the previously defined widget"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Subwidget Index"}),(0,r.jsx)(s.td,{children:"Index to the desired subwidget or 'ALL' to apply the setting to all the subwidgets of this composite widget."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Name"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Setting Value(s)"}),(0,r.jsx)(s.td,{children:"See SETTING for details."}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h2,{id:"named_widget",children:"NAMED_WIDGET"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Name a widget to allow access to it via the getNamedWidget method"})}),"\n",(0,r.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,r.jsx)(s.admonition,{type:"warning",children:(0,r.jsx)(s.p,{children:"getNamedWidget returns the widget itself and thus must be operated on using methods native to that widget"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Name"}),(0,r.jsx)(s.td,{children:"The unique name applied to the following widget instance. Names must be unique per screen."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Type"}),(0,r.jsx)(s.td,{children:"One of the widget types listed in Widget Descriptions"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget Parameters"}),(0,r.jsx)(s.td,{children:"The unique parameters for the given widget type"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'NAMED_WIDGET DURATION TEXTFIELD\nBUTTON "Push" "screen.getNamedWidget(\'DURATION\').text()"\n'})}),"\n",(0,r.jsx)(s.h2,{id:"layout-widgets",children:"Layout Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.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,r.jsx)(s.h3,{id:"vertical",children:"VERTICAL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'VERTICAL 5px\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"verticalbox",children:"VERTICALBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates vertically inside a thin border"})}),"\n",(0,r.jsx)(s.p,{children:"The VERTICALBOX widget sizes itself to fit its contents vertically and to fit the screen horizontally"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Title"}),(0,r.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'VERTICALBOX Info\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontal",children:"HORIZONTAL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally"})}),"\n",(0,r.jsx)(s.p,{children:"The HORIZONTAL widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'HORIZONTAL 100\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontalbox",children:"HORIZONTALBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets it encapsulates horizontally inside a thin border"})}),"\n",(0,r.jsx)(s.p,{children:"The HORIZONTALBOX widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Title"}),(0,r.jsx)(s.td,{children:"Text to place within the border to label the box"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'HORIZONTALBOX Info 10\n  LABEL "TEST"\n  LABEL "SCREEN"\nEND\n'})}),"\n",(0,r.jsx)(s.h3,{id:"matrixbycolumns",children:"MATRIXBYCOLUMNS"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets into a table-like matrix"})}),"\n",(0,r.jsx)(s.p,{children:"The MATRIXBYCOLUMNS widget sizes itself to fit its contents"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Columns"}),(0,r.jsx)(s.td,{children:"The number of columns to create"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"scrollwindow",children:"SCROLLWINDOW"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places the widgets inside of it into a scrollable area"})}),"\n",(0,r.jsx)(s.p,{children:"The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Maximum height of the scroll window in pixels (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Margin"}),(0,r.jsx)(s.td,{children:"Margin between widgets (default = 0px)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"tabbook",children:"TABBOOK"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a tabbed area in which to place TABITEM widgets"})}),"\n",(0,r.jsx)(s.h3,{id:"tabitem",children:"TABITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a VERTICAL layout tab into which to place widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Tab text"}),(0,r.jsx)(s.td,{children:"Text to diplay in the tab"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"iframe",children:"IFRAME"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open external tools in an Iframe within OpenC3"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"URL"}),(0,r.jsx)(s.td,{children:"The path to the page to display in the iframe"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"IFRAME https://openc3.com 900 450\n"})}),"\n",(0,r.jsx)(s.h2,{id:"decoration-widgets",children:"Decoration Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.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,r.jsx)(s.h3,{id:"label",children:"LABEL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays text on the screen"})}),"\n",(0,r.jsx)(s.p,{children:"Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display on the label"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'LABEL "Note: This is only a warning"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"horizontalline",children:"HORIZONTALLINE"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Displays a horizontal line on the screen that can be used as a separator"})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABEL Over\nHORIZONTALLINE\nLABEL Under\n"})}),"\n",(0,r.jsx)(s.h3,{id:"sectionheader",children:"SECTIONHEADER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"DEPRECATED - Displays a label that is underlined with a horizontal line"})}),"\n",(0,r.jsx)(s.p,{children:"Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h3,{id:"title",children:"TITLE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a large centered title on the screen"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'TITLE "Title"\nHORIZONTALLINE\nLABEL "Label"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"spacer",children:"SPACER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Places a fixed size spacer in between widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the spacer in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the spacer in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h2,{id:"telemetry-widgets",children:"Telemetry Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.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,r.jsx)(s.h3,{id:"array",children:"ARRAY"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays ARRAY data organized into rows and space separated"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Items per row"}),(0,r.jsx)(s.td,{children:"Number of array items per row (default = 4)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"block",children:"BLOCK"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays BLOCK data organized into rows and space separated"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Format string applied to each array item (default = nil)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Bytes per word"}),(0,r.jsx)(s.td,{children:"Number of bytes per word (default = 4)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Words per row"}),(0,r.jsx)(s.td,{children:"Number of words per row (default = 4"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Address format"}),(0,r.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,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:'BLOCK INST IMAGE IMAGE 400 130 "%02X" 4 4 "0x%08X:"\n'})}),"\n",(0,r.jsx)(s.h3,{id:"formatvalue",children:"FORMATVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a box with a formatted value"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format string"}),(0,r.jsx)(s.td,{children:"Printf style format string to apply to the telemetry item"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelled",children:"LABELLED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL followed by a LED"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Justification"}),(0,r.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,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"SPLIT, CENTER, LEFT, RIGHT"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to LABELLED. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"led_color",children:"LED_COLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LED color"}),(0,r.jsx)(s.td,{children:"Color of the LED"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelprogressbar",children:"LABELPROGRESSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a PROGRESSBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Scale factor"}),(0,r.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,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the progress bar (default = 80 pixels"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW\nLABELPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvalue",children:"LABELVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a VALUE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELVALUE INST LATEST TIMESEC CONVERTED 18\nLABELVALUE INST LATEST COLLECT_TYPE\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluedesc",children:"LABELVALUEDESC"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the items description followed by a VALUE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Description"}),(0,r.jsx)(s.td,{children:"The description to display in the label (default is to display the description text associated with the telemetry item)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"labelvaluelimitsbar",children:"LABELVALUELIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluelimitscolumn",children:"LABELVALUELIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nLABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"labelvaluerangebar",children:"LABELVALUERANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"led",children:"LED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LED which changes color based on telemetry values"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the LED circle (default = 15)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to LED. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"led_color-1",children:"LED_COLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map a state or value to a color"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value. ANY used to match any value or state not declared."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"LED color"}),(0,r.jsx)(s.td,{children:"Color of the LED"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"limitsbar",children:"LIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item's current value within its colored limits horizontally"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50\nLIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"limitscolumn",children:"LIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item's current value within its colored limits vertically"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200\nLIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"limitscolor",children:"LIMITSCOLOR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a circle depicting the limits color of an item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Radius"}),(0,r.jsx)(s.td,{children:"Radius of the circle (default is 10)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Full Item Name"}),(0,r.jsx)(s.td,{children:"Show the full item name (default is false)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE\nLIMITSCOLOR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuelimitsbar",children:"VALUELIMITSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSBAR INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuelimitscolumn",children:"VALUELIMITSCOLUMN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by LIMITSCOLUMN"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 8)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h3,{id:"valuerangebar",children:"VALUERANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an item VALUE followed by RANGEBAR"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 160)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"linegraph",children:"LINEGRAPH"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a line graph of a telemetry item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to LINEGRAPH. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"sparkline",children:"SPARKLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a sparkline graph (no cursor, scale or legend) of a telemetry item"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to SPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item-1",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime-1",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history-1",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed-1",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved-1",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed-1",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size-1",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"labelsparkline",children:"LABELSPARKLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a LABEL with the item name followed by a SPARKLINE"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to LABELSPARKLINE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"item-2",children:"ITEM"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Add a telemetry item to the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced"}),(0,r.jsxs)(s.td,{children:["Whether to display reduced data. Default is DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"DECOM, REDUCED_MINUTE, REDUCED_HOUR, REDUCED_DAY"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Reduced Type"}),(0,r.jsxs)(s.td,{children:["The type of reduce data to display. Only applies if Reduced is not DECOM.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"MIN, MAX, AVG, STDDEV"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"starttime-2",children:"STARTTIME"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Start the graph history at the designated Time"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Time"}),(0,r.jsxs)(s.td,{children:["Start time as formatted 'YYYY/MM/DD HH:MM",":SS","'"]}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"history-2",children:"HISTORY"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Display an initial history of data"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"Value(d,h,m,s). For example 1d, 2h, 30m, 15s"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"secondsgraphed-2",children:"SECONDSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display the specified number of seconds in the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to display"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointssaved-2",children:"POINTSSAVED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Save the number of seconds in graph memory"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of seconds to save"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"pointsgraphed-2",children:"POINTSGRAPHED"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Number of points to display on the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Time"}),(0,r.jsx)(s.td,{children:"Number of points to graph"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.h4,{id:"size-2",children:"SIZE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Size of the graph"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width in pixels"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"imageviewer",children:"IMAGEVIEWER"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Display a base64 image from a TLM packet"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Format"}),(0,r.jsx)(s.td,{children:"The image format of the base64 data (e.g. jpg, png, etc)"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the widget"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the widget"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"IMAGEVIEWER INST IMAGE IMAGE jpg\n"})}),"\n",(0,r.jsx)(s.h3,{id:"progressbar",children:"PROGRESSBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a progress bar that is useful for displaying percentages"})}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"PROGRESSBAR INST ADCS POSPROGRESS 0.5 200\nPROGRESSBAR INST ADCS POSPROGRESS\n"})}),"\n",(0,r.jsx)(s.h3,{id:"rangebar",children:"RANGEBAR"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a custom range bar displaying the item value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Low Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"High Value"}),(0,r.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,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the range bar (default = 100)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the range bar (default = 25)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"textbox",children:"TEXTBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Provides a large box for multiline text"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the textbox in px (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the textbox in px (default = 200)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70\nTEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED\n"})}),"\n",(0,r.jsx)(s.h3,{id:"value",children:"VALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a box with a telemetry item value"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Number of characters"}),(0,r.jsx)(s.td,{children:"The number of characters wide to make the value box (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18\nVALUE INST HEALTH_STATUS TEMP1\n"})}),"\n",(0,r.jsx)(s.h2,{id:"interactive-widgets",children:"Interactive Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.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,r.jsx)(s.h3,{id:"button",children:"BUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a rectangular clickable button"})}),"\n",(0,r.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,r.jsx)(s.code,{children:'screen.getNamedWidget("WIDGET_NAME").text()'})," method.\nSee the example in CHECKBUTTON."]}),"\n",(0,r.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,r.jsx)(s.code,{children:"+"})," newlines are inserted automatically\nduring string concatenation. If you use `---\nsidebar_position: 9\ntitle: Screens"]}),"\n",(0,r.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,r.jsx)("div",{style:{clear:"both"}}),"\n",(0,r.jsx)(s.h2,{id:"definitions-1",children:"Definitions"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Name"}),(0,r.jsx)(s.th,{children:"Definition"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Widget"}),(0,r.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,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen"}),(0,r.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,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen Definition File"}),(0,r.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,r.jsx)(s.h2,{id:"telemetry-screen-definition-files-1",children:"Telemetry Screen Definition Files"}),"\n",(0,r.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,r.jsx)(s.h2,{id:"new-widgets-1",children:"New Widgets"}),"\n",(0,r.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,r.jsx)(s.a,{href:"/tools/staticdocs/docs/guides/custom-widgets",children:"Custom Widgets"})," guide."]}),"\n",(0,r.jsx)(s.h1,{id:"screen-keywords-1",children:"Screen Keywords"}),"\n",(0,r.jsxs)(s.p,{children:["you'll need to separate lines with a\nsingle semicolon ",(0,r.jsx)(s.code,{children:";"}),". COSMOS uses double semicolon ",(0,r.jsx)(s.code,{children:";;"})," to indicate lines should\nbe evaluated separately. Note that all OpenC3 commands (using api.cmd) must be\nseparated by ",(0,r.jsx)(s.code,{children:";;"}),"."]}),"\n",(0,r.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,r.jsx)(s.p,{children:(0,r.jsx)(s.code,{children:"api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE NORMAL, DURATION '+dur))\""})}),"\n",(0,r.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,r.jsxs)(s.p,{children:["Scripts can be launched from a BUTTON using the ",(0,r.jsx)(s.code,{children:"runScript()"})," method. ",(0,r.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,r.jsx)(s.code,{children:"runScript('INST/procedures/script.rb', false, {'VAR': 'VALUE'})"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Button Text"}),(0,r.jsx)(s.td,{children:"Text displayed on the button"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Button Code"}),(0,r.jsx)(s.td,{children:"Javascript code to execute when the button is pressed"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"checkbutton",children:"CHECKBUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a check box"})}),"\n",(0,r.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Checkbox Text"}),(0,r.jsx)(s.td,{children:"Text displayed next to the checkbox"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"combobox",children:"COMBOBOX"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a drop down list of text items"})}),"\n",(0,r.jsx)(s.p,{children:"Note this is of limited use by itself and is primarily used in conjunction with NAMED_WIDGET."}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Option Text 1"}),(0,r.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Option Text n"}),(0,r.jsx)(s.td,{children:"Text to display in the selection drop down"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"radiogroup",children:"RADIOGROUP"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Creates a group of RADIOBUTTONs"})}),"\n",(0,r.jsx)(s.p,{children:"RADIOBUTTONs must be part of a group to enable selection logic"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Initial selected button"}),(0,r.jsx)(s.td,{children:"Selects a radio button at initialization (0-based)"}),(0,r.jsx)(s.td,{children:"False"})]})})]}),"\n",(0,r.jsx)(s.h3,{id:"radiobutton",children:"RADIOBUTTON"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a radio button and text"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsx)(s.tbody,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to display next to the radio button"}),(0,r.jsx)(s.td,{children:"True"})]})})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"textfield",children:"TEXTFIELD"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays a rectangular box where the user can enter text"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Characters"}),(0,r.jsx)(s.td,{children:"Width of the text field in characters (default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Default text to put in the text field (default is blank)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h2,{id:"canvas-widgets",children:"Canvas Widgets"}),"\n",(0,r.jsx)(s.hr,{}),"\n",(0,r.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,r.jsx)(s.h3,{id:"canvas",children:"CANVAS"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Layout widget for the other canvas widgets"})}),"\n",(0,r.jsx)(s.p,{children:"All canvas widgets must be enclosed within a CANVAS widget."}),"\n",(0,r.jsx)(s.admonition,{type:"warning",children:(0,r.jsx)(s.p,{children:"The canvas coordinate frame places (0,0) in the upper-left corner of the canvas."})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Height"}),(0,r.jsx)(s.td,{children:"Height of the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvaslabel",children:"CANVASLABEL"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws text onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Text"}),(0,r.jsx)(s.td,{children:"Text to draw onto the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Font Size"}),(0,r.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the text"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"canvaslabelvalue",children:"CANVASLABELVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws the text value of a telemetry item onto the canvas in an optional frame"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the text on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Font Size"}),(0,r.jsx)(s.td,{children:"Font size of the text (Default = 12)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the text"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED.",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"canvasimage",children:"CANVASIMAGE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an image on the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image filename"}),(0,r.jsx)(s.td,{children:"Name of a image file. The file must be in the plugin's targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to CANVASIMAGE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"screen-1",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"Name of the target"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen name"}),(0,r.jsx)(s.td,{children:"Name of the screen"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasimagevalue",children:"CANVASIMAGEVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Displays an image on the canvas that changes with a telemetry value"})}),"\n",(0,r.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,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Default image filename"}),(0,r.jsx)(s.td,{children:"The default image to display. The file must be in the targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image width"}),(0,r.jsx)(s.td,{children:"Width of the image (default is 100%)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image height"}),(0,r.jsx)(s.td,{children:"Height of the image (default is 100%)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to CANVASIMAGEVALUE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"image",children:"IMAGE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Map an image to a state or value"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Image filename"}),(0,r.jsx)(s.td,{children:"Image to display. The file must be in the targets/TARGET/public directory."}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the upper-left corner of the image on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h4,{id:"screen-2",children:"SCREEN"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Open another screen when clicked"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"Name of the target"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Screen name"}),(0,r.jsx)(s.td,{children:"Name of the screen"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasline",children:"CANVASLINE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a line onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start X Position"}),(0,r.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End X Position"}),(0,r.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the line"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the line in pixels (default = 1)"}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.h3,{id:"canvaslinevalue",children:"CANVASLINEVALUE"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a color changing line onto the canvas"})}),"\n",(0,r.jsx)(s.p,{children:"The line is represented by one of two colors based on the value of the associated telemetry item"}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Target name"}),(0,r.jsx)(s.td,{children:"The target name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Packet name"}),(0,r.jsx)(s.td,{children:"The packet name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Item name"}),(0,r.jsx)(s.td,{children:"The item name"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start X Position"}),(0,r.jsx)(s.td,{children:"X position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Start Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the start of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End X Position"}),(0,r.jsx)(s.td,{children:"X position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"End Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the end of the line on the canvas"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Width"}),(0,r.jsx)(s.td,{children:"Width of the line in pixels (default = 3)"}),(0,r.jsx)(s.td,{children:"False"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value type"}),(0,r.jsxs)(s.td,{children:["The type of the value to display. Default is CONVERTED",(0,r.jsx)("br",{}),(0,r.jsx)("br",{}),"Valid Values: ",(0,r.jsx)("span",{class:"values",children:"RAW, CONVERTED, FORMATTED, WITH_UNITS"})]}),(0,r.jsx)(s.td,{children:"False"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,r.jsx)(s.p,{children:"The following settings apply to CANVASLINEVALUE. They are applied using the SETTING keyword."}),"\n",(0,r.jsx)(s.h4,{id:"value_eq",children:"VALUE_EQ"}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)("div",{class:"right",children:"(Since 5.5.1)"}),(0,r.jsx)(s.strong,{children:"Map a value to a color"})]}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Value"}),(0,r.jsx)(s.td,{children:"State or value"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the line"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.h3,{id:"canvasdot",children:"CANVASDOT"}),"\n",(0,r.jsx)(s.p,{children:(0,r.jsx)(s.strong,{children:"Draws a dot onto the canvas"})}),"\n",(0,r.jsxs)(s.table,{children:[(0,r.jsx)(s.thead,{children:(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.th,{children:"Parameter"}),(0,r.jsx)(s.th,{children:"Description"}),(0,r.jsx)(s.th,{children:"Required"})]})}),(0,r.jsxs)(s.tbody,{children:[(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"X Position"}),(0,r.jsx)(s.td,{children:"X position of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Y Position"}),(0,r.jsx)(s.td,{children:"Y position of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Color"}),(0,r.jsx)(s.td,{children:"Color of the dot"}),(0,r.jsx)(s.td,{children:"True"})]}),(0,r.jsxs)(s.tr,{children:[(0,r.jsx)(s.td,{children:"Radius"}),(0,r.jsx)(s.td,{children:"Radius of the dot in pixels"}),(0,r.jsx)(s.td,{children:"True"})]})]})]}),"\n",(0,r.jsx)(s.p,{children:"Example Usage:"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.jsx)(s.code,{className:"language-ruby",children:"CANVAS 50 50\n  CANVASDOT 10 15 BLUE 5\nEND\n"})}),"\n",(0,r.jsx)(s.h2,{id:"example-file",children:"Example File"}),"\n",(0,r.jsx)(s.p,{children:"Example File: TARGET/myscreen.txt"}),"\n",(0,r.jsx)(s.pre,{children:(0,r.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,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},1184:(e,s,d)=>{d.d(s,{R:()=>i});var r=d(4041);const n={},t=r.createContext(n);function i(e){const s=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}}}]);

data/tools/staticdocs/assets/js/b6d70f94.66d95cb7.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9005],{1292:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>a,metadata:()=>o,toc:()=>l});var r=n(1085),s=n(1184);const a={sidebar_position:7,title:"Protocols"},i=void 0,o={id:"configuration/protocols",title:"Protocols",description:"Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.",source:"@site/docs/configuration/protocols.md",sourceDirName:"configuration",slug:"/configuration/protocols",permalink:"/tools/staticdocs/docs/configuration/protocols",draft:!1,unlisted:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/protocols.md",tags:[],version:"current",sidebarPosition:7,frontMatter:{sidebar_position:7,title:"Protocols"},sidebar:"defaultSidebar",previous:{title:"Interfaces",permalink:"/tools/staticdocs/docs/configuration/interfaces"},next:{title:"Tables",permalink:"/tools/staticdocs/docs/configuration/table"}},d={},l=[{value:"Packet Delineation Protocols",id:"packet-delineation-protocols",level:2},{value:"Burst Protocol",id:"burst-protocol",level:3},{value:"Fixed Protocol",id:"fixed-protocol",level:3},{value:"Length Protocol",id:"length-protocol",level:3},{value:"Terminated Protocol",id:"terminated-protocol",level:3},{value:"Template Protocol",id:"template-protocol",level:3},{value:"Preidentified Protocol",id:"preidentified-protocol",level:3},{value:"Helper Protocols",id:"helper-protocols",level:2},{value:"CRC Protocol",id:"crc-protocol",level:3},{value:"Ignore Packet Protocol",id:"ignore-packet-protocol",level:3},{value:"Custom Protocols",id:"custom-protocols",level:2},{value:"Method discussions",id:"method-discussions",level:2},{value:"initialize",id:"initialize",level:3},{value:"reset",id:"reset",level:3},{value:"connect_reset",id:"connect_reset",level:3},{value:"disconnect_reset",id:"disconnect_reset",level:3},{value:"read_data",id:"read_data",level:3},{value:"read_packet",id:"read_packet",level:3},{value:"write_packet",id:"write_packet",level:3},{value:"write_data",id:"write_data",level:3},{value:"post_write_interface",id:"post_write_interface",level:3},{value:"Examples",id:"examples",level:2}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol."}),"\n",(0,r.jsx)(t.admonition,{title:"Protocol Run Order",type:"info",children:(0,r.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)."})}),"\n",(0,r.jsx)(t.p,{children:"Protocols are typically used to define the logic to delineate packets and manipulate data as it written to and read from Interfaces. COSMOS includes Interfaces for TCP/IP Client, TCP/IP Server, Udp Client / Server, and Serial connections. For 99% of use cases these Interfaces should not require any changes as they universally handle the low-level details of reading and writing from these types of connections. All unique behavior should now be defined in Protocols."}),"\n",(0,r.jsx)(t.p,{children:"At a minimum, any byte stream based Interface will require a Protocol to delineate packets. TCP/IP and Serial are examples of byte stream based Interfaces. A byte stream is just a simple stream of bytes and thus you need some way to know where packets begin and end within the stream."}),"\n",(0,r.jsx)(t.p,{children:"TCP/IP is a friendly byte stream. Unless you are dealing with a very poorly written system, the first byte received on a TCP/IP connection will always be the start of a packet. Also, TCP/IP is a reliable connection in that it ensures that all data is received in the correct order, that no data is lost, and that the data is not corrupted (TCP/IP is protected by a CRC32 which is pretty good for avoiding unrecognized data corruption)."}),"\n",(0,r.jsx)(t.p,{children:"Serial is a much less friendly byte stream. With serial connections, it is very likely that when you open a serial port and start receiving data you will receive the middle of a message. (This problem is only avoided when interfacing with a system that only writes to the serial port in response to a command). For this reason, sync patterns are highly beneficial for serial interfaces. Additionally, serial interfaces may use some method to protect against unrecognized data corruption (Checksums, CRCs, etc.)"}),"\n",(0,r.jsx)(t.p,{children:"UDP is an inherently packet based connection. If you read from a UDP socket, you will always receive back an entire packet. The best UDP based Protocols take advantage of this fact. Some implementations try to make UDP act like a byte stream, but this is a misuse of the protocol because it is highly likely that you will lose data and have no way to recover."}),"\n",(0,r.jsx)(t.h2,{id:"packet-delineation-protocols",children:"Packet Delineation Protocols"}),"\n",(0,r.jsx)(t.p,{children:"COSMOS provides the following packet delineation protocols: Burst, Fixed, Length, Template, Terminated and Preidentified. Each of these protocols has the primary purpose of separating out packets from a byte stream."}),"\n",(0,r.jsxs)(t.p,{children:['Note that all protocols take a final parameter called "Allow Empty Data". This indicates whether the protocol will allow an empty string to be passed down to later Protocols (instead of returning ',":STOP","). Can be true, false, or nil, where nil is interpreted as true unless the Protocol is the last Protocol of the chain. End users of a protocol will almost always simply leave off this parameter. For more information read the ",(0,r.jsx)(t.a,{href:"/tools/staticdocs/docs/configuration/protocols#custom-protocols",children:"Custom Protocols"})," documentation."]}),"\n",(0,r.jsx)(t.h3,{id:"burst-protocol",children:"Burst Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Burst Protocol simply reads as much data as it can from the interface before returning the data as a COSMOS Packet (It returns a packet for each burst of data read). This Protocol relies on regular bursts of data delimited by time and thus is not very robust. However, it can utilize a sync pattern which does allow it to re-sync if necessary. It can also discard bytes from the incoming data to remove the sync pattern. Finally, it can add sync patterns to data being written out of the Interface."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Discard Leading Bytes"}),(0,r.jsx)(t.td,{children:"The number of bytes to discard from the binary data after reading. Note that this applies to bytes starting with the sync pattern if the sync pattern is being used."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 (do not discard bytes)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Fill Fields"}),(0,r.jsx)(t.td,{children:"Whether to fill in the sync pattern on outgoing packets"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"fixed-protocol",children:"Fixed Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Fixed Protocol reads a preset minimum amount of data which is necessary to properly identify all the defined packets using the interface. It then identifies the packet and proceeds to read as much data from the interface as necessary to create the packet which it then returns. This protocol relies on all the packets on the interface being fixed in length. For example, all the packets using the interface are a fixed size and contain a simple header with a 32-bit sync pattern followed by a 16 bit ID. The Fixed Protocol would elegantly handle this case with a minimum read size of 6 bytes. The Fixed Protocol also supports a sync pattern, discarding leading bytes, and filling the sync pattern similar to the Burst Protocol."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Minimum ID Size"}),(0,r.jsx)(t.td,{children:"The minimum number of bytes needed to identify a packet. All the packet definitions must declare their ID_ITEM(s) within this given number of bytes."}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Discard Leading Bytes"}),(0,r.jsx)(t.td,{children:"The number of bytes to discard from the binary data after reading. Note that this applies to bytes starting with the sync pattern if the sync pattern is being used."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 (do not discard bytes)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Telemetry"}),(0,r.jsx)(t.td,{children:"Whether the data is telemetry"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"true (false means command)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Fill Fields"}),(0,r.jsx)(t.td,{children:"Whether to fill in the sync pattern on outgoing packets"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Unknown Raise"}),(0,r.jsx)(t.td,{children:"Whether to raise an exception for an unknown packet"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"length-protocol",children:"Length Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Length Protocol depends on a length field at a fixed location in the defined packets using the interface. It then reads enough data to grab the length field, decodes it, and reads the remaining length of the packet. For example, all the packets using the interface contain a CCSDS header with a length field. The Length Protocol can be set up to handle the length field and even the length offset CCSDS uses. The Length Protocol also supports a sync pattern, discarding leading bytes, and filling the length and sync pattern similar to the Burst Protocol."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Bit Offset"}),(0,r.jsx)(t.td,{children:"The bit offset from the start of the packet to the length field. Every packet using this interface must have the same structure such that the length field is the same size at the same location. Be sure to account for the length of the Sync Pattern in this value (if present)."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 bits"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Bit Size"}),(0,r.jsx)(t.td,{children:"The size in bits of the length field"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"16 bits"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Value Offset"}),(0,r.jsx)(t.td,{children:"The offset to apply to the length field value. The actual value of the length field plus this offset should equal the exact number of bytes required to read all data for the packet (including the length field itself, sync pattern, etc). For example, if the length field indicates packet length minus one, this value should be one. Be sure to account for the length of the Sync Pattern in this value (if present)."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bytes per Count"}),(0,r.jsx)(t.td,{children:"The number of bytes per each length field 'count'. This is used if the units of the length field is something other than bytes, e.g. if the length field count is in words."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"1 byte"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Length Endianness"}),(0,r.jsx)(t.td,{children:"The endianness of the length field. Must be either 'BIG_ENDIAN' or 'LITTLE_ENDIAN'."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"'BIG_ENDIAN'"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Discard Leading Bytes"}),(0,r.jsx)(t.td,{children:"The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used. Discarding is one of the very last steps so any size and offsets above need to account for all the data before discarding."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 (do not discard bytes)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Max Length"}),(0,r.jsx)(t.td,{children:"The maximum allowed value in the length field"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no maximum length)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Fill Length and Sync Pattern"}),(0,r.jsx)(t.td,{children:"Setting this flag to true causes the length field and sync pattern (if present) to be filled automatically on outgoing packets."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.p,{children:"The most confusing aspect of the Length Protocol is calculating the Length Value Offset. This is especially true in the commonly used CCSDS Space Packet Protocol. The best way to illustrate this is with an example. Suppose you have CCSDS Space Packets prepended with a Sync Pattern of 0x1ACFFC1D. This would look like the following:"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Sync (4 bytes)"}),(0,r.jsx)(t.th,{children:"Header (4 bytes)"}),(0,r.jsx)(t.th,{children:"Length (2 bytes)"}),(0,r.jsx)(t.th,{children:"Data (4 bytes)"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"0x1ACFFC1D"}),(0,r.jsx)(t.td,{children:"0x0001CADB"}),(0,r.jsx)(t.td,{children:"0x0003"}),(0,r.jsx)(t.td,{children:"0xDEADBEEF"})]})})]}),"\n",(0,r.jsxs)(t.p,{children:["In this case the total length of the packet is 14 bytes: ",(0,r.jsx)(t.strong,{children:"4 + 4 + 2 + 4 = 14"}),". With 4 bytes of data, the length field is 3 because in CCSDS the length field is calculated as (data length - 1). So how would we calculate the Length Value Offset? COSMOS reads all the bytes in the packet (including the Sync Pattern) so the total length is 14 bytes. The length field is 3 so the Length Value Offset (offset to apply to the length field value) should be 11 (",(0,r.jsx)(t.strong,{children:"3 + 11 = 14"}),")."]}),"\n",(0,r.jsx)(t.h3,{id:"terminated-protocol",children:"Terminated Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Terminated Protocol delineates packets using termination characters found at the end of every packet. It continuously reads data until the termination characters are found at which point it returns the packet data. For example, all the packets using the interface are followed by 0xABCD. This data can either be a part of each packet that is kept or something which is known only by the Terminated Protocol and simply thrown away."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Write Termination Characters"}),(0,r.jsx)(t.td,{children:"The data to write after writing a command packet. Given as a hex string such as 0xABCD."}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Read Termination Characters"}),(0,r.jsx)(t.td,{children:"The characters which delineate the end of a telemetry packet. Given as a hex string such as 0xABCD."}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Strip Read Termination"}),(0,r.jsx)(t.td,{children:"Whether to remove the read termination characters before returning the telemetry packet"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"true"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Discard Leading Bytes"}),(0,r.jsx)(t.td,{children:"The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 (do not discard bytes)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Fill Fields"}),(0,r.jsx)(t.td,{children:"Whether to fill in the sync pattern on outgoing packets"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"template-protocol",children:"Template Protocol"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.strong,{children:"Deprecated"})}),"\n",(0,r.jsx)(t.p,{children:"This protocol is now deprecated because it is not able to capture the original SCPI messages in COSMOS raw logging. Please use the TemplateAccessor with the CmdResponseProtocol instead."}),"\n",(0,r.jsxs)(t.p,{children:["The Template Protocol works much like the Terminated Protocol except it is designed for text-based command and response type interfaces such as SCPI (Standard Commands for Programmable Instruments). It delineates packets in the same way as the Terminated Protocol except each packet is referred to as a line (because each usually contains a line of text). For outgoing packets, a CMD_TEMPLATE field is expected to exist in the packet. This field contains a template string with items to be filled in delineated within HTML tag style brackets ",(0,r.jsx)(t.code,{children:'"<EXAMPLE>"'}),". The Template Protocol will read the named items from within the packet and fill in the CMD_TEMPLATE. This filled in string is then sent out rather than the originally passed in packet. Correspondingly, if a response is expected the outgoing packet should include a RSP_TEMPLATE and RSP_PACKET field. The RSP_TEMPLATE is used to extract data from the response string and build a corresponding RSP_PACKET. See the TEMPLATE target within the COSMOS Demo configuration for an example of usage."]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Write Termination Characters"}),(0,r.jsx)(t.td,{children:"The data to write after writing a command packet. Given as a hex string such as 0xABCD."}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Read Termination Characters"}),(0,r.jsx)(t.td,{children:"The characters which delineate the end of a telemetry packet. Given as a hex string such as 0xABCD."}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Ignore Lines"}),(0,r.jsx)(t.td,{children:"Number of response lines to ignore (completely drop)"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 lines"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Initial Read Delay"}),(0,r.jsx)(t.td,{children:"An initial delay after connecting after which the interface will be read till empty and data dropped. Useful for discarding connect headers and initial prompts."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no initial read)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Response Lines"}),(0,r.jsx)(t.td,{children:"The number of lines that make up expected responses"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"1 line"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Strip Read Termination"}),(0,r.jsx)(t.td,{children:"Whether to remove the read termination characters before returning the telemetry packet"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"true"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Discard Leading Bytes"}),(0,r.jsx)(t.td,{children:"The number of bytes to discard from the binary data after reading. Note that this applies to bytes including the sync pattern if the sync pattern is being used."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0 (do not discard bytes)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found including the sync pattern will be returned."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Fill Fields"}),(0,r.jsx)(t.td,{children:"Whether to fill in the sync pattern on outgoing packets"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Response Timeout"}),(0,r.jsx)(t.td,{children:"Number of seconds to wait for a response before timing out"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"5.0"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Response Polling Period"}),(0,r.jsx)(t.td,{children:"Number of seconds to wait between polling for a response"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"0.02"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Raise Exceptions"}),(0,r.jsx)(t.td,{children:"Whether to raise exceptions when errors occur like timeouts or unexpected responses"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"preidentified-protocol",children:"Preidentified Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Preidentified Protocol delineates packets using a custom COSMOS header. This Protocol is created to allow tools to connect and receive the entire packet stream. It can also be used to chain COSMOS instances together although that should rarely be needed with the new web native implementation."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Sync Pattern"}),(0,r.jsx)(t.td,{children:"Hex string representing a byte pattern that will be searched for in the raw data. This pattern represents a packet delimiter and all data found AFTER the sync pattern will be returned. The sync pattern itself is discarded."}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no sync pattern)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Max Length"}),(0,r.jsx)(t.td,{children:"The maximum allowed value in the length field"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (no maximum length)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Mode"}),(0,r.jsx)(t.td,{children:"The Version of the preidentified protocol to support (2 or 4).3"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"4"})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"helper-protocols",children:"Helper Protocols"}),"\n",(0,r.jsx)(t.p,{children:"COSMOS provides the following helper protocols: Crc & Ignore. These protocols provide helper functionality to Interfaces."}),"\n",(0,r.jsx)(t.h3,{id:"crc-protocol",children:"CRC Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The CRC protocol can add CRCs to outgoing commands and verify CRCs on incoming telemetry packets."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Write Item Name"}),(0,r.jsx)(t.td,{children:"Item to fill with calculated CRC value for outgoing packets (nil = don't fill)"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Strip CRC"}),(0,r.jsx)(t.td,{children:"Whether to remove the CRC from incoming packets"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"false"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bad Strategy"}),(0,r.jsx)(t.td,{children:"How to handle CRC errors on incoming packets. ERROR = Just log the error, DISCONNECT = Disconnect interface"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:'"ERROR"'})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Offset"}),(0,r.jsx)(t.td,{children:"Bit offset of the CRC in the data. Can be negative to indicate distance from end of packet"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"-32"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Bit Size"}),(0,r.jsx)(t.td,{children:"Bit size of the CRC - Must be 16, 32, or 64"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"32"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Endianness"}),(0,r.jsx)(t.td,{children:"Endianness of the CRC (BIG_ENDIAN/LITTLE_ENDIAN)"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:'"BIG_ENDIAN"'})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Poly"}),(0,r.jsx)(t.td,{children:"Polynomial to use when calculating the CRC expressed as an integer"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (use default polynomial - 16-bit=0x1021, 32-bit=0x04C11DB7, 64-bit=0x42F0E1EBA9EA3693)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Seed"}),(0,r.jsx)(t.td,{children:"Seed value to start the calculation"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (use default seed - 16-bit=0xFFFF, 32-bit=0xFFFFFFFF, 64-bit=0xFFFFFFFFFFFFFFFF)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Xor"}),(0,r.jsx)(t.td,{children:"Whether to XOR the CRC result with 0xFFFF"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (use default value - 16-bit=false, 32-bit=true, 64-bit=true)"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Reflect"}),(0,r.jsx)(t.td,{children:"Whether to bit reverse each byte of data before calculating the CRC"}),(0,r.jsx)(t.td,{children:"No"}),(0,r.jsx)(t.td,{children:"nil (use default value - 16-bit=false, 32-bit=true, 64-bit=true)"})]})]})]}),"\n",(0,r.jsx)(t.h3,{id:"ignore-packet-protocol",children:"Ignore Packet Protocol"}),"\n",(0,r.jsx)(t.p,{children:"The Ignore Packet protocol drops specified command packets sent by COSMOS or drops incoming telemetry packets."}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Parameter"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Target Name"}),(0,r.jsx)(t.td,{children:"Target name of the packet to ignore"}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{children:"nil"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"Packet Name"}),(0,r.jsx)(t.td,{children:"Packet name of the packet to ignore"}),(0,r.jsx)(t.td,{children:"Yes"}),(0,r.jsx)(t.td,{children:"nil"})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"custom-protocols",children:"Custom Protocols"}),"\n",(0,r.jsx)(t.p,{children:"Creating a custom protocol is easy and should be the default solution for customizing COSMOS Interfaces (rather than creating a new Interface class). However, creating custom Interfaces is still useful for defaulting parameters to values that always are fixed for your target and for including the necessary Protocols. The base COSMOS Interfaces take a lot of parameters that can be confusing to your end users. Thus you may want to create a custom Interface just to hard coded these values and cut the available parameters down to something like the hostname and port to connect to."}),"\n",(0,r.jsxs)(t.p,{children:["All custom Protocols should derive from the Protocol class found in the COSMOS gem at ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/protocol.rb",children:"lib/openc3/interfaces/protocols/protocol.rb"}),". This class defines the 9 methods that are relevant to writing your own protocol. The base class implementation for each method is included below as well as a discussion as to how the methods should be overridden and used in your own Protocols."]}),"\n",(0,r.jsx)(t.admonition,{title:"Protocol APIs",type:"info",children:(0,r.jsxs)(t.p,{children:["Protocols should not ",(0,r.jsx)(t.code,{children:"require 'openc3/script'"})," since they are part of a COSMOS interface. They should use the COSMOS library code directly like ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/system/system.rb",children:"System"}),", ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/packets/packet.rb",children:"Packet"}),", ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/utilities/bucket.rb",children:"Bucket"}),", ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/accessors/binary_accessor.rb",children:"BinaryAccessor"}),", etc. When in doubt, consult the existing COSMOS ",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/tree/main/openc3/lib/openc3/interfaces/protocols",children:"protocol"})," classes."]})}),"\n",(0,r.jsx)(t.p,{children:"To really understand how Protocols work, you first must understand the logic within the base Interface class read and write methods."}),"\n",(0,r.jsx)(t.p,{children:"Let's first discuss the read method."}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Interface Read Logic",src:n(2748).A+"",width:"1063",height:"542"})}),"\n",(0,r.jsxs)(t.p,{children:["On EVERY call to read, an empty Ruby string \"\" is first passed down to each of the read Protocol's read_data() method BEFORE new raw data is attempted to be read using the Interface's read_interface() method. This is a signal to Protocols that have cached up more than one packet worth of data to output those cached packets before any new data is read from the Interface. Typically no data will be cached up and one of the Protocols read_data() methods will return ",":STOP"," in response to the empty string, indicating that more data is required to generate a packet. Each Protocol's read_data() method can return one of three things: data that will be passed down to any additional Protocols or turned into a Packet, ",":STOP"," which means more data is required from the Interface for the Protocol to continue, or ",":DISCONNECT"," which means that something has happened that requires disconnecting the Interface (and by default trying to reconnect). Each Protocol's read_data method is passed the data that will eventually be turned into a packet and returns a possibly modified set of data. If the data passes through all Protocol's read_data() methods it is then converted into a COSMOS packet using the Interface's convert_data_to_packet() method. This packet is then run in a similar fashion through each Read Protocol's read_packet() method. This method has essentially the same return possibilities: a Packet (instead of data as in read_data()), ",":STOP",", or ",":DISCONNECT",". If the Packet makes it through all read_packet() methods then the Interface packet read counter is incremented and the Packet is returned to the Interface."]}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"Interface Write Logic",src:n(8129).A+"",width:"931",height:"944"})}),"\n",(0,r.jsx)(t.p,{children:"The Interface write() method works very similarly to read. (It should be mentioned that by default write protocols run in the reverse order of read protocols. This makes sense because when reading you're typically stripping layers of data and when writing you're typically adding on layers in reverse order.)"}),"\n",(0,r.jsxs)(t.p,{children:["First, the packet write counter is incremented. Then each write Protocol is given a chance to modify the packet by its write_packet() method being called. This method can either return a potentially modified packet, ",":STOP",", or ",":DISCONNECT",". If a write Protocol returns ",":STOP"," no data will be written out the Interface and it is assumed that more packets are necessary before a final packet can be output. ",":DISCONNECT"," will disconnect the Interface. If the packet makes it through all the write Protocol's write_packet() methods, then it is converted to binary data using the Interface's convert_packet_to_data() method. Next the write_data() method is called for each write Protocol giving it a chance to modify the lower level data. The same return options are available except a Ruby string of data is returned instead of a COSMOS packet. If the data makes it through all write_data() methods, then it is written out on the Interface using the write_interface() method. Afterwards, each Protocol's post_write_interface() method is called with both the final modified Packet, and the actual data written out to the Interface. This method allows follow-up such as waiting for a response after writing out a message."]}),"\n",(0,r.jsx)(t.h2,{id:"method-discussions",children:"Method discussions"}),"\n",(0,r.jsx)(t.h3,{id:"initialize",children:"initialize"}),"\n",(0,r.jsx)(t.p,{children:"This is the constructor for your custom Protocol. It should always call super(allow_empty_data) to initialize the base Protocol class."}),"\n",(0,r.jsx)(t.p,{children:"Base class implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"# @param allow_empty_data [true/false] Whether STOP should be returned on empty data\ndef initialize(allow_empty_data = false)\n  @interface = nil\n  @allow_empty_data = ConfigParser.handle_true_false(allow_empty_data)\n  reset()\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"As you can see, every Protocol maintains state on at least two items. @interface holds the Interface class instance that the protocol is associated with. This is sometimes necessary to introspect details that only the Interface knows. @allow_empty_data is a flag used by the read_data(data) method that is discussed later in this document."}),"\n",(0,r.jsx)(t.h3,{id:"reset",children:"reset"}),"\n",(0,r.jsx)(t.p,{children:"The reset method is used to reset internal protocol state when the Interface is connected and/or disconnected. This method should be used for common resetting logic. Connect and Disconnect specific logic are handled in the next two methods."}),"\n",(0,r.jsx)(t.p,{children:"Base class implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def reset\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"As you can see, the base class reset implementation doesn't do anything."}),"\n",(0,r.jsx)(t.h3,{id:"connect_reset",children:"connect_reset"}),"\n",(0,r.jsx)(t.p,{children:"The connect_reset method is used to reset internal Protocol state each time the Interface is connected."}),"\n",(0,r.jsx)(t.p,{children:"Base class implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def connect_reset\n  reset()\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class connect_reset implementation just calls the reset method to ensure common reset logic is run."}),"\n",(0,r.jsx)(t.h3,{id:"disconnect_reset",children:"disconnect_reset"}),"\n",(0,r.jsx)(t.p,{children:"The disconnect_reset method is used to reset internal Protocol state each time the Interface is disconnected."}),"\n",(0,r.jsx)(t.p,{children:"Base class implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def disconnect_reset\n  reset()\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class disconnect_reset implementation just calls the reset method to ensure common reset logic is run."}),"\n",(0,r.jsx)(t.h3,{id:"read_data",children:"read_data"}),"\n",(0,r.jsxs)(t.p,{children:["The read_data method is used to analyze and potentially modify any raw data read by an Interface. It takes one parameter as the current state of the data to be analyzed. It can return either a Ruby string of data, ",":STOP",", or ",":DISCONNECT",". If it returns a Ruby string, then it believes that data may be ready to be a full packet, and is ready for processing by any following Protocols. If ",":STOP"," is returned then the Protocol believes it needs more data to complete a full packet. If ",":DISCONNECT"," is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected)."]}),"\n",(0,r.jsx)(t.p,{children:"Base Class Implemenation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def read_data(data)\n  if (data.length <= 0)\n    if @allow_empty_data.nil?\n      if @interface and @interface.read_protocols[-1] == self # Last read interface in chain with auto @allow_empty_data\n        return :STOP\n      end\n    elsif !@allow_empty_data # Don't @allow_empty_data means STOP\n      return :STOP\n    end\n  end\n  data\nend\n"})}),"\n",(0,r.jsxs)(t.p,{children:["The base class implementation does nothing except return the data it was given. The only exception to this is when handling an empty string. If the allow_empty_data flag is false or if it nil and the Protocol is the last in the chain, then the base implementation will return ",":STOP"," data to indicate that it is time to call the Interface read_interface() method to get more data. Blank strings are used to signal Protocols that they have an opportunity to return a cached packet."]}),"\n",(0,r.jsx)(t.h3,{id:"read_packet",children:"read_packet"}),"\n",(0,r.jsxs)(t.p,{children:["The read_packet method is used to analyze and potentially modify a COSMOS packet before it is returned by the Interface. It takes one parameter as the current state of the packet to be analyzed. It can return either a COSMOS packet, ",":STOP",", or ",":DISCONNECT",". If it returns a COSMOS packet, then it believes that the packet is valid, should be returned, and is ready for processing by any following Protocols. If ",":STOP"," is returned then the Protocol believes the packet should be silently dropped. If ",":DISCONNECT"," is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected). This method is where a Protocol would set the stored flag on a packet if it determines that the packet is stored telemetry instead of real-time telemetry."]}),"\n",(0,r.jsx)(t.p,{children:"Base Class Implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def read_packet(packet)\n  return packet\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class always just returns the packet given."}),"\n",(0,r.jsx)(t.h3,{id:"write_packet",children:"write_packet"}),"\n",(0,r.jsxs)(t.p,{children:["The write_packet method is used to analyze and potentially modify a COSMOS packet before it is output by the Interface. It takes one parameter as the current state of the packet to be analyzed. It can return either a COSMOS packet, ",":STOP",", or ",":DISCONNECT",". If it returns a COSMOS packet, then it believes that the packet is valid, should be written out the Interface, and is ready for processing by any following Protocols. If ",":STOP"," is returned then the Protocol believes the packet should be silently dropped. If ",":DISCONNECT"," is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected)."]}),"\n",(0,r.jsx)(t.p,{children:"Base Class Implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def write_packet(packet)\n  return packet\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class always just returns the packet given."}),"\n",(0,r.jsx)(t.h3,{id:"write_data",children:"write_data"}),"\n",(0,r.jsxs)(t.p,{children:["The write_data method is used to analyze and potentially modify data before it is written out by the Interface. It takes one parameter as the current state of the data to be analyzed and sent. It can return either a Ruby String of data, ",":STOP",", or ",":DISCONNECT",". If it returns a Ruby string of data, then it believes that the data is valid, should be written out the Interface, and is ready for processing by any following Protocols. If ",":STOP"," is returned then the Protocol believes the data should be silently dropped. If ",":DISCONNECT"," is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected)."]}),"\n",(0,r.jsx)(t.p,{children:"Base Class Implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def write_data(data)\n  return data\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class always just returns the data given."}),"\n",(0,r.jsx)(t.h3,{id:"post_write_interface",children:"post_write_interface"}),"\n",(0,r.jsxs)(t.p,{children:["The post_write_interface method is called after data has been written out the Interface. The typical use of this method is to provide a hook to implement command/response type interfaces where a response is always immediately expected in response to a command. It takes two parameters, the packet after all modifications by write_packet() and the data that was actually written out the Interface. It can return either the same pair of packet/data, ",":STOP",", or ",":DISCONNECT",". If it returns a packet/data pair then they are passed on to any other Protocols. If ",":STOP"," is returned then the Interface write() call completes and no further Protocols post_write_interface() methods are called. If ",":DISCONNECT",' is returned then the Protocol believes the Interface should be disconnected (and typically automatically reconnected). Note that only the first parameter "packet", is checked to be ',":STOP",", or ",":DISCONNECT"," on the return."]}),"\n",(0,r.jsx)(t.p,{children:"Base Class Implementation:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-ruby",children:"def post_write_interface(packet, data)\n  return packet, data\nend\n"})}),"\n",(0,r.jsx)(t.p,{children:"The base class always just returns the packet/data given."}),"\n",(0,r.jsx)(t.h2,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(t.p,{children:"Please see the included COSMOS protocol code for examples of the above methods in action."}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/protocol.rb",children:"lib/openc3/interfaces/protocols/protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/burst_protocol.rb",children:"lib/openc3/interfaces/protocols/burst_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/fixed_protocol.rb",children:"lib/openc3/interfaces/protocols/fixed_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/length_protocol.rb",children:"lib/openc3/interfaces/protocols/length_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/terminated_protocol.rb",children:"lib/openc3/interfaces/protocols/terminated_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/template_protocol.rb",children:"lib/openc3/interfaces/protocols/template_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/crc_protocol.rb",children:"lib/openc3/interfaces/protocols/crc_protocol.rb"}),"\n",(0,r.jsx)(t.a,{href:"https://github.com/OpenC3/cosmos/blob/main/openc3/lib/openc3/interfaces/protocols/preidentified_protocol.rb",children:"lib/openc3/interfaces/protocols/preidentified_protocol.rb"})]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},2748:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/interface_read_logic-0deef27c1d2fec9de2a3720a3c9ecedb21a00dca7aabd13da0b8815c037e4c26.png"},8129:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/interface_write_logic-3360afe1b4af20b10dafba848a21e09baccaacc06e2ec8b6c132ac7a3c99e994.png"},1184:(e,t,n)=>{n.d(t,{R:()=>i});var r=n(4041);const s={},a=r.createContext(s);function i(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}}}]);