cosmos 4.0.3-java

data/data/config/_items.yaml

@@ -0,0 +1,20 @@
+---
+- name: Bit Size
+  required: true
+  description: Bit size of this telemetry item. 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'.
+  values: \d+
+- name: Data Type
+  required: true
+  description: Data Type of this telemetry item
+  values: <%= %w(INT UINT FLOAT STRING BLOCK DERIVED) %>
+- name: Description
+  required: false
+  description: Description for this telemetry item which must be enclosed with quotes
+  values: "['\"].*['\"]"
+- name: Endianness
+  required: false
+  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format
+  values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_params.yaml

@@ -0,0 +1,58 @@
+---
+- name: Bit Size
+  required: true
+  description: 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'.
+  values: \d+
+- name: Data Type
+  required: true
+  description: Data Type of this parameter
+  values:
+    INT:
+      parameters: &params
+        - name: Minimum Value
+          required: true
+          description: Minimum allowed value for this parameter
+          values: .*
+        - name: Maximum Value
+          required: true
+          description: Maximum allowed value for this parameter
+          values: .*
+        - name: Default Value
+          required: true
+          description: 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.
+          values: .*
+        - name: Description
+          required: false
+          description: Description for this parameter which must be enclosed with quotes
+          values: "['\"].*['\"]"
+        - name: Endianness
+          required: false
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
+    UINT:
+      parameters: *params
+    FLOAT:
+      parameters: *params
+    DERIVED:
+      parameters: *params
+    STRING:
+      parameters: &sparams
+        - name: Default Value
+          required: true
+          description: 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.
+          values: .*
+        - name: Description
+          required: false
+          description: Description for this parameter which must be enclosed with quotes
+          values: "['\"].*['\"]"
+        - name: Endianness
+          required: false
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
+    BLOCK:
+      parameters: *sparams

data/data/config/cmd_tlm_server.yaml

