not1mm 24.3.16__py3-none-any.whl → 24.3.24__py3-none-any.whl

not1mm/vfo.py

@@ -9,58 +9,35 @@ VFO Window
 # usb-Raspberry_Pi_Pico_W_E6614C311B331139-if00
 
 import logging
-
 import os
-
 import platform
-import queue
-import sys
 from json import loads, JSONDecodeError
-from pathlib import Path
 
 import serial
-from PyQt5 import QtCore, QtNetwork, uic, QtWidgets
-from PyQt5.QtCore import QTimer
-from PyQt5.QtWidgets import QApplication, QMainWindow
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+from PyQt5.QtCore import Qt, QTimer
+from PyQt5.QtWidgets import QWidget
 
+import not1mm.fsutils as fsutils
 from not1mm.lib.cat_interface import CAT
 from not1mm.lib.multicast import Multicast
 
-os.environ["QT_QPA_PLATFORMTHEME"] = "gnome"
-
-if __loader__:
-    WORKING_PATH = os.path.dirname(__loader__.get_filename())
-else:
-    WORKING_PATH = os.path.dirname(os.path.realpath(__file__))
+logger = logging.getLogger(__name__)
 
-if "XDG_DATA_HOME" in os.environ:
-    DATA_PATH = os.environ.get("XDG_DATA_HOME")
-else:
-    DATA_PATH = str(Path.home() / ".local" / "share")
-DATA_PATH += "/not1mm"
 
-if "XDG_CONFIG_HOME" in os.environ:
-    CONFIG_PATH = os.environ.get("XDG_CONFIG_HOME")
-else:
-    CONFIG_PATH = str(Path.home() / ".config")
-CONFIG_PATH += "/not1mm"
-
-
-class MainWindow(QMainWindow):
-    """
-    The main window
-    """
+class VfoWindow(QWidget):
+    """The VFO window."""
 
     pref = {}
     old_vfo = ""
     old_pico = ""
     message_shown = False
     multicast_interface = None
+    current_palette = None
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        data_path = WORKING_PATH + "/data/vfo.ui"
-        uic.loadUi(data_path, self)
+        uic.loadUi(fsutils.APP_DATA_PATH / "vfo.ui", self)
         self.rig_control = None
         self.timer = QTimer()
         self.timer.timeout.connect(self.getwaiting)
@@ -69,7 +46,7 @@ class MainWindow(QMainWindow):
         self.lcdNumber.display(0)
         self.pico = None
         self._udpwatch = None
-        self.udp_fifo = queue.Queue()
+
         self.multicast_interface = Multicast(
             self.pref.get("multicast_group", "239.1.1.1"),
             self.pref.get("multicast_port", 2239),
@@ -77,9 +54,45 @@ class MainWindow(QMainWindow):
         )
         self.multicast_interface.ready_read_connect(self.watch_udp)
 
-    def quit_app(self) -> None:
-        """Shutdown the app."""
-        app.quit()
+        self.setup_serial()
+        # app.processEvents()
+        self.poll_rig_timer = QtCore.QTimer()
+        self.poll_rig_timer.timeout.connect(self.poll_radio)
+        self.poll_rig_timer.start(500)
+
+    def setDarkMode(self, dark: bool):
+        """testing"""
+
+        if dark:
+            darkPalette = QtGui.QPalette()
+            darkColor = QtGui.QColor(45, 45, 45)
+            disabledColor = QtGui.QColor(127, 127, 127)
+            darkPalette.setColor(QtGui.QPalette.Window, darkColor)
+            darkPalette.setColor(QtGui.QPalette.WindowText, Qt.white)
+            darkPalette.setColor(QtGui.QPalette.Base, QtGui.QColor(18, 18, 18))
+            darkPalette.setColor(QtGui.QPalette.AlternateBase, darkColor)
+            darkPalette.setColor(QtGui.QPalette.Text, Qt.white)
+            darkPalette.setColor(
+                QtGui.QPalette.Disabled, QtGui.QPalette.Text, disabledColor
+            )
+            darkPalette.setColor(QtGui.QPalette.Button, darkColor)
+            darkPalette.setColor(QtGui.QPalette.ButtonText, Qt.white)
+            darkPalette.setColor(
+                QtGui.QPalette.Disabled, QtGui.QPalette.ButtonText, disabledColor
+            )
+            darkPalette.setColor(QtGui.QPalette.BrightText, Qt.red)
+            darkPalette.setColor(QtGui.QPalette.Link, QtGui.QColor(42, 130, 218))
+            darkPalette.setColor(QtGui.QPalette.Highlight, QtGui.QColor(42, 130, 218))
+            darkPalette.setColor(QtGui.QPalette.HighlightedText, Qt.black)
+            darkPalette.setColor(
+                QtGui.QPalette.Disabled, QtGui.QPalette.HighlightedText, disabledColor
+            )
+            self.current_palette = darkPalette
+            self.setPalette(darkPalette)
+        else:
+            palette = self.style().standardPalette()
+            self.current_palette = palette
+            self.setPalette(palette)
 
     def load_pref(self) -> None:
         """
@@ -87,9 +100,9 @@ class MainWindow(QMainWindow):
         Get CAT interface.
         """
         try:
