Welcome to the OpenC3 system… Let’s get started! This guide is a high level overview that will help with setting up your first OpenC3 project.
- Get OpenC3 Installed onto your computer by following the Installation Guide.
- You should now have OpenC3 installed and a Demo project available that we can make changes to.
- Browse to http://localhost:2900
- The OpenC3 Command and Telemetry Server will appear. This tool provides real-time information about each “target” in the system. Targets are external systems that receive commands and generate telemetry, often over ethernet or serial connections.
- Experiment with other OpenC3 tools. This is a DEMO environment so you can’t break anything. Some things to try:
- Use Command Sender to send individual commands.
- Use Limits Monitor to watch for telemetry limits violations
- Run some of the example scripts in Script Runner and Test Runner
- View individual Telemetry packets in Packet Viewer
- View detailed telemetry displays in Telemetry Viewer
- Graph some data in Telemetry Grapher
- View log type data in Data Viewer
- Process log data with Data Extractor
Browser version issue
When you try to load the page and it fails to load, check with the built-in web development tools / DevTools. We have seen some strange things with version of browsers. You can build to a version of browser if you need to by reading about the browserslist. Some examples would be...
unexpected token ||=
To fix this make sure your browsers is compliant with the current settings in the .browserlistrc file. You can change this and rebuild the image. Note: This can cause build speeds to increase or decrease.
Interfacing with Your Hardware
Playing with the OpenC3 Demo is fun and all, but now you want to talk to your own real hardware? Let’s do it!
Install and Platform
This guide assumes we're on Windows and OpenC3 is installed in C:\OpenC3. Adjust scripts and paths as necessary to match your platform and OpenC3 installation directory.
Before creating your own configuration you should uninstall the OpenC3 Demo so you’re working with a clean OpenC3 system. Click the Admin button and the PLUGINS tab. Then click the Trash can icon next to openc3-demo to delete it. When you go back to the Command and Telemetry Server you should have a blank table with no interfaces.
Create a new “Configuration Directory”. This directory is typically named after your program / project and for this example we’ll call it “tutorial”. Inside this directory it’s recommended to create a README.md (Markdown) to describe your program / project.
Now we need to create a plugin. Plugins are how we add targets and microservices to OpenC3. Our plugin will contain a single target which contains all the information defining the packets (command and telemetry) that are needed to communicate with the target. Use the OpenC3 plugin generator to create the correct structure:
C:\> cd tutorial C:\tutorial> C:\OpenC3\openc3.bat cli generate plugin BOB
This should create a new directory called “openc3-bob” with a bunch of files in it. The full description of all the files is explained by the Plugin Structure page.
Run as the Root user
The cli runs as the default OpenC3 container user which is the recommended practice. If you're having issues running as that user you can run as the root user (effectively `docker run --user=root` ) by running `cliroot` instead of `cli` in any of the examples.
The plugin generate creates a single target named after the plugin. Best practice is to create a single target per plugin to make it easier to share targets and upgrade them individually. Lets see what the plugin generate created for us. Open the openc3-bob/targets/BOB/cmd_tlm/cmd.txt:
COMMAND BOB EXAMPLE BIG_ENDIAN "Packet description" # Keyword Name BitSize Type Min Max Default Description APPEND_ID_PARAMETER ID 16 INT 1 1 1 "Identifier" APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5 "Value" APPEND_PARAMETER BOOL 8 UINT MIN MAX 0 "Boolean" STATE FALSE 0 STATE TRUE 1 APPEND_PARAMETER LABEL 0 STRING "OpenC3" "The label to apply"
What does this all mean?
- We created a COMMAND for target BOB named EXAMPLE.
- The command is made up of BIG_ENDIAN parameters and is described by “Packet description”. Here we are using the append flavor of defining parameters which stacks them back to back as it builds up the packet and you don’t have to worry about defining the bit offset into the packet.
- First we APPEND_ID_PARAMETER a parameter that is used to identify the packet called ID that is an 16-bit signed integer (INT) with a minimum value of 1, a maximum value of 1, and a default value of 1, that is described as the “Identifier”.
- Next we APPEND_PARAMETER a parameter called VALUE that is a 32-bit float (FLOAT) that has a minimum value of 0, a maximum value of 10.5, and a default value of 2.5.
- Then we APPEND_PARAMETER a third parameter called BOOL which is a 8-bit unsigned integer (UINT) with a minimum value of MIN (meaning the smallest value a UINT supports, e.g 0), a maximum value of MAX (largest value a UINT supports, e.g. 255), and a default value of 0. BOOL has two states which are just a fancy way of giving meaning to the integer values 0 and 1. The STATE FALSE has a value of 0 and the STATE TRUE has a value of 1.
- Finally we APPEND_PARAMETER called LABEL which is a 0-bit (meaning it takes up all the remaining space in the packet) string (STRING) with a default value of “OpenC3”. Strings don’t have minimum or maximum values as that doesn’t make sense for STRING types.
Check out the full Command documention for more.
Now open the openc3-bob/targets/BOB/cmd_tlm/tlm.txt:
TELEMETRY BOB STATUS BIG_ENDIAN "Telemetry description" # Keyword Name BitSize Type ID Description APPEND_ID_ITEM ID 16 INT 1 "Identifier" APPEND_ITEM VALUE 32 FLOAT "Value" APPEND_ITEM BOOL 8 UINT "Boolean" STATE FALSE 0 STATE TRUE 1 APPEND_ITEM LABEL 0 STRING "The label to apply"
- This time we created a TELEMETRY packet for target BOB called STATUS that contains BIG_ENDIAN items and is described as “Telemetry description”.
- We start by defininig an ID_ITEM called ID that is a 16-bit signed integer (INT) with an id value of 1 and described as “Identifier”. Id items are used to take unidentified blobs of bytes and determine which packet they are. In this case if a blob comes in with a value of 1, at bit offset 0 (since we APPEND this item first), interpreted as a 16-bit integer, then this packet will be “identified” as STATUS. Note the first packet defined without any ID_ITEMS is a “catch-all” packet that matches all incoming data (even if the data lengths don’t match).
- Next we define three items similar to the command definition above.
Check out the full Telemetry documention for more.
OpenC3 has defined an example command and telemetry packet for our target. Most targets will obviously have more than one command and telemetry packet. To add more simply create additional COMMAND and TELEMETRY lines in your text files. Actual packets should match the structure of your command and telemetry. Be sure to add at least one unique ID_PARAMETER and ID_ITEM so your packets can be distinguished from each other.
Now we need to tell OpenC3 how to connect to our BOB target. Open the openc3-bob/plugin.txt file:
# Set VARIABLEs here to allow variation in your plugin # See https://openc3.com/docs/v5/plugins for more information VARIABLE bob_target_name BOB # Modify this according to your actual target connection # See https://openc3.com/docs/v5/interfaces for more information TARGET BOB <%= bob_target_name %> INTERFACE <%= bob_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST MAP_TARGET <%= bob_target_name %>
- This configures the plugin with a VARIABLE called bob_target_name with a default of “BOB”. When you install this plugin you will have the option to change the name of this target to something other than “BOB”. This is useful to avoid name conflicts and allows you to have multiple copies of the BOB target in your OpenC3 system.
- The TARGET line declares the new BOB target using the name from the variable. The <%= %> syntax is called ERB (embedded Ruby) and allows us to put variables into our text files, in this case referencing our bob_target_name.
- The last line declares a new INTERFACE called (by default) BOB_INT that will connect as a TCP/IP client using the code in tcpip_client_interface.rb to address host.docker.internal (This adds an /etc/hosts entry to the correct IP address for the host’s gateway) using port 8080 for writing and 8081 for reading. It also has a write timeout of 10 seconds and reads will never timeout (nil). The TCP/IP stream will be interpreted using the OpenC3 BURST protocol which means it will read as much data as it can from the interface. For all the details on how to configure OpenC3 interfaces please see the Interface Guide. The MAP_TARGET line tells OpenC3 that it will receive telemetry from and send commands to the BOB target using the BOB_INT interface.
Variables Support Reusability
In a plugin that you plan to reuse you should make things like hostnames and ports variables
Building Your Plugin
Now we need to build our plugin and upload it to OpenC3.
C:\tutorial> cd openc3-bob C:\tutorial\openc3-bob> C:\openc3\openc3.bat cli rake build VERSION=1.0.0 Successfully built RubyGem Name: openc3-bob Version: 126.96.36.19910618174517 File: openc3-bob-188.8.131.5210618174517.gem
- Note that the VERSION is required to specify the version to build. We recommend sematic versioning when building your plugin so people using your plugin (including you) know when there are breaking changes.
Once our plugin is built we need to upload it to OpenC3. Go back to the Admin page and click the Plugins Tab. Click on “Click to Select Plugin” and select the openc3-bob-184.108.40.20610618174517.gem file. Then click Upload. Go back to the CmdTlmServer and you should see the plugin being deployed at which point the BOB_INT interface should appear and try to connect. Go ahead and click ‘Cancel’ because unless you really have something listening on port 8080 this will never connect. At this point you can explore the other CmdTlmServer tabs and other tools to see your newly defined BOB target.
Let’s modify our BOB target and then update the copy in OpenC3. If you open Command Sender in OpenC3 to BOB EXAMPLE you should see the VALUE parameter has value 2.5. Open the openc3-bob/targets/BOB/cmd_tlm/cmd.txt and change the Default value for VALUE to 5 and the description to “New Value”.
COMMAND BOB EXAMPLE BIG_ENDIAN "Packet description" # Keyword Name BitSize Type Min Max Default Description APPEND_ID_PARAMETER ID 16 INT 1 1 1 "Identifier" APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 5 "New Value" APPEND_PARAMETER BOOL 8 UINT MIN MAX 0 "Boolean" STATE FALSE 0 STATE TRUE 1 APPEND_PARAMETER LABEL 0 STRING "OpenC3" "The label to apply"
Rebuild the plugin with a new VERSION number. Since we didn’t make any breaking changes we simply bump the patch release number:
C:\tutorial\openc3-bob> C:\OpenC3\openc3.bat cli rake build VERSION=1.0.1 Successfully built RubyGem Name: openc3-bob Version: 220.127.116.1110618202504 File: openc3-bob-18.104.22.16810618202504.gem
Go back to the Admin page and click the Plugins Tab. This time click the clock icon next to openc3-bob-1.0.0 to Upgrade the plugin. Browse to the newly built plugin gem and select it. This will re-prompt for the plugin variables (bob_target_name) so don’t change the name and just click OK. You should see a message about the plugin being installed at which point the plugins list will change to openc3-bob-22.214.171.12410618202504.gem. Go back to Command Sender and you should see the new Default value for VALUE is 5 and the description is “New Value”. We have upgraded our plugin!
At this point you can create a new plugin named after your real target and start modifying the interface and command and telemetry definitions to enable OpenC3 to connect to and drive your target. If you run into trouble look for solutions on our Github Issues page. If you would like to enquire about support contracts or professional OpenC3 development please contact us at email@example.com.