Version 0.2.0 - Alignment functionality

.github/workflows/python-app.yml

@@ -15,14 +15,14 @@ jobs:
     runs-on:  ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-12]
         # python-version: ["3.8", "3.9", "3.10"]
         python-version: ["3.10"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -45,12 +45,12 @@ jobs:
         cd ..
         cd ..
     - if: ${{ matrix.os != 'windows-latest' }}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: the_ant_farm_${{ matrix.python-version }}_${{ matrix.os }}
+        name: the_ant_farm_${{ matrix.python-version }}_${{ matrix.os }}_${{ github.sha }}_${{ github.run_number }}
         path: src/TheAntFarm/dist/the_ant_farm
     - if: ${{ matrix.os == 'windows-latest' }}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: the_ant_farm_${{ matrix.python-version }}_${{ matrix.os }}.exe
+        name: the_ant_farm_${{ matrix.python-version }}_${{ matrix.os }}_${{ github.sha }}_${{ github.run_number }}
         path: src/TheAntFarm/dist/the_ant_farm.exe

CHANGELOG.md

@@ -0,0 +1,97 @@
+
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.2.0] - Aug 11, 2024  
+
+Added first implementation of alignment tab based on manual selection of points in
+the loaded layer and positioning of the machin tool using camera.
+This allows to create double sided PCB aligning them optically.
+
+
+### Camera Functionality Improvements:
+- **Camera Selection and Deselection**: Added the ability to deselect the camera when the application closes and improved camera selection management, including adding a default "NO Camera" option to avoid accidental startups.
+- **Camera Zoom**: Linked the camera zoom combobox to update the view and added mouse wheel events to control the zoom.
+- **Camera Alignment**: Improved synchronization of alignment buttons, connected camera zoom to the frame manager, and added support for selecting alignment points, including the ability to remove points.
+
+### Alignment Procedure Enhancements:
+- **Alignment Point Management and Visualization**: Introduced a system to manage alignment points, including the removal of points and visual synchronization when alignment is applied. Added signals to update the coordinates of alignment points.
+- **Path Optimization Algorithms**: Implemented and optimized a genetic algorithm to optimize the drilling path, also adding other algorithms like "nearest_insertion" and "two_opt". 
+
+### User Interface Improvements:
+- **UI Changes**: Made numerous changes to enhance the user experience, such as reorganizing the alignment tab, adding new control elements, and connecting various signals to synchronize the application state.
+- **LED Indicators**: Added visual LEDs to signal the status of various processes, such as probing and alignment.
+- **GCode File Handling**: Added the ability to load GCode files as a reference for alignment and improved the integration of the alignment system with the main program.
+
+### Bug Fixes and Optimizations:
+- **Minor Fixes**: Resolved various bugs, such as issues with camera image misalignment, minor UI errors, and incorrect conditions. Improved handling of variables and boundary conditions in XY and Z movements.
+- **MacOS Compatibility**: Termporarily removed generation of executable for ARM64 processor for MacOS.  
+
+### Other Enhancements:
+- **DRC and Camera Offset**: Implemented a validity check for Gerber paths and optimized the use of working positions instead of machine positions to get the camera-tool offset.
+- **Integration of New Features**: Added a new `AlignManager` class to handle alignment and introduced a new alignment algorithm.
+
+
+## [0.1.1] - May 13, 2023  
+
+Modified python-app.yml and added files to generate executables for 3 main OS using  
+github actions.
+
+### **Version and Documentation Updates**:
+   - **Version Bump**: Updated the project version to 0.1.1.
+   - **Documentation**: Enhanced and moved documentation to the wiki and updated `CommandManager` documentation.
+
+### **Build Process Enhancements**:
+   - **Artifact Handling**: Improved artifact naming and handling for different Python versions and operating systems.
+   - **Path and File Management**: Corrected paths for YAML files, executable runs, and excluded certain files from linting.
+   - **CI Configuration**: Adjusted the CI pipeline to support specific Python versions, use a matrix strategy, and added conditional artifact uploads.
+
+### **Compatibility and Dependency Management**:
+   - **Python Version**: Managed support for different Python versions (added 3.11, later removed due to incompatibility).
+   - **Shapely Library**: Addressed deprecation warnings and made preventive changes for Shapely >= 2.0.
+   - **`pyinstaller` Support**: Added spec file and adjustments to support building with `pyinstaller`.
+
+### **Miscellaneous Changes**:
+   - **UI Updates**: Made minor changes to how status signals are managed and displayed in the UI.
+   - **Packaging**: Added `pyproject.toml` for package management using `poetry` (not used at the moment).
+
+
+## [0.1.0] - Oct 07, 2022  
+
+First issue of The Ant Farm, implemented functionality to generate gcode from TOP, 
+BOTTOM, DRILL and EDGE gerber/excellon layers.  
+Implemented Control tab to load gcode and manage CNC controllers using GRBL 1.x.  
+
+### **Initial Setup and Core Functionality**:
+   - Introduction of new features like UI improvements, gcode generation, and tool change automation.
+   - Added handling for different file formats, including Gerber and Excellon files, with support for metric and imperial units.
+   - Improvements to core functionalities like drill file processing, layer management, and gcode visualization.
+
+### **Bug Fixes and Issue Resolution**:
+   - Numerous bug fixes addressing issues like loading files without geometries, converting units, and serial port communication.
+   - Resolved issues related to gcode generation, such as handling empty layers, mirroring, and feedrate errors.
+   - Fixes for threading issues, error handling, and UI bugs.
+
+### **Enhancements and Refactoring**:
+   - Enhanced user interface with better management of settings, color selections, and shortcut keys.
+   - Refactoring of code to improve structure, including splitting large classes into smaller, more manageable parts.
+   - Added features like tool change settings, probe offsets, and automated boundary box (ABL) processing.
+
+### **Documentation and Readability**:
+   - Added and updated documentation, including comments, docstrings, and the README file.
+   - Improved code readability by translating comments into English and following coding style guidelines.
+
+### **Version Control and Compatibility**:
+   - Managed dependencies and compatibility with different Python versions.
+   - Set up environment settings for different operating systems, including Windows, Linux, and Mac.
+
+### **Testing and Optimization**:
+   - Added tests and debugging tools to improve reliability and performance.
+   - Implemented optimizations to reduce gcode complexity and improve processing speed.
+
+### **Final Touches and Releases**:
+   - Prepared the project for release with a new logo, version tagging, and final code clean-up.
+   - Updated requirements, resources, and icons, preparing the application for broader use.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "TheAntFarm"
-version = "0.1.0"
+version = "0.1.2"
 description = "TheAntFarm is an application that simplifies the PCB creation using CNC machines."
 authors = ["The Ant Team"]
 license = "MIT"
@@ -26,6 +26,8 @@ shiboken2 = "5.15.2.1"
 vispy = "0.9.4"
 opencv-python = ">=4.5.1.48"
 
+dynamic = ["version"]
+
 [tool.poetry.dev-dependencies]
 
 [build-system]

src/TheAntFarm/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.2.0'

src/TheAntFarm/app_resources.qrc

@@ -1,5 +1,7 @@
 <RCC>
   <qresource prefix="resources">
+    <file>resources/icons/black_alignment_applied.svg</file>
+    <file>resources/icons/black_apply_align.svg</file>
     <file>resources/icons/gray-refresh.svg</file>
     <file>resources/icons/white-upload-file.svg</file>
     <file>resources/icons/gray-upload-file.svg</file>