cosmos 4.5.1 → 5.0.2

data/bin/rubysloc

@@ -1,13 +1,22 @@
 #!/usr/bin/env ruby
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 Ball Aerospace & Technologies Corp.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 # This file provides a simple ruby sloc counter.
 # Blank lines and comment lines are ignored.  All other
@@ -30,7 +39,7 @@ opts = OptionParser.new do |opts|
     exit
   end
   opts.on("-i DIRECTORY/FILENAME", "--input DIRECTORY/FILENAME",
-    "Parse only the specified directory/filename (relative or absolute path)") do |arg|
+          "Parse only the specified directory/filename (relative or absolute path)") do |arg|
     options.filename = arg
   end
   opts.on("-s SORT", "--sort SORT", "Sort by the specified column. Must be one of LINES, COMMENTS, SLOC, or RATIO.") do |arg|
@@ -64,7 +73,7 @@ if options.filename
   if File.exist?(options.filename)
     if File.directory?(options.filename)
       # Dir only works with unix paths so swap backslashes
-      files = Dir[File.join(options.filename.gsub('\\','/'), '**', '*.rb')]
+      files = Dir[File.join(options.filename.gsub('\\', '/'), '**', '*.rb')]
     else
       files << options.filename
     end
@@ -102,7 +111,7 @@ files.each do |full_filename|
   end
 end
 
-results.sort_by! {|col| col[options.sort_column].finite? ? col[options.sort_column] : -1 } if options.sort_column
+results.sort_by! { |col| col[options.sort_column].finite? ? col[options.sort_column] : -1 } if options.sort_column
 
 # Print results to STDOUT
 total_files    = 0
@@ -111,9 +120,9 @@ total_comments = 0
 total_slocs    = 0
 total_ratio    = 0
 
-puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-"*longest_path)
+puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-" * longest_path)
 puts sprintf("| %-#{longest_path}s |  Lines   | Comments |  SLOCs   |  Ratio |", "Filename")
-puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-"*longest_path)
+puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-" * longest_path)
 results.each do |filename, lines, comments, slocs, ratio|
   # filename = filename[0..32] if filename.length > 33
   puts sprintf("| %-#{longest_path}s | %8d | %8d | %8d | %6.2f |",
@@ -124,7 +133,7 @@ results.each do |filename, lines, comments, slocs, ratio|
   total_slocs    += slocs
 end
 total_ratio = total_comments.to_f / total_slocs.to_f if total_slocs != 0
-puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-"*longest_path)
+puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-" * longest_path)
 puts sprintf("| %-#{longest_path}s | %8d | %8d | %8d | %6.2f |",
-  "Totals - #{total_files} Files", total_lines, total_comments, total_slocs, total_ratio)
-puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-"*longest_path)
+             "Totals - #{total_files} Files", total_lines, total_comments, total_slocs, total_ratio)
+puts sprintf("|-%-#{longest_path}s-|----------|----------|----------|--------|", "-" * longest_path)

data/bin/xtce_converter

@@ -1,13 +1,22 @@
 #!/usr/bin/env ruby
 # encoding: ascii-8bit
 
-# Copyright 2016 Ball Aerospace & Technologies Corp.
+# Copyright 2022 Ball Aerospace & Technologies Corp.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 # This file converts to and from the .xtce file format
 
@@ -36,7 +45,7 @@ option_parser = OptionParser.new do |option_parser|
 
   # Create the system option
   option_parser.on("--system VALUE", "Use an alternative system.txt file") do |arg|
-    Cosmos::System.instance(File.join(Cosmos::USERPATH, 'config', 'system', arg))
+    Cosmos::System.instance(File.join(USERPATH, 'config', 'system', arg))
   end
 
   # Handle --import mode

data/data/config/_params.yaml

@@ -22,13 +22,14 @@
           values: .*
         - name: Default Value
           required: true
-          description: Default value for this parameter. You must provide a default
+          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: "['\"].*['\"]"
+          values: '[''"].*[''"]'
         - name: Endianness
           required: false
           description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
@@ -43,13 +44,14 @@
       parameters: &sparams
         - name: Default Value
           required: true
-          description: Default value for this parameter. You must provide a default
+          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: "['\"].*['\"]"
+          values: '[''"].*[''"]'
         - name: Endianness
           required: false
           description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format

data/data/config/cmd_tlm_server.yaml

@@ -53,10 +53,10 @@ INTERFACE_TARGET:
     - name: Target Name
       required: true
       description: Name of the target
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Configuration File
       required: false
-      description: Configuration file name which contains the interface configuration.
+      description: Configuration filename which contains the interface configuration.
         Defaults to 'cmd_tlm_server.txt'.
       values: .+
 INTERFACE:
@@ -80,7 +80,7 @@ INTERFACE:
       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: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
         documentation for more details.
 ROUTER:
   modifiers:
