hamtest

a game of the FCC/ARRL Question Pools

README.md

@@ -425,6 +425,7 @@ There is no direct support for MQTT in the code, however, reports from Discord a
 | `blackjack` | Plays Blackjack (Casino 21) | ✅ |
 | `dopewars` | Plays the classic drug trader game | ✅ |
 | `golfsim` | Plays a 9-hole Golf Simulator | ✅ |
+| `hamtest` | FCC/ARRL Quiz `hamtest general` or `hamtest extra` | ✅ |
 | `hangman` | Plays the classic word guess game | ✅ |
 | `joke` | Tells a joke | ✅ |
 | `lemonstand` | Plays the classic Lemonade Stand finance game | ✅ |

config.template

@@ -255,6 +255,7 @@ videopoker = True
 mastermind = True
 golfsim = True
 hangman = True
+hamtest = True
 
 [messagingSettings]
 # delay in seconds for response to avoid message collision

mesh_bot.py

@@ -15,7 +15,7 @@ from modules.log import *
 from modules.system import *
 
 # list of commands to remove from the default list for DM only
-restrictedCommands = ["blackjack", "videopoker", "dopewars", "lemonstand", "golfsim", "mastermind", "hangman"]
+restrictedCommands = ["blackjack", "videopoker", "dopewars", "lemonstand", "golfsim", "mastermind", "hangman", "hamtest"]
 restrictedResponse = "🤖only available in a Direct Message📵" # "" for none
 
 # Global Variables
@@ -57,6 +57,7 @@ def auto_response(message, snr, rssi, hop, pkiStatus, message_from_id, channel_n
     "games": lambda: gamesCmdList,
     "globalthermonuclearwar": lambda: handle_gTnW(),
     "golfsim": lambda: handleGolf(message, message_from_id, deviceID),
+    "hamtest": lambda: handleHamtest(message, message_from_id, deviceID),
     "hangman": lambda: handleHangman(message, message_from_id, deviceID),
     "hfcond": hf_band_conditions,
     "history": lambda: handle_history(message, message_from_id, deviceID, isDM),
@@ -687,6 +688,41 @@ def handleHangman(message, nodeID, deviceID):
     time.sleep(responseDelay + 1)
     return msg
 
+def handleHamtest(message, nodeID, deviceID):
+    global hamtestTracker
+    index = 0
+    msg = ''
+    response = message.split(' ')
+    for i in range(len(hamtestTracker)):
+        if hamtestTracker[i]['nodeID'] == nodeID:
+            hamtestTracker[i]["last_played"] = time.time()
+            index = i+1
+            break
+
+    if not index:
+        hamtestTracker.append({"nodeID": nodeID,"last_played": time.time()})
+
+    if "end" in response:
+        msg = hamtest.endGame(nodeID)
+    elif "score" in response:
+        msg = hamtest.getScore(nodeID)
+
+    if "hamtest" in response[0].lower():
+        if len(response) > 1:
+            if "gen" in response[1].lower():
+                msg = hamtest.newGame(nodeID, 'general')
+            elif "ex" in response[1].lower():
+                msg = hamtest.newGame(nodeID, 'extra')
+        else:
+            msg = hamtest.newGame(nodeID, 'technician')
+
+    # if the message is an answer A B C or D upper or lower case
+    if response[0].upper() in ['A', 'B', 'C', 'D']:
+        msg = hamtest.answer(nodeID, response[0])
+
+    time.sleep(responseDelay + 1)
+    return msg
+
 def handle_riverFlow(message, message_from_id, deviceID):
     location = get_node_location(message_from_id, deviceID)
     userRiver = message.lower()
@@ -1012,6 +1048,7 @@ def checkPlayingGame(message_from_id, message_string, rxNode, channel_number):
         (mindTracker, "MasterMind", handleMmind) if 'mindTracker' in globals() else None,
         (golfTracker, "GolfSim", handleGolf) if 'golfTracker' in globals() else None,
         (hangmanTracker, "Hangman", handleHangman) if 'hangmanTracker' in globals() else None,
+        (hamtestTracker, "HamTest", handleHamtest) if 'hamtestTracker' in globals() else None,
     ]
     trackers = [tracker for tracker in trackers if tracker is not None]
 

modules/games/hamtest.py

