Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration Candidate 2020-03-18 #64

Merged
merged 3 commits into from
Mar 27, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Increase version 2.1.5 and update ReadMe.
  • Loading branch information
Gerardo E. Cruz-Ortiz committed Mar 24, 2020
commit 49a9d0f8e61cc36cefbd050bbc9ee52db9f239dc
24 changes: 10 additions & 14 deletions Guide-GroundSystem.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
cFS Ground System Version 2.1.4
cFS Ground System Version 2.1.5

cFS Ground System Info:

The GroundSystem directory contains the new Ground System project for the cFS, that incorporates a main window to launch commands and telemetry systems, and other utilities like FDL/FUL and FT managers to send and receive files. The main window runs alongside the Routing Service (RoutingService.py). The Routing Service handles all incoming data and publishes(PUB-SUB) the data to specific zeroMQ channels, so that the different ground system utilities can receive(subscribe) only the desired data.

This ground system supports commanding and receiving telemetry from multiple spacecrafts using UDP.

The Ground System contains a main window that lets you launch the different utilities. To start receiving data from the cFS, you need to enable telemetry first. To enable telemetry, click the "Start Command System" button from the main window, then from the Command System Main Page click the "Enable Tlm" button (you will need to enter the target/destination IP address as an input to this command).
The Ground System contains a main window that lets you launch the different utilities. To start receiving data from the cFS, you need to enable telemetry first. To enable telemetry, click the "Start Command System" button from the main window, then from the Command System Main Page click the "Enable Tlm" button (you will need to enter the target/destination IP address as an input to this command).

Note: The Main Window needs to be opened at all times so that the telemetry messages can be forwarded to the Telemetry System.

Expand All @@ -19,7 +19,7 @@ Future enhancements:

Before launching the Ground System make sure that:
-> PyQt4 is installed.
-> PyZMQ is installed.
-> PyZMQ is installed.
-> cmdUtil is compiled.


Expand All @@ -32,15 +32,15 @@ Installing and running cFS Ground System on Ubuntu:


The historically included instructions for running on Mac or CentOS are inluded at the bottom of this document for referance.
Please note that instructions have not been maintained.
Please note that instructions have not been maintained.
Welcoming instruction contributions if any of these are your platform of choice.


##############################################################################

ADDING NEW FLIGHT SOFTWARE APPLICATION TO GROUND SYSTEM COMMAND GUI

This section was made to help developers who are adding core Flight Software (cFS) Applications to the Python-based Ground System that comes with this cFS distribution.
This section was made to help developers who are adding core Flight Software (cFS) Applications to the Python-based Ground System that comes with this cFS distribution.

The CHeaderParser.py program that should be found in: GroundSystem/Subsystems/cmdGui is an interactive, command line based program to help walk developers through the process of adding custom cFS applications to the Ground System. Along with CHeaderParser.py is a configuration file that CHeaderParser uses to find the proper header files for your "new" cFS application. This file is named 'CHeaderParser-hdr-paths.txt', and should be placed in the same directory as CHeaderParser.py.

Expand All @@ -55,9 +55,9 @@ cFE-6.4.x-OSS-release/cfe/tools/cFS-GroundSystem/Subsystems/cmdGui/command-pages
Steps to adding application commands to the Ground System:

1) Edit 'CHeaderParser-hdr-paths.txt'
1.1) Locate any header files that contain command code definitions or command structure definitions.
1.1) Locate any header files that contain command code definitions or command structure definitions.
These files typically end in '*app_msg.h' or '*app_msgdefs.h' but could be named anything.
1.2) Add each one of the paths to a new line in CHeaderParser-hdr-paths.txt
1.2) Add each one of the paths to a new line in CHeaderParser-hdr-paths.txt
1.3) Comment out any paths/lines that aren't needed with '#' (at the beginning of the line)

2) Run CHeaderParser
Expand All @@ -81,7 +81,7 @@ Steps to adding application commands to the Ground System:
3.6) Column 6 - Command Send Address (default 127.0.0.1)
3.7) Column 7 - Command Send Port (default 1234)

Notes:
Notes:
- USE ONLY SPACES, NO TABS (Remember, it's Python.)
- Don't leave any empty lines in command-pages.txt, this could cause errors when running GroundSystem.py and
CommandSystem.py
Expand Down Expand Up @@ -134,7 +134,7 @@ Installing and running cFS Ground System on CentOS 6:
$ yum -y update

#### Install pip and python-development ####
# If you are on a 64-bit CentOS / RHEL based system:
# If you are on a 64-bit CentOS / RHEL based system:
$ wget https://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
$ rpm -ivh epel-release-6-8.noarch.rpm

Expand All @@ -157,7 +157,7 @@ Installing and running cFS Ground System on CentOS 6:
$ make
$ make install
$ echo /usr/local/lib > /etc/ld.so.conf.d/local.conf
$ ldconfig
$ ldconfig
$ pip install pyzmq

#### Install pyQT4 ####
Expand All @@ -167,7 +167,3 @@ Installing and running cFS Ground System on CentOS 6:

### Running Ground System ###
$ python GroundSystem.py




6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ See Guide-GroundSystem.txt for more information.

## Version Notes

- 2.1.5: DEVELOPMENT
- Updated build instructions for Python 3
- See https://github.com/nasa/cFS-GroundSystem/pull/64
- 2.1.4: DEVELOPMENT
- Finish conversion to python 3
- cmdutil now accepts --word as alias to --long
- See https://github.com/nasa/cFS-GroundSystem/pull/54
- 2.1.3: DEVELOPMENT
- Minor updates to work with python 3
- No longer compatible with python 2.7
- Note issue #50 is to update the related documentation
- Note issue #50 is to update the related documentation
- See https://github.com/nasa/cFS-GroundSystem/pull/47
- 2.1.2: DEVELOPMENT
- Minor updates (see https://github.com/nasa/cFS-GroundSystem/pull/39)
Expand All @@ -36,4 +39,3 @@ As a lab application, extensive testing is not performed prior to release and on
For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS.

Official cFS page: https://cfs.gsfc.nasa.gov