@@ -0,0 +1,124 @@
+---
+TITLE:
+  summary: Sets the Command and Telemetry Server window title
+  parameters:
+  - name: Text
+    required: true
+    description: Text to put in the title of the Command and Telemetry Server window
+    values: .+
+PACKET_LOG_WRITER:
+  summary: Declare a packet log writer
+  description: Packet log writer is used to declare a packet log writer class and
+    give it a name which can be referenced by an interface. This is required if you
+    want interfaces to have their own dedicated log writers or want to combine
+    various interfaces into a single log file. By default, COSMOS logs all data
+    on all interfaces into a single command log and a single telemetry log.
+    This keyword can also be used if you want to declare a different log file class
+    to create log files.
+  warning: You should NOT override the default without consulting a COSMOS expert
+    as this may break the ability to successfully read and write log files.
+  example: |
+    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb # Default
+    # The default logger filename will be <DATE>_cosmostlm.bin and will create a new log every 1MB
+    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb cosmos true nil 1000000
+    # Create a logger named COSMOS_LOG which creates a new log every 5 min (600s)
+    PACKET_LOG_WRITER COSMOS_LOG packet_log_writer.rb cosmos true 600
+  parameters:
+    - name: Log Writer Name
+      required: true
+      description: The name of the log writer as reference by other cmd_tlm_server keywords.
+        This name also appears in the Logging tab on the Command and Telemetry Server.
+      values: .+
+    - name: Filename
+      required: true
+      description: Ruby file to use when instantiating a new log writer
+      values: '.+\.rb'
+    - name: Parameters
+      required: false
+      description: Optional parameters to pass to the log writer class when instantiating it.
+AUTO_INTERFACE_TARGETS:
+  summary: Automatically use each target's cmd_tlm_server.txt file to define the interface
+  description: Look for a cmd_tlm_server.txt file at the top level
+    of each target directory and use this file to configure the interface for that target.
+    This is a good way of keeping the knowledge of how to interface to a target
+    within that target. However, if you use substitute target names (by using DECLARE_TARGET)
+    or use different IP addresses then this will not work and you'll have to use the
+    INTERFACE_TARGET or INTERFACE keyword.
+INTERFACE_TARGET:
+  summary: Load the specified target's cmd_tlm_server.txt configuration file
+  example: |
+    INTERFACE_TARGET COSMOS # Look in the COSMOS target directory for cmd_tlm_server.txt
+    INTERFACE_TARGET COSMOS config.txt # Look in the COSMOS target directory for config.txt
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+    - name: Configuration File
+      required: false
+      description: Configuration file name which contains the interface configuration.
+        Defaults to 'cmd_tlm_server.txt'.
+      values: .+
+INTERFACE:
+  modifiers:
+    <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a connection to a physical target
+  description: Interfaces are what COSMOS uses to talk to a particular piece
+    of hardware. Interfaces require a Ruby file which implements all the interface
+    methods necessary to talk to the hardware. COSMOS defines many built in interfaces
+    or you can define your own as long as it implements the interface protocol.
+  parameters:
+    - name: Interface Name
+      required: true
+      description: Name of the interface. This name will appear in the
+        Interfaces tab of the Server and is also referenced by other keywords.
+        The COSMOS convention is to name interfaces after their targets with
+        '_INT' appended to the name, e.g. INST_INT for the INST target.
+      values: \D\S*
+    - name: Filename
+      required: true
+      description: Ruby file to use when instantiating the interface.
+      values:
+        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
+      documentation: Additional parameters are required. Please see the [Interfaces](/docs/interfaces)
+        documentation for more details.
+ROUTER:
+  modifiers:
+    <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Create an interface which reverses cmd/tlm data
+  description: Router creates an interface which receives command packets from
+    their remote targets and send them out their interfaces. They receive telemetry
+    packets from their interfaces and send them to their remote targets. This allows
+    routers to be intermediaries between an external client and an actual device.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the router
+      values: .+
+    - name: Filename
+      required: true
+      description: Ruby file to use when instantiating the interface.
+      values:
+        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
+      documentation: Additional parameters are required. Please see the [Interfaces](/docs/interfaces)
+        documentation for more details.
+COLLECT_METADATA:
+  summary: Prompts the user for meta data when starting the Command and Telemetry Server
+BACKGROUND_TASK:
+  summary: Create a background task in the Command and Telemetry Server
+  description: The Server instantiates the class which must inherit from BackgroundTask
+    and then calls the call() method which the class must implement. The call() method
+    is only called once so if your background task is supposed to live on while the
+    Server is running, you must implement your code in a loop with a sleep to not
+    use all the CPU.
+  example: BACKGROUND_TASK example_background_task.rb
+  parameters:
+    - name: Filename
+      required: true
+      description: Ruby file which contains the background task implementation.
+        Must inherit from BackgroundTask and implement the call method.
+      values: '.+\.rb'
+    - name: Optional Arguments
+      required: false
+      description: Optional arguments to the background task constructor
+      values: .+

data/data/config/command.yaml

@@ -0,0 +1,40 @@
+---
+COMMAND:
+  modifiers:
+    <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a new command packet
+  example: COMMAND SYSTEM STARTLOGGING BIG_ENDIAN "Starts logging both commands and telemetry for an interface"
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target this command is associated with
+      values: <%= System.targets.keys %>
+    - name: Command
+      required: true
+      description: Name of this command. Also referred to as its mnemonic.
+        Must be unique to commands to 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 command is to be sent in Big Endian or Little Endian format
+      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+    - name: Description
+      required: false
+      description: Description of this command which must be enclosed with quotes
+      values: "['\"].*['\"]"
+SELECT_COMMAND:
+  modifiers:
+    <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing command packet for editing
+  description: Typically used in a separate configuration file from where the original
+    command is defined to override or add to the existing command definition
+  example: SELECT_COMMAND SYSTEM STARTLOGGING
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target this command is associated with
+      values: <%= System.targets.keys %>
+    - name: Command Name
+      required: true
+      description: Name of the command to select
+      values: .*

data/data/config/command_modifiers.yaml