-            if os.path.exists(CONFIG_PATH + "/not1mm.json"):
+            if os.path.exists(fsutils.CONFIG_FILE):
                 with open(
-                    CONFIG_PATH + "/not1mm.json", "rt", encoding="utf-8"
+                    fsutils.CONFIG_FILE, "rt", encoding="utf-8"
                 ) as file_descriptor:
                     self.pref = loads(file_descriptor.read())
                     logger.info("%s", self.pref)
@@ -119,6 +132,7 @@ class MainWindow(QMainWindow):
                 int(self.pref.get("CAT_port", 4532)),
             )
             self.timer.start(100)
+        self.setDarkMode(self.pref.get("darkmode", False))
 
     def discover_device(self) -> str:
         """
@@ -131,7 +145,7 @@ class MainWindow(QMainWindow):
 
         devices = None
         data = None
-        app.processEvents()
+        # app.processEvents()
         try:
             devices = os.listdir("/dev/serial/by-id")
         except FileNotFoundError:
@@ -154,29 +168,28 @@ class MainWindow(QMainWindow):
         Setup the device returned by discover_device()
         Or display message saying we didn't find one.
         """
-        while True:
-            device = self.discover_device()
-            if device:
-                try:
-                    self.pico = serial.Serial("/dev/serial/by-id/" + device, 115200)
-                    self.pico.timeout = 100
-                    self.lcdNumber.setStyleSheet("QLCDNumber { color: white; }")
-                    break
-                except OSError:
-                    if self.message_shown is False:
-                        self.message_shown = True
-                        self.show_message_box(
-                            "Unable to locate or open the VFO knob serial device."
-                        )
-                    self.lcdNumber.setStyleSheet("QLCDNumber { color: red; }")
-            else:
+
+        device = self.discover_device()
+        if device:
+            try:
+                self.pico = serial.Serial("/dev/serial/by-id/" + device, 115200)
+                self.pico.timeout = 100
+                self.lcdNumber.setStyleSheet("QLCDNumber { color: white; }")
+            except OSError:
                 if self.message_shown is False:
                     self.message_shown = True
                     self.show_message_box(
                         "Unable to locate or open the VFO knob serial device."
                     )
                 self.lcdNumber.setStyleSheet("QLCDNumber { color: red; }")
-            app.processEvents()
+        else:
+            if self.message_shown is False:
+                self.message_shown = True
+                self.show_message_box(
+                    "Unable to locate or open the VFO knob serial device."
+                )
+            self.lcdNumber.setStyleSheet("QLCDNumber { color: red; }")
+        # app.processEvents()
 
     def watch_udp(self) -> None:
         """
@@ -200,8 +213,7 @@ class MainWindow(QMainWindow):
             if json_data.get("station", "") != platform.node():
                 continue
             logger.debug(f"{json_data=}")
-            if json_data.get("cmd", "") == "HALT":
-                self.quit_app()
+
             if json_data.get("cmd", "") == "TUNE":
                 # b'{"cmd": "TUNE", "freq": 7.0235, "spot": "MM0DGI"}'
                 vfo = json_data.get("freq")
@@ -214,6 +226,9 @@ class MainWindow(QMainWindow):
                     logger.critical("Unable to write to serial device.")
                 except AttributeError:
                     logger.critical("Unable to write to serial device.")
+                continue
+            if json_data.get("cmd", "") == "DARKMODE":
+                self.setDarkMode(json_data.get("state", False))
 
     def showNumber(self, the_number) -> None:
         """Display vfo value with dots"""
@@ -221,7 +236,7 @@ class MainWindow(QMainWindow):
         if len(dvfo) > 6:
             dnum = f"{dvfo[:len(dvfo)-6]}.{dvfo[-6:-3]}.{dvfo[-3:]}"
             self.lcdNumber.display(dnum)
-            app.processEvents()
+            # app.processEvents()
 
     def poll_radio(self) -> None:
         """
