cosmos 4.5.2 → 5.0.3

data/data/config/target.yaml

@@ -1,92 +1,142 @@
 ---
-REQUIRE:
-  summary: Requires a Ruby file
-  description: Ruby files must be required to be available to call in other code.
-    Files are first required from the target's lib folder. If no file is found the
-    Ruby system path is checked which includes the base COSMOS/lib folder.
-  example: REQUIRE limits_response.rb
+TARGET:
+  summary: Defines a new target
+  example: TARGET INST
   parameters:
-    - name: Filename
+    - name: Folder Name
       required: true
-      description: Filename to require. For files in the target's lib directory
-        simply supply the filename, e.g. "REQUIRE my_file". Files in the base COSMOS
-        lib directory also should just list the filename. If a file is in a folder
-        under the lib directory then you must specify the folder name, e.g. "REQUIRE
-        folder/my_file". The filename can also be an absolute path but this is not
-        common. Note the ".rb" extension is optional when specifying the filename.
-      values: .+
-IGNORE_PARAMETER:
-  summary: Ignore the given command parameter
-  description: Hint to other COSMOS tools to hide or ignore this command parameter
-    when processing the command. For example, Command Sender and Command Sequence
-    will not display the parameter (by default) when showing the command and Script
-    Runner code completion will not display the parameter.
-  example: IGNORE_PARAMETER CCSDS_VERSION
-  parameters:
-    - name: Parameter Name
-      required: true
-      description: The name of a command parameter. Note that this parameter will
-        be ignored in ALL the commands it appears in.
-      values: .+
-IGNORE_ITEM:
-  summary: Ignore the given telemetry item
-  description: Hint to other COSMOS tools to hide or ignore this telemetry item
-    when processing the telemetry. For example, Packet Viewer will not display the
-    item (by default) when showing the packet.
-  example: IGNORE_ITEM CCSDS_VERSION
-  parameters:
-    - name: Item name
-      required: true
-      description: The name of a telemetry item. Note that this item will be ignored
-        in ALL the telemetry it appears in.
-      values: .+
-COMMANDS:
-  summary: Process the given command definition file
-  description: This keyword is used to explicitly add the command definition file
-    to the list of command and telemetry files to process.
-  warning: Usage of this keyword overrides automatic command and telemetry file
-    discovery. If this keyword is used, you must also use the TELEMETRY keyword
-    to specify the telemetry files to process.
-  example: |
-    COMMANDS inst_cmds_v2.txt
-    TELEMETRY inst_tlm_v2.txt
-  parameters:
-    - name: Filename
-      required: true
-      description: Name of a command definition file in the target's cmd_tlm directory, e.g. "cmd.txt".
-      values: '.*\.txt'
-TELEMETRY:
-  summary: Process the given telemetry definition file
-  description: This keyword is used to explicitly add the telemetry definition
-    file to the list of command and telemetry files to process.
-  warning: Usage of this keyword overrides automatic command and telemetry file
-    discovery. If this keyword is used, you must also use the COMMAND keyword to
-    specify the command files to process.
-  example: |
-    COMMANDS inst_cmds_v2.txt
-    TELEMETRY inst_tlm_v2.txt
-  parameters:
-    - name: Filename
+      description: The target folder
+      values: .*
+    - name: Name
       required: true