@@ -109,7 +109,7 @@ ROUTER:
       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: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
         documentation for more details.
 COLLECT_METADATA:
   summary: Prompts the user for meta data when starting the Command and Telemetry Server

data/data/config/command.yaml

@@ -1,14 +1,16 @@
 ---
 COMMAND:
+  # Prevent prettier from removing the newline after modifiers:
+  # prettier-ignore
   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"
+  example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
   parameters:
     - name: Target
       required: true
       description: Name of the target this command is associated with
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Command
       required: true
       description: Name of this command. Also referred to as its mnemonic.
@@ -17,23 +19,25 @@ COMMAND:
     - 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']
+      values: ["BIG_ENDIAN", "LITTLE_ENDIAN"]
     - name: Description
       required: false
       description: Description of this command which must be enclosed with quotes
-      values: "['\"].*['\"]"
+      values: '[''"].*[''"]'
 SELECT_COMMAND:
+  # prettier-ignore
   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
+  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
+  example: SELECT_COMMAND INST COLLECT
   parameters:
     - name: Target Name
       required: true
       description: Name of the target this command is associated with
-      values: <%= System.targets.keys %>
+      values: .+
     - name: Command Name
       required: true
       description: Name of the command to select

data/data/config/command_modifiers.yaml

@@ -102,8 +102,8 @@ SELECT_PARAMETER:
     <%= 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
+    SELECT_COMMAND INST COLLECT
+      SELECT_PARAMETER DURATION
   parameters:
     - name: Parameter
       required: true
@@ -116,8 +116,8 @@ DELETE_PARAMETER:
     will be a "hole" in the packet where the data is not accessible. You can
     use SELECT_COMMAND and then PARAMETER to define a new parameter.
   example: |
-    SELECT_COMMAND SYSTEM STARTLOGGING
-      DELETE_PARAMETER LABEL
+    SELECT_COMMAND INST COLLECT
+      DELETE_PARAMETER DURATION
   since: 4.4.1
   parameters:
     - name: Parameter

data/data/config/interface_modifiers.yaml

@@ -1,18 +1,19 @@
 ---
-TARGET:
+MAP_TARGET:
   summary: Maps a target name to an interface
   parameters:
     - name: Target Name
       required: true
       description: Target name to map to this interface
-      values: <%= System.targets.keys %>
+      values: .+
 DONT_CONNECT:
   summary: Server will not automatically try to connect to the interface at startup
 DONT_RECONNECT:
   summary: Server will not try to reconnect to the interface if the connection is lost
 RECONNECT_DELAY:
   summary: Reconnect delay in seconds
-  description: If DONT_RECONNECT is not present the Server will try to reconnect to an
+  description:
+    If DONT_RECONNECT is not present the Server will try to reconnect to an
     interface if the connection is lost. Reconnect delay sets the interval in seconds
     between reconnect tries.
   parameters:
@@ -22,12 +23,14 @@ RECONNECT_DELAY:
       values: ([0-9]*[.])?[0-9]+
 DISABLE_DISCONNECT:
   summary: Disable the Disconnect button on the Interfaces tab in the Server
-  description: Use this keyword to prevent the user from disconnecting from the interface.
+  description:
+    Use this keyword to prevent the user from disconnecting from the interface.
     This is typically used in a 'production' environment where you would not want
     the user to inadvertantly disconnect from a target.
 LOG:
   summary: Enable logging on the interface by the specified log writer
-  description: LOG is only required if you want a log writer other than the default
+  description:
+    LOG is only required if you want a log writer other than the default
     to log commands and telemetry on this interface
   warning: Choosing a custom log writer can prevent COSMOS from reading back your log files
   parameters:
@@ -37,7 +40,8 @@ LOG:
       values: \D\S*
 LOG_STORED:
   summary: Enable logging of stored telemetry on the interface by the specified log writer
-  description: LOG_STORED allows you to specify a different log writer for stored telemetry
+  description:
+    LOG_STORED allows you to specify a different log writer for stored telemetry
     (telemetry which has the 'stored' flag set in the packet). By default the stored telemetry
     is intermingled in the normal log file.
   warning: Choosing a custom log writer can prevent COSMOS from reading back your log files
@@ -50,43 +54,46 @@ DONT_LOG:
   summary: Disable logging commands and telemetry on this interface
 LOG_RAW:
   summary: Log all data on the interface exactly as it is sent and received
-  description: LOG_RAW does not add any COSMOS headers and thus can not be read by COSMOS tools.
+  description:
+    LOG_RAW does not add any COSMOS headers and thus can not be read by COSMOS tools.
     It is primarily useful for low level debugging of an interface. You will have to
     manually parse these logs yourself using a hex editor or other application.
 PROTOCOL:
   summary: Protocols modify the interface by processing the data
