openc3 5.0.6

data/data/config/protocols.yaml

@@ -0,0 +1,290 @@
+---
+BURST:
+  description:
+    The Burst Stream Protocol simply reads as much data as it can from
+    the stream before returning the data as a OpenC3 Packet. This Protocol relies
+    on regular bursts of data delimited by time and thus is not very robust.
+    However it can utilize a sync pattern which does allow it to re-sync from the
+    stream if necessary.
+  parameters:
+    - name: Discard Leading Bytes
+      required: false
+      description:
+        The number of bytes to discard from the binary data after reading
+        from the stream. Note that this applies to bytes starting with the sync
+        pattern if the sync pattern is being used. Default is 0 (don't discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned. Default is 'nil'
+        (no sync pattern).
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description:
+        Whether or not to fill in the sync pattern on outgoing packets
+        Default is false.
+      values: ["true", "false"]
+FIXED:
+  description: The Fixed Stream Protocol reads a preset minimum amount of data
+    from the stream which is necessary to properly identify all the defined packets
+    using the interface. It then identifies the packet and proceeds to read as much
+    data from the stream as necessary to create the packet which it then returns.
+    This stream relies on all the packets on the interface being fixed in length.
+    For example, all the packets using the interface are a fixed size and contain
+    a simple header with a 32 bit sync pattern followed by a 16 bit ID. The Fixed
+    Stream Protocol would elegantly handle this case with a minimum read size of
+    6 bytes.
+  parameters:
+    - name: Minimum ID Size
+      required: true
+      description: The minimum amount of bytes needed to identify a packet.
+        All the packet definitions must declare their ID_ITEM(s) within this given
+        amount of bytes.
+      values: \d+
+    - name: Discard Leading Bytes
+      required: false
+      description:
+        The number of bytes to discard from the binary data after reading
+        from the stream. Note that this applies to bytes starting with the sync
+        pattern if the sync pattern is being used. Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned. Default is 'nil'
+        (no sync pattern).
+      values: .+
+    - name: Telemetry Stream
+      required: false
+      description: Whether the stream is returning telemetry. Default is true.
+      values: ["true", "false"]
+    - name: Fill Sync Pattern
+      required: false
+      description:
+        Whether or not to fill in the sync pattern on outgoing packets.
+        Default is false.
+      values: ["false", "true"]
+LENGTH:
+  description: The Length Stream Protocol depends on a length field at a fixed
+    location in the defined packets using the interface. It then reads enough data
+    to grab the length field, decodes it, and reads the remaining length of the
+    packet. For example, all the packets using the interface contain a CCSDS
+    header with a length field. The Length Stream Protocol can be set up to handle
+    the length field and even the "length - 1" offset the CCSDS header uses.
+  parameters:
+    - 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. Be sure to account for the length of the
+        Sync Pattern in this value (if present). Default is 0.
+      values: \d+
+    - name: Length Bit Size
+      required: false
+      description: The size in bits of the length field. Default is 16.
+      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. Be sure to account for the length of the Sync Pattern in this value
+        (if present). Default is 0.
+      values: \d+
+    - name: Bytes per Count
+      required: false
+      description:
+        The number of bytes per each length field 'count'. This is used
+        if the units of the length field is something other than bytes,
+        for example if the length field count is in words. Default is 1.
+      values: \d+
+    - name: Length Endianness
+      required: false
+      description: The endianness of the length field.
+      values: ["BIG_ENDIAN", "LITTLE_ENDIAN"]
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used. Discarding is one of the
+        very last steps so any size and offsets above need to account for all the
+        data before discarding. Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern)
+      values: .+
+    - name: Max Length
+      required: false
+      description: The maximum allowed value in the length field.
+        Default is nil (no maximum length)
+      values: .+
+    - name: Fill Length and Sync Pattern
+      required: false
+      description: Setting this flag to true causes the length field and sync
+        pattern (if present) to be filled automatically on outgoing packets.
+        Default is false
+      values: ["false", "true"]
+TERMINATED:
+  description:
+    The Terminated Stream Protocol delineates packets using termination
+    characters found at the end of every packet. It continuously reads data from
+    the stream until the termination characters are found at which point it returns
+    the packet data. For example, all the packets using the interface are followed
+    by 0xABCD. This data can either be a part of each packet that is kept or
+    something which is known only by the Terminated Stream Protocol and simply
+    thrown away.
+  parameters:
+    - name: Write Termination Characters
+      required: true
+      description:
+        The data to write to the stream after writing a command packet.
+        Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Read Termination Characters
+      required: true
+      description:
+        The characters at the end of the stream which delineate the end
+        of a telemetry packet. Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Strip Read Termination
+      required: false
+      description: Whether to remove the read termination characters from the
+        stream before returning the telemetry packet. Default is true.
+      values: ["true", "false"]
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used.
+        Default is 0 (do not discard bytes)
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern)
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description:
+        Whether or not to fill in the sync pattern on outgoing packets
+        Default is false
+      values: ["false", "true"]
+PREIDENTIFIED:
+  description:
+    The Preidentified Stream Protocol is used internally by the OpenC3
+    Command and Telemetry Server only and delineates packets using a custom OpenC3
+    header. This stream Protocol is configured by default on port 7779 and is
+    created by the Command and Telemetry Server to allow tools to connect and
+    receive the entire packet stream. The Telemetry Grapher uses this port to
+    receive all the packets following through the Command and Telemetry Server
+    in case any need to be graphed.
+  parameters:
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found AFTER the sync pattern will be returned. The sync pattern itself
+        is discarded. Default is nil (no sync pattern)
+      values: .+
+    - name: Max Length
+      required: false
+      description: The maximum allowed value in the length field.
+        Default is nil (no maximum length)
+      values: .+
+TEMPLATE:
+  description:
+    The Template Stream Protocol works much like the Terminated Stream
+    Protocol except it designed for text-based command and response type interfaces
+    such as SCPI (Standard Commands for Programmable Instruments). It delineates
+    packets in the same way as the terminated stream protocol except each packet
+    is referred to as a line (because each usually contains a line of text).
+    For outgoing packets a CMD_TEMPLATE field is expected to exist in the packet.
+    This field contains a template string with items to be filled in deliniated
+    within HTML tag style brackets “". The Template Stream Protocol will read the
+    named items from within the packet fill in the CMD_TEMPLATE. This filled in
+    string is then sent out rather than the originally passed in packet.
+    Correspondingly, if a response is expected the outgoing packet should include
+    a RSP_TEMPLATE and RSP_PACKET field. The RSP_TEMPLATE is used to extract data
+    from the response string and build a corresponding RSP_PACKET. See the TEMPLATE
+    target within the OpenC3 Demo configuration for an example of usage.
+  parameters:
+    - name: Write Termination Characters
+      required: true
+      description:
+        The data to write to the stream after writing a command packet.
+        Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Read Termination Characters
+      required: true
+      description:
+        The characters at the end of the stream which delineate the end
+        of a telemetry packet. Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Ignore Lines
+      required: false
+      description: Number of response lines to ignore (completely drop).
+        Default is 0.
+      values: \d+
+    - name: Initial Read Delay
+      required: false
+      description: An initial delay after connecting after which the stream will
+        be read till empty and data dropped. Useful for discarding connect headers
+        and initial prompts. Default is nil (no initial read).
+      values: .+
+    - name: Response Lines
+      required: false
+      description: The number of lines that make up expected responses.
+        Default is 1.
+      values: \d+
+    - name: Strip Read Termination
+      required: false
+      description: Whether to remove the read termination characters from the
+        stream before returning the telemetry packet. Default is true.
+      values: ["true", "false"]
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used.
+        Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern).
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description:
+        Whether or not to fill in the sync pattern on outgoing packets.
+        Default is false.
+      values: ["false", "true"]
+    - name: Response Timeout
+      required: false
+      description:
+        Number of seconds to wait before timing out when waiting for a response.
+        Default is 5 seconds.
+      values: .+
+    - name: Response Polling Period
+      required: false
+      description: Number of seconds to wait between polling for a response.
+        Default is 0.02 seconds.
+      values: .+
+    - name: Error Action
+      required: false
+      description:
+        How to handle errors in the protocol like unexpected responses
+        or response timeouts. 'DISCONNECT' to disconnect after errors. The default
+        is 'LOG' to log an error and continue.
+      values: ["LOG", "DISCONNECT"]