@@ -244,7 +259,7 @@ class MainWindow(QMainWindow):
                     logger.debug(f"{vfo}")
                     self.showNumber(vfo)
                     # self.lcdNumber.display(dnum)
-                    app.processEvents()
+                    # app.processEvents()
                     cmd = f"F {vfo}\r"
                     try:
                         if self.pico:
@@ -271,56 +286,21 @@ class MainWindow(QMainWindow):
                             self.rig_control.set_vfo(result)
                             self.showNumber(result)
                             # self.lcdNumber.display(result)
-                            app.processEvents()
+                            # app.processEvents()
         except OSError:
             logger.critical("Unable to write to serial device.")
         except AttributeError:
             logger.critical("Unable to write to serial device.")
-        app.processEvents()
+        # app.processEvents()
 
     def show_message_box(self, message: str) -> None:
         """
         Display an alert box with the supplied message.
         """
         message_box = QtWidgets.QMessageBox()
+        message_box.setPalette(self.current_palette)
         message_box.setIcon(QtWidgets.QMessageBox.Information)
         message_box.setText(message)
         message_box.setWindowTitle("Information")
         message_box.setStandardButtons(QtWidgets.QMessageBox.Ok)
         _ = message_box.exec_()
-
-
-def main():
-    """main entry"""
-    window.show()
-    window.setup_serial()
-    app.processEvents()
-    timer = QtCore.QTimer()
-    timer.timeout.connect(window.poll_radio)
-    timer.start(250)
-    sys.exit(app.exec())
-
-
-logger = logging.getLogger("__main__")
-handler = logging.StreamHandler()
-formatter = logging.Formatter(
-    datefmt="%H:%M:%S",
-    fmt="[%(asctime)s] %(levelname)s %(module)s - %(funcName)s Line %(lineno)d:\n%(message)s",
-)
-handler.setFormatter(formatter)
-logger.addHandler(handler)
-
-if Path("./debug").exists():
-    logger.setLevel(logging.DEBUG)
-    logger.debug("debugging on")
-else:
-    logger.setLevel(logging.WARNING)
-    logger.warning("debugging off")
-
-app = QApplication(sys.argv)
-app.setStyle("Adwaita-Dark")
-window = MainWindow()
-
-
-if __name__ == "__main__":
-    main()

