openc3-cosmos-tool-docs 5.12.0 → 5.13.0

data/tools/docs/assets/js/42170351.46c774f8.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4177],{8473:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(7896),i=(n(2784),n(876));const o={title:"Script Writing Guide"},r=void 0,s={unversionedId:"guides/script-writing",id:"guides/script-writing",title:"Script Writing Guide",description:"Introduction",source:"@site/docs/guides/script-writing.md",sourceDirName:"guides",slug:"/guides/script-writing",permalink:"/tools/docs/docs/guides/script-writing",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/guides/script-writing.md",tags:[],version:"current",frontMatter:{title:"Script Writing Guide"},sidebar:"defaultSidebar",previous:{title:"Raspberry Pi",permalink:"/tools/docs/docs/guides/raspberrypi"},next:{title:"Scripting API Guide",permalink:"/tools/docs/docs/guides/scripting-api"}},l={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Concepts",id:"concepts",level:2},{value:"Ruby vs Python in COSMOS",id:"ruby-vs-python-in-cosmos",level:3},{value:"Scripting Philosophy",id:"scripting-philosophy",level:2},{value:"A Super Basic Script Example",id:"a-super-basic-script-example",level:3},{value:"KISS (Keep It Simple Stupid)",id:"kiss-keep-it-simple-stupid",level:3},{value:"Keep things DRY (Don&#39;t Repeat Yourself)",id:"keep-things-dry-dont-repeat-yourself",level:3},{value:"Use Comments Appropriately",id:"use-comments-appropriately",level:3},{value:"Script Runner",id:"script-runner",level:3},{value:"Looping vs Unrolled Loops",id:"looping-vs-unrolled-loops",level:3},{value:"Script Organization",id:"script-organization",level:2},{value:"Organizing Your Scripts into a Plugin",id:"organizing-your-scripts-into-a-plugin",level:3},{value:"Organize Scripts into Methods",id:"organize-scripts-into-methods",level:3},{value:"Using Classes vs Unscoped Methods",id:"using-classes-vs-unscoped-methods",level:3},{value:"Instrumented vs Uninstrumented Lines (require vs load)",id:"instrumented-vs-uninstrumented-lines-require-vs-load",level:3},{value:"Debugging and Auditing",id:"debugging-and-auditing",level:2},{value:"Built-In Debugging Capabilities",id:"built-in-debugging-capabilities",level:3},{value:"Breakpoints",id:"breakpoints",level:3},{value:"Using Disconnect Mode",id:"using-disconnect-mode",level:3},{value:"Auditing your Scripts",id:"auditing-your-scripts",level:3},{value:"Ruby Syntax Check",id:"ruby-syntax-check",level:4},{value:"Common Scenarios",id:"common-scenarios",level:2},{value:"User Input Best Practices",id:"user-input-best-practices",level:3},{value:"Conditionally Require Manual User Input Steps",id:"conditionally-require-manual-user-input-steps",level:3},{value:"Outputing Extra Information to a Report",id:"outputing-extra-information-to-a-report",level:3},{value:"Getting the Most Recent Value of a Telemetry Point from Multiple Packets",id:"getting-the-most-recent-value-of-a-telemetry-point-from-multiple-packets",level:3},{value:"Checking Every Single Sample of a Telemetry Point",id:"checking-every-single-sample-of-a-telemetry-point",level:3},{value:"Using Variables in Mnemonics",id:"using-variables-in-mnemonics",level:3},{value:"Using Custom wait_check_expression",id:"using-custom-wait_check_expression",level:3},{value:"COSMOS Scripting Differences from Regular Ruby Scripting",id:"cosmos-scripting-differences-from-regular-ruby-scripting",level:3},{value:"Do not use single line if statements",id:"do-not-use-single-line-if-statements",level:4},{value:"When Things Go Wrong",id:"when-things-go-wrong",level:2},{value:"Common Reasons Checks Fail",id:"common-reasons-checks-fail",level:3},{value:"How to Recover from Anomalies",id:"how-to-recover-from-anomalies",level:3},{value:"Advanced Topics",id:"advanced-topics",level:2},{value:"Advanced Script Configuration with CSV or Excel",id:"advanced-script-configuration-with-csv-or-excel",level:3},{value:"When to use Ruby Modules",id:"when-to-use-ruby-modules",level:3}],u={toc:c},p="wrapper";function d(e){let{components:t,...n}=e;return(0,i.kt)(p,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"introduction"},"Introduction"),(0,i.kt)("p",null,"This guide aims to provide the best practices for using the scripting capabilities provided by COSMOS. Scripts are used to automate a series of activities for operations or testing. The goal of this document is to ensure scripts are written that are simple, easy to understand, maintainable, and correct. Guidance on some of the key details of using the COSMOS Script Runner is also provided."),(0,i.kt)("h2",{id:"concepts"},"Concepts"),(0,i.kt)("p",null,"COSMOS supports both Ruby and Python for writing scripts. Ruby and Python are very similar scripting languages and most of this guide applies directly to both. Where examples are used, both a Ruby and Python example are given."),(0,i.kt)("h3",{id:"ruby-vs-python-in-cosmos"},"Ruby vs Python in COSMOS"),(0,i.kt)("p",null,"There are many similarities and a few key differences between Ruby and Python when it comes to writing COSMOS scripts."),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"There is no 80 character limit on line length. Lines can be as long as you like, but be careful to not make them too long as it makes printed reviews of scripts more difficult."),(0,i.kt)("li",{parentName:"ol"},"Indentation white space:",(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Ruby: Not significant. Ruby uses the ",(0,i.kt)("inlineCode",{parentName:"li"},"end")," keyword to determine indented code blocks with a standard of 2 spaces."),(0,i.kt)("li",{parentName:"ol"},"Python: Significant. Python uses indentation to determine code blocks with a standard of 4 spaces."))),(0,i.kt)("li",{parentName:"ol"},"Variables do not have to be declared ahead of time and can be reassigned later, i.e. Ruby and Python are dynamically typed."),(0,i.kt)("li",{parentName:"ol"},"Variable interpolation:",(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Ruby: Variable values can be placed into strings using the ",(0,i.kt)("inlineCode",{parentName:"li"},'"#{variable}"')," syntax."),(0,i.kt)("li",{parentName:"ol"},"Python: Variable values can be placed into f-strings using the ",(0,i.kt)("inlineCode",{parentName:"li"},'f"{variable}"')," syntax."))),(0,i.kt)("li",{parentName:"ol"},"A variable declared inside of a block or loop will not exist outside of that block unless it was already declared.")),(0,i.kt)("p",null,"Both languages provides a script writer a lot of power. But with great power comes great responsibility. Remember when writing your scripts that you or someone else will come along later and need to understand them. Therefore use the following style guidelines:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Use consistent spacing for indentation and do NOT use tabs"),(0,i.kt)("li",{parentName:"ul"},"Constants should be all caps with underscores",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"SPEED_OF_LIGHT = 299792458 # meters per s")))),(0,i.kt)("li",{parentName:"ul"},"Variable names and method names should be in lowercase with underscores",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},'last_name = "Smith"')),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"perform_setup_operation()")))),(0,i.kt)("li",{parentName:"ul"},"Class names (when used) should be camel case and the files which contain them should match but be lowercase with underscores",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"class DataUploader # in 'data_uploader.rb'")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"class CcsdsUtility: # in 'ccsds_utility.py'")))),(0,i.kt)("li",{parentName:"ul"},"Don't add useless comments but instead describe intent")),(0,i.kt)("div",{style:{clear:"both"}}),(0,i.kt)("p",null,"The following is an example of good Ruby style:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"load 'TARGET/lib/upload_utility.rb' # library we do NOT want to show executing\nload_utility 'TARGET/lib/helper_utility.rb' # library we do want to show executing\n\n# Declare constants\nOUR_TARGETS = ['INST','INST2']\n\n# Clear the collect counter of the passed in target name\ndef clear_collects(target)\n  cmd(\"#{target} CLEAR\")\n  wait_check(\"#{target} HEALTH_STATUS COLLECTS == 0\", 5)\nend\n\n######################################\n# START\n######################################\nhelper = HelperUtility.new\nhelper.setup\n\n# Perform collects on all the targets\nOUR_TARGETS.each do |target|\n  collects = tlm(\"#{target} HEALTH_STATUS COLLECTS\")\n  cmd(\"#{target} COLLECT with TYPE SPECIAL\")\n  wait_check(\"#{target} HEALTH_STATUS COLLECTS == #{collects + 1}\", 5)\nend\n\nclear_collects('INST')\nclear_collects('INST2')\n")),(0,i.kt)("p",null,"The following is an example of good Python style:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"from openc3.script import *\n\nimport TARGET.lib.upload_utility # library we do NOT want to show executing\nload_utility('TARGET/lib/helper_utility.rb') # library we do want to show executing\n\n# Declare constants\nOUR_TARGETS = ['INST','INST2']\n\n# Clear the collect counter of the passed in target name\ndef clear_collects(target):\n    cmd(f\"{target} CLEAR\")\n    wait_check(f\"{target} HEALTH_STATUS COLLECTS == 0\", 5)\n\n######################################\n# START\n######################################\nhelper = HelperUtility()\nhelper.setup()\n\n# Perform collects on all the targets\nfor target in OUR_TARGETS:\n    collects = tlm(f\"{target} HEALTH_STATUS COLLECTS\")\n    cmd(f\"{target} COLLECT with TYPE SPECIAL\")\n    wait_check(f\"{target} HEALTH_STATUS COLLECTS == {collects + 1}\", 5)\n\nclear_collects('INST')\nclear_collects('INST2')\n")),(0,i.kt)("p",null,"Both examples shows several features of COSMOS scripting in action. Notice the difference between 'load' or 'import' and 'load_utility'. The first is to load additional scripts which will NOT be shown in Script Runner when executing. This is a good place to put code which takes a long time to run such as image analysis or other looping code where you just want the output. 'load_utility' will visually execute the code line by line to show the user what is happening."),(0,i.kt)("p",null,"Next we declare our constants and create an array of strings which we store in OUR_TARGETS. Notice the constant is all uppercase with underscores."),(0,i.kt)("p",null,"Then we declare our local methods of which we have one called clear_collects. Please provide a comment at the beginning of each method describing what it does and the parameters that it takes."),(0,i.kt)("p",null,"The 'helper_utility' is then created. Note the similarity in the class name and the file name we loaded."),(0,i.kt)("p",null,'The collect example shows how you can iterate over the array of strings we previously created and use variables when commanding and checking telemetry. The Ruby pound bracket #{} notation and python f-string f"{} notation puts whatever the variable holds into the string. You can even execute additional code inside the brackets like we do when checking for the collect count to increment.'),(0,i.kt)("p",null,"Finally we call our 'clear_collects' method on each target by passing the target name."),(0,i.kt)("h2",{id:"scripting-philosophy"},"Scripting Philosophy"),(0,i.kt)("h3",{id:"a-super-basic-script-example"},"A Super Basic Script Example"),(0,i.kt)("p",null,"Most COSMOS scripts can be broken down into the simple pattern of sending a command to a system/subsystem and then verifying that the command worked as expected. This pattern is most commonly implemented with cmd() followed by wait_check(), like the following:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'cmd("INST COLLECT with TYPE NORMAL, TEMP 10.0")\nwait_check("INST HEALTH_STATUS TYPE == \'NORMAL\'", 5)\n')),(0,i.kt)("p",null,"or similarly with a counter that is sampled before the command."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'count = tlm("INST HEALTH_STATUS COLLECTS")\ncmd("INST COLLECT with TYPE NORMAL, TEMP 10.0")\nwait_check("INST HEALTH_STATUS COLLECTS >= #{count + 1}", 5)\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'count = tlm("INST HEALTH_STATUS COLLECTS")\ncmd("INST COLLECT with TYPE NORMAL, TEMP 10.0")\nwait_check(f"INST HEALTH_STATUS COLLECTS >= {count + 1}", 5)\n')),(0,i.kt)("p",null,"90% of the COSMOS scripts you write should be the simple patterns shown above except that you may need to check more than one item after each command to make sure the command worked as expected."),(0,i.kt)("h3",{id:"kiss-keep-it-simple-stupid"},"KISS (Keep It Simple Stupid)"),(0,i.kt)("p",null,"Ruby and Python are very powerful languages with many ways to accomplish the same thing. Given that, always choose the method that is easiest to understand for yourself and others. While it is possible to create complex one liners or obtuse regular expressions, you'll thank yourself later by expanding complex one liners and breaking up and documenting regular expressions."),(0,i.kt)("h3",{id:"keep-things-dry-dont-repeat-yourself"},"Keep things DRY (Don't Repeat Yourself)"),(0,i.kt)("p",null,"A widespread problem in scripts written for any command and control system is large blocks of code that are repeated multiple times. In extreme cases, this has led to 100,000+ line scripts that are impossible to maintain and review."),(0,i.kt)("p",null,"There are two common ways repetition presents itself: exact blocks of code to perform a common action such as powering on a subsystem, and blocks of code that only differ in the name of the mnemonic being checked or the values checked against. Both are solved by removing the repetition using methods (or functions)."),(0,i.kt)("p",null,"For example, a script that powers on a subsystem and ensures correct telemetry would become:"),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"def power_on_subsystem\n  # 100 lines of cmd(), wait_check(), etc\nend\n")),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"def power_on_subsystem():\n    # 100 lines of cmd(), wait_check(), etc\n")),(0,i.kt)("p",null,"Ideally, the above methods would be stored in another file where it could be used by other scripts. If it is truly only useful in the one script, then it could be at the top of the file. The updated script would then look like:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"power_on_subsystem()\n# 150 lines operating the subsystem (e.g.)\n# cmd(...)\n# wait_check(...)\n#...\npower_off_subystem()\n# Unrelated activities\npower_on_subsystem()\n# etc.\n")),(0,i.kt)("p",null,"Blocks of code where only the only variation is the mnemonics or values checked can be replaced by methods with arguments."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'def test_minimum_temp(enable_cmd_name, enable_tlm, temp_tlm, expected_temp)\n  cmd("TARGET #{enable_cmd_name} with ENABLE TRUE")\n  wait_check("TARGET #{enable_tlm} == \'TRUE\'", 5)\n  wait_check("TARGET #{temp_tlm} >= #{expected_temp}", 50)\nend\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'def test_minimum_temp(enable_cmd_name, enable_tlm, temp_tlm, expected_temp):\n    cmd(f"TARGET {enable_cmd_name} with ENABLE TRUE")\n    wait_check(f"TARGET {enable_tlm} == \'TRUE\'", 5)\n    wait_check(f"TARGET {temp_tlm} >= {expected_temp}", 50)\n')),(0,i.kt)("h3",{id:"use-comments-appropriately"},"Use Comments Appropriately"),(0,i.kt)("p",null,"Use comments when what you are doing is unclear or there is a higher-level purpose to a set of lines. Try to avoid putting numbers or other details in a comment as they can become out of sync with the underlying code. Ruby and Python comments start with a # pound symbol and can be anywhere on a line."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'# This line sends an abort command - BAD COMMENT, UNNECCESSARY\ncmd("INST ABORT")\n# Rotate the gimbal to look at the calibration target - GOOD COMMENT\ncmd("INST ROTATE with ANGLE 180.0") # Rotate 180 degrees - BAD COMMENT\n')),(0,i.kt)("h3",{id:"script-runner"},"Script Runner"),(0,i.kt)("p",null,"COSMOS provides two unique ways to run scripts (also known as procedures). Script Runner provides both a script execution environment and a script editor. The script editor includes code completion for both COSMOS methods and command/telemetry item names. It is also a great environment to develop and test scripts. Script Runner provides a framework for users that are familiar with a traditional scripting model with longer style procedures, and for users that want to be able to edit their scripts in place."),(0,i.kt)("p",null,"When opening a suite file (named with 'suite') Script Runner provides a more formal, but also more powerful, environment for running scripts. Suite files breaks scripts down into suites, groups, and scripts (individual methods). Suites are the highest-level concept and would typically cover a large procedure such as a thermal vacuum test, or a large operations scenario such as performing on orbit checkout. Groups capture a related set of scripts such as all the scripts regarding a specific mechanism. A Group might be a collection of scripts all related to a subsystem, or a specific series of tests such as an RF checkout. Scripts capture individual activities that can either pass or fail. Script Runner allows for running an entire suite, one or more groups, or one or more scripts easily. It also automatically produces reports containing timing, pass / fail counts, etc."),(0,i.kt)("p",null,"The correct environment for the job is up to individual users, and many programs will use both script formats to complete their goals."),(0,i.kt)("h3",{id:"looping-vs-unrolled-loops"},"Looping vs Unrolled Loops"),(0,i.kt)("p",null,"Loops are powerful constructs that allow you to perform the same operations multiple times without having to rewrite the same code over and over (See the DRY Concept). However, they can make restarting a COSMOS script at the point of a failure difficult or impossible. If there is a low probability of something failing, then loops are an excellent choice. If a script is running a loop over a list of telemetry points, it may be a better choice to \u201cunroll\u201d the loop by making the loop body into a method, and then calling that method directly for each iteration of a loop that would have occurred."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"10.times do |temperature_number|\n  check_temperature(temperature_number + 1)\nend\n")),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"for temperature_number in range(1, 11):\n    check_temperature(temperature_number)\n")),(0,i.kt)("p",null,"If the above script was stopped after temperature number 3, there would be no way to restart the loop at temperature number 4. A better solution for small loop counts is to unroll the loop."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"check_temperature(1)\ncheck_temperature(2)\ncheck_temperature(3)\ncheck_temperature(4)\ncheck_temperature(5)\ncheck_temperature(6)\ncheck_temperature(7)\ncheck_temperature(8)\ncheck_temperature(9)\ncheck_temperature(10)\n")),(0,i.kt)("p",null,"In the unrolled version above, the COSMOS \u201cStart script at selected line\u201d feature can be used to resume the script at any point."),(0,i.kt)("h2",{id:"script-organization"},"Script Organization"),(0,i.kt)("p",null,"All scripts must be part of a ",(0,i.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/plugins"},"Plugin"),". You can create a simple plugin called SCRIPTS or PROCEDURES that only contains lib and procedures directories to store scripts. If COSMOS detects a plugin without defined cmd/tlm it will not spawn microservices for telemetry processing."),(0,i.kt)("h3",{id:"organizing-your-scripts-into-a-plugin"},"Organizing Your Scripts into a Plugin"),(0,i.kt)("p",null,"As your scripts become large with many methods, it makes sense to break them up into multiple files within a plugin. Here is a recommended organization for your plugin's scripts/procedures."),(0,i.kt)("p",null,"| Folder | Description |\n| targets/TARGET_NAME/lib | Place script files containing reusable target specific methods here |\n| targets/TARGET_NAME/procedures | Place simple procedures that are centered around one specific target here |"),(0,i.kt)("p",null,"In your main procedure you will usually bring in the other files with instrumentation using load_utility."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"# Ruby:\nload_utility('TARGET/lib/my_other_script.rb')\n# Python:\nload_utility('TARGET/procedures/my_other_script.py')\n")),(0,i.kt)("h3",{id:"organize-scripts-into-methods"},"Organize Scripts into Methods"),(0,i.kt)("p",null,"Put each activity into a distinct method. Putting your scripts into methods makes organization easy and gives a great high-level overview of what the overall script does (assuming you name the methods well). There are no bonus points for vague, short method names. Make your method names long and clear."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'def test_1_heater_zone_control\n  puts "Verifies requirements 304, 306, and 310"\n  # Test code here\nend\n\ndef script_1_heater_zone_control\n  puts "Verifies requirements 304, 306, and 310"\n  # Test code here\nend\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'def test_1_heater_zone_control():\n    print("Verifies requirements 304, 306, and 310")\n    # Test code here\n\ndef script_1_heater_zone_control():\n    print("Verifies requirements 304, 306, and 310")\n    # Test code here\n')),(0,i.kt)("h3",{id:"using-classes-vs-unscoped-methods"},"Using Classes vs Unscoped Methods"),(0,i.kt)("p",null,"Classes in object-oriented programing allow you to organize a set of related methods and some associated state. The most important aspect is that the methods work on some shared state. For example, if you have code that moves a gimbal around, and need to keep track of the number of moves, or steps, performed across methods, then that is a wonderful place to use a class. If you just need a helper method to do something that happens multiple times in a script without copy and pasting, it probably does not need to be in a class."),(0,i.kt)("p",null,"NOTE: The convention in COSMOS is to have a TARGET/lib/target.","[","rb/py","]"," file which is named after the TARGET name and contains a class called Target. This discussion refers to scripts in the TARGET/procedures directory."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'class Gimbal\n  attr_accessor :gimbal_steps\n  def initialize()\n    @gimbal_steps = 0\n  end\n  def move(steps_to_move)\n    # Move the gimbal\n    @gimbal_steps += steps_to_move\n  end\n  def home_gimbal\n    # Home the gimbal\n    @gimbal_steps = 0\n  end\nend\n\ndef perform_common_math(x, y)\n  x + y\nend\n\ngimbal = Gimbal.new\ngimbal.home_gimbal\ngimbal.move(100)\ngimbal.move(200)\nputs "Moved gimbal #{gimbal.gimbal_steps}"\nresult = perform_common_math(gimbal.gimbal_steps, 10)\nputs "Math:#{result}"\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'class Gimbal:\n    def __init__(self):\n        self.gimbal_steps = 0\n\n    def move(self, steps_to_move):\n        # Move the gimbal\n        self.gimbal_steps += steps_to_move\n\n    def home_gimbal(self):\n        # Home the gimbal\n        self.gimbal_steps = 0\n\ndef perform_common_math(x, y):\n    return x + y\n\ngimbal = Gimbal()\ngimbal.home_gimbal()\ngimbal.move(100)\ngimbal.move(200)\nprint(f"Moved gimbal {gimbal.gimbal_steps}")\nresult = perform_common_math(gimbal.gimbal_steps, 10)\nprint(f"Math:{result}")\n')),(0,i.kt)("h3",{id:"instrumented-vs-uninstrumented-lines-require-vs-load"},"Instrumented vs Uninstrumented Lines (require vs load)"),(0,i.kt)("p",null,"COSMOS scripts are normally \u201cinstrumented\u201d. This means that each line has some extra code added behind the scenes that primarily highlights the current executing line and catches exceptions if things fail such as a wait_check. If your script needs to use code in other files, there are a few ways to bring in that code. Some techniques bring in instrumented code and others bring in uninstrumented code. There are reasons to use both."),(0,i.kt)("p",null,"load_utility (and the deprecated require_utility), bring in instrumented code from other files. When COSMOS runs the code in the other file, Script Runner will dive into the other file and show each line highlighted as it executes. This should be the default way to bring in other files, as it allows continuing if something fails, and provides better visibility to operators."),(0,i.kt)("p",null,"However, sometimes you don't want to display code executing from other files. Externally developed libraries generally do not like to be instrumented, and code that contains large loops or that just takes a long time to execute when highlighting lines, will be much faster if included in a method that does not instrument lines. Ruby provides two ways to bring in uninstrumented code. The first is the \u201cload\u201d keyword. Load will bring in the code from another file and will bring in any changes to the file if it is updated on the next call to load. \u201crequire\u201d is like load but is optimized to only bring in the code from another file once. Therefore, if you use require and then change the file it requires, you must restart Script Runner to re-require the file and bring in the changes. In general, load is recommended over require for COSMOS scripting. One gotcha with load is that it requires the full filename including extension, while the require keyword does not."),(0,i.kt)("p",null,"In Python, libraries are included using the import syntax. Any code imported using import is not instrumented. Only the code imported using load_utility is instrumented."),(0,i.kt)("p",null,"Finally, COSMOS scripting has a special syntax for disabling instrumentation in the middle of an instrumented script, with the disable_instrumentation method. This allows you to disable instrumentation for large loops and other activities that are too slow when running instrumented."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"temp = 0\ndisable_instrumentation do\n  # Make sure nothing in here will raise exceptions!\n  5000000.times do\n    temp += 1\n  end\nend\nputs temp\n")),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"temp = 0\nwith disable_instrumentation():\n    # Make sure nothing in here will raise exceptions!\n    for x in range(0,5000000):\n        temp += 1\nprint(temp)\n")),(0,i.kt)("admonition",{title:"When Running Uninstrumented Code",type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"Make sure that the code will not raise any exceptions or have any check failures. If an exception is raised from uninstrumented code, then your entire script will stop.")),(0,i.kt)("h2",{id:"debugging-and-auditing"},"Debugging and Auditing"),(0,i.kt)("h3",{id:"built-in-debugging-capabilities"},"Built-In Debugging Capabilities"),(0,i.kt)("p",null,"Script Runner has built in debugging capabilities that can be useful in determining why your script is behaving in a certain way. Of primary importance is the ability to inspect and set script variables."),(0,i.kt)("p",null,"To use the debugging functionality, first select the \u201cToggle Debug\u201d option from the Script Menu. This will add a small Debug: prompt to the bottom of the tool. Any code entered in this prompt will be executed when Enter is pressed. To inspect variables in a running script, pause the script and then type the variable name to print out the value of the variable in the debug prompt."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"variable_name\n")),(0,i.kt)("p",null,"Variables can also be set simply by using equals."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"variable_name = 5\n")),(0,i.kt)("p",null,"If necessary, you can also inject commands from the debug prompt using the normal commanding methods. These commands will be logged to the Script Runner message log, which may be advantageous over using a different COSMOS tool like CmdSender (where the command would only be logged in the CmdTlmServer message log)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'cmd("INST COLLECT with TYPE NORMAL")\n')),(0,i.kt)("p",null,"Note that the debug prompt keeps the command history and you can scroll through the history by using the up and down arrows."),(0,i.kt)("h3",{id:"breakpoints"},"Breakpoints"),(0,i.kt)("p",null,"You can click the line number (left side gutter) in Script Runner to add a breakpoint. The script will automatically pause when it hits the breakpoint. Once stopped at the breakpoint, you can evaluate variables using the Debug line."),(0,i.kt)("h3",{id:"using-disconnect-mode"},"Using Disconnect Mode"),(0,i.kt)("p",null,"Disconnect mode is a feature of Script Runner that allows testing scripts in an environment without real hardware in the loop. Disconnect mode is started by selecting Script -> Toggle Disconnect. Once selected, the user is prompted to select which targets to disconnect. By default, all targets are disconnected, which allows for testing scripts without any real hardware. Optionally, only a subset of targets can be selected which can be useful for trying out scripts in partially integrated environments."),(0,i.kt)("p",null,"While in disconnect mode, commands to the disconnected targets always succeed. Additionally, all checks of disconnected targets' telemetry are immediately successful. This allows for a quick run-through of procedures for logic errors and other script specific errors without having to worry about the behavior and proper functioning of hardware."),(0,i.kt)("h3",{id:"auditing-your-scripts"},"Auditing your Scripts"),(0,i.kt)("p",null,"Script Runner includes several tools to help audit your scripts both before and after execution."),(0,i.kt)("h4",{id:"ruby-syntax-check"},"Ruby Syntax Check"),(0,i.kt)("p",null,"The Ruby Syntax Check tool is found under the Script Menu. This tool uses the ruby executable with the -c flag to run a syntax check on your script. If any syntax errors are found the exact message presented by the Ruby interpreter is shown to the user. These can be cryptic, but the most common faults are not closing a quoted string, forgetting an \u201cend\u201d keyword, or using a block but forgetting the proceeding \u201cdo\u201d keyword."),(0,i.kt)("h2",{id:"common-scenarios"},"Common Scenarios"),(0,i.kt)("h3",{id:"user-input-best-practices"},"User Input Best Practices"),(0,i.kt)("p",null,"COSMOS provides several different methods to gather manual user input in scripts. When using user input methods that allow for arbitrary values (like ask() and ask_string()), it is very important to validate the value given in your script before moving on. When asking for text input, it is extra important to handle different casing possibilities and to ensure that invalid input will either re-prompt the user or take a safe path."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'answer = ask_string("Do you want to continue (y/n)?")\nif answer != \'y\' and answer != \'Y\'\n  raise "User entered: #{answer}"\nend\n\ntemp = 0.0\nwhile temp < 10.0 or temp > 50.0\n  temp = ask("Enter the desired temperature between 10.0 and 50.0")\nend\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'answer = ask_string("Do you want to continue (y/n)?")\nif answer != \'y\' and answer != \'Y\':\n    raise RuntimeError(f"User entered: {answer}")\n\ntemp = 0.0\nwhile temp < 10.0 or temp > 50.0:\n    temp = ask("Enter the desired temperature between 10.0 and 50.0")\n')),(0,i.kt)("p",null,"When possible, always use one of the other user input methods that has a constrained list of choices for your users (message_box, vertical_message_box, combo_box)."),(0,i.kt)("p",null,"Note that all these user input methods provide the user the option to \u201cCancel\u201d. When cancel is clicked, the script is paused but remains at the user input line. When hitting \u201cGo\u201d to the continue, the user will be re-prompted to enter the value."),(0,i.kt)("h3",{id:"conditionally-require-manual-user-input-steps"},"Conditionally Require Manual User Input Steps"),(0,i.kt)("p",null,"When possible, a useful design pattern is to write your scripts such that they can run without prompting for any user input. This allows the scripts to be more easily tested and provides a documented default value for any user input choices or values. To implement this pattern, all manual steps such as ask(), prompt(), and infinite wait() statements need to be wrapped with an if statement that checks the value of the $manual variable. If $manual is set, then the manual steps should be executed. If not, then a default value should be used."),(0,i.kt)("p",null,"Ruby Only:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'# Set the $manual variable \u2013 Only needed outside of suites\nanswer = ask("Prompt for manual entry (Y/n)?")\nif answer == \'n\' or answer == \'N\'\n  $manual = false\nelse\n  $manual = true\nend\nif $manual\n  temp = ask("Please enter the temperature")\nelse\n  temp = 20.0\nend\nif !$manual\n  puts "Skipping infinite wait in auto mode"\nelse\n  wait\nend\n')),(0,i.kt)("p",null,"When running suites, there is a checkbox at the top of the tool called \u201cManual\u201d that affects this $manual variable directly."),(0,i.kt)("h3",{id:"outputing-extra-information-to-a-report"},"Outputing Extra Information to a Report"),(0,i.kt)("p",null,"COSMOS Script Runner operating on a script suite automatically generates a report that shows the PASS/FAILED/SKIPPED state for each script. You can also inject arbitrary text into this report using the example as follows. Alternatively, you can simply use print text into the Script Runner message log."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'class MyGroup < OpenC3::Group\n  def script_1\n    # The following text will be placed in the report\n    OpenC3::Group.puts "Verifies requirements 304, 306, 310"\n    # This puts line will show up in the sr_messages log file\n    puts "script_1 complete"\n  end\nend\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'from openc3.script.suite import Group\nclass MyGroup(Group):\n    def script_1():\n        # The following text will be placed in the report\n        Group.print("Verifies requirements 304, 306, 310")\n        # This puts line will show up in the sr_messages log file\n        print("script_1 complete")\n')),(0,i.kt)("h3",{id:"getting-the-most-recent-value-of-a-telemetry-point-from-multiple-packets"},"Getting the Most Recent Value of a Telemetry Point from Multiple Packets"),(0,i.kt)("p",null,"Some systems include high rate data points with the same name in every packet. COSMOS supports getting the most recent value of a telemetry point that is in multiple packets using a special packet name of LATEST. Assume the target INST has two packets, PACKET1 and PACKET2. Both packets have a telemetry point called TEMP."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'# Get the value of TEMP from the most recently received PACKET1\nvalue = tlm("INST PACKET1 TEMP")\n# Get the value of TEMP from the most recently received PACKET2\nvalue = tlm("INST PACKET2 TEMP")\n# Get the value of TEMP from the most recently received PACKET1 or PACKET2\nvalue = tlm("INST LATEST TEMP")\n')),(0,i.kt)("h3",{id:"checking-every-single-sample-of-a-telemetry-point"},"Checking Every Single Sample of a Telemetry Point"),(0,i.kt)("p",null,"When writing COSMOS scripts, checking the most recent value of a telemetry point normally gets the job done. The tlm(), tlm_raw(), etc methods all retrieve the most recent value of a telemetry point. Sometimes you need to perform analysis on every single sample of a telemetry point. This can be done using the COSMOS packet subscription system. The packet subscription system lets you choose one or more packets and receive them all from a queue. You can then pick out the specific telemetry points you care about from each packet."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"id = subscribe_packets([['INST', 'HEALTH_STATUS'], ['INST', 'ADCS']])\nwait 1.5\nid, packets = get_packet(id)\npackets.each do |packet|\n  puts \"#{packet['PACKET_TIMESECONDS']}: #{packet['target_name']} #{packet['packet_name']}\"\nend\n# Wait for some time later and re-use the last returned ID\nid, packets = get_packet(id)\n")),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"id = subscribe_packets([['INST', 'HEALTH_STATUS'], ['INST', 'ADCS']])\nwait(1.5)\nid, packets = get_packet(id)\nfor packet in packets:\n    print(f\"{packet['PACKET_TIMESECONDS']}: {packet['target_name']} {packet['packet_name']}\")\n# Wait for some time later and re-use the last returned ID\nid, packets = get_packet(id)\n")),(0,i.kt)("h3",{id:"using-variables-in-mnemonics"},"Using Variables in Mnemonics"),(0,i.kt)("p",null,"Because command and telemetry mnemonics are just strings in COSMOS scripts, you can make use of variables in some contexts to make reusable code. For example, a method can take a target name as an input to support multiple instances of a target. You could also pass in the value for a set of numbered telemetry points."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'def example(target_name, temp_number)\n  cmd("#{target_name} COLLECT with TYPE NORMAL")\n  wait_check("#{target_name} TEMP#{temp_number} > 50.0")\nend\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'def example(target_name, temp_number):\n    cmd(f"{target_name} COLLECT with TYPE NORMAL")\n    wait_check(f"{target_name} TEMP{temp_number} > 50.0")\n')),(0,i.kt)("p",null,"This can also be useful when looping through a numbered set of telemetry points but be considerate of the downsides of looping as discussed in the ",(0,i.kt)("a",{parentName:"p",href:"#looping-vs-unrolled-loops"},"Looping vs Unrolled Loops")," section."),(0,i.kt)("h3",{id:"using-custom-wait_check_expression"},"Using Custom wait_check_expression"),(0,i.kt)("p",null,"The COSMOS wait_check_expression (and check_expression) allow you to perform more complicated checks and still stop the script with a CHECK error message if something goes wrong. For example, you can check variables against each other or check a telemetry point against a range. The exact string of text passed to wait_check_expression is repeatedly evaluated until it passes, or a timeout occurs. It is important to not use string interpolation within the actual expression or the values inside of the string interpolation syntax will only be evaluated once when it is converted into a string."),(0,i.kt)("p",null,"Ruby:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'one = 1\ntwo = 2\n\nwait_check_expression("one == two", 1)\n# ERROR: CHECK: one == two is FALSE after waiting 1.017035 seconds\n\n# Checking an integer range\nwait_check_expression("one > 0 and one < 10 # init value one = #{one}", 1)\n')),(0,i.kt)("p",null,"Python:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'one = 1\ntwo = 2\n\nwait_check_expression("one == two", 1, 0.25, locals())\n# ERROR: CHECK: one == two is FALSE after waiting 1.017035 seconds\n\n# Checking an integer range\nwait_check_expression("one > 0 and one < 10", 1, 0.25, locals())\n')),(0,i.kt)("h3",{id:"cosmos-scripting-differences-from-regular-ruby-scripting"},"COSMOS Scripting Differences from Regular Ruby Scripting"),(0,i.kt)("h4",{id:"do-not-use-single-line-if-statements"},"Do not use single line if statements"),(0,i.kt)("p",null,"COSMOS scripting instruments each line to catch exceptions if things go wrong. With single line if statements the exception handling doesn't know which part of the statement failed and cannot properly continue. If an exception is raised in a single line if statement, then the entire script will stop and not be able to continue. Do not use single line if statements in COSMOS scripts. (However, they are fine to use in interfaces and other Ruby code, just not COSMOS scripts)."),(0,i.kt)("p",null,"Don't do this:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'run_method() if tlm("INST HEALTH_STATUS TEMP1") > 10.0\n')),(0,i.kt)("p",null,"Do this instead:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'# It is best not to execute any code that could fail in an if statement, ie\n# tlm() could fail if the CmdTlmServer was not running or a mnemonic\n# was misspelled\ntemp1 = tlm("INST HEALTH_STATUS TEMP1")\nif temp1 > 10.0\n  run_method()\nend\n')),(0,i.kt)("h2",{id:"when-things-go-wrong"},"When Things Go Wrong"),(0,i.kt)("h3",{id:"common-reasons-checks-fail"},"Common Reasons Checks Fail"),(0,i.kt)("p",null,"There are three common reasons that checks fail in COSMOS scripts:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The delay given was too short"),(0,i.kt)("p",{parentName:"li"},"The wait_check() method takes a timeout that indicates how long to wait for the referenced telemetry point to pass the check. The timeout needs to be large enough for the system under test to finish its action and for updated telemetry to be received. Note that the script will continue as soon as the check completes successfully. Thus, the only penalty for a longer timeout is the additional wait time in a failure condition.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The range or value checked against was incorrect or too stringent"),(0,i.kt)("p",{parentName:"li"},"Often the actual telemetry value is ok, but the expected value checked against was too tight. Loosen the ranges on checks when it makes sense. Ensure your script is using the wait_check_tolerance() routine when checking floating point numbers and verify you're using an appropriate tolerance value.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The check really failed"),(0,i.kt)("p",{parentName:"li"},"Of course, sometimes there are real failures. See the next section for how to handle them and recover."))),(0,i.kt)("h3",{id:"how-to-recover-from-anomalies"},"How to Recover from Anomalies"),(0,i.kt)("p",null,"Once something has failed, and your script has stopped with a pink highlighted line, how can you recover? Fortunately, COSMOS provides several mechanisms that can be used to recover after something in your script fails."),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Retry"),(0,i.kt)("p",{parentName:"li"},"After a failure, the Script Runner \u201cPause\u201d button changes to \u201cRetry\u201d. Clicking on the Retry button will re-execute the line the failed. For failures due to timing issues, this will often resolve the issue and allow the script to continue. Make note of the failure and be sure to update your script prior to the next run.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Use the Debug Prompt"),(0,i.kt)("p",{parentName:"li"},"By selecting Script -> Toggle Debug, you can perform arbitrary actions that may be needed to correct the situation without stopping the running script. You can also inspect variables to help determine why something failed.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Execute Selection"),(0,i.kt)("p",{parentName:"li"},'If only a small section of a script needs to be run, then \u201cExecute Selection" can be used to execute only a small portion of the script. This can also be used when a script is paused or stopped in error.')),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Run from here"),(0,i.kt)("p",{parentName:"li"},'By clicking into a script, and right clicking to select "Run from here", users can restart a script at an arbitrary point. This works well if no required variable definitions exist earlier in the script.'))),(0,i.kt)("h2",{id:"advanced-topics"},"Advanced Topics"),(0,i.kt)("h3",{id:"advanced-script-configuration-with-csv-or-excel"},"Advanced Script Configuration with CSV or Excel"),(0,i.kt)("p",null,"Using a spreadsheet to store the values for use by a script can be a great option if you have a CM-controlled script but need to be able to tweak some values for a test or if you need to use different values for different serial numbers."),(0,i.kt)("p",null,"The Ruby CSV class be used to easily read data from CSV files (recommended for cross platform projects)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"require 'csv'\nvalues = CSV.read('test.csv')\nputs values[0][0]\n")),(0,i.kt)("p",null,"If you are only using Windows, COSMOS also contains a library for reading Excel files."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"require 'openc3/win32/excel'\nss = ExcelSpreadsheet.new('C:/git/cosmos/test.xlsx')\nputs ss[0][0][0]\n")),(0,i.kt)("h3",{id:"when-to-use-ruby-modules"},"When to use Ruby Modules"),(0,i.kt)("p",null,"Modules in Ruby have two purposes: namespacing and mixins. Namespacing allows having classes and methods with the same name, but with different meanings. For example, if they are namespaced, COSMOS can have a Packet class and another Ruby library can have a Packet class. This isn't typically useful for COSMOS scripting though."),(0,i.kt)("p",null,"Mixins allow adding common methods to classes without using inheritance. Mixins can be useful to add common functionality to some classes but not others, or to break up classes into multiple files."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"module MyModule\n  def module_method\n  end\nend\nclass MyTest < OpenC3::Group\n  include MyModule\n  def test_1\n    module_method()\n  end\nend\n")))}d.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>h});var a=n(2784);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,i=function(e,t){if(null==e)return{};var n,a,i={},o=Object.keys(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),p=c(n),m=i,h=p["".concat(l,".").concat(m)]||p[m]||d[m]||o;return n?a.createElement(h,r(r({ref:t},u),{},{components:n})):a.createElement(h,r({ref:t},u))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,r=new Array(o);r[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[p]="string"==typeof e?e:i,r[1]=s;for(var c=2;c<o;c++)r[c]=n[c];return a.createElement.apply(null,r)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/43652efd.cbac4bc0.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5324],{6777:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>r});var i=a(7896),n=(a(2784),a(876));const o={title:"Data Extractor"},s=void 0,l={unversionedId:"tools/data-extractor",id:"tools/data-extractor",title:"Data Extractor",description:"Introduction",source:"@site/docs/tools/data-extractor.md",sourceDirName:"tools",slug:"/tools/data-extractor",permalink:"/tools/docs/docs/tools/data-extractor",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/data-extractor.md",tags:[],version:"current",frontMatter:{title:"Data Extractor"},sidebar:"defaultSidebar",previous:{title:"Command and Telemetry Server",permalink:"/tools/docs/docs/tools/cmd-tlm-server"},next:{title:"Data Viewer",permalink:"/tools/docs/docs/tools/data-viewer"}},c={},r=[{value:"Introduction",id:"introduction",level:2},{value:"Data Extractor Menus",id:"data-extractor-menus",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Open Configuration",id:"open-configuration",level:4},{value:"Save Configuration",id:"save-configuration",level:4},{value:"Mode Menu Items",id:"mode-menu-items",level:3},{value:"Selecting Items for Output",id:"selecting-items-for-output",level:2},{value:"Start/End Date/Time",id:"startend-datetime",level:3},{value:"Adding Targets Packets Items",id:"adding-targets-packets-items",level:3},{value:"Removing Items",id:"removing-items",level:3},{value:"Editing Items",id:"editing-items",level:3},{value:"Processing Items",id:"processing-items",level:2}],d={toc:r},m="wrapper";function p(e){let{components:t,...o}=e;return(0,n.kt)(m,(0,i.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"introduction"},"Introduction"),(0,n.kt)("p",null,"Data Extractor extracts command and telemetry items into comma or tab separated files. Individual items or entire packets can be processed over any time period. Data Extractor also has a number of options to control the output for post processing in Excel or Matlab, for example."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Data Extractor",src:a(4563).Z,width:"1678",height:"1358"})),(0,n.kt)("h2",{id:"data-extractor-menus"},"Data Extractor Menus"),(0,n.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,n.kt)("img",{src:"/img/v5/data_extractor/file_menu.png",alt:"File Menu",style:{float:"left","margin-right":"50px",height:"160px"}}),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Opens a saved configuration"),(0,n.kt)("li",{parentName:"ul"},"Save the current configuration (item list)"),(0,n.kt)("li",{parentName:"ul"},"Delimit output with commas"),(0,n.kt)("li",{parentName:"ul"},"Delimit output with tabs")),(0,n.kt)("h4",{id:"open-configuration"},"Open Configuration"),(0,n.kt)("p",null,"The Open and Save Configuration options deserve a little more explanation. When you select File Open the Open Configuration dialog appears. It displays a list of all saved configurations (INST_TEMPS in this example). You select a configuration and then click Ok to load it. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Open Config",src:a(2978).Z,width:"1076",height:"500"})),(0,n.kt)("h4",{id:"save-configuration"},"Save Configuration"),(0,n.kt)("p",null,"When you select File Save the Save Configuration dialog appears. It displays a list of all saved configurations (INST_TEMPS in this example). You click the Configuration Name text field, enter the name of your new configuration, and click Ok to save. You can delete existing configurations by clicking the Trash icon next to a configuration name."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Save Config",src:a(2236).Z,width:"1076",height:"592"})),(0,n.kt)("h3",{id:"mode-menu-items"},"Mode Menu Items"),(0,n.kt)("img",{src:"/img/v5/data_extractor/mode_menu.png",alt:"Mode Menu",style:{float:"left","margin-right":"50px",height:"250px"}}),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Fill empty cells with the previous value"),(0,n.kt)("li",{parentName:"ul"},"Add a Matlab comment ('%') to the header"),(0,n.kt)("li",{parentName:"ul"},"Only output changed values"),(0,n.kt)("li",{parentName:"ul"},"Only list item name as column header"),(0,n.kt)("li",{parentName:"ul"},"List full Target Packet Item as header")),(0,n.kt)("h2",{id:"selecting-items-for-output"},"Selecting Items for Output"),(0,n.kt)("h3",{id:"startend-datetime"},"Start/End Date/Time"),(0,n.kt)("p",null,"Data Extractor provides text fields where you specify the time range to extract items. Clicking the Start Date and End Date text fields opens a Date Chooser dialog. Note you can also manually type in the date."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Date Chooser",src:a(2645).Z,width:"820",height:"630"})),(0,n.kt)("p",null,"Clicking the Start Time and End Time icon opens up a Time Chooser dialog. Note you can also manually type in the time."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Time Chooser",src:a(9984).Z,width:"820",height:"602"})),(0,n.kt)("h3",{id:"adding-targets-packets-items"},"Adding Targets Packets Items"),(0,n.kt)("p",null,"Data Extractor provides Target, Packet, Item drop downs to select the items you want to export. When you select a Target the Packet drop down defaults to ","[","All","]",' which sets the button to "Add Target". This would add EVERY item defined in EVERY packet in the target. Note: This can be a LOT of telemetry points but any added point can be removed.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Target",src:a(6389).Z,width:"1652",height:"752"})),(0,n.kt)("p",null,"When you select a Packet the Item drop down defaults to ","[","All","]",' which sets the button to "Add Packet". This would add EVERY item defined in the specified packet. Note: This can be a LOT of telemetry points but any added point can be removed.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Packet",src:a(8935).Z,width:"1652",height:"752"})),(0,n.kt)("p",null,'When you select an individual Item the button changes to "Add Item" and the Description field updates with the item\'s description.'),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Select Item",src:a(1896).Z,width:"1652",height:"752"})),(0,n.kt)("h3",{id:"removing-items"},"Removing Items"),(0,n.kt)("p",null,"Once you've added items the Items table will have a list of items."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Items Table",src:a(9612).Z,width:"1652",height:"676"})),(0,n.kt)("p",null,"Items can be removed by clicking the Trash icon next to the item. ALL items can be removed by clicking the Trash icon in the header."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Delete All Mouseover",src:a(7491).Z,width:"288",height:"252"})),(0,n.kt)("h3",{id:"editing-items"},"Editing Items"),(0,n.kt)("p",null,"Items can be edited by clicking the Pencil icon next to the item. ALL items can be edited by clicking the pencil icon in the header."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit All Mouseover",src:a(2428).Z,width:"288",height:"252"})),(0,n.kt)("p",null,"Clicking the Edit All brings up the Edit All Items dialog."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit All",src:a(7973).Z,width:"1060",height:"586"})),(0,n.kt)("p",null,"This allows you to change the data type of all items in the list. In this example we change from the default of CONVERTED to RAW. This updates the item list as follows."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Items Table Raw",src:a(9927).Z,width:"1638",height:"674"})),(0,n.kt)("p",null,"Clicking the pencil next to an individual item brings up a similar dialog."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit TEMP1",src:a(9720).Z,width:"1064",height:"613"})),(0,n.kt)("p",null,"If we change TEMP1 back to CONVERTED the item list is again updated."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Edit TEMP1",src:a(2566).Z,width:"1638",height:"682"})),(0,n.kt)("h2",{id:"processing-items"},"Processing Items"),(0,n.kt)("p",null,"Clicking the Process button starts the processing of the items list. A progress wheel is shown on the left side of the table and the Process button changes to Cancel to allow cancelling the process."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Processing",src:a(5387).Z,width:"1638",height:"682"})),(0,n.kt)("p",null,"When the processing is complete, the browser shows a file download link. Note this varies by browser. This example is from Chrome."),(0,n.kt)("p",null,(0,n.kt)("img",{alt:"Download",src:a(8243).Z,width:"257",height:"86"})))}p.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var i=a(2784);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,i)}return a}function s(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?o(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):o(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function l(e,t){if(null==e)return{};var a,i,n=function(e,t){if(null==e)return{};var a,i,n={},o=Object.keys(e);for(i=0;i<o.length;i++)a=o[i],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(i=0;i<o.length;i++)a=o[i],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var c=i.createContext({}),r=function(e){var t=i.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=r(e.components);return i.createElement(c.Provider,{value:t},e.children)},m="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},g=i.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=r(a),g=n,u=m["".concat(c,".").concat(g)]||m[g]||p[g]||o;return a?i.createElement(u,s(s({ref:t},d),{},{components:a})):i.createElement(u,s({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=g;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[m]="string"==typeof e?e:n,s[1]=l;for(var r=2;r<o;r++)s[r]=a[r];return i.createElement.apply(null,s)}return i.createElement.apply(null,a)}g.displayName="MDXCreateElement"},4563:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/data_extractor-62c5b1743ba9dfdff2e393bcbdf863c36effc5ef5319d845cfd17186bd757bca.png"},2645:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/date_chooser-10f7b740b9acc76604e5dc86fe409b6b777abe0fb3fa5ebf8f47cb1ac58b9676.png"},7491:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/delete_all_mouseover-06083f3d3d712d39f21bc5eda45adbfff449732a2061e53cb1a0baf6c5f5d4b8.png"},8243:(e,t,a)=>{a.d(t,{Z:()=>i});const i="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQEAAABWCAYAAADPECMGAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABPfSURBVHhe7Z0JeE1X18f/N/MkhigxJKZojRVKqSoSFVPQEtUBKTqosYYq7dtSaipKTK0qHUwdlL5FDG0M31udKIJUEFJBEyoyyTycb699z50y57ZJcNbvefZz9tn7nH32Pc76r7X2uXF1zbo9rYBhGM2iA2qzCDCMhrFRtwzDaBQWAYbROCwCDKNxWAQYRuOwCDCMxmERYBiNwyLAMBqHRYBhNI5VXxb66acdWLduHdLS0tSWsuHq6oqXX34ZHTsOUFsYhqksrBKBkSP7Yk9oKHJyctSWwmnYqBFup6QgISEBjm7ucK1WU7TqkPL3NfTr2wdr136rP5BhmErDqnQgXUQAJAC5ublFFhcXF3yxdStWrVol62nJyUi+dROPDBwNj7qN5RgMw1Q+/9qagI2NThZDWJGamorVq1fjiy++QHp6OnJzspCdlor4y38iNemWehTDMJWN1SJgZ6tDDXc7BPpVx9QX6mDOlHqYNbkhxo9sikc71YWzsx22bt2CHTt2ICsrCzqdDVyq1EBqQiJSEm6ooxROixb3Y98+Eo/LUJQ4ISjRYpxPUL9+HdlPW9qndupPSbkorvWhsZ9YtmwO4uMjkZcXi+zsqzh6dB969fKTfRER/yfmdAULF/5H7ptDbdRHxxiYPXsarl8/U+hYxJQpY3Dt2knZn5NzDefOHcHo0c+qvZZ06vQQdu/eLOdMc6fP+PPPuy3GM6d7987yejQujX/16gmMGvWM7KP79NNPuwrtq1LFDZs2rba4R2vXLpZ9BNWL6mO0hVUiUNXVDgO71MD+Vc3xwfSGmBlcB2OfqoUJz1TH7PH1sGnlo/hkzQA82KoW7O31l7B3cEa9hr4I/3Eb8nKLXkughzck5F34+rbCzJnz4O7ug/feWw0/v0fF9m15zPr1y9T91WjSpCOWL/8Iffr4Y82aRbJ/xowJeP75odi+fTe8vdshMHA43Nxc5bj3399EHmNvb4+AgG7yegaoTm3UZ4AEYNq0scLYjqJVq24IDp4ox/rgg0XSoJ9++gl5vd9/PyX7u3QZgBs3buLdd2fIOZnj798Fn3wSAk/P+/Dyy68JYfTEoEEjhVgl4LPPVmDMmGD1SD00n8WLZ6Fq1Sro12+YOH8wEhKS8MYbk9Chgy/+85/JaNasqRChWejcORC3biVi+vTx8jMuWPCmOOdxLFq0Cl5ebbFr1/dyrlOnvoKxY5/H0KEDhZCGyr7//nev3Kd2RntYJQIvBdTG+6MawNvNAc6KDrps0ZgpSi5gqyShql0cerS3w1cbnkCfXi1EVOAEr8YP4fypMORkZ8gximLw4H5o1+5BkUZ8K407JeU23nlnCY4dC8cjj7QX9dfw8MNtheffIdsvXbqMt95aJPepf8iQ/vDxaSS8eTa++26f8I6xIqo4KPudnBzF2K3ldS5fvoqGDb0xfHiQ3CeoTm3UR5ARBgX1x/nzFzFixAT88cd5bNmyHXPnvi/EqQqGDQuS3tjOzg779x+S/b/88js++mgTMjOz0Lat/loGJk16UcznL3z44efCuN+W3nvz5g+Epz8p50he3FyUfH1byv39+w/L/kOHfsKvvx6Xn4Pa27RpiZMnz2DFio/ldenz1qhRDe3btxHiVw8XLkRjzpyl8h6EhobJe0KCQvc3LS1dCM9Xso+2qalpcjxGe1glAtXIu6cryEsTJV0HRdi1kqUDskRnjtjm3IYuMwbuttexbG5XDHhyIGJjTpYoAETjxg2EceRJozfn8ceHoFGjDsJ76kT4mys88zG1R09ExDnY2tqidevm0muTYS5fPld6TUoTyBgaNmwvxYWIibmK5OQU9O37uNwnunZ9RLZRH0Hetlo1dxw/flqKkQGaW4JIa5o185GGeft2qhCiKdKwSRQ2bvxaXmv+/BD1DP1YXl51hdF/I6MUMlAfn07SuHv39sOqVRvE/G3Qv3+Aegbwv//9Kq7xKMaPnyn3yfDpmrGxN2S0QkIUE3NN9hF03+j+0H0YMGCEEMveao9eUGgxl4SK5pGUlCKFg6CFXEVR5HmM9rBKBLIy8pCenIecVPHgpVHRIS9DMQlBrtjmpiMrLRYXL2VgYrArGno56k8ugbp1PeHo6KDuFeS++zyEAdipeybooaaHmdiwYasIrV+TYfasWdMQHX20QB7v4VFDikXLlg/IsJ5Kx47tZJurq4s8platmsa6ORQZkFclDhz4UUQJ43Hq1B8inB4ptgcLXRMgA05Pz5BGW61aVURFRcso5plnxogIpp+MBggy8qJYtWq+DP/Xr9+C7OxsYfBCb0t4TUtQmhEcPFRGKySCZOwkGObCxmgXq0QgU0QBacm5SE/MRXZKHnKlGAghoOiAhECkBrdTHRAd64rW9c+gae0bGNK/gVxMLIm//oqToXRR/P13vDCAgg8+hbnmnuzrr3dKT1izZnOROy8U2xrGPN4A5ckuLs544ok+slCd2pycnGQ/5fYUJueHcm4HB9O6AUUDPXs+JQSjEV555XVkZGSKXPwtmYMbIIOjtIjC9MTEJJmyUIRCi3e0MEjzsrGxQWRklHqGJevWLRXevZf4DJ+KdOIzKQLCecuIpzgoxaB1jd9/DxcRxRuyjcSSrmWeejDaxbpIIDMPqcL4qaSLkn07D3lmQpCWao+bt9zQtOZN2ClZsM2JQ9f2DsIISg434+JuSGOmvNacH374Wnp0Clvt7GzRuXN7tUcPeXR6uE+fPiuN6rff9sp2Mj5aHKMwnMLnpk0by3aC8vtz56JEhNBdFqpTmwHyzomJyXIdwdxgaG7Vq1eTBrt9+waxPYLHHuso+9at24SQkHWyTqmBARqL8u/hw4fg00+/FPNoJKKC4zId2bv3oBCPYCluO3fuV88wQYISFBSINWs+lesfBKUKlJKQqBggEaN0wBARDRzYG++8M13ek6CgF4ye/88/r4h74WYURIp2KL0wnMdoC6tFID01F6nC+FNFWkCpQZYaEaQkOiIr1QZeromwzVagI6ctHi7v2mmoXtXkPYti48Zt0mvRQ0+r1WR8FNLTYtbhwz+L+mJh4CdEGP2kbCdvSlva//nnYzICoJV6MkB67UX99JqNCnnPmzfj1Svp2bPngPTsVKhuDhnNtm07Zd/nn6+UYz75ZF+Z/9PawaZN2+Rc6tatLV8TUj8VyutJqEjQzKGFTkp3xowZgddemyO8cR0899wr6Nq1k0xVKI3JH6LPmzcTL700TArAm28uUFv1nDkTKd+iTJz4gjTogIDuMpKiNQt6M7Fy5XwhUBcwaNAoi3HDwyOk4QcHPyXvD70ZoIgi/zoMoxnoa8NlKwcWjFd+HNdJOTatoxIx6xEl+r0uStzqbkrshl5K8rYAJXNPDyXnsL+S+6u/opwQJcJfSTjRTenZ1UupXq2acl/NmsqI4cMLHZtKixaPKfv2HVREDi0cv6KIB1gRBqdUqdJE9tev76vs2BGqiFDd2L916w7ZTv103IoVHyvx8QmKyH0VkTcr0dExypQps2R/RMQ5Wah+//2dFeHRZaF6/n4qs2cvVq5f/1uOJYREEV5d6dWL/pdmff/rr89Vrl2Llf1UYmOvK4sXrzb2m5dOnfoqu3f/IOdMFDaeeaF5FMbHH2+W9+nIkd/kGHRd+ozDho2T51F/YRg+19q1nxvnkJSULO+X+XW5aKeIJJ0qZWPf7CDo/jwqcmcFLq42cHIRxdUOrm46OLvZwLGKDWxddLBxFpGASK91DkBCdi4CX7mAyEtp0uv06dMHn28sGPoyDFOxWJUOZIt0QHGqhTzXOshQ3JHtWAeZNh5Iy6uONNRGanoVZOZ4IDvDBZnZNZGVWwupGeKY3Crw8fFB3Xr1jF8vZhimcrEF3Gar9VLzdNe2qBk4DDdvZ8OpdTfEK1UB73awbxWIs1dvI9WlETK8+iEvIwNXXQIRm14XVxJqoEHzx1DfuzG6+fkh5s9onD59SR2RYZjKwqpIIBd2OJ/mgMRaLXDuSjxu1XwAl7JcEH41CQm12+FSZg2cPXcOh5MfwKkbOYjOqIorto1x9q9EuDRuDafGbeDu7q6OxjBMZWLVmkDUiT04/uVm+Q1AFydb5NkqsLO3gbOTDXKErLg528LR0Qa29jrYOQAxiTnYcyIRGVl58i8NnZ1dMHLUSLRr11cdkWGYysIqEWAY5t7BqnSAYZh7BxYBhtE4LAIMo3FYBBhG47AIMIzGYRFgGI3DIsAwGodFgGE0ji50Vyh/WYhhNIyO/p5crUvy7TIMU8HQ/w5VkVikAywADFP5VLQd8poAw2gcFgGG0TgsAgyjcVgEGEbjWLwd4IVB5l6HnvGMjAz5Gw+V+bzTj9fQj9wU9ibgRPgptPO1/N2N8oQjAUZTpKeny5+Qq2yHR3MgMboTYBFgNEVhP2FXWdwpc2ERYJhK4k5Jv1kEGEbjsAgwjMZhEWAYjcMiwDAah0WAYTQOiwDDaJxy+8bgmzOnq7XCmbfgPbXGMBVHUlKyWrszqFq14G9yVvQ3BstNBLKzs9VaQWa//abcDho8BA+17yDrDFMRsAgUpNLSgYFPDsb2b75W9xiGqSz+9UjA4+0eaq0gT7XpiRUDpuLbHd/g5InjaiunBkzFwZFAQSo0Evgq/Hu5fUJEAbPnzJOFYZjKpdxEIH5OGF73D5bb70a9r7YCsZlJCIkJw4wL3+BC2nW1lWHuHnaFhspyr1BuIpCckYoxnQbL7fjtpnA/9OZpHE44j5ScTIw7u0Vt/WfE75yIbj16qiUEEWq7nnCsNPZNxJ44tVlg7XnFoR8z//HmY/XEtJ0lDxaxzHR8t3G7EK+2G4nbhWmlHIswH8/ynDjsGVdUXzEUdf2TIcaxCt7Tux8y/tNnImS5V4Sg3ERg0aHP4O7kig9/+QYxiaYHpY6jO27nZCA2KwmpuZlq6z8hHFuiRuNw2PeybH/1IsYajYYe8GnAUn3f4aVNsPA5w4Np7XlFoTf0BQhAkNpiIH7nIfhsVscKW4IGy4dj5Um1szCEgR3w2Wic2xqfEAxaFq52qgY9F+gRqDaUAAnTWCwp9PrxO+djoY953/wSBa/o64t7MPUiZqifVd5Ts3nf7RgEoHWrlrLcK0JQbiLwevdgnIm7iOndR8C7mqfaCsy7FIp+9z2Iyd5FLyCWjTaYMNm0iOLRIQAdIi8KMxbEHUMYJuFZX9kF+A7FjGbCwKQBWHteUYjxxIO/pL+Xum/Co/8k9DHegjbwF8Zz+UoxluYZiAn9TfespZ84IeqKMRpoOVkY2epAeKv7xROH3/YCM54xfNY2ePbV5th2UG+ccVFnEeRn6vMPPIuoEkSgyOvHXcHlZgF4WJ26vKdm8y47hUcpFhEciYyMSixFmo4pdVRTCswFILBvX1nuFSEoFxF4tJEvQs8eQbc1L+GLE/uxapDpi0Oj6nXB7r9P4XjKFbXlX0YIz9HA7mhpqPt4wUN2EJ7w9inCAK09r8zEISaqOXp0MBl5ScRfuYgOvdubzacsXEdUZBN4m13Ow6uJUVQ8fUyCQJ78wK7m8Cn91Czx9EKDyP34Tb1N8Uf357uPZYEEYDjCehsioiWQbkOkG4P2BmC7bBOFhNyzPXpYiLRe+Mpyj4sjvwAYMBeC78PC1Na7j3IRgSPRJzFuxyJZp+2ADVNknRgtRGD/Q5MxSUQCRx6eobb+S5BHoHBU9XpkPPmhh74A1p5nBRHLhovwe7RZZFAC9NAvb4KRZpFBmSDvrFaNeDaB4StaHv1XYLvPetWzrhdpy4rSz60AFA2NRtRzei89iNIts2irTKjR2Ezj526DPlSnuRsiNiOeeLh3c5NIy3NNEck/xdHRsYAAGDAIwd3Mvy4C9DaAStxbewst5YUMEUWeOjPM9BBLj5cPCn/Nsfa8sqNfMzjgp3qvUiBz74PdhcebpI9QrIG8s1o1QpGOviLD7QV4Q/W2bwBzy7A4mB+5KHgI/gYv7XdI7Fu5OFggGlMRqdKSpcBYKVqmsSn1wN5jMrqJ2BqCBi8GWhmBFKRnjx6FCoAB6qNj7lbKbU2gIiFDlg+yyFML/MNb5KQUigMNvPTWbu15ZYcEQG8cEwzrDCVAAlAWwSiei4gxs2sZ6ZCBkceMDDSLMjzRRxjPUdWYykrEwV3o8OpQk2CVai2lGIpaT/CdpBcZEgPDYi6lBKBUhFKaQPiX8j4z94IIiFB+gcgRTWGjGfQQIgRbDA/hyS+x0LDgZ+15VhCxjN40lMGbC49Kq/mlFYzioYVAYOFWU96/Zbm6UFggl9YbshQIdb8s0AKmhYBIkVHXGCwW70gUDa9R9dGI/m2FWd23O4IiQ7DAGJWEY0/+CMUiNaCUAAjbegiXDWs7TKmotL8iNNC27UMIemqoumcFFIJOFQ9uPoKWql6XHr7nQtTwNxBrDKG1teeVCD3g5rm1foFrYaTsNNFsErYXFoEIKEIZtDx/+tEcM/Ll6xQtfOKzEUsKEzILLOdg/IwSmu80bFP3ELikTOlK/utbzt1szvJ+XsRIeR/N75F+blEv0pzM63S+5dzkvIU4m/7d8t0T9d+sgcXns4S/NlwQ/vERRlOwCBSERaBM5POaKpaetfQU6vGLiRCKxSJyMVAweigt5OXH5g+UyhAl3KmwCBSERYDRFCwCBbkn3g4wDGM9LAIMo3FYBBhG47AIMIzGYRFgGI3DIsAwlYROp1NrlQuLAKMp7O3t1Frlc6fMhUWA0RTOzs7S+CrbCzs42MPJyUndq1z4y0IMcwdSkSLFkQDDaBwWAYbROCwCDKNxWAQYRuNYiMCd8t6SYbRMxdoh8P+iDNBzmzMALwAAAABJRU5ErkJggg=="},7973:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_all_items-2c57aff19d3b1ce52149c37f50dcaad8c30baa0c9931fdc629f1d163bb56ce96.png"},2428:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_all_mouseover-f6646df5320045ee10d4c0a15d0349fed6ede075f9cea6f9e449b3785c4f4f8d.png"},9720:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/edit_temp1-7446e7c5b7869ccc9ddd467779fa86f44301a5e5896751b016a527587c483cb2.png"},9612:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table-2fc1bb4d03a2348c4af7df442e13cee2f310cf455228005d76cbfda7a706aa53.png"},9927:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table_raw-c4d454679c4503ec35710dcee6be5cd1940984595145b333d8604bc505dfe291.png"},2566:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/items_table_temp1-ea091eaf8005cea839800f4514f72f94e9664993111b935f33e7c5aa3061ca64.png"},2978:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/open_config-55ef2f241d02047b252bb8201742f99cffed5680d0e9eb46b3cb53a644ca3dc9.png"},5387:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/processing-b0c50908284739a76e1bbcfcb3eb34dc9446f8716117cb0e9089ad9df53ebed6.png"},2236:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/save_config-0ae36ac1f8114665f2558e936ba3b30e5cba2a16cc01d3494e14ed689b4637f7.png"},1896:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_item-f063106a8d836656496ba81e7e7428f51bd8ab95aebab0aa4eb6ad41ed42e026.png"},8935:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_packet-be9d63c49f898cccb73f9e4b2b39c4b5879cead34a8ab2ede0bb08e953498e95.png"},6389:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/select_target-71ebcab6cbefafd8958939130861a75f7544e99a043d90fa0734ec2f983d835f.png"},9984:(e,t,a)=>{a.d(t,{Z:()=>i});const i=a.p+"assets/images/time_chooser-e4ca0705d5b97c3056b0de3ab7f71f8091482b9b2e8904e69866a43ce4e616f2.png"}}]);

data/tools/docs/assets/js/5109.6a372217.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[5109],{5109:(e,t,n)=>{n.r(t),n.d(t,{default:()=>c});var a=n(2784),o=n(8004),l=n(5982),r=n(8659);function c(){return a.createElement(a.Fragment,null,a.createElement(l.d,{title:(0,o.I)({id:"theme.NotFound.title",message:"Page Not Found"})}),a.createElement(r.Z,null,a.createElement("main",{className:"container margin-vert--xl"},a.createElement("div",{className:"row"},a.createElement("div",{className:"col col--6 col--offset-3"},a.createElement("h1",{className:"hero__title"},a.createElement(o.Z,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),a.createElement("p",null,a.createElement(o.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),a.createElement("p",null,a.createElement(o.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"Please contact the owner of the site that linked you to the original URL and let them know their link is broken.")))))))}}}]);

data/tools/docs/assets/js/54d0d530.e9c8193b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7872],{4352:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var n=i(7896),o=(i(2784),i(876));const r={title:"Limits Monitor"},a=void 0,s={unversionedId:"tools/limits-monitor",id:"tools/limits-monitor",title:"Limits Monitor",description:"Introduction",source:"@site/docs/tools/limits-monitor.md",sourceDirName:"tools",slug:"/tools/limits-monitor",permalink:"/tools/docs/docs/tools/limits-monitor",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/tools/limits-monitor.md",tags:[],version:"current",frontMatter:{title:"Limits Monitor"},sidebar:"defaultSidebar",previous:{title:"Handbooks",permalink:"/tools/docs/docs/tools/handbooks"},next:{title:"Packet Viewer",permalink:"/tools/docs/docs/tools/packet-viewer"}},l={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Limits Monitor Menus",id:"limits-monitor-menus",level:2},{value:"File Menu Items",id:"file-menu-items",level:3},{value:"Limits Tab",id:"limits-tab",level:2},{value:"Log Tab",id:"log-tab",level:2}],d={toc:c},m="wrapper";function u(e){let{components:t,...r}=e;return(0,o.kt)(m,(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The Limits Monitor application provides situational awareness for all telemetry items with limits. All limits items which violate their yellow or red limits are shown and continue to be shown until explicity dismissed. Individual items and entire packets can be manually ignored to filter out known issues. In addition, all limits events are logged in a table which can be searched."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Cmd Tlm Server",src:i(6609).Z,width:"1706",height:"1034"})),(0,o.kt)("h2",{id:"limits-monitor-menus"},"Limits Monitor Menus"),(0,o.kt)("h3",{id:"file-menu-items"},"File Menu Items"),(0,o.kt)("p",null,"Limits Monitor has one menu under File -> Show Ignored:"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Ignored",src:i(8465).Z,width:"1064",height:"546"})),(0,o.kt)("p",null,"This dialog displays all the items which the user has manually ignored by clicking the ignore icons next to out of limits items. Note that entire Packets which have been ignored are listed as TARGET PACKET without an item (as shown by INST MECH). Ignored items are removed by clicking the Trash icon. This means that the next time this item goes out of limits it will be displayed."),(0,o.kt)("h2",{id:"limits-tab"},"Limits Tab"),(0,o.kt)("p",null,"The main interface of Limits Monitor is the Limits tab. This is where items are displayed when they violate a yellow or red limit."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Limits",src:i(6609).Z,width:"1706",height:"1034"})),(0,o.kt)("p",null,"Items with limits values are displayed using a red yellow green limits bar displaying where the current value lies within the defined limits (as shown by the various TEMP items). Items with yellow or red ",(0,o.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/telemetry#state"},"states")," are simply displayed with their state color (as shown by GROUND1STATUS). The COSMOS Demo contains both INST HEALTH_STATUS TEMP2 and INST2 HEALTH_STATUS TEMP2 which are identically named items within different target packets. Limits Monitor only displays the item name to save space, however if you mouse over the value box the full target and packet name is displayed."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Mouseover",src:i(7571).Z,width:"1712",height:"166"})),(0,o.kt)("p",null,"Clicking the first nested 'X' icon ignores the entire packet where the item resides. Any additional items in that packet which go out of limits are also ignored by Limits Monitor. Clicking the second (middle) 'X' ignores ONLY that specific item. If any packets or items are ignored the Overall Limits State is updated to indicate \"(Some items ignored)\" to indicate the Limits State is potentially being affected by ignored items."),(0,o.kt)("p",null,"Clicking the last icon (eye with strike-through) temporarily hides the specified item. This is different from ignoring an item because if this item goes out of limits it will be again be displayed. Hiding an item is useful if the item has gone back to green and you want to continue to track it but want to clean up the current list of items. For example, we might hide GROUND1STATUS and GROUND2STATUS in the above example as they have transitioned back to green."),(0,o.kt)("h2",{id:"log-tab"},"Log Tab"),(0,o.kt)("p",null,"The Log tab lists all limits events. Events can be filtered by using the Search box as shown."),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Log",src:i(43).Z,width:"1712",height:"1062"})))}u.isMDXComponent=!0},876:(e,t,i)=>{i.d(t,{Zo:()=>d,kt:()=>p});var n=i(2784);function o(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}function r(e,t){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),i.push.apply(i,n)}return i}function a(e){for(var t=1;t<arguments.length;t++){var i=null!=arguments[t]?arguments[t]:{};t%2?r(Object(i),!0).forEach((function(t){o(e,t,i[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(i)):r(Object(i)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(i,t))}))}return e}function s(e,t){if(null==e)return{};var i,n,o=function(e,t){if(null==e)return{};var i,n,o={},r=Object.keys(e);for(n=0;n<r.length;n++)i=r[n],t.indexOf(i)>=0||(o[i]=e[i]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)i=r[n],t.indexOf(i)>=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(o[i]=e[i])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),i=t;return e&&(i="function"==typeof e?e(t):a(a({},t),e)),i},d=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},m="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var i=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),m=c(i),h=o,p=m["".concat(l,".").concat(h)]||m[h]||u[h]||r;return i?n.createElement(p,a(a({ref:t},d),{},{components:i})):n.createElement(p,a({ref:t},d))}));function p(e,t){var i=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=i.length,a=new Array(r);a[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:o,a[1]=s;for(var c=2;c<r;c++)a[c]=i[c];return n.createElement.apply(null,a)}return n.createElement.apply(null,i)}h.displayName="MDXCreateElement"},8465:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/ignored-1e20d4ffe7fd88ffab610340957b1176294269f985e8fdb20a9af07d7a78215f.png"},6609:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/limits_monitor-c58d70daea7586b93d5069b9df068a90cea5f7cf2e51a445f3162bf3f66db3d0.png"},43:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/log-ba64fd307e53adafae55fcea7eb31829ee1aacdf4aafe8b40b270b793be3aa27.png"},7571:(e,t,i)=>{i.d(t,{Z:()=>n});const n=i.p+"assets/images/mouseover-95b774047b3c2ca23a3bc645caf75d90511c378729dd9cfb781510a1452e09fe.png"}}]);

data/tools/docs/assets/js/5bc719f6.fce76244.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[1402],{2430:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>i,toc:()=>c});var n=a(7896),o=(a(2784),a(876));const r={sidebar_position:5,title:"Podman"},s=void 0,i={unversionedId:"getting-started/podman",id:"getting-started/podman",title:"Podman",description:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",source:"@site/docs/getting-started/podman.md",sourceDirName:"getting-started",slug:"/getting-started/podman",permalink:"/tools/docs/docs/getting-started/podman",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/podman.md",tags:[],version:"current",sidebarPosition:5,frontMatter:{sidebar_position:5,title:"Podman"},sidebar:"defaultSidebar",previous:{title:"Requirements and Design",permalink:"/tools/docs/docs/getting-started/requirements"},next:{title:"Configuration",permalink:"/tools/docs/docs/configuration"}},l={},c=[{value:"OpenC3 COSMOS Using Rootless Podman and Docker-Compose",id:"openc3-cosmos-using-rootless-podman-and-docker-compose",level:3},{value:"MacOS Instructions",id:"macos-instructions",level:2}],p={toc:c},m="wrapper";function d(e){let{components:t,...a}=e;return(0,o.kt)(m,(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h3",{id:"openc3-cosmos-using-rootless-podman-and-docker-compose"},"OpenC3 COSMOS Using Rootless Podman and Docker-Compose"),(0,o.kt)("admonition",{title:"Optional Installation Option",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"These directions are for installing and running COSMOS using Podman instead of Docker. If you have Docker available, that is a simpler method.")),(0,o.kt)("p",null,"Podman is an alternative container technology to Docker that is actively promoted by RedHat. The key benefit is that Podman can run without a root-level daemon service, making it significantly more secure by design, over standard Docker. However, it is a little more complicated to use. These directions will get you up and running with Podman. The following directions have been tested against RHEL 8.8, and RHEL 9.2, but should be similar on other operating systems."),(0,o.kt)("admonition",{title:"Rootless Podman Does Not Work (Directly) with NFS Home Directories",type:"caution"},(0,o.kt)("p",{parentName:"admonition"},"NFS does not work for holding container storage due to issues with user ids and group ids. There are workarounds available but they all involve moving container storage to another location: either a different partition on the host local disk, or into a special mounted disk image. See: ","[https://www.redhat.com/sysadmin/rootless-podman-nfs]",(0,o.kt)("a",{parentName:"p",href:"https://www.redhat.com/sysadmin/rootless-podman-nfs"},"https://www.redhat.com/sysadmin/rootless-podman-nfs"),"). Note that there is also a newish Podman setting that allows you to more easily change where the storage location is in /etc/containers/storage.conf called rootless_storage_path. See ",(0,o.kt)("a",{parentName:"p",href:"https://www.redhat.com/sysadmin/nfs-rootless-podman"},"https://www.redhat.com/sysadmin/nfs-rootless-podman"))),(0,o.kt)("h1",{id:"redhat-88-and-92-instructions"},"Redhat 8.8 and 9.2 Instructions"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Install Prerequisite Packages"),(0,o.kt)("p",{parentName:"li"},"Note: This downloads and installs docker-compose from the latest 2.x release on Github. If your operating system has a docker-compose package, it will be easier to install using that instead. RHEL8 does not have a docker-compose package."),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"sudo yum update\nsudo yum install git podman-docker netavark\ncurl -SL https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-linux-x86_64 -o docker-compose\nsudo mv docker-compose /usr/local/bin/docker-compose\nsudo chmod +x /usr/local/bin/docker-compose\nsudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Configure Host OS for Redis"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"sudo su\necho never > /sys/kernel/mm/transparent_hugepage/enabled\necho never > /sys/kernel/mm/transparent_hugepage/defrag\nsysctl -w vm.max_map_count=262144\nexit\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Configure Podman to use Netavark for DNS"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"sudo cp /usr/share/containers/containers.conf /etc/containers/.\nsudo vi /etc/containers/containers.conf\n")),(0,o.kt)("p",{parentName:"li"},'Then edit the network_backend line to be "netavark" instead of "cni"')),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Start rootless podman socket service"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"systemctl enable --now --user podman.socket\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Put the following into your .bashrc file (or .bash_profile or whatever)"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},'export DOCKER_HOST="unix://$XDG_RUNTIME_DIR/podman/podman.sock"\n'))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Source the profile file for your current terminal"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"source .bashrc\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Get COSMOS - A release or the current main branch (main branch shown)"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/OpenC3/cosmos.git\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Optional - Set Default Container Registry"),(0,o.kt)("p",{parentName:"li"},"If you don't want podman to keep querying you for which registry to use, you can create a $HOME/.config/containers/registries.conf and modify to just have the main docker registry (or modify the /etc/containers/registries.conf file directly)"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"mkdir -p $HOME/.config/containers\ncp /etc/containers/registries.conf $HOME/.config/containers/.\nvi $HOME/.config/containers/registries.conf\n")),(0,o.kt)("p",{parentName:"li"},"Then edit the unqualified-search-registries = line to just have the registry you care about (probably docker.io)")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Edit cosmos/compose.yaml"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"cd cosmos\nvi compose.yaml\n")),(0,o.kt)("p",{parentName:"li"},'Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: "${OPENC3_USER_ID}:${OPENC3_GROUP_ID}" lines.\nYou may also want to update the traefik configuration to allow access from the internet by removing 127.0.0.1 and probably switching to either an SSL config file, or the allow http one. Also make sure your firewall allows\nwhatever port you choose to use in. Rootless podman will need to use a higher numbered port (not 1-1023).')),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Run COSMOS"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"./openc3.sh run\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Wait until everything is built and running and then goto http://localhost:2900 in your browser"))),(0,o.kt)("admonition",{title:"Podman on MacOS",type:"info"},(0,o.kt)("p",{parentName:"admonition"},"Podman can also be used on MacOS, though we still generally recommend Docker Desktop")),(0,o.kt)("h2",{id:"macos-instructions"},"MacOS Instructions"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Install podman"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"brew install podman\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Start the podman virtual machine"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"podman machine init\npodman machine start\n# Note: update to your username in the next line or copy paste from what 'podman machine start' says\nexport DOCKER_HOST='unix:///Users/ryanmelt/.local/share/containers/podman/machine/qemu/podman.sock'\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Install docker-compose"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"brew install docker-compose # Optional if you already have Docker Desktop\n"))),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Edit cosmos/compose.yaml"),(0,o.kt)("p",{parentName:"li"},'Edit compose.yaml and uncomment the user: 0:0 lines and comment the user: "${OPENC3_USER_ID}:${OPENC3_GROUP_ID}" lines.'),(0,o.kt)("p",{parentName:"li"},"Important: on MacOS you must also remove all :z from the volume mount lines"),(0,o.kt)("p",{parentName:"li"},"You may also want to update the traefik configuration to allow access from the internet.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("p",{parentName:"li"},"Run COSMOS"),(0,o.kt)("pre",{parentName:"li"},(0,o.kt)("code",{parentName:"pre",className:"language-bash"},"cd cosmos\n./openc3.sh run\n")))))}d.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>h});var n=a(2784);function o(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?r(Object(a),!0).forEach((function(t){o(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):r(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function i(e,t){if(null==e)return{};var a,n,o=function(e,t){if(null==e)return{};var a,n,o={},r=Object.keys(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||(o[a]=e[a]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n<r.length;n++)a=r[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(o[a]=e[a])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,o=e.mdxType,r=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),m=c(a),u=o,h=m["".concat(l,".").concat(u)]||m[u]||d[u]||r;return a?n.createElement(h,s(s({ref:t},p),{},{components:a})):n.createElement(h,s({ref:t},p))}));function h(e,t){var a=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=a.length,s=new Array(r);s[0]=u;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[m]="string"==typeof e?e:o,s[1]=i;for(var c=2;c<r;c++)s[c]=a[c];return n.createElement.apply(null,s)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/5c6ce5ec.f909714f.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[9366],{1624:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=n(7896),r=(n(2784),n(876));const i={title:"Streaming API"},o=void 0,s={unversionedId:"development/streaming-api",id:"development/streaming-api",title:"Streaming API",description:"This information is just generally used behind the scenes in COSMOS tools",source:"@site/docs/development/streaming-api.md",sourceDirName:"development",slug:"/development/streaming-api",permalink:"/tools/docs/docs/development/streaming-api",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/development/streaming-api.md",tags:[],version:"current",frontMatter:{title:"Streaming API"},sidebar:"defaultSidebar",previous:{title:"Roadmap",permalink:"/tools/docs/docs/development/roadmap"},next:{title:"Testing COSMOS",permalink:"/tools/docs/docs/development/testing"}},c={},l=[],p={toc:l},d="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(d,(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("admonition",{title:"This documentation is for COSMOS Developers",type:"note"},(0,r.kt)("p",{parentName:"admonition"},"This information is just generally used behind the scenes in COSMOS tools")),(0,r.kt)("p",null,"The COSMOS 5 Streaming Api is the primary interface to receive a stream of the telemetry packets and/or command packets that have passed through the COSMOS system, both logged and continuously in realtime. Either raw binary packets or decommutated JSON packets can be requested."),(0,r.kt)("p",null,"This API is implemented over Websockets using the Rails ActionCable framework. Actioncable client libraries are known to exist for at least Javascript, Ruby, and Python. Other languages may exist or could be created. Websockets allow for easy interaction with the new COSMOS 5 Javascript based frontend."),(0,r.kt)("p",null,"The following interactions are all shown in Javascript, but would be very similar in any language.\nConnecting to this API begins by initiating an ActionCable connection."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"cable = ActionCable.createConsumer('/openc3-api/cable')\n")),(0,r.kt)("p",null,"This call opens the HTTP connection to the given URL and upgrades it to a websocket connection. This connection can then be shared with multiple \u201csubscriptions\u201d."),(0,r.kt)("p",null,"A subscription describes a set of data that you want the API to stream to you. Creating a subscription looks like this:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'subscription = cable.subscriptions.create(\n  {\n    channel: "StreamingChannel",\n    scope: "DEFAULT",\n    token: token,\n  },\n  {\n    received: (data) => {\n      // Handle received data\n    },\n    connected: () => {\n      // First chance to add what you want to stream here\n    },\n    disconnected: () => {\n      // Handle the subscription being disconnected\n    },\n    rejected: () => {\n      // Handle the subscription being rejected\n    },\n  }\n);\n')),(0,r.kt)("p",null,"Subscribing to the StreamingApi requires passing a channel name set to \u201cStreamingChannel\u201d, a scope which is typically \u201cDEFAULT\u201d, and an access token (a password in OpenSource COSMOS). In Javascript you also pass a set of callback functions that run at various lifecycle points in the subscription. The most important of these are ",(0,r.kt)("inlineCode",{parentName:"p"},"connected")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"received"),"."),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"connected")," runs when the subscription is accepted by the StreamApi. This callback is the first opportunity to request specific data that you would like streamed. Data can also be added or removed at any time while the subscription is open."),(0,r.kt)("p",null,"Data can be added to the stream by requesting individual items from a packet or by requesting the entire packet."),(0,r.kt)("p",null,"Adding items to stream is done as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'var items = [\n  ["DECOM__TLM__INST__ADCS__Q1__RAW", "0"],\n  ["DECOM__CMD__INST__COLLECT__DURATION__WITH_UNITS", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n  this.subscription.perform("add", {\n    scope: window.openc3Scope,\n    token: localStorage.openc3Token,\n    items: items,\n    start_time: this.startDateTime,\n    end_time: this.endDateTime,\n  });\n});\n')),(0,r.kt)("p",null,"The values in the item name are separated by double underscores, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<ITEM NAME>__<VALUE TYPE>__<REDUCED TYPE>"),". Mode is either RAW, DECOM, REDUCED_MINUTE, REDUCED_HOUR, or REDUCED_DAY. The next parameter is CMD or TLM followed by the target, packet and item names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS. The last parameter is optional if you want to use the reduced data types. Reduced Type is one of SAMPLE, MIN, MAX, AVG, or STDDEV."),(0,r.kt)("p",null,"Adding packets to stream is done as follows:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'var packets = [\n  ["RAW__TLM__INST__ADCS", "0"],\n  ["DECOM__TLM__INST__HEALTH_STATUS__FORMATTED", "1"],\n];\nOpenC3Auth.updateToken(OpenC3Auth.defaultMinValidity).then(() => {\n  this.subscription.perform("add", {\n    scope: window.openc3Scope,\n    token: localStorage.openc3Token,\n    packets: packets,\n    start_time: this.startDateTime,\n    end_time: this.endDateTime,\n  });\n});\n')),(0,r.kt)("p",null,"The values in the packet name are separated by double underscores, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"<MODE>__<CMD or TLM>__<TARGET NAME>__<PACKET NAME>__<VALUE TYPE>"),". Mode is either RAW or DECOM. The next parameter is CMD or TLM followed by the target and packet names. The Value Type is one of RAW, CONVERTED, FORMATTED, or WITH_UNITS."),(0,r.kt)("p",null,"For Raw mode, VALUE TYPE should be set to RAW or omitted (e.g. TLM","_","_","INST","_","_","ADCS","_","_","RAW or TLM","_","_","INST","_","_","ADCS).\nstart_time and end_time are standard COSMOS 64-bit integer timestamps in nanoseconds since the Unix Epoch (midnight January 1st, 1970). If start_time is null, that indicates to start streaming from the current time in realtime, indefinitely until items are removed, or the subscription is unsubscribed. end_time is ignored if start_time is null. If start_time is given and end_time is null, that indicates to playback from the given starttime and then continue indefinitely in realtime. If both start_time and end_time are given, then that indicates a temporary playback of historical data."),(0,r.kt)("p",null,"Data returned by the streaming API is handled by the received callback in Javascript. Data is returned as a JSON Array, with a JSON object in the array for each packet returned. Results are batched, and the current implementation will return up to 100 packets in each batch (the array will have 100 entries). 100 packets per batch is not guaranteed, and batches may take on varying sizes based on the size of the data returned, or other factors. An empty array indicates that all data has been sent for a purely historical query and can be used as an end of data indicator."),(0,r.kt)("p",null,"For decommutated items, each packet is represented as a JSON object with a 'time' field holding the COSMOS nanosecond timestamp of the packet, and then each of the requested item keys with their corresponding value from the packet."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'[\n  {\n    "time": 1234657585858,\n    "TLM__INST__ADCS__Q1__RAW": 50.0,\n    "TLM__INST__ADCS__Q2__RAW": 100.0\n  },\n  {\n    "time": 1234657585859,\n    "TLM__INST__ADCS__Q1__RAW": 60.0,\n    "TLM__INST__ADCS__Q2__RAW": 110.0\n  }\n]\n')),(0,r.kt)("p",null,"For raw packets, each packet is represented as a JSON object with a time field holding the COSMOS nanosecond timestamp of the packet, a packet field holding the topic the packet was read from in the form of SCOPE","_","_","TELEMETRY","_","_","TARGETNAME","_","_","PACKETNAME, and a buffer field holding a BASE64 encoded copy of the packet data."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-json"},'[\n  {\n    "time": 1234657585858,\n    "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n    "buffer": "SkdfjGodkdfjdfoekfsg"\n  },\n  {\n    "time": 1234657585859,\n    "packet": "DEFAULT__TELEMETRY__INST__ADCS",\n    "buffer": "3i5n49dmnfg9fl32k3"\n  }\n]\n')))}m.isMDXComponent=!0},876:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var a=n(2784);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),l=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=l(n),u=r,h=d["".concat(c,".").concat(u)]||d[u]||m[u]||i;return n?a.createElement(h,o(o({ref:t},p),{},{components:n})):a.createElement(h,o({ref:t},p))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,o=new Array(i);o[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,o[1]=s;for(var l=2;l<i;l++)o[l]=n[l];return a.createElement.apply(null,o)}return a.createElement.apply(null,n)}u.displayName="MDXCreateElement"}}]);

data/tools/docs/assets/js/5e3ed378.cdfe0362.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[7052],{1931:(e,t,a)=>{a.r(t),a.d(t,{default:()=>d});var l=a(2784),c=a(6277),n=a(5982),r=a(5138),m=a(8659),o=a(7133),s=a(7545);const i={mdxPageWrapper:"mdxPageWrapper_SLvB"};function d(e){const{content:t}=e,{metadata:{title:a,description:d,frontMatter:p}}=t,{wrapperClassName:_,hide_table_of_contents:g}=p;return l.createElement(n.FG,{className:(0,c.Z)(_??r.k.wrapper.mdxPages,r.k.page.mdxPage)},l.createElement(n.d,{title:a,description:d}),l.createElement(m.Z,null,l.createElement("main",{className:"container container--fluid margin-vert--lg"},l.createElement("div",{className:(0,c.Z)("row",i.mdxPageWrapper)},l.createElement("div",{className:(0,c.Z)("col",!g&&"col--8")},l.createElement("article",null,l.createElement(o.Z,null,l.createElement(t,null)))),!g&&t.toc.length>0&&l.createElement("div",{className:"col col--2"},l.createElement(s.Z,{toc:t.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level}))))))}}}]);

data/tools/docs/assets/js/5fe211ef.809c3f96.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_openc3_com=self.webpackChunkdocs_openc3_com||[]).push([[4697],{4008:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>u});var n=a(7896),r=(a(2784),a(876));const l={sidebar_position:8,title:"Tables"},i=void 0,o={unversionedId:"configuration/table",id:"configuration/table",title:"Tables",description:"Table Definition Files",source:"@site/docs/configuration/table.md",sourceDirName:"configuration",slug:"/configuration/table",permalink:"/tools/docs/docs/configuration/table",draft:!1,editUrl:"https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/configuration/table.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,title:"Tables"},sidebar:"defaultSidebar",previous:{title:"Protocols",permalink:"/tools/docs/docs/configuration/protocols"},next:{title:"Screens",permalink:"/tools/docs/docs/configuration/telemetry-screens"}},s={},u=[{value:"Table Definition Files",id:"table-definition-files",level:2},{value:"TABLEFILE",id:"tablefile",level:2},{value:"TABLE",id:"table",level:2},{value:"TABLE Modifiers",id:"table-modifiers",level:2},{value:"PARAMETER",id:"parameter",level:3},{value:"PARAMETER Modifiers",id:"parameter-modifiers",level:3},{value:"FORMAT_STRING",id:"format_string",level:4},{value:"UNITS",id:"units",level:4},{value:"DESCRIPTION",id:"description",level:4},{value:"META",id:"meta",level:4},{value:"OVERLAP",id:"overlap",level:4},{value:"KEY",id:"key",level:4},{value:"REQUIRED",id:"required",level:4},{value:"MINIMUM_VALUE",id:"minimum_value",level:4},{value:"MAXIMUM_VALUE",id:"maximum_value",level:4},{value:"DEFAULT_VALUE",id:"default_value",level:4},{value:"STATE",id:"state",level:4},{value:"WRITE_CONVERSION",id:"write_conversion",level:4},{value:"POLY_WRITE_CONVERSION",id:"poly_write_conversion",level:4},{value:"SEG_POLY_WRITE_CONVERSION",id:"seg_poly_write_conversion",level:4},{value:"GENERIC_WRITE_CONVERSION_START",id:"generic_write_conversion_start",level:4},{value:"GENERIC_WRITE_CONVERSION_END",id:"generic_write_conversion_end",level:4},{value:"OVERFLOW",id:"overflow",level:4},{value:"HIDDEN",id:"hidden",level:4},{value:"UNEDITABLE",id:"uneditable",level:4},{value:"APPEND_PARAMETER",id:"append_parameter",level:3},{value:"SELECT_TABLE",id:"select_table",level:2},{value:"DEFAULT",id:"default",level:2},{value:"Example File",id:"example-file",level:2}],p={toc:u},d="wrapper";function m(e){let{components:t,...a}=e;return(0,r.kt)(d,(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"table-definition-files"},"Table Definition Files"),(0,r.kt)("p",null,"Table definition files define the binary tables that can be displayed in COSMOS ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/tools/table-manager"},"Table Manager"),"\n. Table definitions are defined in the target's tables/config directory and are typically named after the table such as ",(0,r.kt)("inlineCode",{parentName:"p"},"PPSSelectionTable_def.txt"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"_def.txt")," extention helps to identify the file as a table definition. Table definitions can be combined using the ",(0,r.kt)("inlineCode",{parentName:"p"},"TABLEFILE")," keyword. This allows you to build individual table components into a larger binary."),(0,r.kt)("p",null,"The Table definition files share a lot of similarity with the ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/configuration/command"},"Command Configuration"),". You have the same data types: INT, UINT, FLOAT, STRING, BLOCK. These correspond to integers, unsigned integers, floating point numbers, strings and binary blocks of data."),(0,r.kt)("div",{style:{clear:"both"}}),(0,r.kt)("h1",{id:"table-keywords"},"Table Keywords"),(0,r.kt)("h2",{id:"tablefile"},"TABLEFILE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Specify another file to open and process for table definitions")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"File Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the file. The file will be looked for in the directory of the current definition file."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"table"},"TABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Start a new table definition")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the table in quotes. The name will appear on the GUI tab."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Endianness"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates if the data in this table is in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Display"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates the table contains KEY_VALUE rows (e.g. each row is unique), or a ROW_COLUMN table with identical rows containing different values.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"KEY_VALUE, ROW_COLUMN")),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"When Display is KEY_VALUE the remaining parameters are:"),(0,r.kt)("p",null,"| Description | Description of the table in quotes. The description is used in mouseover popups and status line information. | False |"),(0,r.kt)("p",null,"When Display is ROW_COLUMN the remaining parameters are:"),(0,r.kt)("p",null,"| Rows | The number of rows in the table | False |\n| Description | Description of the table in quotes. The description is used in mouseover popups and status line information. | False |"),(0,r.kt)("h2",{id:"table-modifiers"},"TABLE Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a TABLE keyword."),(0,r.kt)("h3",{id:"parameter"},"PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a parameter in the current table")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the table."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Offset"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit offset into the table of the Most Significant Bit of this parameter. May be negative to indicate on offset from the end of the table. Always use a bit offset of 0 for derived parameters."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("h3",{id:"parameter-modifiers"},"PARAMETER Modifiers"),(0,r.kt)("p",null,"The following keywords must follow a PARAMETER keyword."),(0,r.kt)("h4",{id:"format_string"},"FORMAT_STRING"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds printf style formatting")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Format"),(0,r.kt)("td",{parentName:"tr",align:null},"How to format using printf syntax. For example, '0x%0X' will display the value in hex."),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'FORMAT_STRING "0x%0X"\n')),(0,r.kt)("h4",{id:"units"},"UNITS"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Add displayed units")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Full Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Full name of the units type, e.g. Celsius"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviated"),(0,r.kt)("td",{parentName:"tr",align:null},"Abbreviation for the units, e.g. C"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"UNITS Celsius C\nUNITS Kilometers KM\n")),(0,r.kt)("h4",{id:"description"},"DESCRIPTION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined description")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new description"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"meta"},"META"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Stores custom user metadata")),(0,r.kt)("p",null,"Meta data is user specific data that can be used by custom tools for various purposes. One example is to store additional information needed to generate source code header files."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the metadata to store"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Meta Values"),(0,r.kt)("td",{parentName:"tr",align:null},"One or more values to be stored for this Meta Name"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'META TEST "This parameter is for test purposes only"\n')),(0,r.kt)("h4",{id:"overlap"},"OVERLAP"),(0,r.kt)("div",{class:"right"},"(Since 4.4.1)"),"**This item is allowed to overlap other items in the packet**",(0,r.kt)("p",null,"If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly allows an item to overlap another and supresses the warning message."),(0,r.kt)("h4",{id:"key"},"KEY"),(0,r.kt)("div",{class:"right"},"(Since 5.0.10)"),"**Defines the key used to access this raw value in the packet.**",(0,r.kt)("p",null,"Keys are often JsonPath or XPath strings"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key string"),(0,r.kt)("td",{parentName:"tr",align:null},"The key to access this item"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"KEY $.book.title\n")),(0,r.kt)("h4",{id:"required"},"REQUIRED"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Parameter is required to be populated in scripts")),(0,r.kt)("p",null,"When sending the command via Script Runner a value must always be given for the current command parameter. This prevents the user from relying on a default value. Note that this does not affect Command Sender which will still populate the field with the default value provided in the PARAMETER definition."),(0,r.kt)("h4",{id:"minimum_value"},"MINIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined minimum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new minimum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"maximum_value"},"MAXIMUM_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined maximum value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new maximum value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"default_value"},"DEFAULT_VALUE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Override the defined default value")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The new default value for the parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h4",{id:"state"},"STATE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a key/value pair for the current command parameter")),(0,r.kt)("p",null,"Key value pairs allow for user friendly strings. For example, you might define states for ON = 1 and OFF = 0. This allows the word ON to be used rather than the number 1 when sending the command parameter and allows for much greater clarity and less chance for user error."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Key"),(0,r.kt)("td",{parentName:"tr",align:null},"The string state name"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Value"),(0,r.kt)("td",{parentName:"tr",align:null},"The numerical state value"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous / Disable Messages"),(0,r.kt)("td",{parentName:"tr",align:null},"Indicates the state is hazardous. This will cause a popup to ask for user confirmation when sending this command. For non-hazardous states you can also set DISABLE_MESSAGES which will not print the command when using that state.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"HAZARDOUS")),(0,r.kt)("td",{parentName:"tr",align:null},"False")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Hazardous Description"),(0,r.kt)("td",{parentName:"tr",align:null},"String describing why this state is hazardous"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'APPEND_PARAMETER ENABLE 32 UINT 0 1 0 "Enable setting"\n  STATE FALSE 0\n  STATE TRUE 1\nAPPEND_PARAMETER STRING 1024 STRING "NOOP" "String parameter"\n  STATE "NOOP" "NOOP" DISABLE_MESSAGES\n  STATE "ARM LASER" "ARM LASER" HAZARDOUS "Arming the laser is an eye safety hazard"\n  STATE "FIRE LASER" "FIRE LASER" HAZARDOUS "WARNING! Laser will be fired!"\n')),(0,r.kt)("h4",{id:"write_conversion"},"WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Applies a conversion when writing the current command parameter")),(0,r.kt)("p",null,"Conversions are implemented in a custom Ruby file which should be located in the target's lib folder and required by the target's target.txt file (see REQUIRE). The class must require 'openc3/conversions/conversion' and inherit from Conversion. It must implement the initialize method if it takes extra parameters and must always implement the call method. The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Class Filename"),(0,r.kt)("td",{parentName:"tr",align:null},"The filename which contains the Ruby class. The filename must be named after the class such that the class is a CamelCase version of the underscored filename. For example, 'the_great_conversion.rb' should contain 'class TheGreatConversion'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional parameter values for the conversion which are passed to the class constructor."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"WRITE_CONVERSION the_great_conversion.rb 1000\n\nDefined in the_great_conversion.rb:\n\nrequire 'openc3/conversions/conversion'\nmodule OpenC3\n  class TheGreatConversion < Conversion\n    def initialize(multiplier)\n      super()\n      @multiplier = multiplier.to_f\n    end\n    def call(value, packet, buffer)\n      return value * multiplier\n    end\n  end\nend\n")),(0,r.kt)("h4",{id:"poly_write_conversion"},"POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"The conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"POLY_WRITE_CONVERSION 10 0.5 0.25\n")),(0,r.kt)("h4",{id:"seg_poly_write_conversion"},"SEG_POLY_WRITE_CONVERSION"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Adds a segmented polynomial conversion factor to the current command parameter")),(0,r.kt)("p",null,"This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Lower Bound"),(0,r.kt)("td",{parentName:"tr",align:null},"Defines the lower bound of the range of values that this segmented polynomial applies to. Is ignored for the segment with the smallest lower bound."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"C0"),(0,r.kt)("td",{parentName:"tr",align:null},"Coefficient"),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Cx"),(0,r.kt)("td",{parentName:"tr",align:null},"Additional coefficient values for the conversion. Any order polynomial conversion may be used so the value of 'x' will vary with the order of the polynomial. Note that larger order polynomials take longer to process than shorter order polynomials, but are sometimes more accurate."),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"SEG_POLY_WRITE_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50\nSEG_POLY_WRITE_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100\nSEG_POLY_WRITE_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100\n")),(0,r.kt)("h4",{id:"generic_write_conversion_start"},"GENERIC_WRITE_CONVERSION_START"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Start a generic write conversion")),(0,r.kt)("p",null,"Adds a generic conversion function to the current command parameter. This conversion factor is applied to the value entered by the user before it is written into the binary command packet and sent. The conversion is specified as ruby code that receives two implied parameters. 'value' which is the raw value being written and 'packet' which is a reference to the command packet class (Note, referencing the packet as 'myself' is still supported for backwards compatibility). The last line of ruby code given should return the converted value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of ruby code for the conversion have been given."),(0,r.kt)("div",{class:"note info"}," ",(0,r.kt)("h5",null,"Multiple write conversions on command parameters")," ",(0,r.kt)("p",null,"When a command is built, each item gets written (and write conversions are run) to set the default value. Then items are written (again write conversions are run) with user provided values. Thus write conversions can be run twice. Also there are no guarantees which parameters have already been written. The packet itself has a given_values() method which can be used to retrieve a hash of the user provided values to the command. That can be used to check parameter values passed in.")," "),(0,r.kt)("div",{class:"note warning"},(0,r.kt)("p",null,"Generic conversions are not a good long term solution. Consider creating a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier to debug and higher performance.")),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0\n  GENERIC_WRITE_CONVERSION_START\n    (value * 1.5).to_i # Convert the value by a scale factor\n  GENERIC_WRITE_CONVERSION_END\n")),(0,r.kt)("h4",{id:"generic_write_conversion_end"},"GENERIC_WRITE_CONVERSION_END"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Complete a generic write conversion")),(0,r.kt)("h4",{id:"overflow"},"OVERFLOW"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Set the behavior when writing a value overflows the type")),(0,r.kt)("p",null,"By default OpenC3 throws an error if you try to write a value which overflows its specified type, e.g. writing 255 to a 8 bit signed value. Setting the overflow behavior also allows for OpenC3 to 'TRUNCATE' the value by eliminating any high order bits. You can also set 'SATURATE' which causes OpenC3 to replace the value with the maximum or minimum allowable value for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for a maximum hex value to be writen, e.g. you can successfully write 255 to a 8 bit signed value."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Behavior"),(0,r.kt)("td",{parentName:"tr",align:null},"How OpenC3 treats an overflow value. Only applies to signed and unsigned integer data types.",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"ERROR, ERROR_ALLOW_HEX, TRUNCATE, SATURATE")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"Example Usage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"OVERFLOW TRUNCATE\n")),(0,r.kt)("h4",{id:"hidden"},"HIDDEN"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Indicates that the parameter should not be shown to the user in the Table Manager GUI")),(0,r.kt)("p",null,"Hidden parameters still exist and will be saved to the resulting binary. This is useful for padding and other essential but non-user editable fields."),(0,r.kt)("h4",{id:"uneditable"},"UNEDITABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Indicates that the parameter should be shown to the user but not editable.")),(0,r.kt)("p",null,"Uneditable parameters are useful for control fields which the user may be interested in but should not be able to edit."),(0,r.kt)("h3",{id:"append_parameter"},"APPEND_PARAMETER"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Defines a parameter in the current table")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Name"),(0,r.kt)("td",{parentName:"tr",align:null},"Name of the parameter. Must be unique within the table."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Bit Size"),(0,r.kt)("td",{parentName:"tr",align:null},"Bit size of this parameter. Zero or Negative values may be used to indicate that a string fills the packet up to the offset from the end of the packet specified by this value. If Bit Offset is 0 and Bit Size is 0 then this is a derived parameter and the Data Type must be set to 'DERIVED'."),(0,r.kt)("td",{parentName:"tr",align:null},"True")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Data Type"),(0,r.kt)("td",{parentName:"tr",align:null},"Data Type of this parameter",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"INT, UINT, FLOAT, DERIVED, STRING, BLOCK")),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("p",null,"When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:"),(0,r.kt)("p",null,"| Minimum Value | Minimum allowed value for this parameter | True |\n| Maximum Value | Maximum allowed value for this parameter | True |\n| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on ",(0,r.kt)("a",{parentName:"p",href:"/tools/docs/docs/guides/little-endian-bitfields"},"Little Endian Bitfields"),".",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("p",null,"When Data Type is STRING, BLOCK the remaining parameters are:"),(0,r.kt)("p",null,"| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True |\n| Description | Description for this parameter which must be enclosed with quotes | False |\n| Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format",(0,r.kt)("br",null),(0,r.kt)("br",null),"Valid Values: ",(0,r.kt)("span",{class:"values"},"BIG_ENDIAN, LITTLE_ENDIAN")," | False |"),(0,r.kt)("h2",{id:"select_table"},"SELECT_TABLE"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Select an existing table for editing, typically done to override an existing definition")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Table"),(0,r.kt)("td",{parentName:"tr",align:null},"The name of the existin table"),(0,r.kt)("td",{parentName:"tr",align:null},"True")))),(0,r.kt)("h2",{id:"default"},"DEFAULT"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Specify default values for a SINGLE row in a multi-column table")),(0,r.kt)("p",null,"If you have multiple rows you need a DEFAULT line for each row. If all your rows are identical consider using ERB as shown in the OpenC3 demo."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Parameter"),(0,r.kt)("th",{parentName:"tr",align:null},"Description"),(0,r.kt)("th",{parentName:"tr",align:null},"Required"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},"Default values"),(0,r.kt)("td",{parentName:"tr",align:null},"A STATE value or data value corresponding to the data type"),(0,r.kt)("td",{parentName:"tr",align:null},"False")))),(0,r.kt)("h2",{id:"example-file"},"Example File"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Example File: TARGET/tables/config/MCConfigurationTable_def.txt")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},'TABLE "MC_Configuration" BIG_ENDIAN KEY_VALUE "Memory Control Configuration Table"\n  APPEND_PARAMETER "Scrub_Region_1_Start_Addr" 32 UINT 0 0x03FFFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_1_End_Addr" 32 UINT 0 0x03FFFFFF 0x03FFFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_Start_Addr" 32 UINT 0 0x03FFFFB 0\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Scrub_Region_2_End_Addr" 32 UINT 0 0x03FFFFF 0x03FFFFF\n    FORMAT_STRING "0x%0X"\n  APPEND_PARAMETER "Dump_Packet_Throttle_(sec)" 32 UINT 0 0x0FFFFFFFF 2 "Number of seconds to wait between dumping large packets"\n  APPEND_PARAMETER "Memory_Scrubbing" 8 UINT 0 1 1\n    STATE DISABLE 0\n    STATE ENABLE 1\n  APPEND_PARAMETER "SIOC_Memory_Config" 8 UINT 1 3 3\n  APPEND_PARAMETER "Uneditable_Text" 32 UINT MIN MAX 0xDEADBEEF "Uneditable field"\n    FORMAT_STRING "0x%0X"\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_State" 16 UINT MIN MAX 0 "Uneditable field"\n    STATE DISABLE 0\n    STATE ENABLE 1\n    UNEDITABLE\n  APPEND_PARAMETER "Uneditable_Check" 16 UINT MIN MAX 1 "Uneditable field"\n    STATE UNCHECKED 0\n    STATE CHECKED 1\n    UNEDITABLE\n  APPEND_PARAMETER "Binary" 32 STRING 0xDEADBEEF "Binary string"\n  APPEND_PARAMETER "Pad" 16 UINT 0 0 0\n    HIDDEN\n')))}m.isMDXComponent=!0},876:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>k});var n=a(2784);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?l(Object(a),!0).forEach((function(t){r(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},l=Object.keys(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n<l.length;n++)a=l[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),u=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=u(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(a),h=r,k=d["".concat(s,".").concat(h)]||d[h]||m[h]||l;return a?n.createElement(k,i(i({ref:t},p),{},{components:a})):n.createElement(k,i({ref:t},p))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=h;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,i[1]=o;for(var u=2;u<l;u++)i[u]=a[u];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}h.displayName="MDXCreateElement"}}]);