Skip to content

Commit 27f49b8

Browse files
authored
Merge pull request #194 from thnkslprpt/FIX-CFS-GROUNDSYSTEM-TYPOS
Fixed doc, comment and message typos.
2 parents 8651e2e + f141a4a commit 27f49b8

14 files changed

+21
-21
lines changed

Guide-GroundSystem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The GroundSystem directory contains the new Ground System project for the cFS, that incorporates the 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.
66

7-
This ground system supports commanding and receiving telemetry from multiple spacecrafts using UDP.
7+
This ground system supports commanding and receiving telemetry from multiple spacecraft using UDP.
88

99
The Ground System contains the main window that lets you launch the different utilities.
1010

@@ -15,11 +15,11 @@ To start receiving data from the cFS, you need to enable telemetry first. To ena
1515

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

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+
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' spacecraft are selected, you can start Telemetry System to display the packet count from multiple spacecraft (if it detected more than one).
1919

2020
Future enhancements:
2121

22-
1. Detect different spacecrafts based on telemetry header (spacecraft `id`) data instead of using the spacecraft IP address.
22+
1. Detect different spacecraft based on telemetry header (spacecraft `id`) data instead of using the spacecraft IP address.
2323
2. Add instructions for Windows.
2424

2525
## Install and run
@@ -94,7 +94,7 @@ Steps to adding application commands to the Ground System:
9494
- USE ONLY SPACES, NO TABS (Remember, it's Python).
9595
- Don't leave any empty lines in `command-pages.txt`, this could cause errors when running `GroundSystem.py` and `CommandSystem.py`.
9696

97-
After completing these steps, restart the Ground System and the changes should have taken affect.
97+
After completing these steps, restart the Ground System and the changes should have taken effect.
9898

9999
## Common issues and troubleshooting
100100

RoutingService.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def run(self):
7272
datagram, host = self.sock.recvfrom(
7373
4096) # buffer size is 1024 bytes
7474

75-
# Ignore datagram if it is not long enough (doesnt contain tlm header?)
75+
# Ignore datagram if it is not long enough (doesn't contain tlm header?)
7676
if len(datagram) < 6:
7777
continue
7878

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To report a vulnerability for the cFS-GroundSystem subsystem please [submit an i
66

77
For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy) for additional information.
88

9-
In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label.
9+
In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label.
1010

1111
## Testing
1212

Subsystems/cmdGui/CHeaderParser.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
# the user for necessary information, and parsing the cFS header files, this
4343
# program will generate up to two different "pickle" files for the ground
4444
# system to use (for information about pickle files and the pickle python
45-
# libary, see the link here: https://docs.python.org/3/library/pickle.html).
45+
# library, see the link here: https://docs.python.org/3/library/pickle.html).
4646
# These files will be placed in CommandFiles/ or ParameterFiles/.
4747
#
4848
# Usage:
@@ -129,7 +129,7 @@ def getFileList(filename='CHeaderParser-hdr-paths.txt'):
129129
# create empty list for dumping header data
130130
master_hdr = []
131131

132-
# Concatonate all headers into one variable for referencing
132+
# Concatenate all headers into one variable for referencing
133133
for hdr_file in file_list:
134134
# open header file as single header
135135
with open(hdr_file) as single_hdr:
@@ -257,7 +257,7 @@ def getFileList(filename='CHeaderParser-hdr-paths.txt'):
257257
f"You entered {command_choice}, but that isn't an option.")
258258
else:
259259
## Choices are presented to user starting at 1, but list
260-
## indicies start at 0
260+
## indices start at 0
261261
command_choice -= 1
262262
cmdName = unused_cmdDesc[command_choice]
263263

@@ -405,7 +405,7 @@ def getFileList(filename='CHeaderParser-hdr-paths.txt'):
405405
# Add original data type (C data type) to list
406406
dataTypesOrig.append(line_split[0])
407407

408-
# Get rid of any occurance of ';' (at the end of the line)
408+
# Get rid of any occurence of ';' (at the end of the line)
409409
paramNames.append(re.sub(';', '', line_split[1]))
410410

411411
# Not sure about why we are keeping track of this yet

Subsystems/cmdGui/CommandFiles/cfe__es__msg_8h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
(lp0
22
(lp1
3-
S'Clears the contents of the Exeception and Reset Log'
3+
S'Clears the contents of the Exception and Reset Log'
44
p2
55
aS'Clear Executive Services System Log'
66
p3
@@ -46,7 +46,7 @@ aS'Stop and Unload Application'
4646
p23
4747
aS'Telemeter Memory Pool Statistics'
4848
p24
49-
aS'Writes Exeception and Reset Log to a File'
49+
aS'Writes Exception and Reset Log to a File'
5050
p25
5151
aS'Writes contents of Executive Services System Log to a File'
5252
p26

Subsystems/cmdGui/Parameter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def ProcessSendButton(self):
6969
if sendSuccess:
7070
self.status_box.setText('Command sent!')
7171
else:
72-
self.status_box.setText('Error occured')
72+
self.status_box.setText('Error occurred')
7373

7474
def closeEvent(self, event):
7575
if self.mcu:

Subsystems/cmdGui/ParameterFiles/struct_c_f_e___e_s___c_d_s_reg_dump_rec__t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ aS'Size, in bytes, of the CDS memory block. boolean Table Flag that indicates wh
3131
p16
3232
aS'Processor Unique Name of CDS.'
3333
p17
34-
aS'Spare byte to insure structure size is multiple of 4 bytes.'
34+
aS'Spare byte to ensure structure size is multiple of 4 bytes.'
3535
p18
3636
aa(lp19
3737
S'--word'

Subsystems/cmdGui/ParameterFiles/struct_c_f_e___e_s___hk_packet__t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ aS'Current state of Performance Analyzer.'
252252
p110
253253
aS'Current mode of Performance Analyzer.'
254254
p111
255-
aS'Number of Times Perfomance Analyzer has Triggered.'
255+
aS'Number of Times Performance Analyzer has Triggered.'
256256
p112
257257
aS'Current Setting of Performance Analyzer Filter Masks.'
258258
p113

Subsystems/cmdGui/ParameterFiles/struct_c_f_e___e_v_s___app_data_cmd__t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ aa(lp5
99
S'[OS_MAX_PATH_LEN]'
1010
p6
1111
aa(lp7
12-
S'Filename where applicaton data is to be written.'
12+
S'Filename where application data is to be written.'
1313
p8
1414
aa(lp9
1515
S'--string'

Subsystems/cmdGui/ParameterFiles/struct_c_f_e___e_v_s___log__t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ag14
3131
aa(lp15
3232
S'Index of the next entry in the local event log.'
3333
p16
34-
aS'Local Event Kog counter.'
34+
aS'Local Event Log counter.'
3535
p17
3636
aS'Local Event Log full flag.'
3737
p18

0 commit comments

Comments
 (0)