You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -9,6 +9,7 @@ This ground system supports commanding and receiving telemetry from multiple spa
9
9
The Ground System contains the main window that lets you launch the different utilities.
10
10
11
11
To start receiving data from the cFS, you need to enable telemetry first. To enable telemetry:
12
+
12
13
- click the "Start Command System" button from the main window,
13
14
- 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).
14
15
@@ -17,68 +18,68 @@ Note: The Main Window needs to be opened at all times so that the telemetry mess
17
18
The Ground System will automatically detect the spacecraft when it starts sending the telemetry, and it will be added to the IP addresses list. You can select the spacecraft from the list, and start Telemetry System to receive its data. If 'All' spacecrafts are selected, you can start Telemetry System to display the packet count from multiple spacecrafts (if it detected more than one).
18
19
19
20
Future enhancements:
21
+
20
22
1. Detect different spacecrafts based on telemetry header (spacecraft `id`) data instead of using the spacecraft IP address.
21
-
1. Add instructions for Windows.
23
+
2. Add instructions for Windows.
22
24
23
25
## Install and run
24
26
25
27
Before launching the Ground System make sure that:
28
+
26
29
- PyQt5 is installed,
27
30
- PyZMQ is installed,
28
31
- cmdUtil is compiled.
29
32
30
33
Installing and running cFS Ground System on Ubuntu:
The historically included instructions for running on macOS or CentOS are included at the bottom of this document for reference.
39
-
Please note that instructions have not been maintained.
40
-
Welcoming instruction contributions if any of these are your platform of choice.
42
+
The historically included instructions for running on macOS or CentOS are included at the bottom of this document for reference. Please note that instructions have not been maintained. Welcoming instruction contributions if any of these are your platform of choice.
41
43
42
44
## Adding new flight software application to ground system command GUI
43
45
44
46
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.
45
47
46
48
The `CHeaderParser.py` program that should be found in:
47
49
50
+
48
51
```GroundSystem/Subsystems/cmdGui```
49
52
50
53
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`.
Steps to adding application commands to the Ground System:
61
62
62
-
1. Edit `CHeaderParser-hdr-paths.txt`:
63
-
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.
64
-
1. Add each one of the paths to a new line in `CHeaderParser-hdr-paths.txt`.
65
-
1. Comment out any paths/lines that aren't needed with `#` (at the beginning of the line).
66
-
67
-
1. Run CHeaderParser:
68
-
1. Call CHeaderParser using python: `python3 CHeaderParser.py`
69
-
1. The program will prompt you to enter a filename for the application. This will create a pickle file for your application named `CommandFiles/<user_defined_name>`. Notice that this file will be stored in the `CommandFiles` directory. This same filename will be used in `command-pages.txt` later.
70
-
1. Type `yes` if any commands in your application have parameters. The program will then look through the provided header files for `definitions.pick` which-ever definitions describe related command codes (one at a time, the program will prompt you for the next command code after all parameters have been added for the current command).
71
-
1. Select the appropriate command structure for the selected command. The program will show all structures that it could find in the provided header files. Enter the index of the command structure (the corresponding index should be above the command structure).
72
-
1. Select any parameters from the structure that apply. Once you have selected all applicable lines from the command structure, enter `-1` to finish. This will create a pickle file for the command/parameters named `ParameterFiles/<command_name>`. Notice that this file will be stored in the `ParameterFiles` directory.
73
-
74
-
1. Update `command-pages.txt` (CSV):
75
-
1. Column 1 - Title of your application (whatever you want it called).
76
-
1. Column 2 - filename of your application (chosen in Step 2.ii) under `CommandFiles` directory.
77
-
1. Column 3 - Message ID for Application Commands (typically defined in `mission_msgids.h`).
78
-
1. Column 4 - Endianess (default little endian: `LE`).
1. Column 7 - Command Send Port (default: `1234`).
63
+
1\. Edit `CHeaderParser-hdr-paths.txt`:
64
+
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.
65
+
1\. Add each one of the paths to a new line in `CHeaderParser-hdr-paths.txt`.
66
+
1\. Comment out any paths/lines that aren't needed with `#` (at the beginning of the line).
67
+
68
+
1\. Run CHeaderParser:
69
+
1\. Call CHeaderParser using python: `python3 CHeaderParser.py`
70
+
1\. The program will prompt you to enter a filename for the application. This will create a pickle file for your application named `CommandFiles/<user_defined_name>`. Notice that this file will be stored in the `CommandFiles` directory. This same filename will be used in `command-pages.txt` later.
71
+
1\. Type `yes` if any commands in your application have parameters. The program will then look through the provided header files for `definitions.pick` which-ever definitions describe related command codes (one at a time, the program will prompt you for the next command code after all parameters have been added for the current command).
72
+
1\. Select the appropriate command structure for the selected command. The program will show all structures that it could find in the provided header files. Enter the index of the command structure (the corresponding index should be above the command structure).
73
+
1\. Select any parameters from the structure that apply. Once you have selected all applicable lines from the command structure, enter `-1` to finish. This will create a pickle file for the command/parameters named `ParameterFiles/<command_name>`. Notice that this file will be stored in the `ParameterFiles` directory.
74
+
75
+
1\. Update `command-pages.txt` (CSV):
76
+
1\. Column 1 - Title of your application (whatever you want it called).
77
+
1\. Column 2 - filename of your application (chosen in Step 2.ii) under `CommandFiles` directory.
78
+
1\. Column 3 - Message ID for Application Commands (typically defined in `mission_msgids.h`).
79
+
1\. Column 4 - Endianess (default little endian: `LE`).
File "/usr/lib/python3.7/subprocess.py", line 642, in __init__
101
-
errread, errwrite)
102
-
File "/usr/lib/python3.7/subprocess.py", line 1234, in _execute_child
103
-
raise child_exception
104
-
OSError: [Errno 8] Exec format error
105
95
```
106
96
107
-
Fix: This problem is most likely caused by calling `cmdUtil` without compiling it. This issue has also been found to occur when the `cmdUtil` executable has been compressed/decompressed. To fix this problem, use the `Makefile` inside of the `cmdUtil` directory to compile or recompile (in the case after decompressing).
97
+
Calling cmdUtil from Parameter.py Traceback (most recent call last): File "Parameter.py", line 100, in ProcessSendButton subprocess.Popen(cmd_args, stdout=subprocess.PIPE) File "/usr/lib/python3.7/subprocess.py", line 642, in __init__ errread, errwrite) File "/usr/lib/python3.7/subprocess.py", line 1234, in _execute_child raise child_exception OSError: [Errno 8] Exec format error
108
98
109
99
```
110
-
$ cd Subsystems/cmdUtil
111
-
$ make
112
-
$ cd ../..
113
-
$ python3 GroundSystem.py
100
+
Fix: This problem is most likely caused by calling `cmdUtil` without compiling it. This issue has also been found to occur when the `cmdUtil` executable has been compressed/decompressed. To fix this problem, use the `Makefile` inside of the `cmdUtil` directory to compile or recompile (in the case after decompressing).
114
101
```
115
102
103
+
$ cd Subsystems/cmdUtil $ make $ cd ../.. $ python3 GroundSystem.py
104
+
105
+
```
116
106
## Historically included instructions for running on macOS or CentOS
117
107
118
108
### Installing and running cFS Ground System on macOS, using Homebrew
119
-
120
-
```
121
-
$ brew install pyqt
122
-
$ brew install zeromq
123
-
$ ( cd Subsystems/cmdUtil/ && make )
124
-
$ python GroundSystem.py
125
109
```
126
110
111
+
$ brew install pyqt $ brew install zeromq $ ( cd Subsystems/cmdUtil/ && make ) $ python GroundSystem.py
112
+
113
+
```
127
114
### Installing and running cFS Ground System on CentOS 6
128
115
129
116
#### Update yum
130
117
```
131
-
$ su
132
-
$ <type password>
133
-
$ yum -y update
134
-
```
135
118
119
+
$ su $
120
+
121
+
<type password="">
122
+
$ yum -y update</type>
123
+
124
+
```
136
125
#### Install pip and python-development ####
137
126
If you are on a 64-bit CentOS / RHEL based system:
Copy file name to clipboardExpand all lines: README.md
+45-30Lines changed: 45 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,54 +2,69 @@
2
2
3
3
This repository contains NASA's Lab Ground System (cFS-GroundSystem), which is a framework component of the Core Flight System.
4
4
5
-
This lab application is a non-flight utility ground system to interact with the cFS. It is intended to be located in the `tools/cFS-GroundSystem` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at https://github.com/nasa/cFS (which includes cFS-GroundSystem as a submodule), which includes build and execution instructions.
5
+
This lab application is a non-flight utility ground system to interact with the cFS. It is intended to be located in the `tools/cFS-GroundSystem` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at <https://github.com/nasa/cFS> (which includes cFS-GroundSystem as a submodule), which includes build and execution instructions.
6
6
7
7
See Guide-GroundSystem.txt for more information.
8
8
9
9
## Version History
10
10
11
-
##### Development Build: 2.1.7
12
-
- Commands and Telemetry definitions now match code
13
-
- See https://github.com/nasa/cFS-GroundSystem/pull/74
11
+
### Development Build: 2.1.8
14
12
15
-
##### Development Build: 2.1.6
16
-
- Cmd code (and checksum) are always in the same place
17
-
- See https://github.com/nasa/cFS-GroundSystem/pull/69
13
+
- No warnings when building with GCC9
14
+
- Event messages now display both Event type and ID.
15
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/86>
18
16
19
-
##### Development Build: 2.1.5
20
-
- Updated build instructions for Python 3
21
-
- See https://github.com/nasa/cFS-GroundSystem/pull/64
17
+
### Development Build: 2.1.7
22
18
23
-
##### Development Build: 2.1.4
24
-
- Finish conversion to python 3
25
-
- cmdutil now accepts --word as alias to --long
26
-
- See https://github.com/nasa/cFS-GroundSystem/pull/54
19
+
- Commands and Telemetry definitions now match code
20
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/74>
27
21
28
-
##### Development Build: 2.1.3
29
-
- Minor updates to work with python 3
30
-
- No longer compatible with python 2.7
31
-
- Note issue #50 is to update the related documentation
32
-
- See https://github.com/nasa/cFS-GroundSystem/pull/47
22
+
### Development Build: 2.1.6
33
23
34
-
##### Development Build: 2.1.2
35
-
- Minor updates (see https://github.com/nasa/cFS-GroundSystem/pull/39)
24
+
- Cmd code (and checksum) are always in the same place
25
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/69>
36
26
37
-
##### Development Build: 2.1.1
38
-
- Minor updates (see https://github.com/nasa/cFS-GroundSystem/pull/36)
27
+
### Development Build: 2.1.5
39
28
40
-
### ***OFFICIAL RELEASE 2.1.0***
41
-
- Minor updates (see https://github.com/nasa/cFS-GroundSystem/pull/26)
42
-
- Released as part of cFE 6.7.0, Apache 2.0
29
+
- Updated build instructions for Python 3
30
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/64>
43
31
44
-
### ***OFFICIAL RELEASE 2.0.90a***
45
-
- Released as part of cFE 6.6.0a, Apache 2.0
32
+
### Development Build: 2.1.4
33
+
34
+
- Finish conversion to python 3
35
+
- cmdutil now accepts --word as alias to --long
36
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/54>
37
+
38
+
### Development Build: 2.1.3
39
+
40
+
- Minor updates to work with python 3
41
+
- No longer compatible with python 2.7
42
+
- Note issue #50 is to update the related documentation
43
+
- See <https://github.com/nasa/cFS-GroundSystem/pull/47>
44
+
45
+
### Development Build: 2.1.2
46
+
47
+
- Minor updates (see <https://github.com/nasa/cFS-GroundSystem/pull/39>)
48
+
49
+
### Development Build: 2.1.1
50
+
51
+
- Minor updates (see <https://github.com/nasa/cFS-GroundSystem/pull/36>)
52
+
53
+
### **_OFFICIAL RELEASE 2.1.0_**
54
+
55
+
- Minor updates (see <https://github.com/nasa/cFS-GroundSystem/pull/26>)
56
+
- Released as part of cFE 6.7.0, Apache 2.0
57
+
58
+
### **_OFFICIAL RELEASE 2.0.90a_**
59
+
60
+
- Released as part of cFE 6.6.0a, Apache 2.0
46
61
47
62
## Known issues
48
63
49
64
As a lab application, extensive testing is not performed prior to release and only minimal functionality is included.
50
65
51
66
## Getting Help
52
67
53
-
For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS.
68
+
For best results, submit issues:questions or issues:help wanted requests at <https://github.com/nasa/cFS>.
0 commit comments