Merge pull request #57 from SpudGunMan/llmLocationAware

LLM location aware enhancement

Dockerfile

@@ -0,0 +1,18 @@
+FROM python:3.10-slim
+ENV PYTHONUNBUFFERED=1
+
+RUN apt-get update && apt-get install -y gettext && rm -rf /var/lib/apt/lists/*
+
+
+WORKDIR /app
+COPY . /app
+COPY requirements.txt .
+
+RUN pip install -r requirements.txt
+COPY . .
+
+COPY config.ini /app/config.ini
+COPY entrypoint.sh /app/entrypoint.sh
+
+RUN chmod +x /app/entrypoint.sh
+ENTRYPOINT ["/app/entrypoint.sh"]

README.md

@@ -6,10 +6,12 @@ Random Mesh Scripts for Network Testing and BBS Activities for Use with [Meshtas
 ## mesh_bot.sh
 The feature-rich bot requires the internet for full functionality. These responder bots will trap keywords like ping and respond to a DM (direct message) with pong! The script will also monitor the group channels for keywords to trap. You can also `Ping @Data to Echo` as an example.
 
-Along with network testing, this bot has a lot of other fun features, like simple mail messaging you can leave for another device, and when that device is seen, it can send the mail as a DM.
+Along with network testing, this bot has a lot of other fun features, like simple mail messaging you can leave for another device, and when that device is seen, it can send the mail as a DM. Or a scheduler to send weather or a reminder weekly for the VHF net.
 
 The bot is also capable of using dual radio/nodes, so you can monitor two networks at the same time and send messages to nodes using the same `bbspost @nodeNumber #message` or `bbspost @nodeShportName #message` function. There is a small message board to fit in the constraints of Meshtastic for posting bulletin messages with `bbspost $subject #message`.
 
+Look up data using wiki results or interact with [Ollama](https://ollama.com) LLM AI see the [OllamaDocs](https://github.com/ollama/ollama/tree/main/docs) If Ollama is enabled you can DM the bot directly. The default model for mesh-bot which is currently `gemma2:2b`
+
 The bot will report on anyone who is getting close to the configured lat/long, if in a remote location.
 
 Store and forward-like message re-play with `messages`, and there is a repeater module for dual radio bots to cross post messages. Messages are also logged locally to disk.
@@ -18,7 +20,9 @@ The bot can also be used to monitor a radio frequency and let you know when high
 
 Any messages that are over 160 characters are chunked into 160 message bytes to help traverse hops, in testing, this keeps delivery success higher.
 
-Full list of commands for the bot.
+[Donate$](https://www.paypal.com/donate?token=ZpiU7zDh-AQDyK76nWmWPQLf04iOm-Iyr3f85lpubt37NWGRYtfe11UyC0LmY1wdcC20UubWo4Kec-_G) via PayPal if you like the project! 
+
+## Full list of commands for the bot
 
 - Various solar details for radio propagation (spaceWeather module)
   - `sun` and `moon` return info on rise and set local time
@@ -33,9 +37,11 @@ Full list of commands for the bot.
 - Other functions
   - `whereami` returns the address of location of sender if known
   - `tide` returns the local tides, NOAA data source
-  - `wx` and `wxc` returns local weather forecast, (wxc is metric value), NOAA or Open Meteo for weather forcasting.
+  - `wx` and `wxc` returns local weather forecast, (wxc is metric value), NOAA or Open Meteo for weather forecasting.
   - `wxa` and `wxalert` return NOAA alerts. Short title or expanded details
   - `joke` tells a joke
+  - `wiki: ` will search wikipedia, return the first few sentances of first result if a match `wiki: lora radio`
+  - `askai` and `ask:` will ask Ollama LLM AI for a response `askai what temp do I cook chicken`
   - `messages` Replay the last messages heard, like Store and Forward
   - `motd` or to set the message `motd $New Message Of the day`
   - `lheard` returns the last 5 heard nodes with SNR, can also use `sitrep`
@@ -51,13 +57,20 @@ The project is written on Linux on a Pi and should work anywhere [Meshtastic](ht
 Clone the project with `git clone https://github.com/spudgunman/meshing-around`
 code is under a lot of development, so check back often with `git pull`
 Copy [config.template](config.template) to `config.ini` and edit for your needs.
+`pip install -r requirements.txt` 
 
 Optionally:
 - `install.sh` will automate optional venv and requirements installation.
 - `launch.sh` will activate and launch the app in the venv if built.
 
+For Docker:
+Check you have serial port properly shared and the GPU if using LLM with [NVidia](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/docker-specialized.html)
+- `git clone https://github.com/spudgunman/meshing-around`
+- `cd meshing-around && docker build -t meshing-around`
+- `docker run meshing-around`
+
 ### Configurations
-Copy the [config.template](config.template) to `config.ini` and set the appropriate interface for your method (serial/ble/tcp). While BLE and TCP will work, they are not as reliable as serial connections. There is a watchdog to reconnect tcp if possible.
+Copy the [config.template](config.template) to `config.ini` and set the appropriate interface for your method (serial/ble/tcp). While BLE and TCP will work, they are not as reliable as serial connections. There is a watchdog to reconnect tcp if possible. To get BLE mac `meshtastic --ble-scan` **NOTE** I have only tested with a single BLE device and the code is written to only have one interface be a BLE port
 
 ```
 #config.ini
@@ -84,7 +97,7 @@ Setting the default channel is the channel that won't be spammed by the bot. It'
 respond_by_dm_only = True
 defaultChannel = 0
 ```
-The weather forcasting defaults to NOAA but for outside the USA you can set UseMeteoWxAPI `True` to use a world weather API. The lat and lon are for defaults when a node has no location data to use.
+The weather forecasting defaults to NOAA but for outside the USA you can set UseMeteoWxAPI `True` to use a world weather API. The lat and lon are for defaults when a node has no location data to use.
 ```
 [location]
 enabled = True
@@ -102,7 +115,7 @@ enabled = False
 DadJokes = False
 StoreForward = False
 ```
-Sentry Bot detects anyone comeing close to the bot-node
+Sentry Bot detects anyone coming close to the bot-node
 ```
 # detect anyone close to the bot
 SentryEnabled = True
@@ -131,8 +144,8 @@ A module allowing a Hamlib compatible radio to connect to the bot, when function
 [radioMon]
 enabled = False
 rigControlServerAddress = localhost:4532
-# channel to brodcast to can be 2,3
-sigWatchBrodcastCh = 2
+# channel to broadcast to can be 2,3
+sigWatchBroadcastCh = 2
 # minimum SNR as reported by radio via hamlib
 signalDetectionThreshold = -10
 # hold time for high SNR
@@ -141,20 +154,52 @@ signalHoldTime = 10
 signalCooldown = 5
 signalCycleLimit = 5
 ```
+Ollama Settings, for Ollama to work the command line `ollama run 'model'` needs to work properly. Check that you have enough RAM and your GPU are working as expected. The default model for this project, is set to `gemma2:2b` (run `ollama pull gemma2:2b` on command line, to download and setup) however I have found gemma2:2b to be lighter, faster and seems better overall vs llama3,1 (`olamma pull llama3.1`)
+ - From the command terminal of your system with mesh-bot, download the default model for mesh-bot which is currently `ollama pull gemma2:2b`
 
-Logging messages to disk or Syslog to disk uses the python native logging fuction. Take a look at the [/modules/log.py](/modules/log.py) you can set the file logger for syslog to INFO for example to not log DEBUG messages to file log, or modify the stdOut level.
+Enable History, set via code readme Ollama Config in [Settings](https://github.com/SpudGunMan/meshing-around?tab=readme-ov-file#configurations) and [llm.py](https://github.com/SpudGunMan/meshing-around/blob/eb3bbdd3c5e0f16fe3c465bea30c781bd132d2d3/modules/llm.py#L12)
+
+```
+# Enable ollama LLM see more at https://ollama.com
+ollama = True
+# Ollama model to use (defaults to llama3.1)
+ollamaModel = gemma2:2b
+```
+
+also see llm.py for changing the defaults of
+```
+# LLM System Variables
+llmEnableHistory = False # enable history for the LLM model to use in responses adds to compute time
+llmContext_fromGoogle = True # enable context from google search results adds to compute time but really helps with responses accuracy
+googleSearchResults = 3 # number of google search results to include in the context more results = more compute time
+llm_history_limit = 6 # limit the history to 3 messages (come in pairs) more results = more compute time
+```
+
+Logging messages to disk or Syslog to disk uses the python native logging function. Take a look at the [/modules/log.py](/modules/log.py) you can set the file logger for syslog to INFO for example to not log DEBUG messages to file log, or modify the stdOut level.
 ```
 [general]
 # logging to file of the non Bot messages
 LogMessagesToFile = True
 # Logging of system messages to file
 SyslogToFile = True
+```
+Example to log to disk only INFO and higher (ignore DEBUG)
+```
 *log.py
 file_handler.setLevel(logging.INFO) # DEBUG used by default for system logs to disk example here shows INFO
 ```
 
+The Scheduler is enabled in the [settings.py](modules/settings.py) by setting `scheduler_enabled = True` the actions and settings are via code only at this time. see [mesh_bot.py](mesh_bot.py) around line [425](https://github.com/SpudGunMan/meshing-around/blob/22983133ee4db3df34f66699f565e506de296197/mesh_bot.py#L425-L435) to edit schedule its most flexible to edit raw code right now.  See https://schedule.readthedocs.io/en/stable/ for more.
+
+```
+# Send WX every Morning at 08:00 using handle_wxc function to channel 2 on device 1
+#schedule.every().day.at("08:00").do(lambda: send_message(handle_wxc(0, 1, 'wx'), 2, 0, 1))
+
+# Send a Net Starting Now Message Every Wednesday at 19:00 using send_message function to channel 2 on device 1
+#schedule.every().wednesday.at("19:00").do(lambda: send_message("Net Starting Now", 2, 0, 1))
+```
 # requirements
-Python 3.4 and likely higher is needed, developed on latest release.
+Python 3.10 minimally is needed, developed on latest release.
 
 The following can also be installed with `pip install -r requirements.txt` or using the install.sh script for venv and automation
 
@@ -173,6 +218,7 @@ pip install beautifulsoup4
 pip install dadjokes
 pip install geopy
 pip install schedule
+pip install wikipedia
 ```
 The following is needed for open-meteo use
 ```
@@ -180,6 +226,13 @@ pip install openmeteo_requests
 pip install retry_requests
 pip install numpy
 ```
+The following is for the Ollama LLM
+```
+pip install langchain
+pip install langchain-ollama
+pip install ollama
+pip install googlesearch-python
+```
 
 To enable emoji in the Debian console, install the fonts `sudo apt-get install fonts-noto-color-emoji`
 
@@ -189,6 +242,6 @@ I used ideas and snippets from other responder bots and want to call them out!
 - https://github.com/pdxlocations/meshtastic-Python-Examples
 - https://github.com/geoffwhittington/meshtastic-matrix-relay
 
-GitHub user PiDiBi looking at test functions and other suggestions like wxc, CPU use, and alerting ideas
+GitHub user mrpatrick1991 For Docker configs, PiDiBi looking at test functions and other suggestions like wxc, CPU use, and alerting ideas
 Discord and Mesh user Cisien, and github Hailo1999, for testing and ideas!
 

config.template

@@ -34,6 +34,12 @@ welcome_message = MeshBot, here for you like a friend who is not. Try sending: p
 DadJokes = True
 # enable or disable the Solar module
 spaceWeather = True
+# enable or disable the wikipedia search module
+wikipedia = True
+# Enable ollama LLM see more at https://ollama.com
+ollama = False
+# Ollama model to use (defaults to gemma2:2b)
+# ollamaModel = llama3.1
 # StoreForward Enabled and Limits
 StoreForward = True
 StoreLimit = 3
@@ -46,7 +52,6 @@ LogMessagesToFile = False
 # Logging of system messages to file
 SyslogToFile = False
 
-
 [sentry]
 # detect anyone close to the bot
 SentryEnabled = True
@@ -75,7 +80,7 @@ lon = -123.0
 NOAAforecastDuration = 4
 # number of weather alerts to display
 NOAAalertCount = 2
-# use Open-Meteo API for weather data not NOAA usefull for non US locations
+# use Open-Meteo API for weather data not NOAA useful for non US locations
 UseMeteoWxAPI = False
 # Default to metric units rather than imperial
 useMetric = False
@@ -93,12 +98,12 @@ repeater_channels =
 # using Hamlib rig control will monitor and alert on channel use
 enabled = False
 rigControlServerAddress = localhost:4532
-# brodcast to all nodes on the channel can alsp be  = 2,3
-sigWatchBrodcastCh = 2
+# broadcast to all nodes on the channel can alsp be  = 2,3
+sigWatchBroadcastCh = 2
 # minimum SNR as reported by radio via hamlib
 signalDetectionThreshold = -10
 # hold time for high SNR
 signalHoldTime = 10
 # the following are combined to reset the monitor
 signalCooldown = 5
-signalCycleLimit = 5
+signalCycleLimit = 5

entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Substitute environment variables in the config file
+envsubst < /app/config.ini > /app/config.tmp && mv /app/config.tmp /app/config.ini
+
+exec python /app/mesh_bot.py

mesh_bot.py

@@ -22,6 +22,9 @@ def auto_response(message, snr, rssi, hop, message_from_id, channel_number, devi
         "wxa": lambda: handle_wxalert(message_from_id, deviceID, message),
         "wxc": lambda: handle_wxc(message_from_id, deviceID, 'wxc'),
         "wx": lambda: handle_wxc(message_from_id, deviceID, 'wx'),
+        "wiki:": lambda: handle_wiki(message),
+        "ask:": lambda: handle_llm(message_from_id, channel_number, deviceID, message, publicChannel),
+        "askai": lambda: handle_llm(message_from_id, channel_number, deviceID, message, publicChannel),
         "joke": tell_joke,
         "bbslist": bbs_list_messages,
         "bbspost": lambda: handle_bbspost(message, message_from_id, deviceID),
@@ -93,6 +96,71 @@ def handle_wxalert(message_from_id, deviceID, message):
 
         return weatherAlert
 
+def handle_wiki(message):
+    # location = get_node_location(message_from_id, deviceID)
+    if "wiki:" in message.lower():
+        search = message.split(":")[1]
+        search = search.strip()
+        return get_wikipedia_summary(search)
+    else:
+        return "Please add a search term example:wiki: travelling gnome"
+
+def handle_llm(message_from_id, channel_number, deviceID, message, publicChannel):
+    global llmRunCounter, llmTotalRuntime, llmLocationTable
+
+    if location_enabled:
+        location = get_node_location(message_from_id, deviceID)
+        # if message_from_id is is the llmLocationTable use the location from the table to save on API calls
+        if message_from_id in llmLocationTable:
+            location = llmLocationTable[message_from_id]
+        else:
+            location_name = where_am_i(str(location[0]), str(location[1]), short = True)
+            llmLocationTable.append({message_from_id: location_name})
+
+        if NO_DATA_NOGPS in location_name:
+            location_name = "no location provided "
+    else:
+        location_name = "no location provided "
+
+    if "ask:" in message.lower():
+        user_input = message.split(":")[1]
+    elif "askai" in message.lower():
+        user_input = message.replace("askai", "")
+    else:
+        user_input = message
+    user_input = user_input.strip()
+        
+    if len(user_input) < 1:
+        return "Please ask a question"
+
+    # information for the user on how long the query will take on average
+    if llmRunCounter > 0:
+        averageRuntime = sum(llmTotalRuntime) / len(llmTotalRuntime)
+        if averageRuntime > 25:
+            msg = f"Please wait, average query time is: {int(averageRuntime)} seconds"
+            if channel_number == publicChannel:
+                send_message(msg, channel_number, message_from_id, deviceID)
+            else:
+                send_message(msg, channel_number, 0, deviceID)
+    else:
+            msg = "Please wait, response could take 3+ minutes. Fund the SysOp's GPU budget!"
+            if channel_number == publicChannel:
+                send_message(msg, channel_number, message_from_id, deviceID)
+            else:
+                send_message(msg, channel_number, 0, deviceID)
+    
+    start = time.time()
+
+    #response = asyncio.run(llm_query(user_input, message_from_id))
+    response = llm_query(user_input, message_from_id, location_name)
+
+    # handle the runtime counter
+    end = time.time()
+    llmRunCounter += 1
+    llmTotalRuntime.append(end - start)
+
+    return response
+
 def handle_wxc(message_from_id, deviceID, cmd):
     location = get_node_location(message_from_id, deviceID)
     if use_meteo_wxApi and not "wxc" in cmd and not use_metric:
@@ -219,11 +287,19 @@ def onDisconnect(interface):
             retry_int1 = True
         elif interface2_enabled and hostname2 in rxHost and interface2_type == 'tcp':
             retry_int2 = True
+    
+    if rxType == 'BLEInterface':
+        logger.critical(f"System: Lost Connection to Device BLE")
+        if interface1_type == 'ble':
+            retry_int1 = True
+        elif interface2_enabled and interface2_type == 'ble':
+            retry_int2 = True
 
 def onReceive(packet, interface):
     # extract interface  defailts from interface object
     rxType = type(interface).__name__
     rxNode = 0
+    #logger.debug(f"System: Packet Received on {rxType}")
     # Debug print the interface object
     #for item in interface.__dict__.items(): print (item)
 
@@ -241,6 +317,12 @@ def onReceive(packet, interface):
         elif interface2_enabled and hostname2 in rxHost and interface2_type == 'tcp':
             rxNode = 2
 
+    if rxType == 'BLEInterface':
+        if interface1_type == 'ble':
+            rxNode = 1
+        elif interface2_enabled and interface2_type == 'ble':
+            rxNode = 2
+
     # Debug print the packet for debugging
     #print(f"Packet Received\n {packet} \n END of packet \n")
     message_from_id = 0
@@ -264,6 +346,8 @@ def onReceive(packet, interface):
             send_message(message, channel_number, message_from_id, rxNode)
 
     # check for a message packet and process it
+    snr = 0
+    rssi = 0
     try:
         if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
             message_bytes = packet['decoded']['payload']
@@ -321,10 +405,16 @@ def onReceive(packet, interface):
                                 "From: " + CustomFormatter.white + f"{get_name_from_number(message_from_id, 'long', rxNode)}")
                     # respond with DM
                     send_message(auto_response(message_string, snr, rssi, hop, message_from_id, channel_number, rxNode), channel_number, message_from_id, rxNode)
-                else: 
-                    # respond with welcome message on DM
-                    logger.warning(f"Device:{rxNode} Ignoring DM: {message_string} From: {get_name_from_number(message_from_id, 'long', rxNode)}")
-                    send_message(welcome_message, channel_number, message_from_id, rxNode)
+                else:
+                    if llm_enabled:
+                        llm = handle_llm(message_from_id, channel_number, rxNode, message_string, publicChannel)
+                        send_message(llm, channel_number, message_from_id, rxNode)
+                    else:
+                        # respond with welcome message on DM
+                        logger.warning(f"Device:{rxNode} Ignoring DM: {message_string} From: {get_name_from_number(message_from_id, 'long', rxNode)}")
+                        send_message(welcome_message, channel_number, message_from_id, rxNode)
+                    
+                    # log the message to the message log
                     msgLogger.info(f"Device:{rxNode} Channel:{channel_number} | {get_name_from_number(message_from_id, 'long', rxNode)} | " + message_string.replace('\n', '-nl-'))
             else:
                 # message is on a channel
@@ -386,6 +476,10 @@ def onReceive(packet, interface):
 
 async def start_rx():
     print (CustomFormatter.bold_white + f"\nMeshtastic Autoresponder Bot CTL+C to exit\n" + CustomFormatter.reset)
+    if llm_enabled:
+        logger.debug(f"System: Ollama LLM Enabled, loading model {llmModel} please wait")
+        llm_query(" ", myNodeNum1)
+        logger.debug(f"System: LLM model {llmModel} loaded")
     # Start the receive subscriber using pubsub via meshtastic library
     pub.subscribe(onReceive, 'meshtastic.receive')
     pub.subscribe(onDisconnect, 'meshtastic.connection.lost')
@@ -409,6 +503,8 @@ async def start_rx():
             logger.debug(f"System: Location Telemetry Enabled using NOAA API")
     if dad_jokes_enabled:
         logger.debug(f"System: Dad Jokes Enabled!")
+    if wikipedia_enabled:
+        logger.debug(f"System: Wikipedia search Enabled")
     if motd_enabled:
         logger.debug(f"System: MOTD Enabled using {MOTD}")
     if sentry_enabled:
@@ -419,8 +515,8 @@ async def start_rx():
         logger.debug(f"System: Respond by DM only")
     if repeater_enabled and interface2_enabled:
         logger.debug(f"System: Repeater Enabled for Channels: {repeater_channels}")
-    if radio_dectection_enabled:
-        logger.debug(f"System: Radio Detection Enabled using rigctld at {rigControlServerAddress} brodcasting to channels: {sigWatchBrodcastCh} for {get_freq_common_name(get_hamlib('f'))}")
+    if radio_detection_enabled:
+        logger.debug(f"System: Radio Detection Enabled using rigctld at {rigControlServerAddress} brodcasting to channels: {sigWatchBroadcastCh} for {get_freq_common_name(get_hamlib('f'))}")
     if scheduler_enabled:
         # Examples of using the scheduler, Times here are in 24hr format
         # https://schedule.readthedocs.io/en/stable/
@@ -432,7 +528,19 @@ async def start_rx():
         #schedule.every().day.at("08:00").do(lambda: send_message(handle_wxc(0, 1, 'wx'), 2, 0, 1))
 
         # Send a Net Starting Now Message Every Wednesday at 19:00 using send_message function to channel 2 on device 1
-        #schedule.every().wednesday.at("19:00").do(lambda: send_message("Net Starting Now", 2, 0, 1)
+        #schedule.every().wednesday.at("19:00").do(lambda: send_message("Net Starting Now", 2, 0, 1))
+
+        # Send a Welcome Notice for group on the 15th and 25th of the month at 12:00 using send_message function to channel 2 on device 1
+        #schedule.every().day.at("12:00").do(lambda: send_message("Welcome to the group", 2, 0, 1)).day(15, 25)
+
+        # Send a joke every 6 hours using tell_joke function to channel 2 on device 1
+        #schedule.every(6).hours.do(lambda: send_message(tell_joke(), 2, 0, 1))
+
+        # Send the Welcome Message every other day at 08:00 using send_message function to channel 2 on device 1
+        #schedule.every(2).days.at("08:00").do(lambda: send_message(welcome_message, 2, 0, 1))
+
+        # Send the MOTD every day at 13:00 using send_message function to channel 2 on device 1
+        #schedule.every().day.at("13:00").do(lambda: send_message(MOTD, 2, 0, 1))
         
         #
         logger.debug("System: Starting the broadcast scheduler")
@@ -447,7 +555,7 @@ async def start_rx():
 async def main():
     meshRxTask = asyncio.create_task(start_rx())
     watchdogTask = asyncio.create_task(watchdog())
-    if radio_dectection_enabled:
+    if radio_detection_enabled:
         hamlibTask = asyncio.create_task(handleSignalWatcher())
         await asyncio.wait([meshRxTask, watchdogTask, hamlibTask])
     else:

modules/bbstools.py

@@ -18,14 +18,14 @@ def load_bbsdb():
             bbs_messages = pickle.load(f)
     except:
         bbs_messages = [[1, "Welcome to meshBBS", "Welcome to the BBS, please post a message!",0]]
-        logger.debug("\nSystem: Creating new bbsdb.pkl")
+        logger.debug("System: Creating new bbsdb.pkl")
         with open('bbsdb.pkl', 'wb') as f:
             pickle.dump(bbs_messages, f)
 
 def save_bbsdb():
     global bbs_messages
     # save the bbs messages to the database file
-    logger.debug("System: Saving bbsdb.pkl\n")
+    logger.debug("System: Saving bbsdb.pkl")
     with open('bbsdb.pkl', 'wb') as f:
         pickle.dump(bbs_messages, f)
 
@@ -112,7 +112,7 @@ def load_bbsdm():
             bbs_dm = pickle.load(f)
     except:
         bbs_dm = [[1234567890, "Message", 1234567890]]
-        logger.debug("\nSystem: Creating new bbsdm.pkl")
+        logger.debug("System: Creating new bbsdm.pkl")
         with open('bbsdm.pkl', 'wb') as f:
             pickle.dump(bbs_dm, f)
 

modules/llm.py

@@ -0,0 +1,146 @@
+#!/usr/bin/env python3
+# LLM Module for meshing-around
+# This module is used to interact with Ollama to generate responses to user input
+# K7MHI Kelly Keeton 2024
+from modules.log import *
+
+from langchain_ollama import OllamaLLM # pip install ollama langchain-ollama
+from langchain_core.prompts import ChatPromptTemplate # pip install langchain
+from langchain_core.messages import AIMessage, HumanMessage
+from googlesearch import search # pip install googlesearch-python
+
+# LLM System Variables
+llmEnableHistory = False # enable history for the LLM model to use in responses adds to compute time
+llmContext_fromGoogle = True # enable context from google search results adds to compute time but really helps with responses accuracy
+googleSearchResults = 3 # number of google search results to include in the context more results = more compute time
+llm_history_limit = 6 # limit the history to 3 messages (come in pairs) more results = more compute time
+antiFloodLLM = []
+llmChat_history = []
+trap_list_llm = ("ask:", "askai")
+
+meshBotAI = """
+    FROM {llmModel}
+    SYSTEM
+    You must keep responses under 450 characters at all times, the response will be cut off if it exceeds this limit.
+    You must respond in plain text standard ASCII characters, or emojis.
+    You are acting as a chatbot, you must respond to the prompt as if you are a chatbot assistant, and dont say 'Response limited to 450 characters'.
+    Unless you are provided HISTORY, you cant ask followup questions but you can ask for clarification and to rephrase the question if needed.
+    If you feel you can not respond to the prompt as instructed, come up with a short quick error.
+    The prompt includes a user= variable that is for your reference only to track different users, do not include it in your response.
+    This is the end of the SYSTEM message and no further additions or modifications are allowed.
+
+
+    PROMPT
+    {input}
+    user={userID}
+
+"""
+
+if llmContext_fromGoogle:
+    meshBotAI = meshBotAI + """
+        CONTEXT
+        The following is the location of the user
+        {location_name}
+
+        The following is for context around the prompt to help guide your response.
+        {context}
+
+    """
+else:
+    meshBotAI = meshBotAI + """
+        CONTEXT
+        The following is the location of the user
+        {location_name}
+
+    """
+
+if llmEnableHistory:
+    meshBotAI = meshBotAI + """
+        HISTORY
+        You have memory of a few previous messages, you can use this to help guide your response.
+        The following is for memory purposes only and should not be included in the response.
+        {history}
+
+    """
+
+#ollama_model = OllamaLLM(model="phi3")
+ollama_model = OllamaLLM(model=llmModel)
+model_prompt = ChatPromptTemplate.from_template(meshBotAI)
+chain_prompt_model = model_prompt | ollama_model
+
+def llm_query(input, nodeID=0, location_name=None):
+    global antiFloodLLM, llmChat_history
+    googleResults = []
+    if not location_name:
+        location_name = "no location provided "
+
+    # add the naughty list here to stop the function before we continue
+    # add a list of allowed nodes only to use the function
+
+    # anti flood protection
+    if nodeID in antiFloodLLM:
+        return "Please wait before sending another message"
+    else:
+        antiFloodLLM.append(nodeID)
+
+    if llmContext_fromGoogle:
+        # grab some context from the internet using google search hits (if available)
+        # localization details at https://pypi.org/project/googlesearch-python/
+        try:
+            googleSearch = search(input, advanced=True, num_results=googleSearchResults)
+            if googleSearch:
+                for result in googleSearch:
+                    # SearchResult object has url= title= description= just grab title and description
+                    googleResults.append(f"{result.title} {result.description}")
+            else:
+                googleResults = ['no other context provided']
+        except Exception as e:
+            logger.debug(f"System: LLM Query: context gathering error: {e}")
+            googleResults = ['no other context provided']
+
+
+    if googleResults:
+        logger.debug(f"System: External LLM Query: {input} From:{nodeID} with context from google")
+    else:
+        logger.debug(f"System: External LLM Query: {input} From:{nodeID}")
+    
+    response = ""
+    result = ""
+    location_name += f" at the current time of {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}"
+
+    try:
+        result = chain_prompt_model.invoke({"input": input, "llmModel": llmModel, "userID": nodeID, \
+                                            "history": llmChat_history, "context": googleResults, "location_name": location_name})
+        #logger.debug(f"System: LLM Response: " + result.strip().replace('\n', ' '))
+    except Exception as e:
+        logger.warning(f"System: LLM failure: {e}")
+        return "I am having trouble processing your request, please try again later."
+    
+
+    response = result.strip().replace('\n', ' ')
+
+    # Store history of the conversation, with limit to prevent template growing too large causing speed issues
+    if len(llmChat_history) > llm_history_limit:
+        # remove the oldest two messages
+        llmChat_history.pop(0)
+        llmChat_history.pop(1)
+    inputWithUserID = input + f"   user={nodeID}"
+    llmChat_history.append(HumanMessage(content=inputWithUserID))
+    llmChat_history.append(AIMessage(content=response))
+
+    # done with the query, remove the user from the anti flood list
+    antiFloodLLM.remove(nodeID)
+
+    return response
+
+# import subprocess
+# def get_ollama_cpu():
+#     try:
+#         psOutput = subprocess.run(['ollama', 'ps'], capture_output=True, text=True)
+#         if "GPU" in psOutput.stdout:
+#             logger.debug(f"System: Ollama process with GPU")
+#         else:
+#             logger.debug(f"System: Ollama process with CPU, query time will be slower")
+#     except Exception as e:
+#         logger.debug(f"System: Ollama process not found, {e}")
+#         return False

modules/locationdata.py

@@ -11,7 +11,7 @@ from modules.log import *
 
 trap_list_location = ("whereami", "tide", "moon", "wx", "wxc", "wxa", "wxalert")
 
-def where_am_i(lat=0, lon=0):
+def where_am_i(lat=0, lon=0, short=False):
     whereIam = ""
     grid = mh.to_maiden(float(lat), float(lon))
     
@@ -23,6 +23,13 @@ def where_am_i(lat=0, lon=0):
     geolocator = Nominatim(user_agent="mesh-bot")
     
     # Nomatim API call to get address
+    if short:
+        location = geolocator.reverse(lat + ", " + lon)
+        address = location.raw['address']
+        address_components = ['city', 'state', 'county', 'country']
+        whereIam = f"City: {address.get('city', '')} State: {address.get('state', '')} County: {address.get('county', '')} Country: {address.get('country', '')}"
+        return whereIam
+    
     if float(lat) == latitudeValue and float(lon) == longitudeValue:
         # redacted address when no GPS and using default location
         location = geolocator.reverse(lat + ", " + lon)
@@ -30,14 +37,13 @@ def where_am_i(lat=0, lon=0):
         address_components = ['city', 'state', 'postcode', 'county', 'country']
         whereIam += ' '.join([address.get(component, '') for component in address_components if component in address])
         whereIam += " Grid: " + grid
-        return whereIam
     else:
         location = geolocator.reverse(lat + ", " + lon)
         address = location.raw['address']
         address_components = ['house_number', 'road', 'city', 'state', 'postcode', 'county', 'country']
         whereIam += ' '.join([address.get(component, '') for component in address_components if component in address])
         whereIam += " Grid: " + grid
-        return whereIam
+    return whereIam
 
 def get_tide(lat=0, lon=0):
     station_id = ""

modules/settings.py

@@ -25,6 +25,10 @@ max_retry_count2 = 4 # max retry count for interface 2
 retry_int1 = False
 retry_int2 = False
 scheduler_enabled = False # enable the scheduler currently config via code only
+wiki_return_limit = 3 # limit the number of sentences returned off the first paragraph first hit
+llmRunCounter = 0
+llmTotalRuntime = []
+llmLocationTable = []
 
 # Read the config file, if it does not exist, create basic config file
 config = configparser.ConfigParser() 
@@ -85,15 +89,18 @@ try:
     publicChannel = config['general'].getint('defaultChannel', 0) # the meshtastic public channel
     zuluTime = config['general'].getboolean('zuluTime', False) # aka 24 hour time
     log_messages_to_file = config['general'].getboolean('LogMessagesToFile', True) # default True
-    syslog_to_file = config['general'].getboolean('SyslogToFile', False) # default True
+    syslog_to_file = config['general'].getboolean('SyslogToFile', False)
     urlTimeoutSeconds = config['general'].getint('urlTimeout', 10) # default 10 seconds
-    store_forward_enabled = config['general'].getboolean('StoreForward', True) # default False
+    store_forward_enabled = config['general'].getboolean('StoreForward', True)
     storeFlimit = config['general'].getint('StoreLimit', 3) # default 3 messages for S&F
-    welcome_message = config['general'].get(f'welcome_message', WELCOME_MSG)
+    welcome_message = config['general'].get('welcome_message', WELCOME_MSG)
     welcome_message = (f"{welcome_message}").replace('\\n', '\n') # allow for newlines in the welcome message
     motd_enabled = config['general'].getboolean('motdEnabled', True)
-    dad_jokes_enabled = config['general'].getboolean('DadJokes', True)
-    solar_conditions_enabled = config['general'].getboolean('spaceWeather', True) 
+    dad_jokes_enabled = config['general'].getboolean('DadJokes', False)
+    solar_conditions_enabled = config['general'].getboolean('spaceWeather', True)
+    wikipedia_enabled = config['general'].getboolean('wikipedia', False)
+    llm_enabled = config['general'].getboolean('ollama', False) # https://ollama.com
+    llmModel = config['general'].get('ollamaModel', 'gemma2:2b') # default gemma2:2b
 
     sentry_enabled = config['sentry'].getboolean('SentryEnabled', False) # default False
     secure_channel = config['sentry'].getint('SentryChannel', 2) # default 2
@@ -118,9 +125,9 @@ try:
     repeater_enabled = config['repeater'].getboolean('enabled', False)
     repeater_channels = config['repeater'].get('repeater_channels', '').split(',')
 
-    radio_dectection_enabled = config['radioMon'].getboolean('enabled', False)
+    radio_detection_enabled = config['radioMon'].getboolean('enabled', False)
     rigControlServerAddress = config['radioMon'].get('rigControlServerAddress', 'localhost:4532') # default localhost:4532
-    sigWatchBrodcastCh = config['radioMon'].get('sigWatchBrodcastCh', '2').split(',') # default Channel 2
+    sigWatchBroadcastCh = config['radioMon'].get('sigWatchBroadcastCh', '2').split(',') # default Channel 2
     signalDetectionThreshold = config['radioMon'].getint('signalDetectionThreshold', -10) # default -10 dBm
     signalHoldTime = config['radioMon'].getint('signalHoldTime', 10) # default 10 seconds
     signalCooldown = config['radioMon'].getint('signalCooldown', 5) # default 1 second

modules/system.py

@@ -64,6 +64,18 @@ if dad_jokes_enabled:
     trap_list = trap_list + ("joke",)
     help_message = help_message + ", joke"
 
+# Wikipedia Search Configuration
+if wikipedia_enabled:
+    import wikipedia # pip install wikipedia
+    trap_list = trap_list + ("wiki:",)
+    help_message = help_message + ", wiki:"
+
+# LLM Configuration
+if llm_enabled:
+    from modules.llm import * # from the spudgunman/meshing-around repo
+    trap_list = trap_list + trap_list_llm # items ask:
+    help_message = help_message + ", askai"
+
 # Scheduled Broadcast Configuration
 if scheduler_enabled:
     import schedule # pip install schedule
@@ -81,11 +93,17 @@ if store_forward_enabled:
     help_message = help_message + ", messages"
 
 # Radio Monitor Configuration
-if radio_dectection_enabled:
+if radio_detection_enabled:
     from modules.radio import * # from the spudgunman/meshing-around repo
+
+# BLE dual interface prevention
+if interface1_type == 'ble' and interface2_type == 'ble':
+    logger.critical(f"System: BLE Interface1 and Interface2 cannot both be BLE. Exiting")
+    exit()
     
 # Interface1 Configuration
 try:
+    logger.debug(f"System: Initializing Interface1")
     if interface1_type == 'serial':
         interface1 = meshtastic.serial_interface.SerialInterface(port1)
     elif interface1_type == 'tcp':
@@ -96,11 +114,12 @@ try:
         logger.critical(f"System: Interface Type: {interface1_type} not supported. Validate your config against config.template Exiting")
         exit()
 except Exception as e:
-    logger.critical(f"System: script abort. Initalizing Interface1 {e}")
+    logger.critical(f"System: script abort. Initializing Interface1 {e}")
     exit()
 
 # Interface2 Configuration
 if interface2_enabled:
+    logger.debug(f"System: Initializing Interface2")
     try:
         if interface2_type == 'serial':
             interface2 = meshtastic.serial_interface.SerialInterface(port2)
@@ -112,7 +131,7 @@ if interface2_enabled:
             logger.critical(f"System: Interface Type: {interface2_type} not supported. Validate your config against config.template Exiting")
             exit()
     except Exception as e:
-        logger.critical(f"System: script abort. Initalizing Interface2 {e}")
+        logger.critical(f"System: script abort. Initializing Interface2 {e}")
         exit()
 
 #Get the node number of the device, check if the device is connected
@@ -409,7 +428,7 @@ def get_closest_nodes(nodeInt=1,returnCount=3):
             return ERROR_FETCHING_DATA
         
 def send_message(message, ch, nodeid=0, nodeInt=1):
-    if message == "":
+    if message == "" or message == None or len(message) == 0:
         return
     # if message over MESSAGE_CHUNK_SIZE characters, split it into multiple messages
     if len(message) > MESSAGE_CHUNK_SIZE:
@@ -478,14 +497,30 @@ def tell_joke():
     else:
         return ''
 
-def messageTrap(msg):
-    # Check if the message contains a trap word
-    message_list=msg.split(" ")
-    for m in message_list:
-        for t in trap_list:
-            if t.lower() == m.lower():
-                return True
-    return False
+def get_wikipedia_summary(search_term):
+    wikipedia_search = wikipedia.search(search_term, results=3)
+    wikipedia_suggest = wikipedia.suggest(search_term)
+    #wikipedia_aroundme = wikipedia.geosearch(location[0], location[1], results=3)
+    #logger.debug(f"System: Wikipedia Nearby:{wikipedia_aroundme}")
+    
+    if len(wikipedia_search) == 0:
+        logger.warning(f"System: No Wikipedia Results for:{search_term}")
+        return ERROR_FETCHING_DATA
+    
+    try:
+        logger.debug(f"System: Searching Wikipedia for:{search_term}, First Result:{wikipedia_search[0]}, Suggest Word:{wikipedia_suggest}")
+        summary = wikipedia.summary(search_term, sentences=wiki_return_limit, auto_suggest=False, redirect=True)
+    except wikipedia.DisambiguationError as e:
+        logger.warning(f"System: Disambiguation Error for:{search_term} trying {wikipedia_search[0]}")
+        summary = wikipedia.summary(wikipedia_search[0], sentences=wiki_return_limit, auto_suggest=True, redirect=True)
+    except wikipedia.PageError as e:
+        logger.warning(f"System: Wikipedia Page Error for:{search_term} {e} trying {wikipedia_search[0]}")
+        summary = wikipedia.summary(wikipedia_search[0], sentences=wiki_return_limit, auto_suggest=True, redirect=True)
+    except Exception as e:
+        logger.error(f"System: Error with Wikipedia for:{search_term} {e}")
+        return ERROR_FETCHING_DATA
+    
+    return summary
 
 def messageTrap(msg):
     # Check if the message contains a trap word
@@ -498,7 +533,7 @@ def messageTrap(msg):
 
 def exit_handler():
     # Close the interface and save the BBS messages
-    logger.debug(f"\nSystem: Closing Autoresponder\n")
+    logger.debug(f"System: Closing Autoresponder")
     try:         
         interface1.close()
         logger.debug(f"System: Interface1 Closed")
@@ -523,7 +558,7 @@ async def BroadcastScheduler():
         await asyncio.sleep(1)
 
 async def handleSignalWatcher():
-    global lastHamLibAlert, antiSpam, sigWatchBrodcastCh
+    global lastHamLibAlert, antiSpam, sigWatchBroadcastCh
     # monitor rigctld for signal strength and frequency
     while True:
         msg =  await signalWatcher()
@@ -534,21 +569,21 @@ async def handleSignalWatcher():
             if time.time() - lastHamLibAlert > 60:
                 lastHamLibAlert = time.time()
                 # if sigWatchBrodcastCh list contains multiple channels, broadcast to all
-                if type(sigWatchBrodcastCh) is list:
-                    for ch in sigWatchBrodcastCh:
+                if type(sigWatchBroadcastCh) is list:
+                    for ch in sigWatchBroadcastCh:
                         if antiSpam and ch != publicChannel:
                             send_message(msg, int(ch), 0, 1)
                             if interface2_enabled:
                                 send_message(msg, int(ch), 0, 2)
                         else:
-                            logger.error(f"System: antiSpam prevented Alert from Hamlib {msg}")
+                            logger.warning(f"System: antiSpam prevented Alert from Hamlib {msg}")
                 else:
-                    if antiSpam and sigWatchBrodcastCh != publicChannel:
-                        send_message(msg, int(sigWatchBrodcastCh), 0, 1)
+                    if antiSpam and sigWatchBroadcastCh != publicChannel:
+                        send_message(msg, int(sigWatchBroadcastCh), 0, 1)
                         if interface2_enabled:
-                            send_message(msg, int(sigWatchBrodcastCh), 0, 2)
+                            send_message(msg, int(sigWatchBroadcastCh), 0, 2)
                     else:
-                        logger.error(f"System: antiSpam prevented Alert from Hamlib {msg}")
+                        logger.warning(f"System: antiSpam prevented Alert from Hamlib {msg}")
 
         await asyncio.sleep(1)
         pass
@@ -635,7 +670,6 @@ async def watchdog():
                 with contextlib.redirect_stdout(None):
                     interface1.localNode.getMetadata()
                     print(f"System: if you see this upgrade python to >3.4")
-                #if "device_state_version:" not in meta:
             except Exception as e:
                 logger.error(f"System: communicating with interface1, trying to reconnect: {e}")
                 retry_int1 = True

pong_bot.py

@@ -104,6 +104,13 @@ def onDisconnect(interface):
         elif interface2_enabled and hostname2 in rxHost and interface2_type == 'tcp':
             retry_int2 = True
 
+    if rxType == 'BLEInterface':
+        logger.critical(f"System: Lost Connection to Device BLE")
+        if interface1_type == 'ble':
+            retry_int1 = True
+        elif interface2_enabled and interface2_type == 'ble':
+            retry_int2 = True
+
 def onReceive(packet, interface):
     # extract interface  defailts from interface object
     rxType = type(interface).__name__
@@ -125,11 +132,19 @@ def onReceive(packet, interface):
         elif interface2_enabled and hostname2 in rxHost and interface2_type == 'tcp':
             rxNode = 2
 
+    if rxType == 'BLEInterface':
+        if interface1_type == 'ble':
+            rxNode = 1
+        elif interface2_enabled and interface2_type == 'ble':
+            rxNode = 2
+
     # Debug print the packet for debugging
     #print(f"Packet Received\n {packet} \n END of packet \n")
     message_from_id = 0
 
     # check for a message packet and process it
+    snr = 0
+    rssi = 0
     try:
         if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
             message_bytes = packet['decoded']['payload']
@@ -273,8 +288,8 @@ async def start_rx():
         logger.debug(f"System: Respond by DM only")
     if repeater_enabled and interface2_enabled:
         logger.debug(f"System: Repeater Enabled for Channels: {repeater_channels}")
-    if radio_dectection_enabled:
-        logger.debug(f"System: Radio Detection Enabled using rigctld at {rigControlServerAddress} brodcasting to channels: {sigWatchBrodcastCh} for {get_freq_common_name(get_hamlib('f'))}")
+    if radio_detection_enabled:
+        logger.debug(f"System: Radio Detection Enabled using rigctld at {rigControlServerAddress} brodcasting to channels: {sigWatchBroadcastCh} for {get_freq_common_name(get_hamlib('f'))}")
 
     # here we go loopty loo
     while True:

requirements.txt

@@ -12,3 +12,8 @@ retry_requests
 numpy
 geopy
 schedule
+wikipedia
+langchain
+langchain-ollama
+ollama
+googlesearch-python