readNews

on demand return of the file news.txt for readnews onair

Author: SpudGunMan

README.md

@@ -47,6 +47,7 @@ Welcome to the Mesh Bot project! This feature-rich bot is designed to enhance yo
 
 ### File Monitor Alerts
 - **File Mon**: Monitor a flat/text file for changes, brodcast the contents of the message to mesh channel.
+- **News File**: on request of news the contents of the file is returned.
 
 ### Data Reporting
 - **HTML Generator**: Visualize bot traffic and data flows with a built-in HTML generator for [data reporting](logs/README.md).
@@ -216,11 +217,14 @@ signalCycleLimit = 5
 
 ### File Monitoring
 Some dev notes for ideas of use
+
 ```ini
 [fileMon]
-enabled = True
+filemon_enabled = True
 file_path = alert.txt
 broadcastCh = 2,4
+enable_read_news = False
+news_file_path = news.txt
 ```
 #### NOAA EAS
 To Alert on Mesh with the NOAA EAS API you can set the channels and enable, checks every 30min

config.template

@@ -147,9 +147,11 @@ signalCooldown = 5
 signalCycleLimit = 5
 
 [fileMon]
-enabled = False
+filemon_enabled = False
 file_path = alert.txt
 broadcastCh = 2
+enable_read_news = False
+news_file_path = news.txt
 
 [messagingSettings]
 # delay in seconds for response to avoid message collision

mesh_bot.py

@@ -57,6 +57,7 @@ def auto_response(message, snr, rssi, hop, pkiStatus, message_from_id, channel_n
     "ping": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
     "pinging": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
     "pong": lambda: "🏓PING!!🛜",
+    "readnews": lambda: read_news(),
     "rlist": lambda: handle_repeaterQuery(message_from_id, deviceID, channel_number),
     "sitrep": lambda: handle_lheard(message, message_from_id, deviceID, isDM),
     "solar": lambda: drap_xray_conditions() + "\n" + solar_conditions(),
@@ -1059,6 +1060,8 @@ async def start_rx():
         logger.debug(f"System: Radio Detection Enabled using rigctld at {rigControlServerAddress} brodcasting to channels: {sigWatchBroadcastCh} for {get_freq_common_name(get_hamlib('f'))}")
     if file_monitor_enabled:
         logger.debug(f"System: File Monitor Enabled for {file_monitor_file_path}, broadcasting to channels: {file_monitor_broadcastCh}")
+    if read_news_enabled:
+        logger.debug(f"System: File Monitor News Reader Enabled for {news_file_path}")
     if wxAlertBroadcastEnabled:
         logger.debug(f"System: Weather Alert Broadcast Enabled on channels {wxAlertBroadcastChannel}")
     if scheduler_enabled:

modules/filemon.py

@@ -5,15 +5,22 @@
 import asyncio
 import os
 
+trap_list_filemon = ("readnews",)
+
+def read_file(file_monitor_file_path):
+    try:
+        with open(file_monitor_file_path, 'r') as f:
+            content = f.read()
+        return content
+    except Exception as e:
+        logger.warning(f"FileMon: Error reading file: {file_monitor_file_path}")
+        return None
+    
+def read_news():
+    # read the news file on demand
+    return read_file(news_file_path)
+
 async def watch_file():
-    def read_file(file_monitor_file_path):
-        try:
-            with open(file_monitor_file_path, 'r') as f:
-                content = f.read()
-            return content
-        except Exception as e:
-            logger.warning(f"FileMon: Error reading file: {file_monitor_file_path}")
-            return None
 
     if not os.path.exists(file_monitor_file_path):
         return None

modules/settings.py

@@ -176,9 +176,11 @@
     signalCycleLimit = config['radioMon'].getint('signalCycleLimit', 5) # default 5 cycles, used with SIGNAL_COOLDOWN
 
     # file monitor
-    file_monitor_enabled = config['fileMon'].getboolean('enabled', False)
+    file_monitor_enabled = config['fileMon'].getboolean('filemon_enabled', False)
     file_monitor_file_path = config['fileMon'].get('file_path', 'alert.txt') # default alert.txt
     file_monitor_broadcastCh = config['fileMon'].getint('broadcastCh', 2) # default 2
+    read_news_enabled = config['fileMon'].getboolean('enable_read_news', False) # default disabled
+    news_file_path = config['fileMon'].get('news_file_path', 'news.txt') # default news.txt
 
     # games
     game_hop_limit = config['messagingSettings'].getint('game_hop_limit', 5) # default 3 hops

modules/system.py

@@ -174,8 +174,11 @@
     from modules.radio import * # from the spudgunman/meshing-around repo
 
 # File Monitor Configuration
-if file_monitor_enabled:
+if file_monitor_enabled or read_news_enabled:
     from modules.filemon import * # from the spudgunman/meshing-around repo
+    if read_news_enabled:
+        trap_list = trap_list + trap_list_filemon # items readnews
+        help_message = help_message + ", readmail"
 
 # BLE dual interface prevention
 if interface1_type == 'ble' and interface2_type == 'ble':

news.txt

@@ -0,0 +1 @@
+no new news is good news!