From c3d2c987e6d47e03e8d45bf00a23be45033155a9 Mon Sep 17 00:00:00 2001 From: Joroph-Koraka Date: Tue, 22 Apr 2025 08:53:17 -0700 Subject: [PATCH 1/6] Adjusted cd filepathing --- extras/mockUI/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/extras/mockUI/README.md b/extras/mockUI/README.md index bd9a6f178..1d2b9a9b3 100644 --- a/extras/mockUI/README.md +++ b/extras/mockUI/README.md @@ -4,7 +4,7 @@ A Python GUI for TankController running on the mocks provided by `Arduino CI`. ## Build Process Follow these steps * `python3 -m pip install wxPython pybind11` -* `cd GUI` +* `cd extras/mockUI` * ``filePath=`bundle exec which arduino_library_location.rb` `` * `export ARDUINO_CI=${filePath%/bin/*}/gems/arduino_ci-1.3.0/cpp/arduino` * `make clean` From 66009e6bb55e4d7350a74098d369533602b95c82 Mon Sep 17 00:00:00 2001 From: Joroph-Koraka Date: Thu, 24 Apr 2025 09:42:19 -0700 Subject: [PATCH 2/6] Added Windows Variant to README in mockUI --- extras/mockUI/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/extras/mockUI/README.md b/extras/mockUI/README.md index 1d2b9a9b3..cefd2fd26 100644 --- a/extras/mockUI/README.md +++ b/extras/mockUI/README.md @@ -1,7 +1,7 @@ # TankControllerGUI A Python GUI for TankController running on the mocks provided by `Arduino CI`. -## Build Process +## Build Process (Mac/Linux) Follow these steps * `python3 -m pip install wxPython pybind11` * `cd extras/mockUI` @@ -11,6 +11,23 @@ Follow these steps * `(mkdir -p build; cd build; make -f ../Makefile)` * `python3 TankController.py` +## Build Process (Windows) +Follow these steps +* `install Ruby via https://rubyinstaller.org` +* `gem install bunder arduino_ci` +* `python3 -m pip install wxPython pybind11` +* `cd extras/mockUI` +* `irb` +* `require 'arduino_ci'; puts Gem::Specification.find_by_name('arduino_ci').gem_dir` +* `copy the returned directory` +* `exit` +* In powershell terminal `$env:ARDUINO_CI = "[INSERT DIRECTORY HERE]"` +* `echo $env:ARDUINO_CI` Should return the directory that was given earlier +* `make clean` +* If the make file fails, launch the Git Bash terminal in the IDE and retry +* `(mkdir -p build; cd build; make -f ../Makefile)` +* `python3 TankController.py` + The `Makefile` provides for making the following: * `libtc.dylib` (on macOS) containing the following: * `Arduino CI` mocks (essentially the Arduino OS) From 5c8508fdcfbbc11cb79420680a42c9d518cad5dc Mon Sep 17 00:00:00 2001 From: Joroph-Koraka Date: Mon, 28 Apr 2025 10:36:32 -0700 Subject: [PATCH 3/6] Version 0.3 of README rework --- Gemfile | 2 ++ extras/mockUI/README.md | 7 ++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/Gemfile b/Gemfile index 16d1d7a3a..85e952b71 100644 --- a/Gemfile +++ b/Gemfile @@ -6,3 +6,5 @@ gem 'arduino_ci', github: 'jgfoster/arduino_ci', branch: 'makefile' # This is helpful when a change to arduino_ci breaks the tests # gem 'arduino_ci', github: 'Arduino-CI/arduino_ci', tag: 'v1.6.0' # gem 'arduino_ci', github: 'Arduino-CI/arduino_ci', ref: '9c1340a4f13638f81949172dc1ac9a0060576006' + +gem "os", "~> 1.1" diff --git a/extras/mockUI/README.md b/extras/mockUI/README.md index cefd2fd26..65ff035dd 100644 --- a/extras/mockUI/README.md +++ b/extras/mockUI/README.md @@ -14,20 +14,21 @@ Follow these steps ## Build Process (Windows) Follow these steps * `install Ruby via https://rubyinstaller.org` -* `gem install bunder arduino_ci` +* In the Ruby command prompt `gem install bunder arduino_ci` * `python3 -m pip install wxPython pybind11` * `cd extras/mockUI` * `irb` * `require 'arduino_ci'; puts Gem::Specification.find_by_name('arduino_ci').gem_dir` -* `copy the returned directory` +* Copy the returned directory * `exit` * In powershell terminal `$env:ARDUINO_CI = "[INSERT DIRECTORY HERE]"` * `echo $env:ARDUINO_CI` Should return the directory that was given earlier * `make clean` -* If the make file fails, launch the Git Bash terminal in the IDE and retry +* If the make file fails, ensure you have make installed on the MINGW64 version of Git Bash * `(mkdir -p build; cd build; make -f ../Makefile)` * `python3 TankController.py` +## Makefile Specs The `Makefile` provides for making the following: * `libtc.dylib` (on macOS) containing the following: * `Arduino CI` mocks (essentially the Arduino OS) From 5587a6b51e203766ffe734bf69e4e29469c2a19d Mon Sep 17 00:00:00 2001 From: Joroph-Koraka Date: Wed, 28 May 2025 13:20:41 -0700 Subject: [PATCH 4/6] Improved Markdown Layout TODO: Finalize the building process so that the python file works correctly --- extras/mockUI/README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/extras/mockUI/README.md b/extras/mockUI/README.md index 65ff035dd..31cc799d2 100644 --- a/extras/mockUI/README.md +++ b/extras/mockUI/README.md @@ -1,7 +1,7 @@ # TankControllerGUI A Python GUI for TankController running on the mocks provided by `Arduino CI`. -## Build Process (Mac/Linux) +## Build Process (Mac/Linux) [Not up to date] Follow these steps * `python3 -m pip install wxPython pybind11` * `cd extras/mockUI` @@ -13,20 +13,22 @@ Follow these steps ## Build Process (Windows) Follow these steps -* `install Ruby via https://rubyinstaller.org` -* In the Ruby command prompt `gem install bunder arduino_ci` -* `python3 -m pip install wxPython pybind11` -* `cd extras/mockUI` -* `irb` -* `require 'arduino_ci'; puts Gem::Specification.find_by_name('arduino_ci').gem_dir` -* Copy the returned directory -* `exit` -* In powershell terminal `$env:ARDUINO_CI = "[INSERT DIRECTORY HERE]"` -* `echo $env:ARDUINO_CI` Should return the directory that was given earlier -* `make clean` -* If the make file fails, ensure you have make installed on the MINGW64 version of Git Bash -* `(mkdir -p build; cd build; make -f ../Makefile)` -* `python3 TankController.py` +* Install Ruby via https://rubyinstaller.org +* Inside IDE terminal (Or equivalent Powershell terminal) + * `cd extras/mockUI` + * `irb` + * `gem install bunder arduino_ci` + * `require 'arduino_ci'; puts Gem::Specification.find_by_name('arduino_ci').gem_dir` + * Copy the returned directory + * `exit` +* Inside powershell terminal + * `python3 -m pip install wxPython pybind11` + * `$env:ARDUINO_CI = "[INSERT DIRECTORY HERE]"` + * `echo $env:ARDUINO_CI` Should return the directory that was given earlier + * `make clean` + * If the make file fails, ensure you have make installed on the MINGW64 version of Git Bash + * `(mkdir -p build; cd build; make -f ../Makefile)` + * `python3 TankController.py` ## Makefile Specs The `Makefile` provides for making the following: From b7d6535a9899ec39bf0a62dd1cd2264a03c37edc Mon Sep 17 00:00:00 2001 From: Joroph-Koraka Date: Thu, 29 May 2025 21:17:56 -0700 Subject: [PATCH 5/6] Readme Rework Halted Touched up the Windows version and found a critical error that could not be solved with the time that I have. Please view the note in the README for more information. --- extras/mockUI/README.md | 6 +++++- extras/mockUI/TankController.py | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/extras/mockUI/README.md b/extras/mockUI/README.md index 31cc799d2..95fa28dbc 100644 --- a/extras/mockUI/README.md +++ b/extras/mockUI/README.md @@ -17,7 +17,7 @@ Follow these steps * Inside IDE terminal (Or equivalent Powershell terminal) * `cd extras/mockUI` * `irb` - * `gem install bunder arduino_ci` + * `gem install bundler arduino_ci` * `require 'arduino_ci'; puts Gem::Specification.find_by_name('arduino_ci').gem_dir` * Copy the returned directory * `exit` @@ -25,10 +25,14 @@ Follow these steps * `python3 -m pip install wxPython pybind11` * `$env:ARDUINO_CI = "[INSERT DIRECTORY HERE]"` * `echo $env:ARDUINO_CI` Should return the directory that was given earlier + * `pip install libTC` +* Inside the MINGW64 terminal * `make clean` * If the make file fails, ensure you have make installed on the MINGW64 version of Git Bash * `(mkdir -p build; cd build; make -f ../Makefile)` * `python3 TankController.py` + * NOTE: As of right now, there will likely be an error like this: `"D:\Code\OpenSource\TankControllerMockUIRework\extras\mockUI\TankController.py", line 6, in import libTC ModuleNotFoundError: No module named 'libTC'` + * This is because there are modules that cannot be found in libTC.cpp, for example, cannot be found and used in that file. No solution has been found as of yet. ## Makefile Specs The `Makefile` provides for making the following: diff --git a/extras/mockUI/TankController.py b/extras/mockUI/TankController.py index a4e5b5cb3..070b9bab4 100755 --- a/extras/mockUI/TankController.py +++ b/extras/mockUI/TankController.py @@ -2,6 +2,7 @@ import errno import time +import sys import libTC import os import shutil From 2da3156a52fdedc47b27bce35856f21f834548c9 Mon Sep 17 00:00:00 2001 From: James Foster Date: Thu, 12 Jun 2025 11:08:24 -0700 Subject: [PATCH 6/6] Update TankController.py Remove unused import. --- extras/mockUI/TankController.py | 1 - 1 file changed, 1 deletion(-) diff --git a/extras/mockUI/TankController.py b/extras/mockUI/TankController.py index 070b9bab4..a4e5b5cb3 100755 --- a/extras/mockUI/TankController.py +++ b/extras/mockUI/TankController.py @@ -2,7 +2,6 @@ import errno import time -import sys import libTC import os import shutil