{not1mm-24.3.16.dist-info → not1mm-24.3.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: not1mm
-Version: 24.3.16
+Version: 24.3.24
 Summary: NOT1MM Logger
 Author-email: Michael Bridak <michael.bridak@gmail.com>
 Project-URL: Homepage, https://github.com/mbridak/not1mm
@@ -27,6 +27,7 @@ Requires-Dist: soundfile
 Requires-Dist: numpy
 Requires-Dist: notctyparser >=23.6.21
 Requires-Dist: rapidfuzz
+Requires-Dist: appdata
 
 # Not1MM
 
@@ -47,19 +48,16 @@ The worlds #1 unfinished contest logger <sup>*According to my daughter Corinna.<
   - [Our Code Contributors ✨](#our-code-contributors-)
   - [List of should be working contests](#list-of-should-be-working-contests)
   - [Recent Changes](#recent-changes)
-  - [Installing from PyPi](#installing-from-pypi)
-    - [Python and pip](#python-and-pip)
-    - [Installing with pip](#installing-with-pip)
-      - [Ubuntu 22.04 LTS](#ubuntu-2204-lts)
-      - [Ubuntu 23.04](#ubuntu-2304)
-      - [Fedora 38 \& 39](#fedora-38--39)
+  - [Installation](#installation)
+    - [Python, PyPI, pip and pipx](#python-pypi-pip-and-pipx)
+    - [Bootstrapping pipx](#bootstrapping-pipx)
+    - [Installing with pipx](#installing-with-pipx)
+    - [Installing portaudio](#installing-portaudio)
+  - [After install](#after-install)
     - [You may or may not get a warning message like](#you-may-or-may-not-get-a-warning-message-like)
     - [Or this fan favorite](#or-this-fan-favorite)
-    - [Updating with pip/pipx](#updating-with-pippipx)
-  - [Other Libraries](#other-libraries)
-    - [Dark mode on Ubuntu](#dark-mode-on-ubuntu)
   - [Wayland Compositor](#wayland-compositor)
-  - [Running from source](#running-from-source)
+    - [Running from source](#running-from-source)
   - [Various data file locations](#various-data-file-locations)
     - [Data](#data)
     - [Config](#config)
@@ -70,13 +68,14 @@ The worlds #1 unfinished contest logger <sup>*According to my daughter Corinna.<
     - [Revisiting an old friend](#revisiting-an-old-friend)
   - [Station Settings dialog (REQUIRED)](#station-settings-dialog-required)
     - [Changing station information](#changing-station-information)
-  - [Adding a contest to the current dababase (REQUIRED)](#adding-a-contest-to-the-current-dababase-required)
-  - [Selecting an existing contest as the current contest](#selecting-an-existing-contest-as-the-current-contest)
-  - [Editing existing contest parameters](#editing-existing-contest-parameters)
+  - [Selecting a contest (REQUIRED)](#selecting-a-contest-required)
+    - [Selecting a new contest](#selecting-a-new-contest)
+    - [Selecting an existing contest as the current contest](#selecting-an-existing-contest-as-the-current-contest)
+    - [Editing existing contest parameters](#editing-existing-contest-parameters)
   - [Configuration Settings](#configuration-settings)
     - [Lookup](#lookup)
     - [Soundcard](#soundcard)
-    - [CAT](#cat)
+    - [CAT Control](#cat-control)
     - [CW Keyer interface](#cw-keyer-interface)
     - [Cluster](#cluster)
     - [N1MM Packets](#n1mm-packets)
@@ -89,7 +88,7 @@ The worlds #1 unfinished contest logger <sup>*According to my daughter Corinna.<
   - [Other uses for the call field](#other-uses-for-the-call-field)
   - [Windows](#windows)
     - [The Main Window](#the-main-window)
-      - [Keyboard commands](#keyboard-commands)
+    - [Keyboard commands](#keyboard-commands)
     - [Log Display](#log-display)
       - [Editing a contact](#editing-a-contact)
   - [Recalulate Mults](#recalulate-mults)
@@ -168,6 +167,10 @@ I wish to thank those who've contributed to the project.
 
 ## Recent Changes
 
+- [24-3-24] Reworked fsutil.py to correct directory paths for Linux.
+- [24-3-23] Yanked version 24-3-21, too many bugs for existing userbase.
+- [24-3-21] Merged PR from @kyleboyle for docking windows. MacOS and Windows support.
+- [24-3-19] Removed some useless bloat causing slow interface on FreeBSD 13/14 and maybe others.
 - [24-3-16] Add Save/Fail confirmation dialogs when saving ADIF of Cabrillo files.
 - [24-3-15] Change 'CWR' to 'CW' in the ADIF output.
 - [24-3-13] Added CQ 160 CW and SSB
@@ -178,43 +181,64 @@ I wish to thank those who've contributed to the project.
 
 See [CHANGELOG.md](CHANGELOG.md) for prior changes.
 
-## Installing from PyPi
+## Installation
 
-### Python and pip
+### Python, PyPI, pip and pipx
 
-This software is a Python package hosted on PyPi, and installable with the pip or pipx command. If this is your first exposure to pip you can get all the details from [The PyPA](https://packaging.python.org/en/latest/tutorials/installing-packages/). In short, most linux distros come with Python pre installed. If pip is not installed by default, you can usually load it through your package manager. For example `sudo apt install python3-pip` or `sudo dnf install python3-pip`.
+This software is a Python package hosted on PyPI, and installable with the pip or pipx command. If this is your first exposure to Python packaging you can get all the details from:
 
-### Installing with pip
+- [The PyPA](https://packaging.python.org/en/latest/tutorials/installing-packages/)
+- [Install packages in a virtual environment using pip and venv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
+- [Installing stand alone command line tools](https://packaging.python.org/en/latest/guides/installing-stand-alone-command-line-tools/)
 
-I've included what installation steps I took to install on fresh images of Ubuntu and Fedora below. YMMV.
+In short, You should install stuff into a Python virtual environment. Newer Linux distros will make you do this unless you include a command line argument akin to '--break-my-system' when using pip. I'm not telling you to use pipx. But... **Use pipx**.
 
-#### Ubuntu 22.04 LTS
+### Bootstrapping pipx
+
+Assuming you have only Python installed, your path to pipx is:
 
 ```bash
-sudo apt update
-sudo apt upgrade
-sudo apt install -y libportaudio2 python3-pip python3-pyqt5 python3-numpy adwaita-qt
-pip install -U not1mm
+# First get pip installed. Either with apt or dnf, or the ensurepip command.
+python3 -m ensurepip
+
+# Update the pip that was just installed.
+python3 -m pip install --upgrade pip
+
+# Install pipx
+python3 -m pip install --user pipx
+python3 -m pipx ensurepath
 ```
 
-#### Ubuntu 23.04
+### Installing with pipx
+
+Then installing not1mm is as simple as:
 
 ```bash
-sudo apt update
-sudo apt upgrade
-sudo apt install -y libportaudio2 adwaita-qt pipx
+# Install not1mm
 pipx install not1mm
-pipx ensurepath
 ```
 
-#### Fedora 38 & 39
+If you need to later update not1mm, you can do so with:
+
+```bash
+# Update not1mm
+pipx upgrade not1mm
+```
+
+### Installing portaudio
+
+not1mm uses portaudio to play audio. You can install it with:
 
 ```bash
-sudo dnf upgrade --refresh
+# Ubuntu
+sudo apt install -y libportaudio2
+
+# Fedora
 sudo dnf install python3-pip portaudio
-pip install not1mm
 ```
 
+## After install
+
 You can now open a new terminal and type `not1mm`. On it's first run, it may or may not install a lovely non AI generated
 icon, which you can later click on to launch the application.
 
@@ -241,27 +265,13 @@ To avoid this you can export an environment variable and launch the app like thi
 
 For a more permanent solution you can place the line `export QT_QPA_PLATFORM=wayland` in your home directories .bashrc file. Then after logging out and back in you should be able to launch it normally.
 
-### Updating with pip/pipx
-
-I've been posting updates just about everyday. Sometimes multiple times a day. It's early days, so there is much to do. You can check for and install updates with `pip install -U not1mm` or if installed with pipx `pipx upgrade not1mm`.
-
-## Other Libraries
-
-The audio library used, uses pipewire/portaudio. You may need to install portaudio. Ubuntu: `sudo apt install libportaudio2`
-
-### Dark mode on Ubuntu
-
-I believe I figured out dark mode in Ubuntu and have it working on my shack PC that runs Ubuntu 22.04. The secret sauce seems to be installing adwaita-qt with apt, and setting an environment variable `QT_STYLE_OVERRIDE` to `Adwaita-Dark`. I set the environment variable in the start of the program if running on a Gnome platform. So you don't need to do that part.
-
-Or see this discussion [darkmode](https://github.com/mbridak/not1mm/discussions/60).
-
 ## Wayland Compositor
 
 One side effect of Wayland is that we are not able to request for a window to regain or retain focus. So if you were to click on a spot in the bandmap window to tune to that spot, you would have to then click on the main window to continue entering contest data. I'm aware of this, but I can not change it.
 
-## Running from source
+### Running from source
 
-Since this is packaged for PyPi, if you want to work on your own source branch, after cloning from github you would:
+Since this is packaged for PyPI, if you want to work on your own source branch, after cloning from github you would:
 
 ```bash
 pip install --upgrade pip
@@ -330,19 +340,21 @@ You can fill. You can fill. Everyone look at your keys.
 
 Station information can be changed any time by going to `File` > `Station Settings` and editing the information.
 
-## Adding a contest to the current dababase (REQUIRED)
+## Selecting a contest (REQUIRED)
+
+### Selecting a new contest
 
 Select `File` > `New Contest`
 
 ![New Contest Dialog](https://github.com/mbridak/not1mm/raw/master/pic/new_contest.png)
 
-## Selecting an existing contest as the current contest
+### Selecting an existing contest as the current contest
 
 Select `File` > `Open Contest`
 
 ![Open an existing contest](https://github.com/mbridak/not1mm/raw/master/pic/select_contest.png)
 
-## Editing existing contest parameters
+### Editing existing contest parameters
 
 You can edit the parameters of a previously defined contest by selecting it as the current contest. Then select `File` > `Edit Current Contest`. Click `OK` to save the new values and reload the contest. `Cancel` to keep the existing parameters.
 
@@ -362,7 +374,7 @@ For callsign lookup, Two services are supported. QRZ and HamQTH. They require a
 
 Choose the sound output device for the voice keyer.
 
-### CAT
+### CAT Control
 
 Under the `CAT` TAB, you can choose either `rigctld` normally with an IP of `127.0.0.1` and a port of `4532`. Or `flrig`, IP normally of `127.0.0.1` and a port of `12345`. `None` is always an option, but is it really? There's an onscreen icon for CAT status. Green good, Red bad, Grey neither.
 
@@ -445,7 +457,7 @@ After this, a request is made to QRZ for the gridsquare of the callsign. If ther
 
 ![Main screen with callouts](https://github.com/mbridak/not1mm/raw/master/pic/mainwithcallouts.png)
 
-#### Keyboard commands
+### Keyboard commands
 
 | Key | Result |
 | -------------- | --- |