data/data/config/screen.yaml

@@ -0,0 +1,147 @@
+---
+SCREEN:
+  summary: Define a telemetry viewer screen
+  parameters:
+    - name: Width
+      required: true
+      description: Width in pixels or AUTO to let Telemetry Viewer automatically
+        layout the screen
+      values: \d+
+    - name: Height
+      required: true
+      description: Height in pixels or AUTO to let Telemetry Viewer automatically
+        layout the screen
+      values: \d+
+    - name: Polling Period
+      required: true
+      description: Number of seconds between screen updates
+      values: '[0-9]*\.?[0-9]+'
+END:
+  summary: Indicates the close of a layout widget
+  description: All layout widgets must be closed to properly identify where they
+    stop. For example, a VERTICALBOX keyword must be matched with an END keyword
+    to indicate where the VERTICALBOX ends.
+GLOBAL_SETTING:
+  summary: Applies a widget setting to all widgets of a certain type
+  parameters:
+    - name: Widget Class Name
+      required: true
+      description: The name of the class of widgets that this setting will be
+        applied to. For example, LABEL or BUTTON.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. OpenC3 defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+GLOBAL_SUBSETTING:
+  summary: Applies a widget subsetting to all widgets of a certain type
+  description: Subsettings are only valid for widgets that are
+    made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
+    at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
+    settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
+    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
+    Index to first index the LABELVALUE and then the LABEL.
+  parameters:
+    - name: Widget Class Name
+      required: true
+      description: The name of the class of widgets that this setting will be
+        applied to. For example, LABELVALUE.
+      values: .+
+    - name: Subwidget Index
+      required: true
+      description: Index to the desired subwidget or 'ALL' to apply the setting
+        to all the subwidgets of this composite widget.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. OpenC3 defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+SETTING:
+  summary: Applies a widget setting to the previously defined widget
+  parameters:
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. OpenC3 defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+SUBSETTING:
+  summary: Applies a widget subsetting to the previously defined widget
+  description: Subsettings are only valid for widgets that are
+    made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
+    at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
+    settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
+    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
+    Index to first index the LABELVALUE and then the LABEL.
+  parameters:
+    - name: Subwidget Index
+      required: true
+      description: Index to the desired subwidget or 'ALL' to apply the setting
+        to all the subwidgets of this composite widget.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. OpenC3 defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+NAMED_WIDGET:
+  summary: Name a widget to allow access to it via the get_named_widget method
+  description: To programatically access parts of a telemetry screen you need
+    to name the widget. This is useful when creating screens with buttons that
+    read values from other widgets.
+  warning: get_named_widget returns the widget itself and thus must be operated
+    on using methods native to that widget
+  parameters:
+    - name: Widget Name
+      required: true
+      description: The unique name applied to the following widget instance.
+        Names must be unique per screen.
+      values: .+
+    - name: Widget Type
+      required: true
+      description: One of the widget types listed in Widget Descriptions
+      values: .+
+    - name: Widget Parameters
+      required: true
+      description: The unique parameters for the given widget type
+      values: .+
+# Even though these are technically SCREEN modifiers we load them at the top_frame
+# level so they appear as available keywords
+<%= MetaConfigParser.load('widgets.yaml').to_meta_config_yaml(0) %>

