TL-8 Calendar shall allow deleting timelines Delete a timeline
Admin
The Admin tool provides administrative functionality including managing plugins for the COSMOS system
-Reqt. ID Description Test Description AD-1 The Admin Tool shall allow installing plugins Upload and Install a Plugin AD-2 The Admin Tool shall support upgrading plugins Upgrade an installed plugin AD-3 The Admin Tool shall support uninstalling plugins Uninstall a plugin AD-4 The Admin Tool shall display information on installed plugins View info on Interfaces, Microservices, etc AD-5 The Admin Tool shall support editing microservices Edit the settings for a microservice AD-6 The Admin Tool shall support discovery of plugins Discover and download a plugin AD-7 The Admin Tool shall support adding links to external tools Add a link to Google AD-8 The Admin Tool shall support reordering tools Reorder tools on the tools tab AD-9 The Admin Tool shall support configuring a classification bar Add a classification bar on the settings tab
\ No newline at end of file
+Reqt. ID Description Test Description AD-1 The Admin Tool shall allow installing plugins Upload and Install a Plugin AD-2 The Admin Tool shall support upgrading plugins Upgrade an installed plugin AD-3 The Admin Tool shall support uninstalling plugins Uninstall a plugin AD-4 The Admin Tool shall display information on installed plugins View info on Interfaces, Microservices, etc AD-5 The Admin Tool shall support editing microservices Edit the settings for a microservice AD-6 The Admin Tool shall support discovery of plugins Discover and download a plugin AD-7 The Admin Tool shall support adding links to external tools Add a link to Google AD-8 The Admin Tool shall support reordering tools Reorder tools on the tools tab AD-9 The Admin Tool shall support configuring a classification bar Add a classification bar on the settings tab
\ No newline at end of file
diff --git a/docs/docs/getting-started/upgrading.html b/docs/docs/getting-started/upgrading.html
index 29f06b7e40..35d2c18d34 100644
--- a/docs/docs/getting-started/upgrading.html
+++ b/docs/docs/getting-started/upgrading.html
@@ -1,4 +1,4 @@
-Upgrading | OpenC3 Docs On this page
COSMOS Upgrades
+
Upgrading | OpenC3 Docs On this page
COSMOS Upgrades
COSMOS is released as Docker containers. Since we're using Docker containers and volumes we can simply stop the existing COSMOS application, then download and run the new release.
Always check the release notes associated with the release on the releases page. Sometimes there are migration notes.
This example assumes an existing COSMOS project at C:\cosmos-project.
@@ -155,4 +155,4 @@
COSMOS 4 was a Qt Desktop based application. COSMOS 5 is a completely new architecture which runs natively in the browser using Vue.js as the Javascript framework and Vuetify as the GUI library. We utilize single-spa to allow you to write COSMOS tool plugins in any language and provide templates for Vue.js (recommended), Angular, React and Svelte. Any COSMOS 4 custom tools will have to be completely re-written to run in COSMOS 5. We recommend using the native COSMOS tools and finding GUI concepts and functionality that best match the tool you're trying to re-create.
-
If you need custom development get in touch at sales@openc3.com .
\ No newline at end of file
+
If you need custom development get in touch at sales@openc3.com .
Guides | OpenC3 Docs Guides | OpenC3 Docs Bridges | OpenC3 Docs On this page
COSMOS Bridges provide an easy solution for getting data from devices that don't speak Ethernet into COSMOS.
+
Bridges | OpenC3 Docs On this page
COSMOS Bridges provide an easy solution for getting data from devices that don't speak Ethernet into COSMOS.
Serial ports are the most common, but other devices such as USB, PCI cards, and Bluetooth devices can also be
supported by using bridges to convert from a host computer accessible device, into an Ethernet byte stream that COSMOS can process from inside of containers.
Bridges are Meant to be Dumb
The purpose of bridges is to get bytes into COSMOS. Processing should be done in COSMOS itself, including details such as
@@ -47,4 +47,4 @@
Note on S
Add the following to the operator service in compose.yaml:
devices: - "/dev/ttyUSB0:/dev/ttyUSB0" Make sure the serial device has permissions for the user running Docker to access:
-
sudo chmod 666 /dev/ttyUSB0
\ No newline at end of file
+
sudo chmod 666 /dev/ttyUSB0
\ No newline at end of file
diff --git a/docs/docs/guides/cfs.html b/docs/docs/guides/cfs.html
index 9032dd9501..ed35e1a93d 100644
--- a/docs/docs/guides/cfs.html
+++ b/docs/docs/guides/cfs.html
@@ -1,4 +1,4 @@
-
COSMOS and NASA cFS | OpenC3 Docs On this page
Working configuration
+
COSMOS and NASA cFS | OpenC3 Docs On this page
Working configuration
This tutorial has been tested using the following components:
COSMOS v5 release 5.0.6
@@ -97,4 +97,4 @@ Uploading
the plugin's .gem file. Make sure your configuration is typo-free. In the example above, the operator image is running at 172.20.0.8. To enable telemetry, go to the browser and connect to
http://localhost:2900/tools/cmdsender/CFS/TO_LAB_ENABLE . Change the DEST_IP to the IP address of the operator image (172.20.0.8) and send the command.
-
Under http://localhost:2900/tools/cmdtlmserver/tlm-packets , you should see the incoming packets. Note in the CmdTlmServer you will also see CFS_INT UNKNOWN packets because we did not define the full cFS packet set. That exercise is left to the reader.
\ No newline at end of file
+
Under http://localhost:2900/tools/cmdtlmserver/tlm-packets , you should see the incoming packets. Note in the CmdTlmServer you will also see CFS_INT UNKNOWN packets because we did not define the full cFS packet set. That exercise is left to the reader.
Custom Widgets | OpenC3 Docs On this page
COSMOS allows you to build custom widgets which can be deployed with your plugin and used in Telemetry Viewer . Building custom widgets can utilize any javascript frameworks but since COSMOS is written with Vue.js, we will use that framework in this tutorial. Please see the Widget Generator guide for information about generating the scaffolding for a custom widget.
+
Custom Widgets | OpenC3 Docs On this page
COSMOS allows you to build custom widgets which can be deployed with your plugin and used in Telemetry Viewer . Building custom widgets can utilize any javascript frameworks but since COSMOS is written with Vue.js, we will use that framework in this tutorial. Please see the Widget Generator guide for information about generating the scaffolding for a custom widget.
We're basically going to follow the COSMOS Demo and explain how that custom widget was created.
If you look at the bottom of the Demo's plugin.txt file you'll see we declare the widgets:
@@ -15,4 +15,4 @@
Opening this screen in Telemetry Viewer results in the following:
-
While this is a simple example the possibilities with custom widgets are limitless!
\ No newline at end of file
+
While this is a simple example the possibilities with custom widgets are limitless!
Exposing Microservices | OpenC3 Docs On this page
COSMOS provides a simple method to add new APIs and make custom microservices and interfaces accessible to the network.
+
Make sure anything you expose is secure
Make sure that any new apis you expose check for user credentials and authorize actions appropriately.
+
Expose microservices using the PORT and ROUTE_PREFIX keywords
+
In your plugin.txt file, both INTERFACE and MICROSERVICE support the keywords PORT and ROUTE_PREFIX .
+
PORT is used to declare the port(s) that your microservice is listening for connections on. This is used in combination with ROUTE_PREFIX to create a dynamic traefik route to your microservice.
+
The following code is used internally to let traefik know where to connect to your microservice internally:
+
if ENV [ 'OPENC3_OPERATOR_HOSTNAME' ] url = "http:// #{ ENV [ 'OPENC3_OPERATOR_HOSTNAME' ] } : #{ port } " else if ENV [ 'KUBERNETES_SERVICE_HOST' ] url = "http:// #{ microservice_name . downcase . gsub ( '__' , '-' ) . gsub ( '_' , '-' ) } -service: #{ port } " else url = "http://openc3-operator: #{ port } " end end
+
Note that this is the internal route to your microservice. Determining this route checks two different environment variables.
+
OPENC3_OPERATOR_HOSTNAME is used to override the default service name for our regular docker compose operator of "openc3-operator". Usually this is not set.
+
In OpenC3 Enterprise, KUBERNETES_SERVICE_HOST is used to detect if we are running in a Kubernetes environment (it will be set by Kubernetes), in which case the service is expected to have a Kubernetes service named scope-user-microservicename-service. For example, if you are using the DEFAULT scope and have a microservice named MYMICROSERVICE the service would be found at the hostname: default-user-mymicroservice-service. Double underscores or single underscores are replaced by a dash and the name is all lower case.
+
ROUTE_PREFIX is used to define the external route. The external route will take the form of http(s)://YOURCOSMOSDOMAIN:PORT/ROUTE_PREFIX. So for example, if you set the ROUTE_PREFIX to /mymicroservice then on a default local installation, it could be reached at http://localhost:2900/mymicroservice. The http://localhost:2900 part should be substituted by whatever domain you are accessing COSMOS at.
+
Here is a snippet of code showing PORT and ROUTE_PREFIX in use within a plugin.txt file:
+
VARIABLE cfdp_microservice_name CFDP VARIABLE cfdp_route_prefix /cfdp VARIABLE cfdp_port 2905 MICROSERVICE CFDP < % = cfdp_microservice_name % > WORK_DIR . ROUTE_PREFIX < % = cfdp_route_prefix % > PORT < % = cfdp_port % >
+
Leaving the variables at their default values the following will occur:
+
+The microservice will be exposed internally to Docker (Open Source or Enterprise) at: http://openc3-operator:2905
+The microservice will be exposed internally to Kubernetes (Enterprise) at: http://default-user-cfdp-service:2905
+The microservice will be exposed externally to the network at: http://localhost:2900/cfdp
+
+
The same can be done for INTERFACE but note that the Kubernetes service name will use the microservice name of the interface which takes the form of SCOPE__INTERFACE__INTERFACENAME.
+
Here is an example using PORT and ROUTE_PREFIX with INTERFACE :
+
VARIABLE my_interface_name MY_INT VARIABLE my_route_prefix /myint VARIABLE my_port 2910 INTERFACE < % = my_interface_name % > http_server_interface.rb < % = my_port % > ROUTE_PREFIX < % = my_route_prefix % > PORT < % = my_port % >
+
+The interface will be exposed internally to Docker (Open Source or Enterprise) at: http://openc3-operator:2910
+The interface will be exposed internally to Kubernetes (Enterprise) at: http://default-interface-my-int-service:2905
+The interface will be exposed externally to the network at: http://localhost:2900/myint
+
+
Sharded Operator on Kubernetes (Enterprise)
The sharded operator is expected to be used on Kubernetes whenever the Kubernetes Operator is not used. Typically this will be because the user does not have permission to use the Kubernetes API directly to spawn containers which is required for use of the Kubernetes Operator. In this case, Kubernetes services will NOT be automatically created, and will have to be manually created by a user with permissions in Kubernetes, or through some other authorized method (like a custom framework dashboard or config file).
+
Connecting to microservices from a different INTERFACE in plugin.txt
+
Sometimes you might want to have an INTERFACE connect to a microservice you are running. For this case, only the PORT keyword is required on the INTERFACE or MICROSERVICE because we are only connecting internally and ROUTE_PREFIX isn't used.
+
The following code taken from our demo plugin provides an example of how to calculate the correct hostname across both Open Source and Enterprise versions of COSMOS in a plugin.txt file:
+
<% example_host = ENV['KUBERNETES_SERVICE_HOST'] ? "#{scope}-user-#{example_microservice_name.downcase.gsub('__', '-').gsub('_', '-')}-service" : "openc3-operator" %> INTERFACE <%= example_int_name %> example_interface.rb <%= example_host %> <%= example_port %> MAP_TARGET <%= example_target_name %>
+
Note that the above code does not handle the OPENC3_OPERATOR_HOSTNAME environment variable which might change the default name of openc3-operator. Update as needed.
Little Endian Bitfields | OpenC3 Docs Defining little endian bitfields is a little weird but is possible in COSMOS. However, note that APPEND does not work with little endian bitfields.
+
Little Endian Bitfields | OpenC3 Docs Defining little endian bitfields is a little weird but is possible in COSMOS. However, note that APPEND does not work with little endian bitfields.
Here are the rules on how COSMOS handles LITTLE_ENDIAN data:
@@ -16,4 +16,4 @@
struct { unsigned short a : 4 ; unsigned short b : 8 ; unsigned short c : 4 ; } ITEM A 4 4 UINT "struct item a" ITEM B 12 8 UINT "struct item b" ITEM C 8 4 UINT "struct item c" This is hard to visualize, but the structure above gets spread out in a byte array like the following after byte swapping: least significant 4 bits of b, 4-bits a, 4-bits c, most significant 4 bits of b.
-
The best advice is to experiment and use the View Raw feature in the Command and Telemetry Service to inspect the bytes of the packet and adjust as necessary.
\ No newline at end of file
+
The best advice is to experiment and use the View Raw feature in the Command and Telemetry Service to inspect the bytes of the packet and adjust as necessary.
Local Mode | OpenC3 Docs On this page
Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions.
+
Local Mode | OpenC3 Docs On this page
Local Mode is a new feature in the 5.0.9 COSMOS release. It is intended to capture the configuration of an edited plugin so it can be configuration managed. It allows you to edit portions of a plugin (scripts and screens) locally in the editor of your choice and instantly have those changes appear in the COSMOS plugin. This avoids the plugin build / install cycle which is required when editing command and telemetry or interface definitions.
Using Local Mode
In this tutorial we will use the COSMOS Demo as configured by the Installation Guide . You should have cloned a cosmos-project and started it using openc3.sh run.
If you check the project directory you should see a plugins/DEFAULT/openc3-cosmos-demo directory. This will contain both the gem that was installed and a plugin_instance.json file. The plugin_instance.json file captures the plugin.txt values when the plugin was installed. Note, all files in the plugins directory are meant to be configuration managed with the project. This ensures if you make local edits and check them in, another user can clone the project and get the exact same configuration. We will demonstrate this later.
@@ -19,4 +19,4 @@
Confi
Upgrade the plugin using the Admin Plugins tab and the Upgrade link. When you select your newly built plugin, COSMOS detects the existing changes and asks if you want to delete them. There is a stern warning attached because this will permanently remove these changes! Since we just moved over the changes and rebuilt the plugin we will check the box and INSTALL.
When the new plugin is installed, the project's plugins directory gets updated with the new plugin and everything under the targets_modified directory is removed because there are no modifications on a new install.
-
Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS.
\ No newline at end of file
+
Local Mode is a powerful way to develop scripts and screens on the local file system and automatically have them sync to COSMOS.
Logging | OpenC3 Docs On this page
The COSMOS Bucket Explorer tool provides a way to browse the COSMOS bucket storage backend whether you are running locally or in a cloud environment. Browse to http://localhost:2900/tools/bucketexplorer and you should see the list of buckets at the top:
+
Logging | OpenC3 Docs On this page
The COSMOS Bucket Explorer tool provides a way to browse the COSMOS bucket storage backend whether you are running locally or in a cloud environment. Browse to http://localhost:2900/tools/bucketexplorer and you should see the list of buckets at the top:
Note the config and logs buckets are organized by scopes of which there initially is just one: DEFAULT. Clicking the DEFAULT folder in the logs bucket shows the decom_logs, raw_logs, reduced_xxx_logs, text_logs and tool_logs.
decom_logs & raw_logs
@@ -12,4 +12,4 @@
\ No newline at end of file
+
Monitoring | OpenC3 Docs On this page
Monitoring and observability
+
Monitoring | OpenC3 Docs On this page
Monitoring and observability
With moving COSMOS to container based service, we needed a better way to monitor the internals of COSMOS. So here is some information on external services that you can use to monitor COSMOS. If you want to read more about Monitoring Distributed Systems
@@ -37,4 +37,4 @@
\ No newline at end of file
+
FROM grafana/grafana COPY datasource.yaml /etc/grafana/provisioning/datasources/ Performance | OpenC3 Docs On this page
The COSMOS architecture was created with scalability in mind. Our goal is to support an unlimited number of connections and use cloud technologies to scale. Only COSMOS Enterprise Edition supports Kubernetes and the various cloud platforms which allow this level of scalability. While true scalability is only achieved in COSMOS Enterprise, both Open Source and Enterprise have various levels of observability and configuration settings which can affect performance.
+
Performance | OpenC3 Docs On this page
The COSMOS architecture was created with scalability in mind. Our goal is to support an unlimited number of connections and use cloud technologies to scale. Only COSMOS Enterprise Edition supports Kubernetes and the various cloud platforms which allow this level of scalability. While true scalability is only achieved in COSMOS Enterprise, both Open Source and Enterprise have various levels of observability and configuration settings which can affect performance.
COSMOS Hardware Requirements Memory
COSMOS can run on a Raspberry Pi up to a Kubernetes cluster in the cloud. On all platforms the key performance factor is the number and complexity of the targets and their defined packets. Targets can vary from simple targets taking 100 MB of RAM to complex targets taking 400 MB. The base COSMOS containers require about 800 MB of RAM. A good rule of thumb is to average about 300 MB of RAM for targets. As an example data point, the COSMOS Demo has 4 targets, two complex (INST & INST2) and two relatively simple (EXAMPLE & TEMPLATED), and requires 800 MB of RAM (on top of the 800 MB of base container RAM).
@@ -45,4 +45,4 @@
Conclusions
-
\ No newline at end of file
+
Raspberry Pi | OpenC3 Docs On this page
COSMOS Running on Raspberry Pi 4
+
Raspberry Pi | OpenC3 Docs On this page
COSMOS Running on Raspberry Pi 4
The Raspberry Pi 4 is a low-cost powerful ARM-based minicomputer that runs linux. And because it runs modern linux, it can also run COSMOS! These directions will get you up and running.
What you'll need:
\ No newline at end of file
+
Script Writing Guide | OpenC3 Docs On this page
Introduction
+
Script Writing Guide | OpenC3 Docs On this page
Introduction
This guide aims to provide the best practices for using the scripting capabilities provided by COSMOS. Scripts are used to automate a series of activities for operations or testing. The goal of this document is to ensure scripts are written that are simple, easy to understand, maintainable, and correct. Guidance on some of the key details of using the COSMOS Script Runner is also provided.
Concepts
COSMOS supports both Ruby and Python for writing scripts. Ruby and Python are very similar scripting languages and most of this guide applies directly to both. Where examples are used, both a Ruby and Python example are given.
@@ -245,4 +245,4 @@
When to use Ruby Modules
Modules in Ruby have two purposes: namespacing and mixins. Namespacing allows having classes and methods with the same name, but with different meanings. For example, if they are namespaced, COSMOS can have a Packet class and another Ruby library can have a Packet class. This isn't typically useful for COSMOS scripting though.
Mixins allow adding common methods to classes without using inheritance. Mixins can be useful to add common functionality to some classes but not others, or to break up classes into multiple files.
-
module MyModule def module_method end end class MyTest < OpenC3 :: Group include MyModule def test_1 module_method ( ) end end
\ No newline at end of file
+
module MyModule def module_method end end class MyTest < OpenC3 :: Group include MyModule def test_1 module_method ( ) end end Scripting API Guide | OpenC3 Docs On this page
This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.
+
Scripting API Guide | OpenC3 Docs On this page
This document provides the information necessary to write test procedures using the COSMOS scripting API. Scripting in COSMOS is designed to be simple and intuitive. The code completion ability for command and telemetry mnemonics makes Script Runner the ideal place to write your procedures, however any text editor will do. If there is functionality that you don't see here or perhaps an easier syntax for doing something, please submit a ticket.
Concepts
Programming Languages
COSMOS scripting is implemented using either Ruby or Python. Ruby and Python are very similar scripting languages and in many cases the COSMOS APIs are identical between the two. This guide is written to support both with additional language specific information found in the Script Writing Guide .
@@ -886,7 +886,7 @@
The local_screen allows you to create a local screen directly from a script which is not permanently saved to the Telemetry Viewer screen list. This is useful for one off screens that help users interact with scripts.
Python / Ruby Syntax:
-
local_screen ( "<Screen Name>" "<Definition>" , < X Position ( optional ) > , < Y Position ( optional ) > )
+
local_screen ( "<Screen Name>" , "<Definition>" , < X Position ( optional ) > , < Y Position ( optional ) > ) Parameter Description Screen Name Screen name within the specified target Definition The entire screen definition as a String X Position X coordinate for the upper left hand corner of the screen Y Position Y coordinate for the upper left hand corner of the screen
NOTE: It is possible to specify a X, Y location off the visible display. If you do so and try to re-create the screen it will not display (because it is already displayed). Try issuing a clear_all_screens() first to clear any screens off the visible display space.
Ruby Example:
@@ -1063,4 +1063,4 @@
Parameter Description Tool Name Name of the tool Configuration Name Name of the configuration local_mode Whether to delete the configuration in local mode
Ruby / Python Example:
-delete_config ( 'telemetry_grapher' , 'adcs' ) delete_config ( 'telemetry_grapher' , 'adcs' ) Meta | OpenC3 Docs Meta | OpenC3 Docs Contributing | OpenC3 Docs On this page
So you've got an awesome idea to throw into COSMOS. Great! This is the basic process:
+
Contributing | OpenC3 Docs On this page
So you've got an awesome idea to throw into COSMOS. Great! This is the basic process:
Fork the project on Github
Create a feature branch
@@ -37,4 +37,4 @@
\ No newline at end of file
+GitHub describing what we can do to make it better.
Licenses | OpenC3 Docs On this page
OpenC3 COSMOS is offered under a tri-licensing model allowing users to choose between the following three options:
+
Licenses | OpenC3 Docs On this page
OpenC3 COSMOS is offered under a tri-licensing model allowing users to choose between the following three options:
AGPLv3
This is our default open source license and the license that most free users use. The AGPLv3 is a modification of the GPLv3 which is what is known as a copy-left license or a viral license. You can read the whole thing here: OpenC3 AGPLv3
Obviously, the actual license text applies, but here is a short summary:
@@ -100,4 +100,4 @@
\ No newline at end of file
+
Philosophy | OpenC3 Docs COSMOS is a C3 (Command, Control and Communication) system with the following primary goals:
+
Philosophy | OpenC3 Docs COSMOS is a C3 (Command, Control and Communication) system with the following primary goals:
Interface with Anything
@@ -24,4 +24,4 @@
Empower Developers
COSMOS is meant to be easy enough to be used by everyone, not just C2 software experts.
-
\ No newline at end of file
+
XTCE Support | OpenC3 Docs On this page
COSMOS now has support for the XTCE Command and Telemetry Definition Standard . This is an open standard designed to allow command and telemetry definitions to be transferred between different ground systems. COSMOS can run directly using the .xtce files, or can convert them into the COSMOS configuration file format.
+
XTCE Support | OpenC3 Docs On this page
COSMOS now has support for the XTCE Command and Telemetry Definition Standard . This is an open standard designed to allow command and telemetry definitions to be transferred between different ground systems. COSMOS can run directly using the .xtce files, or can convert them into the COSMOS configuration file format.
Running COSMOS using an .xtce definition file
A single .xtce file containing the command and telemetry definitions for a target can be used in place of the normal COSMOS command and telemetry definition files. Simply place the target's .xtce file in the target's cmd_tlm folder and COSMOS will use it for the command and telemetry definitions.
Converting a .xtce file into a COSMOS configuration
@@ -95,4 +95,4 @@
Unsupport
Additional Data Types
Container References
-
If there is a particular element or feature you need supported please submit a ticket on Github.
\ No newline at end of file
+
If there is a particular element or feature you need supported please submit a ticket on Github.
OpenC3, Inc. Privacy Policy | OpenC3 Docs OpenC3, Inc. Privacy Policy On this page
OpenC3, Inc. Privacy Policy OpenC3 Inc. is strongly committed to protecting your privacy and complying with your choices. Both personal and non-personal information collected is safeguarded according to the highest privacy and data protection standards adopted worldwide. We have always had a robust and effective data protection program in place which complies with existing law and abides by the data protection principles. However, we recognise our obligations in updating and expanding this program to meet the demands of the GDPR.
+
OpenC3, Inc. Privacy Policy | OpenC3 Docs OpenC3, Inc. Privacy Policy On this page
OpenC3, Inc. Privacy Policy OpenC3 Inc. is strongly committed to protecting your privacy and complying with your choices. Both personal and non-personal information collected is safeguarded according to the highest privacy and data protection standards adopted worldwide. We have always had a robust and effective data protection program in place which complies with existing law and abides by the data protection principles. However, we recognise our obligations in updating and expanding this program to meet the demands of the GDPR.
Our Commitment
• Your information will not be shared, rented or sold to any third party.
• We use state-of-the-art security measures to protect your information from unauthorized users.
@@ -53,4 +53,4 @@
12. E
If you have questions or comments about this privacy policy, please email us at: support@openc3.com
For additional information about how to contact OpenC3, Inc. please visit our help page.
-
Dated: August 11th, 2022
\ No newline at end of file
+
Dated: August 11th, 2022
Tools | OpenC3 Docs Tools | OpenC3 Docs Admin | OpenC3 Docs On this page
Introduction
+
Admin | OpenC3 Docs On this page
Introduction
Admin has it's own dedicated button at the top of the tools list. It is responsible for administering the COSMOS system including installing new plugins, viewing configuration, storing secrets and changing settings.
Plugins
The Plugins tab is where you install new plugins into the COSMOS system. Plugins can dynamically add targets, microservices, interfaces, protocols, Telemetry Viewer widgets, and entire tools into the COSMOS runtime. The following screenshot shows the Plugins tab when only the COSMOS Demo is installed:
@@ -33,4 +33,4 @@
The Settings tab contains various settings used throughout COSMOS. These including clearing saved tool configuration, hiding the Astro Clock, changing the system time zone, adding a top and bottom banner, creating a subtitle in the navigation bar, and changing the URLs of the various package libraries.
\ No newline at end of file
+
Autonomic (Enterprise) | OpenC3 Docs Tools Autonomic (Enterprise) On this page
Introduction
+
Autonomic (Enterprise) | OpenC3 Docs Tools Autonomic (Enterprise) On this page
Introduction
Autonomic allows for the automated execution of commands and scripts based on user-defined rules.
Overview
Autonomic operates with some basic building blocks: Trigger Groups, Triggers, and Reactions. Triggers are simply logical blocks which evaluate true or false. Reactions can be linked to one or many Triggers and specify an action to perform. Together they allow for an action to be taken based on anything going on in your system.
@@ -29,4 +29,4 @@
\ No newline at end of file
+
Bucket Explorer | OpenC3 Docs On this page
Introduction
+
Bucket Explorer | OpenC3 Docs On this page
Introduction
Bucket Explorer is a file browser to the COSMOS backend bucket storage system. It allows you to view files in an intuitive file browser hierarchy and download them. Bucket Explorer works both with local installations of COSMOS as well as cloud deployments which utilize cloud storage such as AWS S3 and GCP Cloud Storage.
Browsing Files
@@ -9,4 +9,4 @@
Click the Download icon to download any of the individual files from any bucket and path.
Delete
-
Click the Trash icon to delete an individual file. Note that in COSMOS Enterprise you can only delete files in the config/DEFAULT/targets_modified folder unless you're an Admin.
\ No newline at end of file
+
Click the Trash icon to delete an individual file. Note that in COSMOS Enterprise you can only delete files in the config/DEFAULT/targets_modified folder unless you're an Admin.
Calendar (Enterprise) | OpenC3 Docs Tools Calendar (Enterprise) On this page
Introduction
+
Calendar (Enterprise) | OpenC3 Docs Tools Calendar (Enterprise) On this page
Introduction
Calendar visualizes metadata, notes, and timeline information in one easy to understand place. Timelines allow for the simple execution of commands and scripts based on future dates and times.
Adding Timelines
@@ -29,4 +29,4 @@
The main thread will block on the web socket to listen to request changes to the timeline, these could be adding, removing, or updating activities. The main thread will make the changes to the in memory schedule if these changes are within the hour of the current time. When the web socket gets an update it has an action lookup table. These actions are "created", "updated", "deleted", etc... Some actions require updating the schedule from the database to ensure the schedule and the database are always in sync.
The schedule thread checks every second to make sure if a task can be run. If the start time is equal or less then the last 15 seconds it will then check the previously queued jobs list in the schedule. If the activity has not been queued and is not fulfilled the activity will be queued, this adds an event to the activity but is not saved to the database.
The workers block on the queue until an activity is placed on the queue. Once a job is pulled from the queue they check the type and run the activity. The thread will mark the activity fulfillment true and update the database record with the complete. If the worker gets an error while trying to run the task the activity will NOT be fulfilled and record the error in the database.
-
\ No newline at end of file
+
Command Sender | OpenC3 Docs On this page
Introduction
+
Command Sender | OpenC3 Docs On this page
Introduction
Command Sender provides the ability to send any command defined by COSMOS. Commands are selected using the Target and Packet drop down fields which populate the command parameter (if any). A command history is stored which is also editable. Commands in the command history can be re-executed by pressing Enter. Related telemetry or screens are displayed in the bottom right next to the command history.
Command Sender Menus
@@ -22,4 +22,4 @@
Hazardous C
Commands can also have hazardous states (INST COLLECT with TYPE SPECIAL) which also prompt the user. In this example, we've also checked all the menu options to show ignored parameters, display state values in hex (see SPECIAL, 0x1), disabled range checking (DURATION 1000), and disabled parameter conversions.
-
Selecting Yes will send the command and update the history with all the parameters shown. Note that when writing Scripts all parameters are optional unless explicitly marked required .
\ No newline at end of file
+
Selecting Yes will send the command and update the history with all the parameters shown. Note that when writing Scripts all parameters are optional unless explicitly marked required .
Command and Telemetry Server | OpenC3 Docs Tools Command and Telemetry Server On this page
Command and Telemetry Server Introduction
+
Command and Telemetry Server | OpenC3 Docs Tools Command and Telemetry Server On this page
Command and Telemetry Server Introduction
The Command and Telemetry Server application provides status about the interfaces and targets instantiated in your COSMOS installation. Interfaces can be connected or disconnected and raw byte counts are returned. The application also provides quick shortcuts to view
both raw and formatted command and telemetry packets as they go through the COSMOS system. At the bottom of the Command and Telemetry Server is the Log Messages showing server messages.
@@ -35,4 +35,4 @@
\ No newline at end of file
+
Command History (Enterprise) | OpenC3 Docs Tools Command History (Enterprise) On this page
Command History (Enterprise) Introduction
+
Command History (Enterprise) | OpenC3 Docs Tools Command History (Enterprise) On this page
Command History (Enterprise) Introduction
Command History provides the ability to see all the commands sent in COSMOS. Commands are listed in time execution order and include who sent the command and whether they were successful (if validated).
Selecting Time
@@ -7,4 +7,4 @@
Commands Table<
The commands table is sorted by Time and list the User (or process), the Command, the Result and an optional Description.
As shown above, the User can be an actual user in the system (admin, operator) or a background process (DEFAULT__MULTI__INST, DEFAULT__DECOM__INST2).
The Result field is the result of executing Command Validators established by the VALIDATOR keyword. Command Validators are either a Ruby or Python class which is used to validate the command success or failure with both a pre_check and post_check method. Usually when a command fails, a description is given as in the example above.
-
For more information read the VALIDATOR documentation and also see the Ruby Example and the Python Example in the COSMOS Demo .
\ No newline at end of file
+
For more information read the VALIDATOR documentation and also see the Ruby Example and the Python Example in the COSMOS Demo .
Data Extractor | OpenC3 Docs On this page
Introduction
+
Data Extractor | OpenC3 Docs On this page
Introduction
Data Extractor extracts command and telemetry items into comma or tab separated files. Individual items or entire packets can be processed over any time period. Data Extractor also has a number of options to control the output for post processing in Excel or Matlab, for example.
@@ -48,4 +48,4 @@
Processing It
Clicking the Process button starts the processing of the items list. A progress wheel is shown on the left side of the table and the Process button changes to Cancel to allow canceling the process.
When the processing is complete, the browser shows a file download link. Note this varies by browser. This example is from Chrome.
-
\ No newline at end of file
+
Data Viewer | OpenC3 Docs On this page
Introduction
+
Data Viewer | OpenC3 Docs On this page
Introduction
Data Viewer allows you to view packet data or individual item data in both the past and in real time.
@@ -17,4 +17,4 @@
Adding Compo
DataViewer displays data in a component. To add a new component to the interface click the plus icon. This brings up the Add Component dialog. First you select the component you want to use to visual the data. Next you add packets which will populate the component. Finally click Create to see the DataViewer component visualization.
To adjust the settings of the COSMOS Raw/Decom component click the gear icon to bring up the Display Settings dialog. You can turn on and off various visualizations, increase the number of packets displayed and the history.
-
\ No newline at end of file
+
Handbooks | OpenC3 Docs On this page
Introduction
+
Handbooks | OpenC3 Docs On this page
Introduction
Handbooks formats the COSMOS command and telemetry definitions into a nicely formatted webpage that can be exported to a PDF.
-
You can select the targets you want to display and the number of columns to display on the page. You can then use the browser to Print the page. Most browsers have the capability to Save as PDF rather than print to save the resulting page as PDF.
\ No newline at end of file
+
You can select the targets you want to display and the number of columns to display on the page. You can then use the browser to Print the page. Most browsers have the capability to Save as PDF rather than print to save the resulting page as PDF.
Limits Monitor | OpenC3 Docs On this page
Introduction
+
Limits Monitor | OpenC3 Docs On this page
Introduction
The Limits Monitor application provides situational awareness for all telemetry items with limits. All limits items which violate their yellow or red limits are shown and continue to be shown until explicitly dismissed. Individual items and entire packets can be manually ignored to filter out known issues. In addition, all limits events are logged in a table which can be searched.
@@ -29,4 +29,4 @@
\ No newline at end of file
+
Packet Viewer | OpenC3 Docs On this page
Introduction
+
Packet Viewer | OpenC3 Docs On this page
Introduction
Packet Viewer is a live telemetry viewer which requires no configuration to display the current values for all defined target, packet, items. Items with limits are displayed colored (blue, green, yellow, or red) according to their current state. Items can be right clicked to get detailed information.
@@ -25,4 +25,4 @@
Selecting Pa
Details
Right-clicking an item and selecting Details will open the details dialog.
-
This dialog lists everything defined on the telemetry item.
\ No newline at end of file
+
This dialog lists everything defined on the telemetry item.
Script Runner | OpenC3 Docs On this page
Introduction
+
Script Runner | OpenC3 Docs On this page
Introduction
Script Runner is both an editor of COSMOS scripts as well as executes scripts. Script files are stored within a COSMOS target and Script Runner provides the ability to open, save, download and delete these files. When a suite of scripts is opened, Script Runner provides additional options to run individual scripts, groups of scripts, or entire suites.
@@ -88,4 +88,4 @@
Break Loop
Debugging Scripts
When you enable the Debug prompt an additional line appears between the script and the Log Messages. You can type local variables to cause them to be output in the Log Messages. You can also set local variables by typing var = 10.
-
The Step button allows you to step line by line through the script. Clicking Go continues regular execution.
\ No newline at end of file
+
The Step button allows you to step line by line through the script. Clicking Go continues regular execution.
Table Manager | OpenC3 Docs On this page
Introduction
+
Table Manager | OpenC3 Docs On this page
Introduction
Table Manager is a binary file editor. It takes binary file definitions similar to the COSMOS command packet definitions and builds a GUI to edit the fields in the binary file.
@@ -19,4 +19,4 @@
download.rb
The COSMOS demo creates the following download.rb script. Note that the ENV['TBL_FILENAME'] is set to the name of the table file to OVERWRITE and the script uses put_target_file to get access to the file. At this point the logic to download the file from the target is specific to the commanding defined by the target but an example script is given.
-puts "file: #{ ENV [ 'TBL_FILENAME' ] } " buffer = '' put_target_file ( ENV [ 'TBL_FILENAME' ] , buffer ) puts "file: #{ ENV [ 'TBL_FILENAME' ] } " buffer = '' put_target_file ( ENV [ 'TBL_FILENAME' ] , buffer ) Telemetry Grapher | OpenC3 Docs On this page
Introductions
+
Telemetry Grapher | OpenC3 Docs On this page
Introductions
Telemetry Grapher is a graphing application that allows for one or more telemetry points per graph. It supports multiple graphs per screen which can be resized and reordered. Multiple configurations can be saved and restored for different situations.
@@ -45,4 +45,4 @@
Graph
The line button minimizes the graph to effectively hide it. This allows you to focus on a single graph without losing existing graphs.
-
The final X button closes the graph.
\ No newline at end of file
+
The final X button closes the graph.
Telemetry Viewer | OpenC3 Docs On this page
Introduction
+
Telemetry Viewer | OpenC3 Docs On this page
Introduction
Telemetry Viewer is a live telemetry viewer which displays custom built screens. Screens are configured through simple text files which utilize numerous built-in widgets.
@@ -30,4 +30,4 @@
Scree
The X button closes the screen.
Building Screens
For documentation on how to build Telemetry Screens and how to configure the
-screen widgets please see the Telemetry Screens .
\ No newline at end of file
+screen widgets please see the
Telemetry Screens .
Hello from OpenC3 Docs | OpenC3 Docs Easy to Configure OpenC3 COSMOS was designed from the ground up to be easy to configure. Simply define the messages needed to talk to your hardware (commands and telemetry), and you are ready to go!
Modern Architecture Built with a modern design, cloud native, and ready to scale. OpenC3 COSMOS has a microservice architecture built to scale, and with fully maintained and up-to-date dependencies.
Pick Your Favorite Language OpenC3 COSMOS supports both Ruby and Python for scripting and connecting to targets. Frontend applications can be written in Vue, React, Angular, or Svelte. Whatever languages your team knows, we support.
Hello from OpenC3 Docs | OpenC3 Docs Easy to Configure OpenC3 COSMOS was designed from the ground up to be easy to configure. Simply define the messages needed to talk to your hardware (commands and telemetry), and you are ready to go!
Modern Architecture Built with a modern design, cloud native, and ready to scale. OpenC3 COSMOS has a microservice architecture built to scale, and with fully maintained and up-to-date dependencies.
Pick Your Favorite Language OpenC3 COSMOS supports both Ruby and Python for scripting and connecting to targets. Frontend applications can be written in Vue, React, Angular, or Svelte. Whatever languages your team knows, we support.
Markdown page example | OpenC3 Docs
-You don't need React to write simple standalone pages.
Markdown page example | OpenC3 Docs
+You don't need React to write simple standalone pages.
https://docs.openc3.com/markdown-page weekly 0.5 https://docs.openc3.com/docs weekly 0.5 https://docs.openc3.com/docs/configuration weekly 0.5 https://docs.openc3.com/docs/configuration/accessors weekly 0.5 https://docs.openc3.com/docs/configuration/command weekly 0.5 https://docs.openc3.com/docs/configuration/format weekly 0.5 https://docs.openc3.com/docs/configuration/interfaces weekly 0.5 https://docs.openc3.com/docs/configuration/plugins weekly 0.5 https://docs.openc3.com/docs/configuration/protocols weekly 0.5 https://docs.openc3.com/docs/configuration/ssl-tls weekly 0.5 https://docs.openc3.com/docs/configuration/table weekly 0.5 https://docs.openc3.com/docs/configuration/target weekly 0.5 https://docs.openc3.com/docs/configuration/telemetry weekly 0.5 https://docs.openc3.com/docs/configuration/telemetry-screens weekly 0.5 https://docs.openc3.com/docs/development weekly 0.5 https://docs.openc3.com/docs/development/curl weekly 0.5 https://docs.openc3.com/docs/development/developing weekly 0.5 https://docs.openc3.com/docs/development/json-api weekly 0.5 https://docs.openc3.com/docs/development/log-structure weekly 0.5 https://docs.openc3.com/docs/development/roadmap weekly 0.5 https://docs.openc3.com/docs/development/streaming-api weekly 0.5 https://docs.openc3.com/docs/development/testing weekly 0.5 https://docs.openc3.com/docs/getting-started weekly 0.5 https://docs.openc3.com/docs/getting-started/generators weekly 0.5 https://docs.openc3.com/docs/getting-started/gettingstarted weekly 0.5 https://docs.openc3.com/docs/getting-started/installation weekly 0.5 https://docs.openc3.com/docs/getting-started/key_concepts weekly 0.5 https://docs.openc3.com/docs/getting-started/podman weekly 0.5 https://docs.openc3.com/docs/getting-started/requirements weekly 0.5 https://docs.openc3.com/docs/getting-started/upgrading weekly 0.5 https://docs.openc3.com/docs/guides weekly 0.5 https://docs.openc3.com/docs/guides/bridges weekly 0.5 https://docs.openc3.com/docs/guides/cfs weekly 0.5 https://docs.openc3.com/docs/guides/custom-widgets weekly 0.5 https://docs.openc3.com/docs/guides/little-endian-bitfields weekly 0.5 https://docs.openc3.com/docs/guides/local-mode weekly 0.5 https://docs.openc3.com/docs/guides/logging weekly 0.5 https://docs.openc3.com/docs/guides/monitoring weekly 0.5 https://docs.openc3.com/docs/guides/performance weekly 0.5 https://docs.openc3.com/docs/guides/raspberrypi weekly 0.5 https://docs.openc3.com/docs/guides/script-writing weekly 0.5 https://docs.openc3.com/docs/guides/scripting-api weekly 0.5 https://docs.openc3.com/docs/meta weekly 0.5 https://docs.openc3.com/docs/meta/contributing weekly 0.5 https://docs.openc3.com/docs/meta/licenses weekly 0.5 https://docs.openc3.com/docs/meta/philosophy weekly 0.5 https://docs.openc3.com/docs/meta/xtce weekly 0.5 https://docs.openc3.com/docs/privacy weekly 0.5 https://docs.openc3.com/docs/tools weekly 0.5 https://docs.openc3.com/docs/tools/admin weekly 0.5 https://docs.openc3.com/docs/tools/autonomic weekly 0.5 https://docs.openc3.com/docs/tools/bucket-explorer weekly 0.5 https://docs.openc3.com/docs/tools/calendar weekly 0.5 https://docs.openc3.com/docs/tools/cmd-sender weekly 0.5 https://docs.openc3.com/docs/tools/cmd-tlm-server weekly 0.5 https://docs.openc3.com/docs/tools/command_history weekly 0.5 https://docs.openc3.com/docs/tools/data-extractor weekly 0.5 https://docs.openc3.com/docs/tools/data-viewer weekly 0.5 https://docs.openc3.com/docs/tools/handbooks weekly 0.5 https://docs.openc3.com/docs/tools/limits-monitor weekly 0.5 https://docs.openc3.com/docs/tools/packet-viewer weekly 0.5 https://docs.openc3.com/docs/tools/script-runner weekly 0.5 https://docs.openc3.com/docs/tools/table-manager weekly 0.5 https://docs.openc3.com/docs/tools/tlm-grapher weekly 0.5 https://docs.openc3.com/docs/tools/tlm-viewer weekly 0.5 https://docs.openc3.com/ weekly 0.5 https://docs.openc3.com/markdown-page weekly 0.5 https://docs.openc3.com/docs weekly 0.5 https://docs.openc3.com/docs/configuration weekly 0.5 https://docs.openc3.com/docs/configuration/accessors weekly 0.5 https://docs.openc3.com/docs/configuration/command weekly 0.5 https://docs.openc3.com/docs/configuration/format weekly 0.5 https://docs.openc3.com/docs/configuration/interfaces weekly 0.5 https://docs.openc3.com/docs/configuration/plugins weekly 0.5 https://docs.openc3.com/docs/configuration/protocols weekly 0.5 https://docs.openc3.com/docs/configuration/ssl-tls weekly 0.5 https://docs.openc3.com/docs/configuration/table weekly 0.5 https://docs.openc3.com/docs/configuration/target weekly 0.5 https://docs.openc3.com/docs/configuration/telemetry weekly 0.5 https://docs.openc3.com/docs/configuration/telemetry-screens weekly 0.5 https://docs.openc3.com/docs/development weekly 0.5 https://docs.openc3.com/docs/development/curl weekly 0.5 https://docs.openc3.com/docs/development/developing weekly 0.5 https://docs.openc3.com/docs/development/json-api weekly 0.5 https://docs.openc3.com/docs/development/log-structure weekly 0.5 https://docs.openc3.com/docs/development/roadmap weekly 0.5 https://docs.openc3.com/docs/development/streaming-api weekly 0.5 https://docs.openc3.com/docs/development/testing weekly 0.5 https://docs.openc3.com/docs/getting-started weekly 0.5 https://docs.openc3.com/docs/getting-started/generators weekly 0.5 https://docs.openc3.com/docs/getting-started/gettingstarted weekly 0.5 https://docs.openc3.com/docs/getting-started/installation weekly 0.5 https://docs.openc3.com/docs/getting-started/key_concepts weekly 0.5 https://docs.openc3.com/docs/getting-started/podman weekly 0.5 https://docs.openc3.com/docs/getting-started/requirements weekly 0.5 https://docs.openc3.com/docs/getting-started/upgrading weekly 0.5 https://docs.openc3.com/docs/guides weekly 0.5 https://docs.openc3.com/docs/guides/bridges weekly 0.5 https://docs.openc3.com/docs/guides/cfs weekly 0.5 https://docs.openc3.com/docs/guides/custom-widgets weekly 0.5 https://docs.openc3.com/docs/guides/exposing_microservices weekly 0.5 https://docs.openc3.com/docs/guides/little-endian-bitfields weekly 0.5 https://docs.openc3.com/docs/guides/local-mode weekly 0.5 https://docs.openc3.com/docs/guides/logging weekly 0.5 https://docs.openc3.com/docs/guides/monitoring weekly 0.5 https://docs.openc3.com/docs/guides/performance weekly 0.5 https://docs.openc3.com/docs/guides/raspberrypi weekly 0.5 https://docs.openc3.com/docs/guides/script-writing weekly 0.5 https://docs.openc3.com/docs/guides/scripting-api weekly 0.5 https://docs.openc3.com/docs/meta weekly 0.5 https://docs.openc3.com/docs/meta/contributing weekly 0.5 https://docs.openc3.com/docs/meta/licenses weekly 0.5 https://docs.openc3.com/docs/meta/philosophy weekly 0.5 https://docs.openc3.com/docs/meta/xtce weekly 0.5 https://docs.openc3.com/docs/privacy weekly 0.5 https://docs.openc3.com/docs/tools weekly 0.5 https://docs.openc3.com/docs/tools/admin weekly 0.5 https://docs.openc3.com/docs/tools/autonomic weekly 0.5 https://docs.openc3.com/docs/tools/bucket-explorer weekly 0.5 https://docs.openc3.com/docs/tools/calendar weekly 0.5 https://docs.openc3.com/docs/tools/cmd-sender weekly 0.5 https://docs.openc3.com/docs/tools/cmd-tlm-server weekly 0.5 https://docs.openc3.com/docs/tools/command_history weekly 0.5 https://docs.openc3.com/docs/tools/data-extractor weekly 0.5 https://docs.openc3.com/docs/tools/data-viewer weekly 0.5 https://docs.openc3.com/docs/tools/handbooks weekly 0.5 https://docs.openc3.com/docs/tools/limits-monitor weekly 0.5 https://docs.openc3.com/docs/tools/packet-viewer weekly 0.5 https://docs.openc3.com/docs/tools/script-runner weekly 0.5 https://docs.openc3.com/docs/tools/table-manager weekly 0.5 https://docs.openc3.com/docs/tools/tlm-grapher weekly 0.5 https://docs.openc3.com/docs/tools/tlm-viewer weekly 0.5 https://docs.openc3.com/ weekly 0.5 
-
