style: rename things

Renamed some things to be more clear. Also, now any save files such as
message history are stored under the `save-data/` directory.

Author: Koloss0

.gitignore

@@ -7,6 +7,7 @@
 messages.json
 camera_data.txt
 *.jpeg
+save-data/
 
 ###############################################################################
 # VSCode

soti-cli/__main__.py

@@ -8,8 +8,8 @@
 import os
 import serial.tools.list_ports
 
-from cli_utils import help_strings
-from cli_utils.constants import NodeID, CmdID, COMM_INFO, MSG_HISTORY_FILENAME
+from utils import help_strings
+from utils.constants import SAVE_DATA_DIR, NodeID, CmdID, COMM_INFO, MSG_HISTORY_PATH
 
 from serial_reader import serial_reader
 from message_parser import parser
@@ -79,7 +79,7 @@ def do_query(self, arg):
         """Queries the telemetry."""
         print(f"\nSearching message history for {arg} commands...")
 
-        with open(MSG_HISTORY_FILENAME, encoding="utf_8") as history:
+        with open(MSG_HISTORY_PATH, encoding="utf_8") as history:
             msgs = json.load(history)
 
         num_results = 0
@@ -94,7 +94,7 @@ def do_query(self, arg):
 
     def do_clear(self, _):
         """Clears the json message history file."""
-        with open(MSG_HISTORY_FILENAME, 'w', encoding="utf_8") as history:
+        with open(MSG_HISTORY_PATH, 'w', encoding="utf_8") as history:
             history.write("[]")
             history.flush()
         print("The json message history file has been cleared.\n")
@@ -128,8 +128,11 @@ def do_exit(self, _):
 
 def init_json():
     """Initializes the JSON file which logs all messages."""
-    if (not os.path.exists(MSG_HISTORY_FILENAME)) or (os.path.getsize(MSG_HISTORY_FILENAME) == 0):
-        with open(MSG_HISTORY_FILENAME, 'w', encoding="utf_8") as history:
+    if not os.path.exists(SAVE_DATA_DIR):
+        os.mkdir(SAVE_DATA_DIR)
+
+    if (not os.path.exists(MSG_HISTORY_PATH)) or (os.path.getsize(MSG_HISTORY_PATH) == 0):
+        with open(MSG_HISTORY_PATH, 'w', encoding="utf_8") as history:
             history.write("[]")
 
 

soti-cli/message_parser.py

@@ -3,7 +3,7 @@
 import datetime
 import json
 import struct
-from cli_utils.constants import NodeID, CmdID, MSG_HISTORY_FILENAME
+from utils.constants import NodeID, CmdID, MSG_HISTORY_PATH
 
 
 def parser(in_msg_queue):
@@ -13,10 +13,10 @@ def parser(in_msg_queue):
         new_msg_raw = in_msg_queue.get()
         new_msg_json = parse_message(new_msg_raw)
         print(f"Message Parsed: {new_msg_json}")
-        with open(MSG_HISTORY_FILENAME, encoding="utf_8") as history:
+        with open(MSG_HISTORY_PATH, encoding="utf_8") as history:
             history_json = json.load(history)
         history_json.append(new_msg_json)
-        with open(MSG_HISTORY_FILENAME, 'w', encoding="utf_8") as history:
+        with open(MSG_HISTORY_PATH, 'w', encoding="utf_8") as history:
             json.dump(history_json, history, indent=4)
 
 

soti-cli/serial_reader.py

@@ -2,7 +2,7 @@
 
 from queue import Empty
 import serial
-from cli_utils.constants import MSG_SIZE
+from utils.constants import MSG_SIZE
 
 
 def serial_reader(in_msg_queue, out_msg_queue, soti_port):

soti-cli/cli_utils/constants.py renamed to soti-cli/utils/constants.py

@@ -5,10 +5,11 @@
 
 ROOT_DIR = Path(__file__).resolve().parent.parent
 
-# files
-MSG_HISTORY_FILENAME = ROOT_DIR / "messages.json"
+SAVE_DATA_DIR = ROOT_DIR / "save-data"
 
-# message size
+MSG_HISTORY_PATH = SAVE_DATA_DIR / "messages.json"
+
+# The length of a serialized message in bytes.
 MSG_SIZE = 11
 
 
@@ -18,15 +19,15 @@ class NodeID(Enum):
     PWR  = 1
     ADCS = 2
     PLD  = 3
-    
+
     def get_display_name(self) -> str:
         """
         Returns a friendlier name for each enum member.
         
         Example Usage:
         print(Node.CDH.get_display_name())
         """
-        
+
         display_names = {
             NodeID.CDH: "CDH",
             NodeID.PWR: "Power",

soti-cli/cli_utils/help_strings.py renamed to soti-cli/utils/help_strings.py

@@ -1,6 +1,6 @@
 """Includes strings used in help messages."""
 
-from cli_utils.constants import CmdID
+from utils.constants import CmdID
 
 
 HELP_MESSAGE = """