@@ -0,0 +1,145 @@
+---
+PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet
+  example: |
+    PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
+    PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
+    PARAMETER LABEL 96 96 STRING "COSMOS" "The label to apply"
+    PARAMETER BLOCK 192 0 BLOCK '' "Block of binary data"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+APPEND_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet
+  example: |
+    APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
+    APPEND_PARAMETER LABEL 0 STRING "COSMOS" "The label to apply"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+ID_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines an identification command parameter in the current command packet
+  description: ID parameters are used to identify the binary block of data as a
+    particular command. A command packet may have one or more ID_PARAMETERs and all
+    must match the binary data for the command to be identified.
+  example: ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ID_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines an identification command parameter in the current command packet
+  description: ID parameters are used to identify the binary block of data as a
+    particular command. A command packet may have one or more ID_PARAMETERs and all
+    must match the binary data for the command to be identified.
+  example: APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+ARRAY_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet that is an array
+  example: ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: \'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ARRAY_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet that is an array
+  example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: '\D\S*'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+SELECT_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing command parameter for editing
+  example: |
+    SELECT_COMMAND SYSTEM STARTLOGGING
+      SELECT_PARAMETER LABEL
+  parameters:
+    - name: Parameter
+      required: true
+      description: Name of the parameter to select for modification
+      values: .+
+HIDDEN:
+  summary: Hides this command from all COSMOS tools such as Command Sender and Handbook Creator
+  description: Hidden commands do not appear in the Script Runner popup helper when writing scripts.
+    The command still exists in the system and can be sent by scripts.
+DISABLED:
+  summary: Disables this command from being sent
+  description: Hides the command and also disables it from being sent by scripts.
+    Attempts to send DISABLED commands result in an error message.
+DISABLE_MESSAGES:
+  summary: Disable the Server from printing cmd(...) messages. Commands are still logged.
+META:
+  summary: Stores metadata for the current command
+  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 command"
+  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: .*
+HAZARDOUS:
+  summary: Designates the current command as hazardous
+  description: Sending a hazardous command causes a dialog asking for confirmation
+    before sending the command
+  parameters:
+    - name: Description
+      required: false
+      description: Description for why the command is hazardous which must be enclosed with quotes
+      values: "['\"].*['\"]"

data/data/config/command_telemetry.yaml

@@ -0,0 +1,3 @@
+---
+<%= MetaConfigParser.load('command.yaml').to_meta_config_yaml(0) %>
+<%= MetaConfigParser.load('telemetry.yaml').to_meta_config_yaml(0) %>

data/data/config/data_viewer.yaml

@@ -0,0 +1,43 @@
+---
+AUTO_START:
+  summary: Automatically start Data Viewer and connect to the Server
+AUTO_TARGET_COMPONENTS:
+  summary: Automatically load all data_viewer.txt configuration files in each target
+TARGET_COMPONENT:
+  summary: Load a Data Viewer configuration file in the specified target
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+    - name: Filename
+      required: false
+      description: The Data Viewer configuration file name. Defaults to data_viewer.txt.
+      values: '(.+\.txt)?'
+COMPONENT:
+  summary: Declare a Data Viewer component
+  parameters:
+    - name: Tab Name
+      required: true
+      description: Name of the component which shows up in the GUI tab
+      values: .+
+    - name: Filename
+      required: true
+      description: Name of the Ruby file which contains the component class
+      values: '.+\.rb'
+    - name: Options
+      required: false
+      description: Optional parameters that are sent to the component constructor
+      values: .*
+  modifiers:
+    PACKET:
+      summary: Declare a packet to process by the component
+      parameters:
+        - name: Target
+          required: true
+          description: Name of the target
+          values: <%= System.targets.keys %>
+        - name: Packet
+          required: true
+          description: Name of the packet
+          values: .+

data/data/config/handbook_creator.yaml

@@ -0,0 +1,23 @@
+---
+PAGE:
+  modifiers:
+    <%= MetaConfigParser.load('page_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Create a new top level webpage
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML file
+      values: '.*\.html'
+TARGET_PAGES:
+  modifiers:
+    <%= MetaConfigParser.load('page_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Create a new webpage for each of the defined TARGETS
+  description: The page will be generated for each target. A top level "Targets"
+    drop down will be created with links to all the generated target pages.
+  parameters:
+    - name: Filename Postfix
+      required: true
+      description: The postfix will be applied to each generated target file.
+        For example, a target named INST with a postfix of '_cmd_tlm.html' will
+        result in a file named 'inst_cmd_tlm.html'.
+      values: '.*\.html'