cosmos 3.9.2 → 4.0.0

data/data/config/_array_params.yaml

@@ -0,0 +1,23 @@
+---
+- name: Item Bit Size
+  required: true
+  description: Bit size of each array item
+  values: \d+
+- name: Item Data Type
+  required: true
+  description: Data Type of each array item
+  values: <%= %w(INT UINT FLOAT STRING BLOCK DERIVED) %>
+- name: Array Bit Size
+  required: true
+  description: Total Bit Size of the Array. Zero or Negative values may be used
+    to indicate the array fills the packet up to the offset from the end of the
+    packet specified by this value.
+  values: '[-]?\d+'
+- name: Description
+  required: false
+  description: Description which must be enclosed with quotes
+  values: "['\"].*['\"]"
+- name: Endianness
+  required: false
+  description: Indicates if the data is to be sent in Big Endian or Little Endian format
+  values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_id_items.yaml

@@ -0,0 +1,24 @@
+---
+- 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 DERVIED) %>
+- name: ID Value
+  required: true
+  description: The value of this telemetry item that uniquely identifies this telemetry packet
+  values: .+
+- 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/_id_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: ID Value
+          required: true
+          description: Identification value for this parameter. The binary data must
+            match this value for the buffer to be identified as this packet.
+          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
+    DERVIED:
+      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/_interfaces.yaml

