add eknitter ip handling

CONTRIBUTING.md

@@ -25,7 +25,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 In short, when you submit code changes, your submissions are understood to be under the same [GPL-3.0 License](https://choosealicense.com/licenses/gpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern.
 
 ## Report bugs using Github's [issues](https://github.com/AllYarnsAreBeautiful/ayab-desktop/issues)
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/AllYarnsAreBeautiful/ayab-desktop/issues/new); it's that easy!
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
 
 ## Write bug reports with detail, background, and sample code
 

README.md

@@ -86,11 +86,19 @@ macOS
 You can install Git using Homebrew:
 ```bash
     brew install git
+    brew install esptool
 ```
 You will also need the Xcode command line tools:
 ```bash
     xcode-select --install
 ```
+
+get ayab-desktop for eKnitter from github:
+
+```bash
+    git clone -b eKnitter https://github.com/yekomS/ayab-desktop ayab-desktop-eknitter
+```
+
 Install python from [the official universal2 installer](https://www.python.org/ftp/python/3.11.8/python-3.11.8-macos11.pkg). (Conda does not produce universal binaries)  
 
 If you encounter the pip `SSL:TLSV1_ALERT_PROTOCOL_VERSION` problem:

requirements.txt

@@ -6,3 +6,4 @@ types-pyserial==3.5.0
 types-mock
 types-Pillow==10
 mypy==1.9.0
+esptool==3.3.3

setup-environment.ps1

@@ -35,6 +35,9 @@ pyside6-rcc src/main/python/main/ayab/ayab_logo_rc.qrc -o src/main/python/main/a
 pyside6-rcc src/main/python/main/ayab/engine/lowercase_e_rc.qrc -o src/main/python/main/ayab/engine/lowercase_e_rc.py
 pyside6-rcc src/main/python/main/ayab/engine/lowercase_e_reversed_rc.qrc -o src/main/python/main/ayab/engine/lowercase_e_reversed_rc.py
 
+pyside6-rcc src/main/python/main/ayab/engine/eKnitter_rc.qrc -o src/main/python/main/ayab/engine/eKnitter_rc.py
+pyside6-rcc src/main/python/main/ayab/engine/eKnitter_reversed_rc.qrc -o src/main/python/main/ayab/engine/eKnitter_reversed_rc.py
+
 # generate translation files
 cd src/main/resources/base/ayab/translations/
 perl ayab_trans.pl

src/main/NSIS/Installer.nsi

@@ -16,7 +16,7 @@ Function .onInit
   ;Do not use InstallDir at all so we can detect empty $InstDir!
   ${If} $InstDir == "" ; /D not used
       ${If} $MultiUser.InstallMode == "AllUsers"
-          StrCpy $InstDir "C:\%{app_name}-v%{version}"
+          StrCpy $InstDir "$%HOMEDRIVE%\%{app_name}-v%{version}"
       ${Else}
           StrCpy $InstDir "$LOCALAPPDATA\%{app_name}"
       ${EndIf}

src/main/python/main/ayab/about.py

@@ -38,7 +38,7 @@ def __init__(self, parent: GuiMain):
         super().__init__()
         self.__version = utils.package_version(parent.app_context)
         self.__ui = Ui_AboutForm()
-        self.__ui.setupUi(self)
+        self.__ui.setupUi(self) # type: ignore
         self.__ui.title_label.setText(
             QCoreApplication.translate("MainWindow", "All Yarns Are Beautiful")
             + " "

src/main/python/main/ayab/about_gui.ui

@@ -11,7 +11,7 @@
    </rect>
   </property>
   <property name="windowTitle">
-   <string>About AYAB</string>
+   <string>About AYAB for eKnitter</string>
   </property>
   <property name="autoFillBackground">
    <bool>false</bool>
@@ -41,7 +41,7 @@
    <item>
     <widget class="QLabel" name="title_label">
      <property name="text">
-      <string>All Yarns Are Beautiful</string>
+      <string>All Yarns Are Beautiful for eKnitter</string>
      </property>
     </widget>
    </item>

src/main/python/main/ayab/ayab.py

@@ -17,6 +17,7 @@
 #    Copyright 2014 Sebastian Oliva, Christian Obersteiner,
 #       Andreas Müller, Christian Gerbrandt
 #    https://github.com/AllYarnsAreBeautiful/ayab-desktop
+#   Copyright 2024 Marcus Hoose (eKnitter.com)
 """Provides a graphical interface for users to operate AYAB."""
 
 from __future__ import annotations
@@ -25,6 +26,7 @@
 
 from PySide6.QtWidgets import QMainWindow
 from PySide6.QtCore import QCoreApplication
+from PySide6.QtCore import QEvent
 
 from .main_gui import Ui_MainWindow
 from .gui_fsm import gui_fsm
@@ -58,6 +60,11 @@ class GuiMain(QMainWindow):
     components from `menu_gui.ui`.
     """
 
+    def closeEvent(self, event: QEvent) -> None:
+        print("close")
+        self.engine.close()
+        event.accept()
+
     def __init__(self, app_context: AppContext):
         super().__init__()
         self.app_context = app_context
@@ -68,7 +75,7 @@ def __init__(self, app_context: AppContext):
 
         # create UI
         self.ui = Ui_MainWindow()
-        self.ui.setupUi(self)
+        self.ui.setupUi(self) # type: ignore
 
         # add modular components
         self.menu = Menu(self)
@@ -131,6 +138,7 @@ def __set_prefs(self) -> None:
 
     def __quit(self) -> None:
         logging.debug("Quitting")
+        self.engine.close()
         instance = QCoreApplication.instance()
         if instance is not None:
             instance.quit()

src/main/python/main/ayab/engine/communication_ip.py

@@ -0,0 +1,200 @@
+# -*- coding: utf-8 -*-
+# This file is part of AYAB.
+#
+#    AYAB is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    AYAB is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with AYAB.  If not, see <http://www.gnu.org/licenses/>.
+#
+#    Copyright 2024 Marcus Hoose (eKnitter.com)
+"""Handles the IP communication protocol.
+
+This module handles IP communication, currently works in a synchronous way.
+"""
+
+from .communication import *
+from ..machine import *
+
+import socket
+
+import logging
+import pprint
+from time import sleep
+
+# Port for TCP
+remotePort = 12346
+
+class CommunicationIP(Communication):
+    def __init__(self) -> None:
+        logging.basicConfig(level=logging.DEBUG)
+        self.logger = logging.getLogger(type(self).__name__)
+        self.__tarAddressPort: tuple[str | None, int]  = ("255.255.255.255", 12345)
+        self.__sockTCP: None | socket.socket = None
+        # socket.socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
+        self.rx_msg_list = list()
+        self.version = 6
+
+    def __del__(self) -> None:
+        self.close_socket()
+
+    def is_open(self) -> bool:
+        if self.__sockTCP is not None:
+            return True
+        else:
+            return False
+
+    def open_serial(self, portname: str | None = None) -> bool:
+        print("open: " , portname)
+        return self.open_tcp(portname)
+
+    def close_serial(self) -> None:
+        return None
+
+    def open_tcp(self, pPortname: str | None = None) -> bool:
+        try:
+            self.__portname = pPortname
+            self.__tarAddressPort = (self.__portname, remotePort)
+            self.__sockTCP = socket.socket(family=socket.AF_INET, type=socket.SOCK_STREAM)
+            self.__sockTCP.settimeout(10.0)
+            self.__sockTCP.connect(self.__tarAddressPort)
+            self.__sockTCP.settimeout(0.0)
+            self.__sockTCP.setblocking(False)
+            self.logger.info("Open TCP Socket successful")
+            return True
+        except:
+            self.logger.info("Open TCP Socket faild")
+            return False
+
+    def close_socket(self) -> None:
+        if self.__sockTCP is not None:
+            try:
+                self.__sockTCP.close()
+                del self.__sockTCP
+                self.logger.info("Closing TCP Socket successful.")
+            except:
+                self.logger.warning("Closing TCP Socket failed. (mem Leak?)")
+            self.__sockTCP = None
+
+    def send(self, data: bytearray) -> None:
+        if self.__sockTCP is not None:
+            try:
+                self.__sockTCP.send(bytes(data))
+                # self.logger.info("SEND b'"+data+"'")
+                sleep(0.5)
+            except Exception as e:
+                if hasattr(e, 'message'):
+                    self.logger.exception(e.message)
+                else:
+                    self.logger.exception("Connection...Error")
+                self.close_socket()
+
+    # NB this method must be the same for all API versions
+    def req_info(self) -> None:
+        self.send(bytearray([Token.reqInfo.value,self.version]))
+
+    def req_test_API6(self) -> None:
+        self.send(bytearray([Token.reqTest.value]))
+
+    def req_start_API6(self, start_needle: int, stop_needle: int,
+                       continuous_reporting: bool, disable_hardware_beep: bool) -> None:
+        """Send a start message to the device."""
+        data = bytearray()
+        data.append(Token.reqStart.value)
+        data.append(start_needle)
+        data.append(stop_needle)
+        data.append(
+            1 * continuous_reporting +
+            2 * (not disable_hardware_beep))
+        hash = 0
+        hash = add_crc(hash, data)
+        data.append(hash)
+        self.send(data)
+
+    def req_init_API6(self, machine: Machine) -> None:
+        """Send a start message to the device."""
+        data = bytearray()
+        data.append(Token.reqInit.value)
+        data.append(machine.value)
+        hash = 0
+        hash = add_crc(hash, data)
+        data.append(hash)
+        self.send(data)
+
+    def cnf_line_API6(self, line_number: int , color: int, flags: int, line_data: bytes) -> None:
+        """Send a line of data via the serial port.
+
+        Send a line of data to the serial port. All arguments are mandatory.
+        The data sent here is parsed by the Arduino controller which sets the
+        knitting needles accordingly.
+
+        Args:
+          line_number (int): The line number to be sent.
+          color (int): The yarn color to be sent.
+          flags (int): The flags sent to the controller.
+          line_data (bytes): The bytearray to be sent to needles.
+        """
+        data = bytearray()
+        data.append(Token.cnfLine.value)
+        data.append(line_number)
+        data.append(color)
+        data.append(flags)
+        data.extend(line_data)
+        hash = 0
+        hash = add_crc(hash, data)
+        data.append(hash)
+        self.send(data)
+
+    def update_API6(self) -> tuple[bytes | None, Token, int]:
+        """Read data from serial and parse as SLIP packet."""
+        return self.parse_API6(self.read_API6())
+
+    def parse_API6(self, msg: bytes | None) -> tuple[bytes | None, Token, int]:
+        if msg is None:
+            return None, Token.none, 0
+        # else
+        for t in list(Token):
+            if msg[0] == t.value:
+                return msg, t, msg[1]
+        # fallthrough
+        self.logger.debug("unknown message: ")  # drop crlf
+        pp = pprint.PrettyPrinter(indent=4)
+        pp.pprint(msg[1: -1].decode())
+        return msg, Token.unknown, 0
+
+    def read_API6(self) -> bytes | None:
+        """Read data from serial as SLIP packet."""
+        if self.__sockTCP is not None:
+            try:
+                data = self.__sockTCP.recv(1024)
+            except BlockingIOError:
+                data = bytes()
+            except Exception as e:
+                if hasattr(e, 'message'):
+                    self.logger.exception(e.message)
+                else:
+                    self.logger.exception("Connection...Error")
+                self.close_socket()
+                self.open_tcp(self.__portname)
+                data = bytes()
+
+            if len(data) > 0:
+                self.rx_msg_list.append(data)
+            if len(self.rx_msg_list) > 0:
+                return self.rx_msg_list.pop(0)  # FIFO
+        # else
+        return None
+
+    def write_API6(self, cmd: bytes | bytearray) -> None:
+        # SLIP protocol, no CRC8
+        if self.__ser:
+            self.__ser.write(bytes(cmd))
+
+

src/main/python/main/ayab/engine/control.py

@@ -17,6 +17,7 @@
 #    Copyright 2013-2020 Sebastian Oliva, Christian Obersteiner,
 #    Andreas Müller, Christian Gerbrandt
 #    https://github.com/AllYarnsAreBeautiful/ayab-desktop
+#   Copyright 2024 Marcus Hoose (eKnitter.com)
 
 from __future__ import annotations
 import logging
@@ -177,7 +178,13 @@ def __log_cnfInfo(self, msg: bytes) -> None:
         api = msg[1]
         log = "API v" + str(api)
         if api >= 5:
-            log += ", FW v" + str(msg[2]) + "." + str(msg[3]) + "." + str(msg[4])
+            if len(msg) < 5:
+                if len(msg) < 4:
+                    log += ", FW v?" 
+                else:
+                    log += ", FW v" + str(msg[2]) + "." + str(msg[3])
+            else:
+                log += ", FW v" + str(msg[2]) + "." + str(msg[3]) + "." + str(msg[4])
             suffix = msg[5:21]
             suffix_null_index = suffix.find(0)
             suffix_str = suffix[: suffix_null_index + 1].decode()

src/main/python/main/ayab/engine/eKnitter_rc.qrc

@@ -0,0 +1,5 @@
+<RCC>
+  <qresource prefix="/">
+    <file>eKnitter.png</file>
+  </qresource>
+</RCC>

src/main/python/main/ayab/engine/eKnitter_reversed_rc.qrc

@@ -0,0 +1,5 @@
+<RCC>
+  <qresource prefix="/">
+    <file>eKnitter-reversed.png</file>
+  </qresource>
+</RCC>