-      description: Name of a telemetry definition file in the target's cmd_tlm
-        directory, e.g. "tlm.txt".
-      values: '.*\.txt'
-AUTO_SCREEN_SUBSTITUTE:
-  summary: Automatically substitute the target's name in screen definitions
-  description: Targets can be renamed when they are declared which would break
-    any screen definitions using the explicit target name. This keyword automatically
-    replaces the target name in the screen definitions with the actual target name.
-  warning: Replaces ALL target names in a screen definition file, so this is not
-    suitable for screens with multiple targets.
-CMD_UNIQUE_ID_MODE:
-  summary: Flags that commands to this target are identified in a mixed variety of ways
-  description: Ideally all commands for a target are identified using the exact same fields in a header
-    for each command.  If  this target identifies packets using different fields for some commands than others,
-    then this flag must be set to force a brute force identification method.
-  warning: Using this mode significantly slows packet identification
-TLM_UNIQUE_ID_MODE:
-  summary: Flags that telemetry to this target are identified in a mixed variety of ways
-  description: Ideally all telemetry for a target are identified using the exact same fields in a header
-    for each packet.  If  this target identifies packets using different fields for some telemetry packets than others,
-    then this flag must be set to force a brute force identification method.
-  warning: Using this mode significantly slows packet identification
+      description:
+        The target name. While this is almost always the same as Folder Name
+        it can be different to create multiple targets based on the same target folder.
+      values: .*
+  modifiers:
+    CMD_LOG_CYCLE_TIME:
+      summary: Command binary logs can be cycled on a time interval.
+      parameters:
+        - name: Time
+          required: true
+          description: Maximum time between files in seconds (default = 600)
+          values: \d+
+    CMD_LOG_CYCLE_SIZE:
+      summary: Command binary logs can be cycled after a certain log file size is reached.
+      parameters:
+        - name: Size
+          required: true
+          description: Maximum file size in bytes (default = 50_000_000)
+          values: \d+
+    CMD_LOG_RETAIN_TIME:
+      summary: How long to keep raw command logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep raw command logs (default = nil = Forever)
+          values: \d+
+    CMD_DECOM_LOG_CYCLE_TIME:
+      summary: Command decommutation logs can be cycled on a time interval.
+      parameters:
+        - name: Time
+          required: true
+          description: Maximum time between files in seconds (default = 600)
+          values: \d+
+    CMD_DECOM_LOG_CYCLE_SIZE:
+      summary: Command decommutation logs can be cycled after a certain log file size is reached.
+      parameters:
+        - name: Size
+          required: true
+          description: Maximum file size in bytes (default = 50_000_000)
+          values: \d+
+    CMD_DECOM_LOG_RETAIN_TIME:
+      summary: How long to keep decom command logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep decom command logs (default = nil = Forever)
+          values: \d+
+    TLM_LOG_CYCLE_TIME:
+      summary: Telemetry binary logs can be cycled on a time interval.
+      parameters:
+        - name: Time
+          required: true
+          description: Maximum time between files in seconds (default = 600)
+          values: \d+
+    TLM_LOG_CYCLE_SIZE:
+      summary: Telemetry binary logs can be cycled after a certain log file size is reached.
+      parameters:
+        - name: Size
+          required: true
+          description: Maximum file size in bytes (default = 50_000_000)
+          values: \d+
+    TLM_LOG_RETAIN_TIME:
+      summary: How long to keep raw telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep raw telemetry logs (default = nil = Forever)
+          values: \d+
+    TLM_DECOM_LOG_CYCLE_TIME:
+      summary: Telemetry decommutation logs can be cycled on a time interval.
+      parameters:
+        - name: Time
+          required: true
+          description: Maximum time between files in seconds (default = 600)
+          values: \d+
+    TLM_DECOM_LOG_CYCLE_SIZE:
+      summary: Telemetry decommutation logs can be cycled after a certain log file size is reached.
+      parameters:
+        - name: Size
+          required: true
+          description: Maximum file size in bytes (default = 50_000_000)
+          values: \d+
+    TLM_DECOM_LOG_RETAIN_TIME:
+      summary: How long to keep decom telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep decom telemetry logs (default = nil = Forever)
+          values: \d+
+    REDUCED_MINUTE_LOG_RETAIN_TIME:
+      summary: How long to keep reduced minute telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep reduced minute telemetry logs (default = nil = Forever)
+          values: \d+
+    REDUCED_HOUR_LOG_RETAIN_TIME:
+      summary: How long to keep reduced hour telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep reduced hour telemetry logs (default = nil = Forever)
+          values: \d+
+    REDUCED_DAY_LOG_RETAIN_TIME:
+      summary: How long to keep reduced day telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep reduced day telemetry logs (default = nil = Forever)
+          values: \d+
+    LOG_RETAIN_TIME:
+      summary: How long to keep all regular telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep all regular telemetry logs (default = nil = Forever)
+          values: \d+
+    REDUCED_LOG_RETAIN_TIME:
+      summary: How long to keep all reduced telemetry logs in seconds.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds to keep all reduced telemetry logs (default = nil = Forever)
+          values: \d+
+    CLEANUP_POLL_TIME:
+      summary: Period at which to run the cleanup process.
+      parameters:
+        - name: Time
+          required: true
+          description: Number of seconds between runs of the cleanup process (default = 900 = 15 minutes)
+          values: \d+

data/data/config/target_config.yaml

