Merge pull request #30 from AlbertaSat/rowan/feature/update_main_readme

Rowan/feature/update main readme
AlbertaSat · Oct 24, 2024 · 7eec710 · 7eec710
2 parents 2bd528b + 38c81d3
commit 7eec710
Showing 1 changed file with 12 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -20,36 +20,35 @@ Contained here is the shared functionality mentioned above between the ground st
 
 Scripts to run various sections of the software together can be found in the [scripts](./scripts) directory.
 
-(For now) These scripts use bash which is a standard shell, and tmux which is a terminal multiplexer available on most operating systems (e.g. `sudo apt install tmux`).
 
-### Running all components needs for a tall-thin demo of the Command Message Uplink
+(For now) These scripts use bash and gnome-terminal which is are the standard shell and terminal shipped with Ubuntu systems. *Additionally*, these scripts also use the ex3_simulated_subsystem repo which is on the main AlbertaSat Github page. One must clone this, then provide the relative path to it when running the script as the first command line argument.
 
-This script takes the user defined path to wherever the simulated subsytem repo is for them, in order to start the simulated DFGM subsystem.
+### Testing Uplink
+
+Commands for uplink can be found in a master spreadsheet [here].(https://docs.google.com/spreadsheets/d/1rWde3jjrgyzO2fsg2rrVAKxkPa2hy-DDaqlfQTDaNxg/edit?gid=0#gid=0)
 
-First cd into the scripts directory, then run the following command.
+One can send a command by running the uplink script: ```uplink_command_msg.sh```.
 
 ```@sh
-bash ./uplink_command_msg.sh <path_to_simulated_subsystem_directory>
+./uplink_command_msg <relative_path_to_sim_subsystem_dir>
 ```
 
-**As of now**, you'll need to run the bulk_msg_dispatcher separately as well for downlinking purposes. Find [here](./ex3_obc_fsw/bulk_msg_dispatcher/).
+Next, an operator will send commands from the Ground Station. Right now, it is the SIM_GS terminal that is spawned by the script. Next, type in a command structured as ```<DEST> <opcode> <body>(optional)```.
 
-### Testing Uplink
-
-Commands for uplink can be found in a master spreadsheet [here].(https://docs.google.com/spreadsheets/d/1rWde3jjrgyzO2fsg2rrVAKxkPa2hy-DDaqlfQTDaNxg/edit?gid=0#gid=0)
-
-One can send a command by running the uplink script: ```uplink_command_msg.sh```.
+An example to toggle the collection of DFGM data would be:
 
 ```@sh
-./uplink_command_msg <path_to_sim_subsystem_dir>
+DFGM 0 1
 ```
 
-Next, an operator will send commands from the Ground Station. Right now, it is the SIM_GS terminal that is spawned by the script. Next, type in a command structured as ```<DEST> <opcode> <body>(optional)```. An example to toggle the collection of DFGM data would be:
+followed by:
 
 ```@sh
 DFGM 0 1
 ```
 
+to toggle off the data collection. **NOTE**: this method of data collection is unique to the DFGM subsystem. Other subsystems will be able to collect data without having to toggle a flag.
+
 ### Testing Downlink  
 
 Once all the processes are running, Send the command: