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
Copy file name to clipboardexpand all lines: Guide-GroundSystem.md
+58-49
Original file line number
Diff line number
Diff line change
@@ -50,33 +50,37 @@ The `CHeaderParser.py` program that should be found in:
50
50
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:
59
63
60
-
1\. Edit `CHeaderParser-hdr-paths.txt`:
61
-
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.
62
-
1\. Add each one of the paths to a new line in `CHeaderParser-hdr-paths.txt`.
63
-
1\. Comment out any paths/lines that aren't needed with `#` (at the beginning of the line).
64
-
65
-
1\. Run CHeaderParser:
66
-
1\. Call CHeaderParser using python: `python3 CHeaderParser.py`
67
-
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.
68
-
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).
69
-
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).
70
-
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.
71
-
72
-
1\. Update `command-pages.txt` (CSV):
73
-
1\. Column 1 - Title of your application (whatever you want it called).
74
-
1\. Column 2 - filename of your application (chosen in Step 2.ii) under `CommandFiles` directory.
75
-
1\. Column 3 - Message ID for Application Commands (typically defined in `mission_msgids.h`).
76
-
1\. Column 4 - Endianess (default little endian: `LE`).
1\. Column 7 - Command Send Port (default: `1234`).
64
+
1. Edit `CHeaderParser-hdr-paths.txt`:
65
+
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.
66
+
1. Add each one of the paths to a new line in `CHeaderParser-hdr-paths.txt`.
67
+
1. Comment out any paths/lines that aren't needed with `#` (at the beginning of the line).
68
+
69
+
1. Run CHeaderParser:
70
+
1. Call CHeaderParser using python: `python3 CHeaderParser.py`
71
+
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.
72
+
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).
73
+
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).
74
+
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.
75
+
76
+
1. Update `command-pages.txt` (CSV):
77
+
1. Column 1 - Title of your application (whatever you want it called).
78
+
1. Column 2 - filename of your application (chosen in Step 2.ii) under `CommandFiles` directory.
79
+
1. Column 3 - Message ID for Application Commands (typically defined in `mission_msgids.h`).
80
+
1. Column 4 - Endianess (default little endian: `LE`).
1. Column 7 - Command Send Port (default: `1234`).
80
84
81
85
Notes:
82
86
- USE ONLY SPACES, NO TABS (Remember, it's Python).
@@ -90,61 +94,66 @@ After completing these steps, restart the Ground System and the changes should h
90
94
91
95
Traceback:
92
96
```
93
-
94
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
95
-
96
98
```
97
99
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).
98
100
```
99
-
100
101
$ cd Subsystems/cmdUtil $ make $ cd ../.. $ python3 GroundSystem.py
101
-
102
102
```
103
103
## Historically included instructions for running on macOS or CentOS
104
104
105
+
These are NOT kept up-to-date, but included for historical reference (may be easier than starting from scratch)
106
+
105
107
### Installing and running cFS Ground System on macOS, using Homebrew
106
108
```
107
-
108
-
$ brew install pyqt $ brew install zeromq $ ( cd Subsystems/cmdUtil/ && make ) $ python GroundSystem.py
109
-
109
+
$ brew install pyqt
110
+
$ brew install zeromq
111
+
$ ( cd Subsystems/cmdUtil/ && make )
112
+
$ python GroundSystem.py
110
113
```
111
114
### Installing and running cFS Ground System on CentOS 6
112
115
113
116
#### Update yum
114
117
```
115
-
116
-
$ su $
117
-
118
-
<type password="">
118
+
$ su
119
+
$ <type password="">
119
120
$ yum -y update</type>
120
-
121
121
```
122
122
#### Install pip and python-development ####
123
123
If you are on a 64-bit CentOS / RHEL based system:
0 commit comments