not1mm 24.12.3.1__tar.gz → 24.12.5.1__tar.gz

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: not1mm
-Version: 24.12.3.1
+Version: 24.12.5.1
 Summary: NOT1MM Logger
 Author-email: Michael Bridak <michael.bridak@gmail.com>
 Project-URL: Homepage, https://github.com/mbridak/not1mm
@@ -238,6 +238,9 @@ generated, 'cause I'm lazy, list of those who've submitted PR's.
 
 ## Recent Changes (Polishing the Turd)
 
+-[24-12-5-1] ARRL 160 gets rtc.
+- [24-12-5] Add 'real time' score posting to external sites.
+- [24-12-4] Merged PR from @alduhoo Add STATION_CALLSIGN field to ADIF output
 - [24-12-3-1] Adding ARRL 160
 - [24-12-3] Add button to bandmap to delete marked spots.
 
@@ -532,7 +535,7 @@ You can fill. You can fill. Everyone look at your keys.
 
 ### Changing station information
 
-Station information can be changed any time by going toawandahl
+Station information can be changed any time by going to
 `File` > `Station Settings` and editing the information.
 
 ## Selecting a contest (It's REQUIRED Russ)
@@ -585,10 +588,7 @@ onscreen icon for CAT status. Green good, Red bad, Grey neither.
 
 Under the `CW` TAB, There are three options. `cwdaemon`, which normally uses IP
 `127.0.0.1`port `6789`. `pywinkeyer` which normally uses IP `127.0.0.1` port `8000` and
-`CAT` which if your radio supports it, sends Morse characters via rigctld. As far
-as I can tell rigctld does not support setting the radios internal keyer speed. So
-the CW speed control widget will not be functional and you'd need to control the
-keyer speed thru the radios interface.
+`CAT` which if your radio supports it, sends Morse characters via rigctld.
 
 ### Cluster
 
@@ -616,27 +616,22 @@ appear. Those without will not.
 
 ### Options
 
-On the Options TAB you can select to use Enter Sends Message (ESM), configure its function keys.
-Select whether or not to use Call History info.
+On the Options TAB you can:
 
