implement tmux and split gs cli

Author: c4bae

.tmux.conf

@@ -0,0 +1,7 @@
+set -g mouse on
+set -g pane-border-status top
+
+select-pane -t 0 -T "logs"
+select-pane -t 1 -T "gs_cli"
+
+set -g pane-border-format "#P: #{pane_title}"

CMakeLists.txt

@@ -8,7 +8,7 @@ if(${CMAKE_BUILD_TYPE} MATCHES OBC)
     endif()
     set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/toolchain_arm_none_eabi.cmake)
 elseif(${CMAKE_BUILD_TYPE} MATCHES GS)
-    set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/toolchain_ground_station_gcc.cmake)
+    #set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/toolchain_ground_station_gcc.cmake)
 elseif(${CMAKE_BUILD_TYPE} MATCHES HIL)
     include(${CMAKE_SOURCE_DIR}/cmake/fetch_googletest.cmake)
     set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/toolchain_hil_gcc.cmake)
@@ -63,4 +63,4 @@ endif()
 add_subdirectory(libs)
 
 # Build interface libs
-add_subdirectory(interfaces)
+add_subdirectory(interfaces)

README.md

@@ -167,7 +167,68 @@ Take a look at `cmake/fw_build_options.cmake` to see the available build options
 
 #### **Ground Station**
 