@@ -0,0 +1,142 @@
+# hamradio test module for meshbot DE K7MHI 2025
+# depends on the JSON question data files from https://github.com/russolsen/ham_radio_question_pool
+
+# data files which are expected to be in ../../data/hamradio/ similar to the following:
+# https://raw.githubusercontent.com/russolsen/ham_radio_question_pool/refs/heads/master/technician-2022-2026/technician.json
+# https://raw.githubusercontent.com/russolsen/ham_radio_question_pool/refs/heads/master/general-2023-2027/general.json
+# https://raw.githubusercontent.com/russolsen/ham_radio_question_pool/refs/heads/master/extra-2024-2028/extra.json
+
+import json
+import random
+import os
+from modules.log import *
+
+class HamTest:
+    def __init__(self):
+        self.questions = {}
+        self.load_questions()
+        self.game = {}
+
+    def load_questions(self):
+        for level in ['technician', 'general', 'extra']:
+            try:
+                with open(f'{os.path.dirname(__file__)}/../../data/hamradio/{level}.json') as f:
+                    self.questions[level] = json.load(f)
+            except FileNotFoundError:
+                logger.error(f"File not found: ../../data/hamradio/{level}.json")
+                self.questions[level] = []
+            except json.JSONDecodeError:
+                logger.error(f"Error decoding JSON from file: ../../data/hamradio/{level}.json")
+                self.questions[level] = []
+
+    def newGame(self, id, level='technician'):
+        msg = f"📻New {level} quiz started, 'end' to exit."
+        if id in self.game:
+            level = self.game[id]['level']
+        self.game[id] = {
+            'level': level,
+            'score': 0,
+            'total': 0,
+            'errors': [],
+            'qId': None,
+            'question': None,
+            'answers': None,
+            'correct': None
+        }
+        # set the pool needed for the game
+        if self.game[id]['level'] == 'extra':
+            self.game[id]['total'] = 50
+        else:
+            self.game[id]['total'] = 35
+
+        # randomize the questions
+        random.shuffle(self.questions[level])
+
+        msg += f"\n{self.nextQuestion(id)}"
+        return msg
+    
+    def nextQuestion(self, id):
+        level = self.game[id]['level']
+        # if question has the word figure in it, skip it
+        question = random.choice(self.questions[level])
+        while 'figure' in question['question'].lower():
+            question = random.choice(self.questions[level])
+
+        self.game[id]['question'] = question['question']
+        self.game[id]['answers'] = question['answers']
+        self.game[id]['correct'] = question['correct']
+        self.game[id]['qId'] = question['id']
+        self.game[id]['total'] -= 1
+
+        if self.game[id]['total'] == 0:
+            return self.endGame(id)
+
+        # ask the question and return answers in A, B, C, D format
+        msg = f"{self.game[id]['question']}\n"
+        for i, answer in enumerate(self.game[id]['answers']):
+            msg += f"{chr(65+i)}. {answer}\n"
+        return msg
+    
+    def answer(self, id, answer):
+        if id not in self.game:
+            return "No game in progress"
+        if self.game[id]['correct'] == ord(answer.upper()) - 65:
+            self.game[id]['score'] += 1
+            return f"Correct👍\n" + self.nextQuestion(id)
+        else:
+            # record the section of the question for study aid
+            section = self.game[id]['qId'][:3]
+            self.game[id]['errors'].append(section)
+            # provide the correct answer
+            answer = [self.game[id]['correct']]
+            return f"Wrong.⛔️ Correct is {chr(65+self.game[id]['correct'])}\n" + self.nextQuestion(id)
+        
+    def getScore(self, id):
+        if id not in self.game:
+            return "No game in progress"
+        score = self.game[id]['score']
+        total = self.game[id]['total']
+        level = self.game[id]['level']
+        if self.game[id]['errors']:
+            areaofstudy = max(set(self.game[id]['errors']), key = self.game[id]['errors'].count)
+        else:
+            areaofstudy = "None"
+
+        if level == 'extra':
+            pool = 50
+        else:
+            pool = 35
+        
+        return f"Score: {score}/{pool} Questions left: {total} Area of study: {areaofstudy}"
+    
+    def endGame(self, id):
+        if id not in self.game:
+            return "No game in progress"
+        
+        score = self.game[id]['score']
+        level = self.game[id]['level']
+
+        if level == 'extra':
+            # passing score for extra is 37
+            pool = 50
+        else:
+            # passing score for technician and general is 26
+            pool = 35
+
+        if score >= pool:
+            msg = f"Game over. Score: {score} 73! You passed the {level} exam."
+        else:
+            # find the most common section of the questions missed
+            if self.game[id]['errors']:
+                areaofstudy = max(set(self.game[id]['errors']), key = self.game[id]['errors'].count)
+            else:
+                areaofstudy = "None"
+            msg = f"Game over. Score: {score} 73! You did not pass the {level} exam. \nYou may want to study {areaofstudy}."
+        
+        # remove the game[id] from the list
+        del self.game[id]
+        return msg
+
+hamtestTracker = []
+hamtest = HamTest()
+   

modules/settings.py

@@ -332,6 +332,7 @@ try:
     mastermind_enabled = config['games'].getboolean('mastermind', True)
     golfSim_enabled = config['games'].getboolean('golfSim', True)
     hangman_enabled = config['games'].getboolean('hangman', True)
+    hamtest_enabled = config['games'].getboolean('hamtest', True)
 
     # messaging settings
     responseDelay = config['messagingSettings'].getfloat('responseDelay', 0.7) # default 0.7

modules/system.py

@@ -157,6 +157,11 @@ if hangman_enabled:
     trap_list = trap_list + ("hangman",)
     games_enabled = True
 
+if hamtest_enabled:
+    from modules.games.hamtest import * # from the spudgunman/meshing-around repo
+    trap_list = trap_list + ("hamtest",)
+    games_enabled = True
+
 # Games Configuration
 if games_enabled is True:
     help_message = help_message + ", games"
@@ -179,6 +184,8 @@ if games_enabled is True:
         gamesCmdList += "golfSim, "
     if hangman_enabled:
         gamesCmdList += "hangman, "
+    if hamtest_enabled:
+        gamesCmdList += "hamTest, "
     gamesCmdList = gamesCmdList[:-2] # remove the last comma
 else:
     gamesCmdList = ""