Merge pull request #2229 from OpenC3/playback

TlmViewer Playback

Author: jmthomas

.env

@@ -12,7 +12,7 @@ OPENC3_ENTERPRISE_REGISTRY=ghcr.io
 OPENC3_ENTERPRISE_NAMESPACE=openc3
 OPENC3_UBI_REGISTRY=registry1.dso.mil
 OPENC3_UBI_IMAGE=ironbank/redhat/ubi/ubi9-minimal
-OPENC3_UBI_TAG=9.5
+OPENC3_UBI_TAG=9.6
 # Defined here as blank to avoid warnings. Used in the compose.yaml to pass '-ubi'.
 OPENC3_IMAGE_SUFFIX=
 # Bucket & Volume configuration
@@ -35,6 +35,12 @@ OPENC3_REDIS_HOSTNAME=openc3-redis
 OPENC3_REDIS_PORT=6379
 OPENC3_REDIS_EPHEMERAL_HOSTNAME=openc3-redis-ephemeral
 OPENC3_REDIS_EPHEMERAL_PORT=6380
+# Database configuration
+# OPENC3_TSDB_HOSTNAME=openc3-tsdb
+# OPENC3_TSDB_QUERY_PORT=8812
+# OPENC3_TSDB_INGEST_PORT=9000
+# OPENC3_TSDB_USERNAME=openc3quest
+# OPENC3_TSDB_PASSWORD=openc3questpassword
 # Usernames and passwords
 # These lines can be removed from this file if available in the host computer environment variables
 OPENC3_REDIS_USERNAME=openc3

compose-build.yaml

@@ -66,6 +66,14 @@ services:
         OPENC3_DEPENDENCY_REGISTRY: ${OPENC3_DEPENDENCY_REGISTRY}
     image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-minio:${OPENC3_TAG}"
 
+  openc3-tsdb:
+    build:
+      context: "openc3-tsdb"
+      network: host
+      args:
+        OPENC3_DEPENDENCY_REGISTRY: ${OPENC3_DEPENDENCY_REGISTRY}
+    image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-tsdb:${OPENC3_TAG}"
+
   openc3-redis:
     build:
       context: "openc3-redis"

compose.yaml

@@ -49,6 +49,32 @@ services:
       REQUESTS_CA_BUNDLE: "/devel/cacert.pem"
       NODE_EXTRA_CA_CERTS: "/devel/cacert.pem"
 
+  # Uncomment to use QuestDB as the time series database
+  # Also uncomment the openc3-tsdb-v volume in the volumes section
+  # openc3-tsdb:
+  #   image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-tsdb${OPENC3_IMAGE_SUFFIX}:${OPENC3_TAG}"
+  #   ports:
+  #     # You should disable the QuestDB Console in production
+  #     # as it gives unlimited access to the database
+  #     - "127.0.0.1:9000:9000" # OPENC3_TSDB_INGEST_PORT & QuestDB Console
+  #     # The Postgresql port doesn't typically need to be exposed to the host
+  #     # but if you have external software that needs to connect to QuestDB
+  #     # you can uncomment the following line to expose it.
+  #     # - "127.0.0.1:8812:8812" # OPENC3_TSDB_QUERY_PORT
+  #   volumes:
+  #     - "openc3-tsdb-v:/var/lib/questdb"
+  #   restart: "unless-stopped"
+  #   logging:
+  #     driver: "json-file"
+  #     options:
+  #       max-size: "10m"
+  #       max-file: "3"
+  #   environment:
+  #     QDB_PG_USER: "${OPENC3_TSDB_USERNAME}"
+  #     QDB_PG_PASSWORD: "${OPENC3_TSDB_PASSWORD}"
+  #     QDB_HTTP_USER: "${OPENC3_TSDB_USERNAME}"
+  #     QDB_HTTP_PASSWORD: "${OPENC3_TSDB_PASSWORD}"
+
   openc3-redis:
     user: "${OPENC3_USER_ID:-1001}:${OPENC3_GROUP_ID:-1001}"
     image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-redis${OPENC3_IMAGE_SUFFIX}:${OPENC3_TAG}"
@@ -263,6 +289,7 @@ services:
       - .env
 
 volumes:
+  # openc3-tsdb-v: {}
   openc3-redis-v: {}
   openc3-redis-ephemeral-v: {}
   openc3-bucket-v: {}

docs.openc3.com/docs/guides/scripting-api.md

@@ -131,7 +131,7 @@ The following API methods are either deprecated (will not be ported to COSMOS 5)
 | stop_tlm_log                          | Command and Telemetry Server | Deprecated                                                          |
 | subscribe_limits_events               | Command and Telemetry Server | Deprecated                                                          |
 | subscribe_packet_data                 | Command and Telemetry Server | Deprecated, use subscribe_packets                                   |
-| subscribe_server_messages             | Command and Telemetry Server | Unimplemented                                                       |
+| subscribe_server_messages             | Command and Telemetry Server | Deprecated                                                          |
 | tlm_variable                          | Script Runner                | Deprecated, use tlm() and pass type                                 |
 | unsubscribe_limits_events             | Command and Telemetry Server | Deprecated                                                          |
 | unsubscribe_packet_data               | Command and Telemetry Server | Deprecated                                                          |
@@ -1928,7 +1928,7 @@ status = critical_cmd_can_approve("2fa14183-3148-4399-9a74-a130257118f9") #=> tr
 <TabItem value="python" label="Python Example">
 
 ```python
-status = critical_cmd_can_approve("2fa14183-3148-4399-9a74-a130257118f9") #=> true / false
+status = critical_cmd_can_approve("2fa14183-3148-4399-9a74-a130257118f9") #=> True / False
 ```
 
 </TabItem>