-From the top-level directory, run the following to build the ground station. Currently, the ground station is only supported on Windows.
+From the top-level directory, run the following to build the ground station. Currently, the ground station has only been supported for Windows and may be subject to bugs on MacOS. If on a Linux or Windows system, skip the MacOS instructions.
+
+<b>For MacOS users only</b>:\
+First, add the following to the top of file `./obc/CMakeLists.txt`, and should be placed as shown:
+```
+...
+cmake_minimum_required(VERSION 3.15)
+
+# Add the following 4 lines
+if(APPLE) 
+    find_library(COREFOUNDATION CoreFoundation)
+    find_library(IOKIT IOKit)
+endif()
+...
+```
+
+Next, add the following to the file `./gs/backend/CMakeLists.txt` positioned as below:
+```
+...
+target_compile_options(gs.out PUBLIC -Wall -g)
+
+# Add the following 6 lines
+if(APPLE)
+    target_link_libraries(gs.out PUBLIC
+        "-framework CoreFoundation"
+        "-framework IOKit"
+    )
+endif()
+...
+```
+
+Next, comment out line in `./CMakeLists.txt` like as shown:
+```
+...
+#set(CMAKE_TOOLCHAIN_FILE ${CMAKE_SOURCE_DIR}/cmake/toolchain_ground_station_gcc.cmake)
+...
+```
+
+Next, open `./gs/backend/main.c` and add and remove the following headers:
+```.c
+...
+<malloc.h> # Remove
+...
+<CoreFoundation/CoreFoundation.h> # Add
+...
+```
+
+Next, open `./gs/interfaces/obc_gs_interface/__init__.py` and change the end of the path extension to `.dylib`, as shown:
+```py
+...
+path = (Path(__file__).parent / "../../build_gs/interfaces/libobc-gs-interface.dylib").resolve() 
+# originally ...interface.so, change to ...interface.dylib
+...
+```
+
+Lastly, run the following in the terminal:
+```sh
+pip install -e .
+```
+<b>End of MacOS instructions. Continue with the last step below.</b>
+
+Then, run the following in the terminal from the top-level directory:
 
 ```sh
 mkdir -p build_gs && cd build_gs

gs/backend/CMakeLists.txt

@@ -12,6 +12,13 @@ target_include_directories(gs.out PUBLIC
     ${CMAKE_CURRENT_SOURCE_DIR}/serial_utils
 )
 
+if(APPLE)
+    target_link_libraries(gs.out PUBLIC
+        "-framework CoreFoundation"
+        "-framework IOKit"
+    )
+endif()
+
 target_compile_options(gs.out PUBLIC -Wall -g)
 
 if(UNIX)
@@ -20,13 +27,13 @@ if(UNIX)
         lib-correct
         obc-gs-interface
         CSerialPort
-)
+    )
 elseif(WIN32)
     target_link_libraries(gs.out PUBLIC
         tiny-aes
         lib-correct
         obc-gs-interface
         CSerialPort
         setupapi
-)
-endif()
+    )
+endif()

gs/backend/ground_station_cli.py

@@ -33,7 +33,7 @@ def __init__(self, com_port: str) -> None:
     ██║   ██║██║███╗██║    ██║   ██║██╔══██╗██╔══██╗██║   ██║   ██╔══██║██║
     ╚██████╔╝╚███╔███╔╝    ╚██████╔╝██║  ██║██████╔╝██║   ██║   ██║  ██║███████╗
      ╚═════╝  ╚══╝╚══╝      ╚═════╝ ╚═╝  ╚═╝╚═════╝ ╚═╝   ╚═╝   ╚═╝  ╚═╝╚══════╝
-  Welcome to the UW Orbital Command Line Inteface! Type help or ? to list commands.\n
+  Welcome to the UW Orbital Command Line Interface! Type help or ? to list commands.\n
     """
     prompt = "(UW Orbital): "
     file = None
@@ -133,8 +133,10 @@ def do_print_logs(self, line: str) -> None:
         """
         # Preliminary checks for the function to run
         # Write out the logs that we previously got
-        with open(LOG_PATH) as file:
-            print(file.read())
+
+        # Commented out as it is displayed in the left pane
+        # with open(LOG_PATH) as file:
+        #     print(file.read())
 
         if self.background_logging is not None:
             self.background_logging.kill()

gs/backend/main.c

@@ -12,11 +12,11 @@
 #include <aes.h>
 #include <cserialport.h>
 
-#include <malloc.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <CoreFoundation/CoreFoundation.h>
 #include <time.h>
 
 const uint8_t TEMP_STATIC_KEY[AES_KEY_SIZE] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,

gs/backend/obc_utils/command_utils.py

@@ -366,5 +366,5 @@ def poll(com_port: str, file_path: str | Path, timeout: int = 0, print_console:
 
             file.write(data_string)
             file.flush()
-            if print_console and len(data_string) != 0:
-                print(data_string)
+            # if print_console and len(data_string) != 0:
+            #     # print(data_string)

gs/backend/tmux_cli.py

@@ -0,0 +1,38 @@
+import libtmux
+import time
+from libtmux.constants import PaneDirection
+from sys import argv
+
+def main() -> None:
+    if len(argv) != 2:
+        print("One argument needed: Com Port")
+        return
+
+    com_port = str(argv[1])
+    server = libtmux.Server()
+    if server.has_session("gs_cli"):
+        server.kill_session("gs_cli")
+            
+    # Does not attach the new session right away through attach parameter
+    session = server.new_session(session_name="gs_cli", attach=False)
+    window = session.active_window
+
+    pane1 = window.active_pane
+    pane2 = window.split(attach=True, direction=PaneDirection.Right, size=80)        
+
+    # Initialize gs cli
+    pane2.send_keys(f"source .venv/bin/activate && tmux source-file .tmux.conf && python3.11 gs/backend/ground_station_cli.py {com_port}")
+
+    # Sleep to allow appropriate time for cli setup
+    time.sleep(1.5)
+
+    # Enable logs pane
+    pane1.send_keys(f"tail -f gs/backend/logs.log") 
+
+    # Display tmux cli
+    session.attach()
+
+
+
+if __name__ == "__main__":
+    main()

interfaces/obc_gs_interface/__init__.py

@@ -2,5 +2,5 @@
 from pathlib import Path
 
 # The shared object file we are using the access the c functions via ctypes
-path = (Path(__file__).parent / "../../build_gs/interfaces/libobc-gs-interface.so").resolve()
+path = (Path(__file__).parent / "../../build_gs/interfaces/libobc-gs-interface.dylib").resolve()
 interface = CDLL(str(path))

obc/CMakeLists.txt

@@ -1,5 +1,10 @@
 cmake_minimum_required(VERSION 3.15)
 
+if(APPLE)
+    find_library(COREFOUNDATION CoreFoundation)
+    find_library(IOKIT IOKit)
+endif()
+
 # Set default values for firmware build options
 include(${CMAKE_SOURCE_DIR}/cmake/obc_build_options.cmake)