-![Bands Options Screen](https://github.com/mbridak/not1mm/blob/master/pic/configuration_options.png?raw=true)
+- Select to use Enter Sends Message (ESM), and configure it's function keys.
+- Select whether or not to use Call History info.
+- Select whether or not to send XML score info to online scoreboards.
 
-## Logging WSJT-X FT8/FT4/ETC and FLDIGI RTTY contacts
-
-**Digital modes only working for:**
+![Options Screen](https://github.com/mbridak/not1mm/blob/master/pic/configuration_options.png?raw=true)
 
-- ARRL Field Day
-- ARRL VHF
-- Weekly RTTY
-- CQ WW DX RTTY
-- CQ WPX RTTY
+## Logging WSJT-X FT8/FT4/ETC and FLDIGI RTTY contacts
 
 not1mm listens for WSJT-X UDP traffic on the Multicast address 224.0.0.1:2237.
 No setup is needed to be done on not1mm's side. That's good because I'm lazy.
 
 not1mm polls for fldigi QSOs via it's XMLRPC interface. It does this in a rather stupid
 way. It just keeps asking what was the last QSO and compares it to the previous response.
-If it's different, it's new. I've added the Weekly RTTY Test so this can be tested.
+If it's different, it's new.
 
 The F1-F12 function keys be sent to fldigi via XMLRPC. Fldigi will be placed into TX
 mode, the message will be sent and a ^r will be tacked onto the end to place it back into
@@ -649,18 +644,20 @@ Generic Contest. Make sure the Text Capture Order field says CALL EXCHANGE.
 ## Sending CW
 
 Other than sending CW by hand, you can also send predefined CW text messages by
-pressing F1 - F12. See next section on Editing macro keys. If you need to send
-something freeform, you can press CTRL-SHIFT-K, this will expose an entry field
-at the bottom of the window which you can type directly into. When you're done
-you can either press CTRL-SHIFT-K again, or press the Enter Key to close the
-field.
+pressing F1 - F12. See next section on Editing macro keys. 
+
+If you need to send something freeform, you can press `CTRL-SHIFT-K`, this will
+expose an entry field at the bottom of the window which you can type directly into.
+When you're done you can either press CTRL-SHIFT-K again, or press the Enter Key to
+close the field.
 
 ## Editing macro keys
 
 To edit the macros, choose `File` > `Edit Macros`. This will open your systems
 registered text editor with current macros loaded. When your done just save the
 file and close the editor. The file loaded to edit, CW, SSB or RTTY, will be
-determined by your current operating mode.
+determined by your current operating mode and contest. Each contest gets it's own
+copy of the macros.
 
 After editing and saving the macro file. You can force the logger to reload the
 macro file by toggeling between `Run` and `S&P` states.

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/README.md

@@ -207,6 +207,9 @@ generated, 'cause I'm lazy, list of those who've submitted PR's.
 
 ## Recent Changes (Polishing the Turd)
 
+-[24-12-5-1] ARRL 160 gets rtc.
+- [24-12-5] Add 'real time' score posting to external sites.
+- [24-12-4] Merged PR from @alduhoo Add STATION_CALLSIGN field to ADIF output
 - [24-12-3-1] Adding ARRL 160
 - [24-12-3] Add button to bandmap to delete marked spots.
 
@@ -501,7 +504,7 @@ You can fill. You can fill. Everyone look at your keys.
 
 ### Changing station information
 
-Station information can be changed any time by going toawandahl
+Station information can be changed any time by going to
 `File` > `Station Settings` and editing the information.
 
 ## Selecting a contest (It's REQUIRED Russ)
@@ -554,10 +557,7 @@ onscreen icon for CAT status. Green good, Red bad, Grey neither.
 
 Under the `CW` TAB, There are three options. `cwdaemon`, which normally uses IP
 `127.0.0.1`port `6789`. `pywinkeyer` which normally uses IP `127.0.0.1` port `8000` and
-`CAT` which if your radio supports it, sends Morse characters via rigctld. As far
-as I can tell rigctld does not support setting the radios internal keyer speed. So
-the CW speed control widget will not be functional and you'd need to control the
-keyer speed thru the radios interface.
+`CAT` which if your radio supports it, sends Morse characters via rigctld.
 
 ### Cluster
 
@@ -585,27 +585,22 @@ appear. Those without will not.
 
 ### Options
 
-On the Options TAB you can select to use Enter Sends Message (ESM), configure its function keys.
-Select whether or not to use Call History info.
+On the Options TAB you can:
 
-![Bands Options Screen](https://github.com/mbridak/not1mm/blob/master/pic/configuration_options.png?raw=true)
+- Select to use Enter Sends Message (ESM), and configure it's function keys.
+- Select whether or not to use Call History info.
+- Select whether or not to send XML score info to online scoreboards.
 
-## Logging WSJT-X FT8/FT4/ETC and FLDIGI RTTY contacts
-
-**Digital modes only working for:**
+![Options Screen](https://github.com/mbridak/not1mm/blob/master/pic/configuration_options.png?raw=true)
 
-- ARRL Field Day
-- ARRL VHF
-- Weekly RTTY
-- CQ WW DX RTTY
-- CQ WPX RTTY
+## Logging WSJT-X FT8/FT4/ETC and FLDIGI RTTY contacts
 
 not1mm listens for WSJT-X UDP traffic on the Multicast address 224.0.0.1:2237.
 No setup is needed to be done on not1mm's side. That's good because I'm lazy.
 
 not1mm polls for fldigi QSOs via it's XMLRPC interface. It does this in a rather stupid
 way. It just keeps asking what was the last QSO and compares it to the previous response.
-If it's different, it's new. I've added the Weekly RTTY Test so this can be tested.
+If it's different, it's new.
 
 The F1-F12 function keys be sent to fldigi via XMLRPC. Fldigi will be placed into TX
 mode, the message will be sent and a ^r will be tacked onto the end to place it back into
@@ -618,18 +613,20 @@ Generic Contest. Make sure the Text Capture Order field says CALL EXCHANGE.
 ## Sending CW
 
 Other than sending CW by hand, you can also send predefined CW text messages by
-pressing F1 - F12. See next section on Editing macro keys. If you need to send
-something freeform, you can press CTRL-SHIFT-K, this will expose an entry field
-at the bottom of the window which you can type directly into. When you're done
-you can either press CTRL-SHIFT-K again, or press the Enter Key to close the
-field.
+pressing F1 - F12. See next section on Editing macro keys. 
+
+If you need to send something freeform, you can press `CTRL-SHIFT-K`, this will
+expose an entry field at the bottom of the window which you can type directly into.
+When you're done you can either press CTRL-SHIFT-K again, or press the Enter Key to
+close the field.
 
 ## Editing macro keys
 
 To edit the macros, choose `File` > `Edit Macros`. This will open your systems
 registered text editor with current macros loaded. When your done just save the
 file and close the editor. The file loaded to edit, CW, SSB or RTTY, will be
-determined by your current operating mode.
+determined by your current operating mode and contest. Each contest gets it's own
+copy of the macros.
 
 After editing and saving the macro file. You can force the logger to reload the
 macro file by toggeling between `Run` and `S&P` states.

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/not1mm/__main__.py

@@ -77,6 +77,7 @@ from not1mm.vfo import VfoWindow
 from not1mm.radio import Radio
 from not1mm.voice_keying import Voice
 from not1mm.lookupservice import LookupService
+from not1mm.rtc_service import RTCService
 
 poll_time = datetime.datetime.now()
 
@@ -102,6 +103,11 @@ class MainWindow(QtWidgets.QMainWindow):
         "multicast_group": "239.1.1.1",
         "multicast_port": 2239,
         "interface_ip": "0.0.0.0",
+        "send_rtc_scores": False,
+        "rtc_url": "",
+        "rtc_user": "",
+        "rtc_pass": "",
+        "rtc_interval": 2,
         "send_n1mm_packets": False,
         "n1mm_station_name": "20M CW Tent",
         "n1mm_operator": "Bernie",
@@ -156,7 +162,6 @@ class MainWindow(QtWidgets.QMainWindow):
     opon_dialog = None
     dbname = fsutils.USER_DATA_PATH, "/ham.db"
     radio_state = {}
-    rig_control = None
     worked_list = {}
     cw_entry_visible = False
     last_focus = None
@@ -170,6 +175,7 @@ class MainWindow(QtWidgets.QMainWindow):
     radio_thread = QThread()
     voice_thread = QThread()
     fldigi_thread = QThread()
+    rtc_thread = QThread()
 
     fldigi_watcher = None
     rig_control = None
@@ -179,6 +185,7 @@ class MainWindow(QtWidgets.QMainWindow):
     vfo_window = None
     lookup_service = None
     fldigi_util = None
+    rtc_service = None
 
     current_widget = None
 
@@ -604,7 +611,7 @@ class MainWindow(QtWidgets.QMainWindow):
         logger.debug(f"{QT_VERSION_STR=} {PYQT_VERSION_STR=}")
         x = PYQT_VERSION_STR.split(".")
         old_Qt = True
-        # test if pyqt version is at least 6.7.1
+        # test if pyqt version is at least 6.8
         if len(x) == 1:
             if int(x[0]) > 6:
                 old_Qt = False
@@ -612,7 +619,7 @@ class MainWindow(QtWidgets.QMainWindow):
             if int(x[0]) >= 6 and int(x[1]) >= 8:
                 old_Qt = False
 
-        # Featureset for wayland if pyqt is older that 6.7.1
+        # Featureset for wayland if pyqt is older that 6.8
         dockfeatures = (
             QtWidgets.QDockWidget.DockWidgetFeature.DockWidgetClosable
             | QtWidgets.QDockWidget.DockWidgetFeature.DockWidgetMovable
@@ -712,7 +719,7 @@ class MainWindow(QtWidgets.QMainWindow):
                 )
 
     def load_call_history(self) -> None:
-        """"""
+        """Display filepicker and load chosen call history file."""
         filename = self.filepicker("other")
         if filename:
             self.database.create_callhistory_table()
@@ -755,13 +762,13 @@ class MainWindow(QtWidgets.QMainWindow):
                 self.show_message_box(f"{err}")
 
     def on_focus_changed(self, new):
-        """"""
+        """Called when text entry focus has changed."""
         if self.use_esm:
             if hasattr(self.contest, "process_esm"):
                 self.contest.process_esm(self, new_focused_widget=new)
 
     def make_button_green(self, the_button: QtWidgets.QPushButton) -> None:
-        """Turn the_button green."""
+        """Takes supplied QPushButton object and turns it green."""
         if the_button is not None:
             pal = QPalette()
             pal.isCopyOf(self.current_palette)
@@ -1599,6 +1606,7 @@ class MainWindow(QtWidgets.QMainWindow):
                             self.set_window_title()
                             if self.rig_control:
                                 self.rig_control.set_mode(self.radio_state.get("mode"))
+                        self.update_rtc_xml()
                 except ModuleNotFoundError:
                     self.pref["contest"] = 1
                     self.show_message_box("Contest plugin not found")
@@ -2457,7 +2465,7 @@ class MainWindow(QtWidgets.QMainWindow):
         self.worked_list = self.database.get_calls_and_bands()
         self.send_worked_list()
         self.clearinputs()
-
+        self.update_rtc_xml()
         cmd = {}
         cmd["cmd"] = "UPDATELOG"
         if self.log_window:
@@ -2465,6 +2473,17 @@ class MainWindow(QtWidgets.QMainWindow):
         if self.check_window:
             self.check_window.msg_from_main(cmd)
 
+    def update_rtc_xml(self):
+        """Update RTC XML"""
+        print("update the xml")
+        if self.pref.get("send_rtc_scores", False):
+            if self.contest is None:
+                return
+            if hasattr(self.contest, "online_score_xml"):
+                if self.rtc_service is not None:
+                    self.rtc_service.xml = self.contest.online_score_xml(self)
+                    print(f"{self.rtc_service.xml=}")
+
     def new_contest_dialog(self) -> None:
         """
         Show new contest dialog.
@@ -2898,6 +2917,31 @@ class MainWindow(QtWidgets.QMainWindow):
             self.setDarkMode(False)
             self.actionDark_Mode_2.setChecked(False)
 
+        try:
+            if self.rtc_thread.isRunning():
+                self.rtc_service.time_to_quit = True
+                self.rtc_thread.quit()
+                self.rtc_thread.wait(1000)
+
+        except (RuntimeError, AttributeError):
+            ...
+
+        self.rtc_service = None
+
+        self.send_rtc_scores = self.pref.get("send_rtc_scores", False)
+        self.rtc_url = self.pref.get("rtc_url", "")
+        self.rtc_user = self.pref.get("rtc_user", "")
+        self.rtc_pass = self.pref.get("rtc_pass", "")
+        self.rtc_interval = self.pref.get("rtc_interval", 2)
+
+        if self.pref.get("send_rtc_scores", False):
+            self.rtc_service = RTCService()
+            self.rtc_service.moveToThread(self.rtc_thread)
+            self.rtc_thread.started.connect(self.rtc_service.run)
+            self.rtc_thread.finished.connect(self.rtc_service.deleteLater)
+            # self.rtc_service.poll_callback.connect(self.rtc_result)
+            self.rtc_thread.start()
+
         try:
             if self.radio_thread.isRunning():
                 self.rig_control.time_to_quit = True
@@ -3046,6 +3090,8 @@ class MainWindow(QtWidgets.QMainWindow):
         self.esm_dict["MYCALL"] = fkey_dict.get(self.pref.get("esm_mycall", "DISABLED"))
         self.esm_dict["QSOB4"] = fkey_dict.get(self.pref.get("esm_qsob4", "DISABLED"))
 
+        self.update_rtc_xml()
+
     def dark_mode_state_changed(self) -> None:
         """Called when the Dark Mode menu state is changed."""
         self.pref["darkmode"] = self.actionDark_Mode_2.isChecked()

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/not1mm/data/configuration.ui

@@ -2173,6 +2173,76 @@
             </property>
            </widget>
           </item>
+          <item>
+           <widget class="Line" name="line">
+            <property name="orientation">
+             <enum>Qt::Horizontal</enum>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QCheckBox" name="send_rtc_scores">
+            <property name="text">
+             <string>Use RTC score reporting</string>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QComboBox" name="rtc_url">
+            <item>
+             <property name="text">
+              <string>https://hamscore.com/postxml/</string>
+             </property>
+            </item>
+            <item>
+             <property name="text">
+              <string>https://contestonlinescore.com/post/</string>
+             </property>
+            </item>
+            <item>
+             <property name="text">
+              <string>http://contest.run</string>
+             </property>
+            </item>
+           </widget>
+          </item>
+          <item>
+           <widget class="QLineEdit" name="rtc_user">
+            <property name="placeholderText">
+             <string>username</string>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QLineEdit" name="rtc_pass">
+            <property name="echoMode">
+             <enum>QLineEdit::EchoMode::Password</enum>
+            </property>
+            <property name="placeholderText">
+             <string>password</string>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QLabel" name="label_28">
+            <property name="text">
+             <string>Score posting interval (minutes)</string>
+            </property>
+            <property name="alignment">
+             <set>Qt::AlignCenter</set>
+            </property>
+           </widget>
+          </item>
+          <item>
+           <widget class="QLineEdit" name="rtc_interval">
+            <property name="text">
+             <string>2</string>
+            </property>
+            <property name="alignment">
+             <set>Qt::AlignCenter</set>
+            </property>
+           </widget>
+          </item>
           <item>
            <spacer name="verticalSpacer_8">
             <property name="orientation">

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/not1mm/lib/plugin_common.py

@@ -4,6 +4,58 @@ import datetime
 from decimal import Decimal
 from pathlib import Path
 from not1mm.lib.ham_utility import get_adif_band
+from not1mm.lib.version import __version__
+
+
+def online_score_xml(self):
+    """generate online xml"""
+
+    mults = self.contest.get_mults(self)
+    the_mults = ""
+    for thing in mults:
+        the_mults += (
+            f'<mult band="total" mode="ALL" type="{thing}">{mults.get(thing,0)}</mult>'
+        )
+
+    the_points = self.contest.just_points(self)
+
+    the_date_time = datetime.datetime.now(datetime.timezone.utc).isoformat(" ")[:19]
+    assisted = self.contest_settings.get("AssistedCategory", "")
+    bands = self.contest_settings.get("BandCategory", "")
+    modes = self.contest_settings.get("ModeCategory", "")
+    xmiter = self.contest_settings.get("TransmitterCategory", "")
+    ops = self.contest_settings.get("OperatorCategory", "")
+    overlay = self.contest_settings.get("OverlayCategory", "")
+    power = self.contest_settings.get("PowerCategory", "")
+
+    the_xml = (
+        '<?xml version="1.0"?>'
+        "<dynamicresults>"
+        f"<contest>{self.contest.cabrillo_name}</contest>"
+        f'<call>{self.station.get("Call", "")}</call>'
+        # <ops>NR9Q</ops>
+        f'<class power="{power}" assisted = "{assisted}" transmitter="{xmiter}" ops="{ops}" bands="{bands}" mode="{modes}" overlay="{overlay}"></class>'
+        f"<club>{self.station.get('Club', '').upper()}</club>"
+        "<soft>Not1MM</soft>"
+        f"<version>{__version__}</version>"
+        "<qth>"
+        # <dxcccountry>K</dxcccountry>
+        f"<cqzone>{self.station.get('CQZone','')}</cqzone>"
+        f"<iaruzone>{self.station.get('IARUZone','')}</iaruzone>"
+        f"<arrlsection>{self.station.get('ARRLSection', '')}</arrlsection>"
+        f"<stprvoth>{self.station.get('State','')}</stprvoth>"
+        f"<grid6>{self.station.get('GridSquare','')}</grid6>"
+        "</qth>"
+        "<breakdown>"
+        f'<qso band="total" mode="ALL">{self.contest.show_qso(self)}</qso>'
+        f"{the_mults}"
+        f'<point band="total" mode="ALL">{the_points}</point>'
+        "</breakdown>"
+        f"<score>{self.contest.calc_score(self)}</score>"
+        f"<timestamp>{the_date_time}</timestamp>"
+        "</dynamicresults>"
+    )
+    return the_xml
 
 
 def get_points(self):
@@ -21,10 +73,9 @@ def gen_adif(self, cabrillo_name: str, contest_id=""):
     """
     now = datetime.datetime.now()
     date_time = now.strftime("%Y-%m-%d_%H-%M-%S")
+    station_callsign = self.station.get("Call", "").upper()
     filename = (
-        str(Path.home())
-        + "/"
-        + f"{self.station.get('Call', '').upper()}_{cabrillo_name}_{date_time}.adi"
+        str(Path.home()) + "/" + f"{station_callsign}_{cabrillo_name}_{date_time}.adi"
     )
     log = self.database.fetch_all_contacts_asc()
     try:
@@ -71,6 +122,15 @@ def gen_adif(self, cabrillo_name: str, contest_id=""):
                 except TypeError:
                     ...
 
+                try:
+                    print(
+                        f"<STATION_CALLSIGN:{len(station_callsign)}>{station_callsign}",
+                        end="\r\n",
+                        file=file_descriptor,
+                    )
+                except TypeError:
+                    ...
+
                 try:
                     print(
                         f"<CALL:{len(hiscall)}>{hiscall.upper()}",

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/not1mm/lib/settings.py

@@ -41,6 +41,19 @@ class Settings(QtWidgets.QDialog):
     def setup(self):
         """setup dialog"""
 
+        self.send_rtc_scores.setChecked(
+            bool(self.preference.get("send_rtc_scores", False))
+        )
+
+        value = self.preference.get("rtc_url", "")
+        index = self.rtc_url.findText(value)
+        if index != -1:
+            self.rtc_url.setCurrentIndex(index)
+
+        self.rtc_user.setText(str(self.preference.get("rtc_user", "")))
+        self.rtc_pass.setText(str(self.preference.get("rtc_pass", "")))
+        self.rtc_interval.setText(str(self.preference.get("rtc_interval", "2")))
+
         self.use_call_history.setChecked(
             bool(self.preference.get("use_call_history", False))
         )
@@ -195,6 +208,15 @@ class Settings(QtWidgets.QDialog):
         """
         Write preferences to json file.
         """
+        self.preference["send_rtc_scores"] = self.send_rtc_scores.isChecked()
+        self.preference["rtc_url"] = self.rtc_url.currentText()
+        self.preference["rtc_user"] = self.rtc_user.text()
+        self.preference["rtc_pass"] = self.rtc_pass.text()
+        try:
+            self.preference["rtc_interval"] = int(self.rtc_interval.text())
+        except ValueError:
+            self.preference["rtc_interval"] = 2
+
         self.preference["use_call_history"] = self.use_call_history.isChecked()
         self.preference["use_esm"] = self.use_esm.isChecked()
         self.preference["esm_cq"] = self.esm_cq.currentText()

not1mm-24.12.5.1/not1mm/lib/version.py

@@ -0,0 +1,3 @@
+"""It's the version"""
+
+__version__ = "24.12.5.1"

{not1mm-24.12.3.1 → not1mm-24.12.5.1}/not1mm/lookupservice.py

@@ -3,8 +3,8 @@
 not1mm Contest logger
 Email: michael.bridak@gmail.com
 GPL V3
-Class: BandMapWindow
-Purpose: Onscreen widget to show realtime spots from an AR cluster.
+Class: LookupService
+Purpose: Lookup callsigns with online services.
 """
 
 # pylint: disable=unused-import, c-extension-no-member, no-member, invalid-name, too-many-lines