@@ -0,0 +1,206 @@
+---
+tcpip_client_interface.rb:
+  parameters:
+    - name: Host
+      required: true
+      description: Machine name to connect to. Can be either a named
+        machine (DNS entry) or IP address.
+      values: .+
+    - name: Write Port
+      required: true
+      description: Port which COSMOS writes commands to
+      values: \d{2,5}
+    - name: Read Port
+      required: true
+      description: Port which COSMOS reads telemetry from
+      values: \d{2,5}
+    - name: Write Timeout
+      required: true
+      description: Number of seconds to wait before aborting the write.
+        Pass 'nil' to block on write.
+      values: .+
+    - name: Read Timeout
+      required: true
+      description: Number of seconds to wait before aborting the read.
+        Pass 'nil' to block on read.
+      values: .+
+    - name: Protocol Type
+      required: true
+      description: Protocol to apply on the interface data
+      values:
+        <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
+tcpip_server_interface.rb:
+  parameters:
+    - name: Write Port
+      required: true
+      description: Port which COSMOS writes commands to
+      values: \d{2,5}
+    - name: Read Port
+      required: true
+      description: Port which COSMOS reads telemetry from
+      values: \d{2,5}
+    - name: Write Timeout
+      required: true
+      description: Number of seconds to wait before aborting the write.
+        Pass 'nil' to block on write.
+      values: .+
+    - name: Read Timeout
+      required: true
+      description: Number of seconds to wait before aborting the read.
+        Pass 'nil' to block on read.
+      values: .+
+    - name: Protocol Type
+      required: true
+      description: Protocol to apply on the interface data
+      values:
+        <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
+udp_interface.rb:
+  description: The UDP interface uses UDP packets to send and receive telemetry
+    from the target
+  parameters:
+    - name: Host
+      required: true
+      description: Machine name to connect to. Can be either a named
+        machine (DNS entry) or IP address.
+      values: .+
+    - name: Write Port
+      required: true
+      description: Port which COSMOS writes commands to
+      values: \d{2,5}
+    - name: Read Port
+      required: true
+      description: Port which COSMOS reads telemetry from
+      values: \d{2,5}
+    - name: Write Source Port
+      required: false
+      description: Port on the local machine to send commands from. Default is
+        'nil' (socket is not bound to an outgoing port).
+      values: \d{2,5}
+    - name: Inteface Address
+      required: false
+      description: If the remote machine supports multicast the interface address
+        is used to configure the outgoing multicast address
+      values: .+
+    - name: Time To Live
+      required: false
+      description: The number of intermediate routers allowed before dropping the packet
+      values: .+
+    - name: Write Timeout
+      required: false
+      description: Number of seconds to wait before aborting the write. Default is
+        'nil' (block on write).
+      values: .+
+    - name: Read Timeout
+      required: false
+      description: Number of seconds to wait before aborting the read. Default is
+        'nil' (block on read).
+      values: .+
+serial_interface.rb:
+  description: Connects to a target over a serial port. COSMOS provides drivers
+    for both Windows and POSIX drivers for UNIX based systems.
+  parameters:
+    - name: Write Port
+      required: true
+      description: Name of the serial port to write, e.g. 'COM1' or '/dev/ttyS0'.
+        Pass 'nil' to disable writing.
+      values: \d{2,5}
+    - name: Read Port
+      required: true
+      description: Name of the serial port to read, e.g. 'COM1' or '/dev/ttyS0'.
+        Pass 'nil' to disable reading.
+      values: \d{2,5}
+    - name: Baud Rate
+      required: true
+      description: Baud rate to read and write
+      values: .+
+    - name: Parity
+      required: true
+      description: Serial port parity
+      values: ['NONE','EVENT','ODD']
+    - name: Stop Bits
+      required: true
+      description: Number of stop bits
+      values: .+
+    - name: Write Timeout
+      required: true
+      description: Number of seconds to wait before aborting the write.
+        Pass 'nil' to block on write.
+      values: .+
+    - name: Read Timeout
+      required: true
+      description: Number of seconds to wait before aborting the read.
+        Pass 'nil' to block on read.
+      values: .+
+    - name: Protocol Type
+      required: true
+      description: Protocol to apply on the interface data
+      values:
+        <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
+cmd_tlm_server_interface.rb:
+  description: Provides a connection to the COSMOS Command and Telemetry Server.
+    This allows scripts and other COSMOS tools to send commands to the CmdTlmServer
+    to enable and disable logging. It also allows scripts and other tools to
+    receive a COSMOS version information packet and a limits change packet which
+    is sent when any telemetry items change limits states. The CmdTlmServer
+    interface can be used by any COSMOS configuration.
+linc_interface.rb:
+  description: The LINC interface uses a single TCPIP socket to talk to a Ball
+    Aerospace LINC Labview target.
+  parameters:
+    - name: Host
+      required: true
+      description: Machine name to connect to. Can be either a named
+        machine (DNS entry) or IP address.
+      values: .+
+    - name: Port
+      required: true
+      description: Port to write commands to and read telemetry from
+      values: \d{2,5}
+    - name: Handshake Enabled
+      required: false
+      description: Enable command handshaking where commands block until the
+        corresponding handshake message is received. Default is true.
+      values: ['true','false']
+    - name: Response Timeout
+      required: false
+      description: Number of seconds to wait for a handshaking response.
+        Default is 5 seconds
+      values: \d+
+    - name: Read Timeout
+      required: true
+      description: Number of seconds to wait before aborting the read.
+        Pass 'nil' to block on read. Default is nil.
+      values: .+
+    - name: Write Timeout
+      required: true
+      description: Number of seconds to wait before aborting the write.
+        Pass 'nil' to block on write. Default is 5 seconds.
+      values: .+
+    - name: Length Bit Offset
+      required: false
+      description: The bit offset of the length field. Every packet using this
+        interface must have the same structure such that the length field is the
+        same size at the same location. Default is 0.
+      values: \d+
+    - name: Length Bit Size
+      required: false
+      description: The size in bits of the length field. Default is 16 bits.
+      values: \d+
+    - name: Length Value Offset
+      required: false
+      description: The offset to apply to the length field value. For example if
+        the length field indicates packet length minus one, this value should be one.
+        Default is 4.
+      values: \d+
+    - name: GUID Fieldname
+      required: false
+      description: Fieldname of the GUID field. Default is 'HDR_GUID'.
+      values: .+
+    - name: Length Endianness
+      required: false
+      description: The endianness of the length field. Default is BIG_ENDIAN.
+      values: ['BIG_ENDIAN','LITTLE_ENDIAN']
+    - name: Length Fieldname
+      required: false
+      description: Fieldname of the length field. Defaults is 'HDR_LENGTH'.
+      values: .+

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 DERVIED) %>
+- 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
+    DERVIED:
+      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,110 @@
+---
+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.
+  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
+  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) %>
+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) %>
+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.
+  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: .+