@@ -2309,6 +2309,52 @@ names_values_and_limits_states = get_tlm_packet("INST HEALTH_STATUS", type='FORM
 </TabItem>
 </Tabs>
 
+### get_tlm_available
+
+Returns the _actual_ items available based on the specified set of telemetry items. For example, if you request `INST__HEALTH_STATUS__CCSDSVER__WITH_UNITS` the method will return `INST__HEALTH_STATUS__CCSDSVER__RAW` for that item because it does not have formatting or conversions so only the RAW value is available. This _must_ be called before calling `get_tlm_values` when passing a `start_time` / `end_time` as it ensures a correct request of historical data.
+
+<Tabs groupId="script-language">
+<TabItem value="ruby" label="Ruby Syntax">
+
+```ruby
+actual = get_tlm_available(<Items>)
+```
+
+</TabItem>
+
+<TabItem value="python" label="Python Syntax">
+
+```python
+actual = get_tlm_available(<Items>)
+```
+
+</TabItem>
+</Tabs>
+
+| Parameter | Description                                                 |
+| --------- | ----------------------------------------------------------- |
+| Items     | Array of strings of the form ['TGT__PKT__ITEM__TYPE', ... ] |
+
+<Tabs groupId="script-language">
+<TabItem value="ruby" label="Ruby Example">
+
+```ruby
+actual = get_tlm_available(["INST__HEALTH_STATUS__CCSDSVER__WITH_UNITS", "INST__HEALTH_STATUS__TEMP1__WITH_UNITS"])
+puts values # ["INST__HEALTH_STATUS__CCSDSVER__RAW", "INST__HEALTH_STATUS__TEMP1__WITH_UNITS"]
+```
+
+</TabItem>
+
+<TabItem value="python" label="Python Example">
+
+```python
+values = get_tlm_available(["INST__HEALTH_STATUS__CCSDSVER__WITH_UNITS", "INST__HEALTH_STATUS__TEMP1__WITH_UNITS"])
+print(values) # ["INST__HEALTH_STATUS__CCSDSVER__RAW", "INST__HEALTH_STATUS__TEMP1__WITH_UNITS"]
+```
+
+</TabItem>
+</Tabs>
+
 ### get_tlm_values
 
 Returns the values and current limits state for a specified set of telemetry items. Items can be in any telemetry packet in the system. They can all be retrieved using the same value type or a specific value type can be specified for each item.
@@ -2340,7 +2386,7 @@ values, limits_states, limits_settings, limits_set = get_tlm_values(<Items>)
 
 ```ruby
 values = get_tlm_values(["INST__HEALTH_STATUS__TEMP1__CONVERTED", "INST__HEALTH_STATUS__TEMP2__RAW"])
-print(values) # [[-100.0, :RED_LOW], [0, :RED_LOW]]
+puts values # [[-100.0, :RED_LOW], [0, :RED_LOW]]
 ```
 
 </TabItem>
@@ -2388,7 +2434,7 @@ get_all_tlm("<Target Name>")
 
 ```ruby
 packets = get_all_tlm("INST")
-print(packets)
+puts packets
 #[{"target_name"=>"INST",
 #  "packet_name"=>"ADCS",
 #  "endianness"=>"BIG_ENDIAN",
@@ -2549,7 +2595,7 @@ get_tlm("<Target Name>", "<Packet Name>")
 
 ```ruby
 packet = get_tlm("INST HEALTH_STATUS")
-print(packet)
+puts packet
 #{"target_name"=>"INST",
 # "packet_name"=>"HEALTH_STATUS",
 # "endianness"=>"BIG_ENDIAN",
@@ -2633,7 +2679,7 @@ get_item("<Target Name>", "<Packet Name>", "<Item Name>")
 
 ```ruby
 item = get_item("INST HEALTH_STATUS CCSDSVER")
-print(item)
+puts item
 #{"name"=>"CCSDSVER",
 # "bit_offset"=>0,
 # "bit_size"=>3,
@@ -3258,7 +3304,7 @@ success = wait("<Target Name> <Packet Name> <Item Name> <Comparison>", <Timeout>
 <TabItem value="python" label="Python Syntax">
 
 ```python
-# Returns true or false based on the whether the expression is true or false
+# Returns True or False based on the whether the expression is True or False
 success = wait("<Target Name> <Packet Name> <Item Name> <Comparison>", <Timeout>, <Polling Rate (optional)>, type, quiet)
 ```
 
@@ -3435,7 +3481,7 @@ success = wait_packet("<Target>", "<Packet>", <Num Packets>, <Timeout>, <Polling
 <TabItem value="python" label="Python Syntax">
 
 ```python
-# Returns true or false based on the whether the packet was received
+# Returns True or False based on the whether the packet was received
 success = wait_packet("<Target>", "<Packet>", <Num Packets>, <Timeout>, <Polling Rate (optional)>, quiet)
 ```
 
@@ -4133,7 +4179,7 @@ set_limits('INST', 'HEALTH_STATUS', 'TEMP1', -10.0, 0.0, 50.0, 60.0, 30.0, 40.0,
 <TabItem value="python" label="Python Example">
 
 ```python
-set_limits('INST', 'HEALTH_STATUS', 'TEMP1', -10.0, 0.0, 50.0, 60.0, 30.0, 40.0, 'TVAC', 1, true)
+set_limits('INST', 'HEALTH_STATUS', 'TEMP1', -10.0, 0.0, 50.0, 60.0, 30.0, 40.0, 'TVAC', 1, True)
 ```
 
 </TabItem>
@@ -4239,7 +4285,7 @@ get_limits_event(<Offset>, count)
 
 ```ruby
 events = get_limits_event()
-print(events)
+puts events
 #[["1613077715557-0",
 #  {"type"=>"LIMITS_CHANGE",
 #   "target_name"=>"TGT",
@@ -4260,7 +4306,7 @@ print(events)
 #   "message"=>"message"}]]
 # The last offset is the first item ([0]) in the last event ([-1])
 events = get_limits_event(events[-1][0])
-print(events)
+puts events
 #[["1613077715657-0",
 #  {"type"=>"LIMITS_CHANGE",
 #   ...
@@ -4363,7 +4409,7 @@ plugins = plugin_list(default: true) #=>
 
 ```python
 plugins = plugin_list() #=> ['openc3-cosmos-demo-6.0.3.pre.beta0.20250116214358.gem__20250116214539']
-plugins = plugin_list(default: true) #=>
+plugins = plugin_list(default=True) #=>
 # ['openc3-cosmos-demo-6.0.3.pre.beta0.20250116214358.gem__20250116214539',
 #  'openc3-cosmos-tool-admin-6.0.3.pre.beta0.20250115200004.gem__20250116211504',
 #  'openc3-cosmos-tool-bucketexplorer-6.0.3.pre.beta0.20250115200008.gem__20250116211525',
@@ -4521,7 +4567,7 @@ get_target("<Target Name>")
 
 ```ruby
 target = get_target("INST")
-print(target)
+puts target
 # {"name"=>"INST",
 #  "folder_name"=>"INST",
 #  "requires"=>[],
@@ -4663,7 +4709,7 @@ get_interface("<Interface Name>")
 
 ```ruby
 interface = get_interface("INST_INT")
-print(interface)
+puts interface
 # {"name"=>"INST_INT",
 #  "config_params"=>["interface.rb"],
 #  "target_names"=>["INST"],
@@ -5243,7 +5289,7 @@ get_router("<Router Name>")
 
 ```ruby
 router = get_router("ROUTER_INT")
-print(router)
+puts router
 #{"name"=>"ROUTER_INT",
 # "config_params"=>["router.rb"],
 # "target_names"=>["INST"],
@@ -7429,7 +7475,7 @@ The method gets the maximum number of characters to display in Script Runner out
 <TabItem value="ruby" label="Ruby Example">
 
 ```ruby
-print(get_max_output()) #=> 50000
+puts get_max_output() #=> 50000
 ```
 
 </TabItem>
@@ -9660,3 +9706,4 @@ autonomic_reaction_destroy("REACT1")
 
 </TabItem>
 </Tabs>
+````

docs.openc3.com/docs/guides/troubleshooting.md

@@ -67,4 +67,13 @@ We've seen a number of issues deploying COSMOS via Docker in various types of in
 
    We've seen this on old versions of Docker Desktop when using bind mounts instead of named volumes. Our docker compose files use named volumes by default so be careful with bind mounts. We also recommend upgrading Docker Desktop and WLS2 if possible as this maybe OBE in newer versions of Docker Desktop / WSL2.
 
+1. When exposing COSMOS to the network through http, Chrome [DevTools](https://developer.chrome.com/docs/devtools/open) shows "Web crypto API is not available".
+
+   Make sure to follow all the instructions in the [COSMOS Enterprise Project README](https://github.com/OpenC3/cosmos-enterprise-project/blob/main/README.md). In this case you need to do the following:
+
+   - In Chrome go to: chrome://flags/#unsafely-treat-insecure-origin-as-secure
+   - Add your http://<Your IP Address>:2900
+   - Enable the Setting
+   - Completely restart Chrome. On MacOS make sure the dot below the icon in chrome is gone by long pressing the icon and choosing Quit.
+
 Encountering an issue not on this list? If you're a customer, please get in touch at [[email protected]](mailto:[email protected]).

mise.toml

@@ -1,4 +1,4 @@
 [tools]
 node = "22.11"
 python = "3.12"
-ruby = "3.3"
+ruby = "3.4"

openc3-cosmos-cmd-tlm-api/app/controllers/api_controller.rb

@@ -14,19 +14,41 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'openc3/utilities/open_telemetry'
+require 'pg'
+
+$tsdb_connection = nil
 
 class ApiController < ApplicationController
   def ping
     render plain: 'OK'
   end
 
+  # Time Seriese Database (TSDB) presence check
+  def tsdb
+    if $tsdb_connection
+      render plain: 'OK', status: 200
+      return
+    end
+    begin
+      PG::Connection.new(host: ENV['OPENC3_TSDB_HOSTNAME'],
+                         port: ENV['OPENC3_TSDB_QUERY_PORT'],
+                         user: ENV['OPENC3_TSDB_USERNAME'],
+                         password: ENV['OPENC3_TSDB_PASSWORD'],
+                         dbname: 'qdb').close() # Default dbname
+      $tsdb_connection = 'OK'
+      render plain: 'OK', status: 200
+    rescue => e
+      render plain: e.message, status: 404
+    end
+  end
+
   def api
     OpenC3.in_span('jsonrpc_api') do |span|
       req = Rack::Request.new(request.env)

openc3-cosmos-cmd-tlm-api/config/routes.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -193,6 +193,7 @@
     # to do the remote procedure call
     post "/api" => "api#api"
     get "/ping" => "api#ping"
+    get "/tsdb" => "api#tsdb"
 
     get "/auth/token-exists" => "auth#token_exists"
     post "/auth/verify" => "auth#verify"