@@ -0,0 +1,94 @@
+---
+REQUIRE:
+  summary: Requires a Ruby file
+  description:
+    Ruby files must be required to be available to call in other code.
+    Files are first required from the target's lib folder. If no file is found the
+    Ruby system path is checked which includes the base COSMOS/lib folder.
+  example: REQUIRE limits_response.rb
+  parameters:
+    - name: Filename
+      required: true
+      description: Filename to require. For files in the target's lib directory
+        simply supply the filename, e.g. "REQUIRE my_file". Files in the base COSMOS
+        lib directory also should just list the filename. If a file is in a folder
+        under the lib directory then you must specify the folder name, e.g. "REQUIRE
+        folder/my_file". The filename can also be an absolute path but this is not
+        common. Note the ".rb" extension is optional when specifying the filename.
+      values: .+
+IGNORE_PARAMETER:
+  summary: Ignore the given command parameter
+  description:
+    Hint to other COSMOS tools to hide or ignore this command parameter
+    when processing the command. For example, Command Sender and Command Sequence
+    will not display the parameter (by default) when showing the command and Script
+    Runner code completion will not display the parameter.
+  example: IGNORE_PARAMETER CCSDS_VERSION
+  parameters:
+    - name: Parameter Name
+      required: true
+      description:
+        The name of a command parameter. Note that this parameter will
+        be ignored in ALL the commands it appears in.
+      values: .+
+IGNORE_ITEM:
+  summary: Ignore the given telemetry item
+  description: Hint to other COSMOS tools to hide or ignore this telemetry item
+    when processing the telemetry. For example, Packet Viewer will not display the
+    item (by default) when showing the packet.
+  example: IGNORE_ITEM CCSDS_VERSION
+  parameters:
+    - name: Item name
+      required: true
+      description:
+        The name of a telemetry item. Note that this item will be ignored
+        in ALL the telemetry it appears in.
+      values: .+
+COMMANDS:
+  summary: Process the given command definition file
+  description:
+    This keyword is used to explicitly add the command definition file
+    to the list of command and telemetry files to process.
+  warning: Usage of this keyword overrides automatic command and telemetry file
+    discovery. If this keyword is used, you must also use the TELEMETRY keyword
+    to specify the telemetry files to process.
+  example: |
+    COMMANDS inst_cmds_v2.txt
+    TELEMETRY inst_tlm_v2.txt
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of a command definition file in the target's cmd_tlm directory, e.g. "cmd.txt".
+      values: '.*\.txt'
+TELEMETRY:
+  summary: Process the given telemetry definition file
+  description: This keyword is used to explicitly add the telemetry definition
+    file to the list of command and telemetry files to process.
+  warning: Usage of this keyword overrides automatic command and telemetry file
+    discovery. If this keyword is used, you must also use the COMMAND keyword to
+    specify the command files to process.
+  example: |
+    COMMANDS inst_cmds_v2.txt
+    TELEMETRY inst_tlm_v2.txt
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of a telemetry definition file in the target's cmd_tlm
+        directory, e.g. "tlm.txt".
+      values: '.*\.txt'
+CMD_UNIQUE_ID_MODE:
+  summary: Command packet identifiers don't all share the same bit offset, size, and type
+  description:
+    Ideally all commands for a target are identified using the exact same bit offset, size,
+    and type field in each command. If ANY command identifiers differ then this flag must be set
+    to force a brute force identification method.
+  warning: Using this mode significantly slows packet identification
+  since: 4.4.0
+TLM_UNIQUE_ID_MODE:
+  summary: Telemetry packets identifiers don't all share the same bit offset, size, and type
+  description:
+    Ideally all telemetry for a target are identified using the exact same bit offset, size,
+    and type field in each packet. If ANY telemetry identifiers differ then this flag must be set
+    to force a brute force identification method.
+  warning: Using this mode significantly slows packet identification
+  since: 4.4.0

data/data/config/telemetry.yaml

@@ -1,5 +1,7 @@
 ---
 TELEMETRY:
+  # Prevent prettier from removing the newline after modifiers:
+  # prettier-ignore
   modifiers:
     <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a new telemetry packet
@@ -8,39 +10,43 @@ TELEMETRY:
     - name: Target
       required: true
       description: Name of the target this telemetry packet is associated with
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Command
       required: true
-      description: Name of this telemetry packet. Also referred to as its mnemonic.
+      description:
+        Name of this telemetry packet. Also referred to as its mnemonic.
         Must be unique to telemetry packets in this target. Ideally will be as short and clear as possible.
       values: \D\S*
     - name: Endianness
       required: true
       description: Indicates if the data in this packet is in Big Endian or Little Endian format
