openc3 5.0.6

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 openc3/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 OpenC3
+        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 OpenC3 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 OpenC3 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

@@ -0,0 +1,87 @@
+---
+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
+  example: TELEMETRY SYSTEM LIMITS_CHANGE BIG_ENDIAN "OpenC3 limits change"
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target this telemetry packet is associated with
+      values: .+
+    - name: Command
+      required: true
+      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"]
+    - name: Description
+      required: false
+      description: Description of this telemetry packet which must be enclosed with quotes
+      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
+    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: .+
+    - 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.
+    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
+    disable_limits_group("NAME") in Script Runner. Items can belong to multiple groups
+    but the last enabled or disabled group "wins". For example, if an item belongs to
+    GROUP1 and GROUP2 and you first enable GROUP1 and then disable GROUP2 the item will
+    be disabled. If you then enable GROUP1 again it will be enabled.
+  parameters:
+    - name: Group Name
+      required: true
+      description: Name of the 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
+    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
+    last and contains information that crosses target boundaries.
+  example: |
+    LIMITS_GROUP SUBSYSTEM
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Name of the packet
+      values: .+
+    - name: Item Name
+      required: true
+      description: Name of the telemetry item to add to the group
+      values: .+

data/data/config/telemetry_modifiers.yaml

@@ -0,0 +1,159 @@
+---
+ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: |
+    ITEM PKTID 112 16 UINT "Packet ID"
+    ITEM DATA 0 0 DERIVED "Derived data"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_items.yaml').to_meta_config_yaml(4) %>
+APPEND_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: APPEND_ITEM PKTID 16 UINT "Packet ID"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_items.yaml').to_meta_config_yaml(4) %>
+ID_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet.
+    Note, packets defined without one or more ID_ITEMs are "catch-all" packets which
+    will match all incoming data. Normally this is the job of the UNKNOWN packet.
+  example: ID_ITEM PKTID 112 16 UINT 1 "Packet ID which must be 1"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_id_items.yaml').to_meta_config_yaml(4) %>
+APPEND_ID_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: APPEND_ID_ITEM PKTID 16 UINT 1 "Packet ID which must be 1"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_id_items.yaml').to_meta_config_yaml(4) %>
+ARRAY_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet that is an array
+  example: ARRAY_ITEM ARRAY 64 32 FLOAT 320 "Array of 10 floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ARRAY_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet that is an array
+  example: APPEND_ARRAY_ITEM ARRAY 32 FLOAT 320 "Array of 10 floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+SELECT_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing telemetry item for editing
+  example: |
+    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+      SELECT_ITEM ITEM
+  parameters:
+    - name: Item
+      required: true
+      description: Name of the item to select for modification
+      values: .+
+DELETE_ITEM:
+  summary: Delete an existing telemetry item from the packet definition
+  description: Deleting an item from the packet definition does not remove the
+    defined space for that item. Thus unless you redefine a new item, there
+    will be a "hole" in the packet where the data is not accessible. You can
+    use SELECT_TELEMETRY and then ITEM to define a new item.
+  example: |
+    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+      DELETE_ITEM ITEM
+  since: 4.4.1
+  parameters:
+    - name: Item
+      required: true
+      description: Name of the item to delete
+      values: .+
+META:
+  summary: Stores metadata for the current telemetry packet
+  description: 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.
+  example: META FSW_TYPE "struct tlm_packet"
+  parameters:
+    - name: Meta Name
+      required: true
+      description: Name of the metadata to store
+      values: .*
+    - name: Meta Values
+      required: false
+      description: One or more values to be stored for this Meta Name
+      values: .*
+PROCESSOR:
+  summary: Defines a processor class that executes code every time a packet is received
+  example: PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1
+  parameters:
+    - name: Processor Name
+      required: true
+      description: The name of the processor
+      values: .+
+    - name: Processor Class Filename
+      required: true
+      description: Name of the Ruby file which implements the processor.
+        This file should be in the config/TARGET/lib directory so it can be found by OpenC3.
+      values: '.+\.rb'
+    - name: Processor Specific Options
+      required: false
+      description: Variable length number of options that will be passed to the class constructor.
+      values: .+
+ALLOW_SHORT:
+  summary: Process telemetry packets which are less than their defined length
+  description: Allows the telemetry packet to be received with a data portion that
+    is smaller than the defined size without warnings. Any extra space in the packet
+    will be filled in with zeros by OpenC3.
+HIDDEN:
+  summary: Hides this telemetry packet from all the OpenC3 tools
+  description: This packet will not appear in Packet Viewer, Telemetry Grapher and Handbook Creator.
+    It also hides this telemetry from appearing in the Script Runner popup helper
+    when writing scripts. The telemetry still exists in the system and can received
+    and checked by scripts.

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 OpenC3 system. Tools are web based applications that make use of the Single-SPA javascript library that allows them to by dynamically added to the running system as independent frontend microservices.
+  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 OpenC3 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 OpenC3. 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 OpenC3 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 openc3 base tool.
+      parameters:
+        - name: Shown
+          required: true
+          description: Whether or not the tool is shown.  TRUE or FALSE
+          values: ["true", "false"]

data/data/config/unknown.yaml

@@ -0,0 +1,3 @@
+---
+UNKNOWN:
+  summary: Unknown keyword selected