data/data/config/table_manager.yaml

@@ -0,0 +1,89 @@
+---
+TABLEFILE:
+  summary: Specify another file to open and process for table definitions
+  parameters:
+    - name: File Name
+      required: true
+      description: Name of the file. The file will be looked for in the directory
+        of the current definition file.
+      values: '.+\.txt'
+TABLE:
+  modifiers:
+    PARAMETER:
+      modifiers:
+        <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+        <%= MetaConfigParser.load('table_parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+      summary: Defines a parameter in the current table
+      parameters:
+        - name: Name
+          required: true
+          description: Name of the parameter. Must be unique within the table.
+          values: '\D\S*'
+        - name: Bit Offset
+          required: true
+          description: Bit offset into the table of the Most Significant Bit of this parameter.
+            May be negative to indicate on offset from the end of the table.
+            Always use a bit offset of 0 for derived parameters.
+          values: '[-]?\d+'
+        <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(8) %>
+    APPEND_PARAMETER:
+      modifiers:
+        <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+        <%= MetaConfigParser.load('table_parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+      summary: Defines a parameter in the current table
+      parameters:
+        - name: Name
+          required: true
+          description: Name of the parameter. Must be unique within the table.
+          values: .+
+        <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(8) %>
+  summary: Start a new table definition
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the table in quotes. The name will appear on the GUI tab.
+      values: "['\"].*['\"]"
+    - name: Endianness
+      required: true
+      description: Indicates if the data in this table is in Big Endian or Little Endian format
+      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+    - name: Display
+      requires: true
+      description: Indicates the table contains KEY_VALUE rows (e.g. each row is unique),
+        or a ROW_COLUMN table with identical rows containing different values.
+      values:
+        KEY_VALUE:
+          summary: Table rows will be unique items (previously ONE_DIMENSIONAL, now deprecated)
+          parameters:
+            - name: Description
+              requires: true
+              description: Description of the table in quotes. The description is
+                used in mouseover popups and status line information.
+              values: "['\"].*['\"]"
+        ROW_COLUMN:
+          summary: Table rows will be indentical with multiple columns (previously TWO_DIMENSIONAL, now deprecated)
+          parameters:
+            - name: Rows
+              requires: true
+              description: The number of rows in the table
+              values: \d+
+            - name: Description
+              requires: true
+              description: Description of the table in quotes. The description is
+                used in mouseover popups and status line information.
+              values: "['\"].*['\"]"
+SELECT_TABLE:
+  summary: Select an existing table for editing, typically done to override an existing definition
+  parameters:
+    - name: Table
+      required: true
+      description: The name of the existin table
+      values: .*
+DEFAULT:
+  summary: Specify default values for a SINGLE row in a multi-column table.
+    If you have multiple rows you need a DEFAULT line for each row.
+    If all your rows are identical consider using ERB as shown in the OpenC3 demo.
+  parameters:
+    - name: Default values
+      required: false
+      description: A STATE value or data value corresponding to the data type

data/data/config/table_parameter_modifiers.yaml

@@ -0,0 +1,9 @@
+---
+HIDDEN:
+  summary: Indicates that the parameter should not be shown to the user in the Table Manager GUI
+  description: Hidden parameters still exist and will be saved to the resulting
+    binary. This is useful for padding and other essential but non-user editable fields.
+UNEDITABLE:
+  summary: Indicates that the parameter should be shown to the user but not editable.
+  description: Uneditable parameters are useful for control fields which the user
+    may be interested in but should not be able to edit.

data/data/config/target.yaml

@@ -0,0 +1,142 @@
+---
+TARGET:
+  summary: Defines a new target
+  example: TARGET INST
+  parameters:
+    - name: Folder Name
+      required: true
+      description: The target folder
+      values: .*
+    - name: Name
+      required: true
+      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+