-      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+      values: ["BIG_ENDIAN", "LITTLE_ENDIAN"]
     - name: Description
       required: false
       description: Description of this telemetry packet which must be enclosed with quotes
-      values: "['\"].*['\"]"
+      values: '[''"].*[''"]'
 SELECT_TELEMETRY:
+  # prettier-ignore
   modifiers:
     <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Selects an existing telemetry packet for editing
-  description: Typically used in a separate configuration file from where the original
+  description:
+    Typically used in a separate configuration file from where the original
     telemetry is defined to override or add to the existing telemetry definition
   example: SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
   parameters:
     - name: Target Name
       required: true
       description: Name of the target this telemetry packet is associated with
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Command Name
       required: true
       description: Name of the telemetry packet to select
       values: .+
 LIMITS_GROUP:
   summary: Defines a group of related limits Items
-  description: Limits groups contain telemetry items that can be enabled and disabled together.
+  description:
+    Limits groups contain telemetry items that can be enabled and disabled together.
     It can be used to group related limits as a subsystem that can be enabled or disabled
     as that particular subsystem is powered (for example). To enable a group call the
     enable_limits_group("NAME") method in Script Runner. To disable a group call the
@@ -55,7 +61,8 @@ LIMITS_GROUP:
       values: .+
 LIMITS_GROUP_ITEM:
   summary: Adds the specified telemetry item to the last defined LIMITS_GROUP
-  description: Limits group information is typically kept in a separate configuration
+  description:
+    Limits group information is typically kept in a separate configuration
     file in the config/TARGET/cmd_tlm folder named limits_groups.txt. If you want to
     configure multiple target items in a particular group you should put this information
     in the config/SYSTEM/cmd_tlm/limits_groups.txt file. The SYSTEM target is processed
@@ -69,7 +76,7 @@ LIMITS_GROUP_ITEM:
     - name: Target Name
       required: true
       description: Name of the target
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Packet Name
       required: true
       description: Name of the packet

data/data/config/tool.yaml

@@ -0,0 +1,63 @@
+---
+TOOL:
+  summary: Define a tool
+  example: TOOL DEMO Demo
+  description: Defines a tool that the plugin adds to the COSMOS system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices.
+  parameters:
+    - name: Tool Folder Name
+      description: The exact name of the tool folder in the plugin. ie. tools/<Tool Folder Name>
+      required: true
+      values: .+
+    - name: Tool Name
+      description: Name of the tool that is displayed in the COSMOS Navigation menu
+      required: true
+      values: .+
+  modifiers:
+    URL:
+      summary: Url used to access the tool
+      description: The relative url used to access the tool. Defaults to "/tools/<Tool Folder Name>".
+      parameters:
+        - name: Url
+          required: true
+          description: The url. If not given defaults to tools/<Tool Folder Name>. Generally should not be given unless linking to external tools.
+          values: .+
+    INLINE_URL:
+      summary: Internal url to load a tool
+      description: The url of the javascript file used to load the tool into single-SPA. Defaults to "js/app.js".
+      parameters:
+        - name: Url
+          required: true
+          description: The inline url. If not given defaults to js/app.js. Generally should not be given unless using a non-standard filename.
+          values: .+
+    WINDOW:
+      summary: How to display the tool when navigated to
+      description: The window mode used to display the tool. INLINE opens the tool internally without refreshing the page using the Single-SPA framework. IFRAME opens external tools in an Iframe within COSMOS. NEW opens the tool in a new TAB.
+      parameters:
+        - name: Window Mode
+          required: true
+          description: Tool display mode
+          values: ["INLINE", "IFRAME", "NEW"]
+    ICON:
+      summary: Set tool icon
+      description: Icon shown next to the tool name in the COSMOS navigation menu.
+      parameters:
+        - name: Icon Name
+          required: true
+          description: Icon to display next to the tool name. Icons come from Font Awesome, Material Design (https://materialdesignicons.com/), and Astro.
+          values: .+
+    CATEGORY:
+      summary: Category for the tool
+      description: Associates the tool with a category. In a future release this will be able to organize tools into submenus in the Navigation menu.
+      parameters:
+        - name: Category Name
+          required: true
+          description: Category to associate the tool with
+          values: .+
+    SHOWN:
+      summary: Show the tool or not
+      description: Whether or not the tool is shown in the Navigation menu. Should generally be true, except for the cosmos base tool.
+      parameters:
+        - name: Shown
+          required: true
+          description: Whether or not the tool is shown.  TRUE or FALSE
+          values: ["true", "false"]