-  description: Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data
+  description:
+    Protocols can be either READ, WRITE, or READ_WRITE. READ protocols act on the data
     received by the interface while write acts on the data before it is sent out. READ_WRITE applies
     the protocol to both reading and writing.<br/><br/>
     There is only one built in protocol implemented by override_protocol.rb.
     This protocol allows for Scripts to use the override_tlm() and normalize_tlm() methods to permanently
     change a telemetry value. Note, this differs from set_tlm() as set_tlm() is over-written by new
     incoming telemetry.<br/><br/>
-    For information on creating your own custom protocol please see <a href="http://cosmosrb.com/docs/protocols">cosmosrb.com/docs/protocols</a>
+    For information on creating your own custom protocol please see <a href="http://cosmosc2.com/docs/v5/protocols">cosmosc2.com/docs/v5/protocols</a>
   since: 4.0.0
   parameters:
     - name: Type
       required: true
       description: Whether to apply the protocol on incoming data, outgoing data, or both
-      values: ['READ', 'WRITE', 'READ_WRITE']
+      values: ["READ", "WRITE", "READ_WRITE"]
     - name: Protocol Filename or Classname
       required: true
-      description: Ruby file name or class name which implements the protocol
+      description: Ruby filename or class name which implements the protocol
       values: .*
     - name: Protocol specific parameters
       required: false
       description: Additional parameters used by the protocol
 OPTION:
   summary: Set a parameter on an interface
-  description: When an option is set the interface class calls the set_option method.
+  description:
+    When an option is set the interface class calls the set_option method.
     Custom interfaces can override set_option to handle any additional options they want.
   parameters:
     - name: Name
       required: true
-      description: The option to set. COSMOS defines several options on the core provided
-        interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS,
-        STRUCT to directly set fields in the Windows DCB or POSIX structure and it defines
-        DATA_BITS which changes the data bits of the serial interface.
+      description:
+        The option to set. COSMOS defines several options on the core provided
+        interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS
+        and DATA_BITS which changes the data bits of the serial interface.
         The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept
         connections on (default 0.0.0.0) and AUTO_SYSTEM_META which will automatically send
         SYSTEM META when the interface connects (default false).

data/data/config/item_modifiers.yaml

@@ -55,11 +55,11 @@ READ_CONVERSION:
       end
     end
   parameters:
-    - name: Class File Name
+    - name: Class Filename
       required: true
-      description: The file name which contains the Ruby class. The file name must
+      description: 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 file name. For example, 'the_great_conversion.rb' should contain
+        underscored filename. For example, 'the_great_conversion.rb' should contain
         'class TheGreatConversion'.
       values: .*\.rb
     - name: Parameter

data/data/config/microservice.yaml

@@ -0,0 +1,66 @@
+---
+MICROSERVICE:
+  summary: Defines a new microservice
+  example: MICROSERVICE EXAMPLE example-microservice
+  parameters:
+    - name: Folder Name
+      required: true
+      description: The target folder where the microservice is located
+      values: .*
+    - name: Name
+      required: true
+      description: The microservice name
+      values: .*
+  modifiers:
+    ENV:
+      summary: Environment variable
+      parameters:
+        - name: Name
+          required: true
+          description: Environment variable name
+          values: .*
+        - name: Value
+          required: true
+          description: Environment variable value
+          values: .*
+    WORK_DIR:
+      summary: Directory to start the microservice in (CWD)
+      parameters:
+        - name: Path
+          required: true
+          description: Relative path from the target directory
+          values: .*
+    TOPIC:
+      summary: Topic the microservice should process data from
+      parameters:
+        - name: Name
+          required: true
+          description: Topic name
+          values: .*
+    TARGET_NAME:
+      summary: Target which this microservice processes
+      parameters:
+        - name: Name
+          required: true
+          description: Target name
+          values: .*
+    CMD:
+      summary: Command to run which starts the microservice
+      parameters:
+        - name: Executable
+          required: true
+          description: Executable to call
+          values: .*
+        - name: Command parameters
+          required: false
+          description: Additional parameters used by the command
+    OPTION:
+      summary: Options to pass to the underlying microservice (used by InterfaceMicroservice, etc.)
+      parameters:
+        - name: Name
+          required: true
+          description: Option name
+          values: .*
+        - name: Values
+          required: false
+          description: Option values

data/data/config/parameter_modifiers.yaml

@@ -96,11 +96,11 @@ WRITE_CONVERSION:
       end
     end
   parameters:
-    - name: Class File Name
+    - name: Class Filename
       required: true
-      description: The file name which contains the Ruby class. The file name must
+      description: 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 file name. For example, 'the_great_conversion.rb' should contain
+        underscored filename. For example, 'the_great_conversion.rb' should contain
         'class TheGreatConversion'.
       values: .*\.rb
     - name: Parameter