Merge pull request #178 from SpudGunMan/lab

Gemma3 LLM

.gitignore

@@ -1,15 +1,24 @@
 # config
 config.ini
 
-# Pickle files, specifically, bbsdb.pkl
-bbsdb.pkl
-bbsdm.pkl
+# Pickle files
+*.pkl
 
 # virtualenv
 venv/
 
+# logs
+logs/
+install_notes.txt
+
 # modified .service files
 etc/*.service
 
 # Python cache
 __pycache__/
+
+# rag data
+data/rag/*
+
+# qrz db
+data/qrz.db

CONTRIBUTING.md

@@ -1 +1,2 @@
-currently operating under "Agile software development" aka rolling code; no major structure. meshing about .. get it..
+currently operating under "Agile software development" aka rolling code; no major structure. meshing about .. get it..
+there is some ideas for adding code in modules/README.md

Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.13-slim
+ENV PYTHONUNBUFFERED=1
+
+RUN apt-get update && apt-get install -y gettext tzdata locales nano && rm -rf /var/lib/apt/lists/*
+
+# Set the locale default to en_US.UTF-8
+RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
+    dpkg-reconfigure --frontend=noninteractive locales && \
+    update-locale LANG=en_US.UTF-8
+ENV LANG="en_US.UTF-8"
+ENV TZ="America/Los_Angeles"
+
+WORKDIR /app
+COPY . /app
+COPY config.template /app/config.ini
+
+RUN pip install -r requirements.txt
+
+RUN chmod +x /app/script/docker/entrypoint.sh
+
+ENTRYPOINT ["/bin/bash", "/app/script/docker/entrypoint.sh"]

README.md

@@ -1,66 +1,194 @@
-# meshing-around
-Random Mesh Scripts for Network Testing and BBS Activities for Use with Meshtastic Nodes
+# Mesh Bot for Network Testing and BBS Activities
 
-![alt text](etc/pong-bot.jpg "Example Use")
+Welcome to the Mesh Bot project! This feature-rich bot is designed to enhance your [Meshtastic](https://meshtastic.org/docs/introduction/) network experience with a variety of powerful tools and fun features, connectivity and utility through text-based message delivery. Whether you're looking to perform network tests, send messages, or even play games, [mesh_bot.py](mesh_bot.py) has you covered. 
 
-## 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 for further processing.
+![Example Use](etc/pong-bot.jpg "Example Use")
 
-Along with network testing, this bot has a lot of other 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.
+## Key Features
+![CodeQlBadge](https://github.com/SpudGunMan/meshing-around/actions/workflows/dynamic/github-code-scanning/codeql/badge.svg)
 
-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` function. There is a small message board to fit in the constraints of Meshtastic for posting bulletin messages with `bbspost $subject #message`.
+### Intelligent Keyword Responder
+- **Automated Responses**: The bot detects keywords like "ping" and responds with "pong" in direct messages (DMs) or group channels.
+- **Customizable Triggers**: Monitor group channels for specific keywords and set custom responses.
+- **Emergency Response**: Monitor channels for keywords indicating emergencies and alert a wider audience.
+- **New Node Hello**: Greet new nodes on the mesh with a hello message
 
-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.
+### Network Tools
+- **Build, Test Local Mesh**: Ping allow for message delivery testing with more realistic packets vs. telemetry
+- **Test Node Hardware**: `test` will send incremental sized data into the radio buffer for overall length of message testing
 
-The bot can also be used to monitor a frequency and let you know when activity is seen. Using Hamlib to watch the S meter on a connected radio. You can send alerts to channels when a frequency is detected for 20 seconds within the thresholds set in config.ini
+### Multi Radio/Node Support
+- **Simultaneous Monitoring**: Monitor up to nine networks at the same time.
+- **Flexible Messaging**: send mail and messages, between networks.
 
-Any messages that are over 160 characters are chunked into 160 message bytes to help traverse hops, in testing, this keeps delivery success higher.
+### Advanced Messaging Capabilities
+- **Mail Messaging**: Leave messages for other devices, which are sent as DMs when the device is seen.
+- **Scheduler**: Schedule messages like weather updates or reminders for weekly VHF nets.
+- **Store and Forward**: Replay messages with the `messages` command, and log messages locally to disk.
+- **Send Mail**: Send mail to nodes using `bbspost @nodeNumber #message` or `bbspost @nodeShortName #message`.
+- **BBS Linking**: Combine multiple bots to expand BBS reach.
+- **E-Mail/SMS**: Send mesh-messages to E-Mail or SMS(Email) expanding visability.
+- **New Node Hello**: Send a hello to any new node seen in text message.
 
-- Various solar details for radio propagation
-  - `sun` and `moon` return info on rise and set local time
-  - `solar` gives an idea of the x-ray flux
-  - `hfcond` returns a table of HF solar conditions
-- Bulletin Board (BBS) functions
-  - `bbshelp` returns the following
-  - `bbslist` list the messages by ID and subject
-  - `bbsread` read a message example use: `bbsread #1`
-  - `bbspost` post a message to public board or send a DM example use: `bbspost $subject #message, or bbspost @nodeNumber #message`
-  - `bbsdelete` delete a message example use: `bbsdelete #4`
-- 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, NOAA data source (wxc is metric value)
-  - `wxa` and `wxalert` return NOAA alerts. Short title or expanded details
-  - `joke` tells a joke
-  - `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`
-  - `cmd` returns the list of commands (the help message)
+### Interactive AI and Data Lookup
+- **NOAA location Data**: Get localized weather(alerts), River Flow, and Tide information. Open-Meteo is used for wx only outside NOAA coverage. 
+- **Wiki Integration**: Look up data using Wikipedia results.
+- **Ollama LLM AI**: Interact with the [Ollama](https://github.com/ollama/ollama/tree/main/docs) LLM AI for advanced queries and responses.
+- **Satalite Pass Info**: Get passes for satalite at your location.
 
-## pong_bot.sh
-Stripped-down bot, mostly around for archive purposes. The mesh-bot enhanced modules can be disabled by config to disable features.
+### Proximity Alerts
+- **Location-Based Alerts**: Get notified when members arrive back at a configured lat/long, perfect for remote locations like campsites.
+- **High Flying Alerts**: Get notified when nodes with high altitude are seen on mesh
 
-## Hardware
-The project is written on Linux on a Pi and should work anywhere meshtastic Python modules will function, with any supported meshtastic hardware. While BLE and TCP will work, they are not as reliable as serial connections.
- - Firmware 2.3.14/15 could also have an issue with connectivity with slower devices.
+### CheckList / Check In Out
+- **Asset Tracking**: Maintain a list of node/asset checkin and checkout. Usefull for accountability of people, assets. Radio-Net, FEMA, Trailhead.
 
-## Install
-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.
-- Optionally
-- `install.sh` will automate optional venv and requirements installation.
-- `launch.sh` will activate and launch the app in the venv if built.
+### Fun and Games
+- **Built-in Games**: Enjoy games like DopeWars, Lemonade Stand, BlackJack, and VideoPoker.
+- **FCC ARRL QuizBot**: The exam question pool quiz-bot.
+- **Command-Based Gameplay**: Issue `games` to display help and start playing.
 
-### 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.
+### Radio Frequency Monitoring
+- **SNR RF Activity Alerts**: Monitor a radio frequency and get alerts when high SNR RF activity is detected.
+- **Hamlib Integration**: Use Hamlib (rigctld) to watch the S meter on a connected radio.
 
+### EAS Alerts
+- **FEMA iPAWS/EAS Alerts via API**: Use an internet-connected node to message Emergency Alerts from FEMA
+- **NOAA EAS Alerts via API**: Use an internet-connected node to message Emergency Alerts from NOAA.
+- **USGS Volcano Alerts via API**: Use an internet-connected node to message Emergency Alerts from USGS.
+- **EAS Alerts over the air**: Utilizing external tools to report EAS alerts offline over mesh.
+- **NINA alerts for Germany**: Emergency Alerts from xrepository.de feed
+
+### File Monitor Alerts
+- **File Monitor**: Monitor a flat/text file for changes, broadcast the contents of the message to the mesh channel.
+- **News File**: On request of news, the contents of the file are returned.
+
+### Data Reporting
+- **HTML Generator**: Visualize bot traffic and data flows with a built-in HTML generator for [data reporting](logs/README.md).
+
+### Robust Message Handling
+- **Message Chunking**: Automatically chunk messages over 160 characters to ensure higher delivery success across hops.
+
+## Getting Started
+This project is developed on Linux (specifically a Raspberry Pi) but should work on any platform where the [Meshtastic protobuf API](https://meshtastic.org/docs/software/python/cli/) modules are supported, and with any compatible [Meshtastic](https://meshtastic.org/docs/getting-started/) hardware. For pico or low-powered devices, see projects for embedding, [buildroot](https://github.com/buildroot-meshtastic/buildroot-meshtastic), also see [femtofox](https://github.com/noon92/femtofox). 🥔 Please use responsibly and follow local rulings for such equipment. This project captures packets, logs them, and handles over the air communications which can include PII such as GPS locations.
+
+### Quick Setup 
+#### Clone the Repository
+If you dont have git you will need it `sudo apt-get install git`
+```sh
+git clone https://github.com/spudgunman/meshing-around
 ```
-#config.ini
+- **Automated Installation**: `install.sh` will automate optional venv and requirements installation.
+- **Launch Script**: `launch.sh` only used in a venv install, to launch the bot and the report generator.
+
+## Full list of commands for the bot
+
+### Networking
+| Command | Description | ✅ Works Off-Grid |
+|---------|-------------|-
+| `ping`, `ack` | Return data for signal. Example: `ping 15 #DrivingI5` (activates auto-ping every 20 seconds for count 15 via DM only) | ✅ |
+| `cmd` | Returns the list of commands (the help message) | ✅ |
+| `history` | Returns the last commands run by user(s) | ✅ |
+| `lheard` | Returns the last 5 heard nodes with SNR. Can also use `sitrep` | ✅ |
+| `motd` | Displays the message of the day or sets it. Example: `motd $New Message Of the day` | ✅ |
+| `sysinfo` | Returns the bot node telemetry info | ✅ |
+| `test` | used to test the limits of data transfer `test 4` sends data to the maxBuffer limit (default 220) via DM only | ✅ |
+| `whereami` | Returns the address of the sender's location if known |
+| `whoami` | Returns details of the node asking, also returned when position exchanged 📍 | ✅ |
+| `whois` | Returns details known about node, more data with bbsadmin node | ✅ |
+
+### Radio Propagation & Weather Forcasting
+| Command | Description | |
+|---------|-------------|-------------------
+| `ea` and `ealert` | Return FEMA iPAWS/EAS alerts in USA or DE Headline or expanded details for USA | |
+| `hfcond` | Returns a table of HF solar conditions | |
+| `rlist` | Returns a table of nearby repeaters from RepeaterBook | |
+| `riverflow` | Return information from NOAA for river flow info. Example: `riverflow modules/settings.py`| |
+| `solar` | Gives an idea of the x-ray flux | |
+| `sun` and `moon` | Return info on rise and set local time | ✅ |
+| `tide` | Returns the local tides (NOAA data source) | |
+| `valert` | Returns USGS Volcano Data | |
+| `wx` | Return local weather forecast, NOAA or Open Meteo (which also has `wxc` for metric and imperial) | |
+| `wxa` and `wxalert` | Return NOAA alerts. Short title or expanded details | |
+| `mwx` | Return the NOAA Coastal Marine Forcast data | |
+
+### Bulletin Board & Mail
+| Command | Description | |
+|---------|-------------|-
+| `bbshelp` | Returns the following help message | ✅ |
+| `bbslist` | Lists the messages by ID and subject | ✅ |
+| `bbsread` | Reads a message. Example: `bbsread #1` | ✅ |
+| `bbspost` | Posts a message to the public board or sends a DM(Mail) Examples: `bbspost $subject #message`, `bbspost @nodeNumber #message`, `bbspost @nodeShortName #message` | ✅ |
+| `bbsdelete` | Deletes a message. Example: `bbsdelete #4` | ✅ |
+| `bbsinfo` | Provides stats on BBS delivery and messages (sysop) | ✅ |
+| `bbslink` | Links Bulletin Messages between BBS Systems | ✅ |
+| `email:`  | Sends email to address on file for the node or `email: bob@test.net # hello from mesh` | |
+| `sms:`    | Send sms-email to multiple address on file | |
+| `setemail`| Sets the email for easy communciations | |
+| `setsms` | Adds the SMS-Email for quick communications | |
+| `clearsms` | Clears all SMS-Emails on file for node | |
+
+### Data Lookup 
+| Command | Description | |
+|---------|-------------|-
+| `askai` and `ask:` | Ask Ollama LLM AI for a response. Example: `askai what temp do I cook chicken` | ✅ |
+| `messages` | Replays the last messages heard, like Store and Forward | ✅ |
+| `readnews` | returns the contents of a file (news.txt, by default) via the chunker on air | ✅ |
+| `satpass` | returns the pass info from API for defined NORAD ID in config or Example: `satpass 25544,33591`| |
+| `wiki:` | Searches Wikipedia and returns the first few sentences of the first result if a match. Example: `wiki: lora radio` |
+
+### CheckList
+| Command | Description | |
+|---------|-------------|-
+| `checkin` | Check in the node to the checklist database, you can add a note like `checkin ICO` or `checkin radio4` | ✅ |
+| `checkout` | Checkout the node in the checklist database, checkout all from node | ✅ |
+| `checklist` | Display the checklist database, with note | ✅ |
+
+### Games (via DM only)
+| Command | Description | |
+|---------|-------------|-
+| `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` and `score` | ✅ |
+| `hangman` | Plays the classic word guess game | ✅ |
+| `joke` | Tells a joke | ✅ |
+| `lemonstand` | Plays the classic Lemonade Stand finance game | ✅ |
+| `mastermind` | Plays the classic code-breaking game | ✅ |
+| `videopoker` | Plays basic 5-card hold Video Poker | ✅ |
+
+## Other Install Options
+
+### Docker Installation - handy for windows
+See further info on the [docker.md](script/docker/README.md)
+
+### Manual Install
+Install the required dependencies using pip:
+```sh
+pip install -r requirements.txt
+```
+
+Copy the configuration template to `config.ini` and edit it to suit your needs:
+```sh
+cp config.template config.ini
+```
+
+### Configuration Guide
+The following is documentation for the config.ini file
+
+If you have not done so, or want to 'factory reset', 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 the BLE MAC address, use:
+```sh
+meshtastic --ble-scan
+```
+
+**Note**: The code has been tested with a single BLE device and is written to support only one BLE port.
+
+```ini
+# config.ini
 # type can be serial, tcp, or ble.
 # port is the serial port to use; commented out will try to auto-detect
 # hostname is the IP address of the device to connect to for TCP type
-# mac is the MAC address of the device to connect to for ble type
+# mac is the MAC address of the device to connect to for BLE type
 
 [interface]
 type = serial
@@ -68,21 +196,45 @@ type = serial
 # hostname = 192.168.0.1
 # mac = 00:11:22:33:44:55
 
-# Additional interface for dual radio support See config.template for more.
+# Additional interface for dual radio support. See config.template for more.
 [interface2]
 enabled = False
 ```
-The following pair of settings determine how to respond: The default action is to not spam the default channel. Setting'respond_by_DM_only'` will force all messages to be sent to DM, which may not be wanted. Setting the value to False will allow responses in the channel for all to see.
 
-Setting the default channel is the channel that won't be spammed by the bot. It's the public default channel 0 on the new Meshtastic firmware. Anti-Spam is hard-coded into the responder to prevent abuse of the public channel.
-```
+### General Settings
+The following settings determine how the bot responds. By default, the bot will not spam the default channel. Setting `respond_by_dm_only` to `True` will force all messages to be sent via DM, which may not be desired. Setting it to [`False`] will allow responses in the channel for all to see. If you have no default channel you can set this value to `-1` or any unused channel index. You can also have the bot ignore the defaultChannel for any commands, but still observe the channel.
+
+```ini
 [general]
 respond_by_dm_only = True
 defaultChannel = 0
+ignoreDefaultChannel = False # ignoreDefaultChannel, the bot will ignore the default channel set above
+ignoreChannels = # ignoreChannels is a comma separated list of channels to ignore, e.g. 4,5
+cmdBang = False # require ! to be the first character in a command
+explicitCmd = True # require explicit command, the message will only be processed if it starts with a command word disable to get more activity
 ```
 
-Modules can be disabled or enabled.
+### Location Settings
+The weather forecasting defaults to NOAA, for locations outside the USA, you can set `UseMeteoWxAPI` to `True`, to use a global weather API. The `lat` and `lon` are default values when a node has no location data, as well as the default for all NOAA, repeater lookup. It is also the center of radius for Sentry.
+
+```ini
+[location]
+enabled = True
+lat = 48.50
+lon = -123.0
+UseMeteoWxAPI = True
+
+coastalEnabled = False # NOAA Coastal Data Enable NOAA Coastal Waters Forecasts and Tide
+# Find the correct costal weather directory at https://tgftp.nws.noaa.gov/data/forecasts/marine/coastal/
+# this map can help https://www.weather.gov/marine select location and then look at the 'Forecast-by-Zone Map'
+myCoastalZone = https://tgftp.nws.noaa.gov/data/forecasts/marine/coastal/pz/pzz135.txt # myCoastalZone is the .txt file with the forecast data
+coastalForecastDays = 3 # number of data points to return, default is 3
 ```
+
+### Module Settings
+Modules can be enabled or disabled as needed. They are essentally larger functions of code which you may not want on your mesh or in memory space.
+
+```ini
 [bbs]
 enabled = False
 
@@ -90,58 +242,307 @@ enabled = False
 DadJokes = False
 StoreForward = False
 ```
-The BBS has admin and block lists; see the [config.template](config.template)
 
-A repeater function for two different nodes and cross-posting messages. The'repeater_channels` is a list of repeater channel(s) that will be consumed and rebroadcast on the same number channel on the other device, node, or interface. Each node should have matching channel numbers. The channel names and PSK do not need to be the same on the nodes. With great power comes great responsibility; danger could lurk in the use of this feature! If you have the two nodes in the same radio configuration, you could create a feedback loop!!!
+### History 
+The history command shows the last commands the user ran, and [`lheard`] reflects the last users on the bot.
 
+```ini
+enableCmdHistory = True # history command enabler
+lheardCmdIgnoreNodes = # command history ignore list ex: 2813308004,4258675309
 ```
-# repeater module
-[repeater]
+
+### Sentry Settings
+
+Sentry Bot detects anyone coming close to the bot-node. uses the Location Lat/Lon value.
+
+```ini
+SentryEnabled = True # detect anyone close to the bot
+emailSentryAlerts = True # if SMTP enabled send alert to sysop email list
+SentryRadius = 100 # radius in meters to detect someone close to the bot
+SentryChannel = 9 # holdoff time multiplied by seconds(20) of the watchdog
+SentryHoldoff = 2 # channel to send a message to when the watchdog is triggered
+sentryIgnoreList = # list of ignored nodes numbers ex: 2813308004,4258675309
+highFlyingAlert = True # HighFlying Node alert
+highFlyingAlertAltitude = 2000 # Altitude in meters to trigger the alert
+```
+
+### E-Mail / SMS Settings
+To enable connectivity with SMTP allows messages from meshtastic into SMTP. The term SMS here is for connection via [carrier email](https://avtech.com/articles/138/list-of-email-to-sms-addresses/)
+
+```ini
+[smtp]
+# enable or disable the SMTP module, minimum required for outbound notifications
+enableSMTP = True # enable or disable the IMAP module for inbound email, not implimented yet
+enableImap = False # list of Sysop Emails seperate with commas, used only in emergemcy responder currently
+sysopEmails =
+# See config.template for all the SMTP settings
+SMTP_SERVER = smtp.gmail.com
+SMTP_AUTH = True
+EMAIL_SUBJECT = Meshtastic✉️
+```
+
+### Emergency Response Handler
+Traps the following ("emergency", "911", "112", "999", "police", "fire", "ambulance", "rescue") keywords. Responds to the user, and calls attention to the text message in logs and via another network or channel.
+
+```ini
+[emergencyHandler]
+enabled = True # enable or disable the emergency response handler
+alert_channel = 2 # channel to send a message to when the emergency handler is triggered
+alert_interface = 1
+```
+
+### EAS Alerting
+To Alert on Mesh with the EAS API you can set the channels and enable, checks every 20min.
+
+#### FEMA iPAWS/EAS and NINA
+This uses USA: SAME, FIPS, to locate the alerts in the feed. By default ignoring Test messages.
+
+```ini
+eAlertBroadcastEnabled = False # Goverment IPAWS/CAP Alert Broadcast
+eAlertBroadcastCh = 2,3 # Goverment Emergency IPAWS/CAP Alert Broadcast Channels
+ignoreFEMAenable = True # Ignore any headline that includes followig word list
+ignoreFEMAwords = test,exercise
+# comma separated list of FIPS codes to trigger local alert. find your FIPS codes at https://en.wikipedia.org/wiki/Federal_Information_Processing_Standard_state_code
+myFIPSList = 57,58,53
+# find your SAME https://www.weather.gov/nwr/counties comma separated list of SAME code to further refine local alert.
+mySAMEList = 053029,053073
+
+# To use other country services enable only a single optional serivce
+enableDEalerts = False # Use DE Alert Broadcast Data see template for filters
+myRegionalKeysDE = 110000000000,120510000000
+```
+
+#### NOAA EAS
+ This uses the defined lat-long of the bot for collecting of data from the API. see [File-Monitoring](#File-Monitoring) for ideas to collect EAS alerts from a RTL-SDR.
+
+```ini
+# EAS Alert Broadcast 
+wxAlertBroadcastEnabled = True
+# EAS Alert Broadcast Channels
+wxAlertBroadcastCh = 2,4
+ignoreEASenable = True # Ignore any headline that includes followig word list
+ignoreEASwords = test,advisory
+```
+
+#### USGS River flow data and Volcano alerts
+Using the USGS water data page locate a water flow device, for example Columbia River at Vancouver, WA - USGS-14144700
+
+Volcano Alerts use lat/long to determine ~1000km radius
+```ini
+[location]
+# USGS Hydrology unique identifiers, LID or USGS ID https://waterdata.usgs.gov
+riverList = 14144700 # example Mouth of Columbia River
+
+# USGS Volcano alerts Enable USGS Volcano Alert Broadcast
+volcanoAlertBroadcastEnabled = False
+volcanoAlertBroadcastCh = 2
+```
+
+### Repeater Settings
+A repeater function for two different nodes and cross-posting messages. The `repeater_channels` is a list of repeater channels that will be consumed and rebroadcast on the same number channel on the other device, node, or interface. Each node should have matching channel numbers. The channel names and PSK do not need to be the same on the nodes. Use this feature responsibly to avoid creating a feedback loop.
+
+```ini
+[repeater] # repeater module
 enabled = True
 repeater_channels = [2, 3]
 ```
-A module allowing a Hamlib compatible radio to connect to the bot, when functioning it will message the channel configured with a message of in use. **Requires hamlib/rigctld to be running as a service.**
 
+### Ollama (LLM/AI) Settings
+For Ollama to work, the command line `ollama run 'model'` needs to work properly. Ensure you have enough RAM and your GPU is working as expected. The default model for this project is set to `gemma3:270m`. Ollama can be remote [Ollama Server](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server) works on a pi58GB with 40 second or less response time.
+
+```ini
+# Enable ollama LLM see more at https://ollama.com
+ollama = True # Ollama model to use (defaults to gemma2:2b)
+ollamaModel = gemma3:latest # Ollama model to use (defaults to gemma3:270m)
+ollamaHostName = http://localhost:11434 # server instance to use (defaults to local machine install)
 ```
+
+Also see `llm.py` for changing the defaults of:
+
+```ini
+# LLM System Variables
+rawQuery = True # if True, the input is sent raw to the LLM if False, it is processed by the meshBotAI template
+
+# Used in the meshBotAI template (legacy)
+llmEnableHistory = True # enable history for the LLM model to use in responses adds to compute time
+llmContext_fromGoogle = True # enable context from google search results helps with responses accuracy
+googleSearchResults = 3 # number of google search results to include in the context more results = more compute time
+```
+Note for LLM in docker with [NVIDIA](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/docker-specialized.html). Needed for the container with ollama running. 
+
+### Radio Monitoring
+A module allowing a Hamlib compatible radio to connect to the bot. When functioning, it will message the configured channel with a message of in use. **Requires hamlib/rigctld to be running as a service.**
+
+```ini
 [radioMon]
-enabled = False
+enabled = True
 rigControlServerAddress = localhost:4532
-# channel to brodcast to can be 2,3
-sigWatchBrodcastCh = 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
+sigWatchBroadcastCh = 2 # channel to broadcast to can be 2,3
+signalDetectionThreshold = -10 # minimum SNR as reported by radio via hamlib
+signalHoldTime = 10 # hold time for high SNR
+signalCooldown = 5 # the following are combined to reset the monitor
 signalCycleLimit = 5
 ```
-# requirements
-can also be installed with `pip install -r requirements.txt`
 
+### File Monitoring
+Some dev notes for ideas of use
+
+```ini
+[fileMon]
+filemon_enabled = True
+file_path = alert.txt
+broadcastCh = 2,4
+enable_read_news = False
+news_file_path = news.txt
+news_random_line = False # only return a single random line from the news file
+enable_runShellCmd = False # enables running of bash commands runShell.sh demo for sysinfo
 ```
+
+#### Offline EAS
+
+To Monitor EAS with no internet connection see the following notes
+- [samedec](https://crates.io/crates/samedec) rust decoder much like multimon-ng
+  - [sameold](https://crates.io/crates/sameold) rust SAME message translator much like EAS2Text and dsame3
+
+no examples yet for these tools
+
+- [EAS2Text](https://github.com/A-c0rN/EAS2Text)
+  - depends on [multimon-ng](https://github.com/EliasOenal/multimon-ng), [direwolf](https://github.com/wb2osz/direwolf), [samedec](https://crates.io/crates/samedec) rust decoder much like multimon-ng
+- [dsame3](https://github.com/jamieden/dsame3)
+  - has a sample .ogg file for testing alerts
+
+The following example shell command can pipe the data using [etc/eas_alert_parser.py](etc/eas_alert_parser.py) to alert.txt
+```bash
+sox -t ogg WXR-RWT.ogg -esigned-integer -b16 -r 22050 -t raw - | multimon-ng -a EAS -v 1 -t raw - | python eas_alert_parser.py
+```
+The following example shell command will pipe rtl_sdr to alert.txt
+```bash
+rtl_fm -f 162425000 -s 22050 | multimon-ng -t raw -a EAS /dev/stdin | python eas_alert_parser.py
+```
+
+#### Newspaper on mesh
+a newspaper could be built by external scripts. could use Ollama to compile text via news web pages and write news.txt
+
+### Greet new nodes QRZ module
+This isnt QRZ.com this is Q code for who is calling me, this will track new nodes and say hello
+```ini
+[qrz] 
+enabled = True # QRZ Hello to new nodes
+qrz_hello_string = "send CMD or DM me for more info." # will be sent to all heard nodes once
+training = True # Training mode will not send the hello message to new nodes, use this to build up database
+```
+
+### Scheduler
+In the config.ini enable the module
+```ini
+[scheduler]
+# enable or disable the scheduler module
+enabled = False
+# interface to send the message to
+interface = 1
+# channel to send the message to
+channel = 2
+message = "MeshBot says Hello! DM for more info."
+# value can be min,hour,day,mon,tue,wed,thu,fri,sat,sun
+value =
+# interval to use when time is not set (e.g. every 2 days)
+interval = 
+# time of day in 24:00 hour format when value is 'day' and interval is not set
+time =
+```
+ The basic brodcast message can be setup in condig.ini. For advanced, See mesh_bot.py around the bottom of file, line [1491](https://github.com/SpudGunMan/meshing-around/blob/e94581936530c76ea43500eebb43f32ba7ed5e19/mesh_bot.py#L1491) to edit the schedule. See [schedule documentation](https://schedule.readthedocs.io/en/stable/) for more. Recomend to backup changes so they dont get lost.
+
+```python
+#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))
+```
+
+#### BBS Link
+The scheduler also handles the BBS Link Brodcast message, this would be an esxample of a mesh-admin channel on 8 being used to pass BBS post traffic between two bots as the initator, one direction pull.
+```python
+# Send bbslink looking for peers every other day at 10:00 using send_message function to channel 8 on device 1
+schedule.every(2).days.at("10:00").do(lambda: send_message("bbslink MeshBot looking for peers", 8, 0, 1))
+```
+```ini
+bbslink_enabled = True
+bbslink_whitelist = # list of whitelisted nodes numbers ex: 2813308004,4258675309 empty list allows all
+```
+
+### MQTT Notes
+There is no direct support for MQTT in the code, however, reports from Discord are that using [meshtasticd](https://meshtastic.org/docs/hardware/devices/linux-native-hardware/) with no radio and attaching the bot to the software node, which is MQTT-linked, allows routing. Tested working fully Firmware:2.5.15.79da236 with [mosquitto](https://meshtastic.org/docs/software/integrations/mqtt/mosquitto/).
+
+~~There also seems to be a quicker way to enable MQTT by having your bot node with the enabled [serial](https://meshtastic.org/docs/configuration/module/serial/) module with echo enabled and MQTT uplink and downlink. These two~~ 
+
+# Recognition
+
+I used ideas and snippets from other responder bots and want to call them out!
+
+### Inspiration and Code Snippets
+- [MeshLink](https://github.com/Murturtle/MeshLink)
+- [Meshtastic Python Examples](https://github.com/pdxlocations/meshtastic-Python-Examples)
+- [Meshtastic Matrix Relay](https://github.com/geoffwhittington/meshtastic-matrix-relay)
+
+### Games Ported From
+- [Lemonade Stand](https://github.com/tigerpointe/Lemonade-Stand/)
+- [Drug Wars](https://github.com/Reconfirefly/drugwars)
+- [BlackJack](https://github.com/Himan10/BlackJack)
+- [Video Poker Terminal Game](https://github.com/devtronvarma/Video-Poker-Terminal-Game)
+- [Python Mastermind](https://github.com/pwdkramer/pythonMastermind/)
+- [Golf](https://github.com/danfriedman30/pythongame)
+- ARRL Question Pool Data from https://github.com/russolsen/ham_radio_question_pool
+
+### Special Thanks
+- **xdep**: For the reporting tools.
+- **Nestpebble**: For new ideas and enhancements.
+- **mrpatrick1991**: For Docker configurations.
+- **[https://github.com/A-c0rN](A-c0rN)**: Assistance with iPAWS and EAS
+- **Mike O'Connell/skrrt**: For [eas_alert_parser](etc/eas_alert_parser.py) enhanced by **sheer.cold**
+- **PiDiBi**: For looking at test functions and other suggestions like wxc, CPU use, and alerting ideas.
+- **WH6GXZ nurse dude**: For bashing on installer, Volcano Alerts 🌋
+- **Josh**: For more bashing on installer!
+- **dj505**: trying it on windows!
+- **mikecarper**: ideas, and testing. hamtest
+- **c.merphy360**: high altitude alerts
+- **Cisien, bitflip, **Woof**, **propstg**, **trs2982**, **Josh** and Hailo1999**: For testing and feature ideas on Discord and GitHub.
+- **Meshtastic Discord Community**: For tossing out ideas and testing code.
+
+### Tools
+- **Node Backup Management**: [Node Slurper](https://github.com/SpudGunMan/node-slurper)
+
+### Requirements
+Python 3.8? or later is needed (docker on 3.13). The following can be installed with `pip install -r requirements.txt` or using the [install.sh](install.sh) script for venv and automation:
+
+```sh
 pip install meshtastic
 pip install pubsub
 ```
-mesh-bot enhancements
 
-```
+Mesh-bot enhancements:
+
+```sh
 pip install pyephem
 pip install requests
 pip install geopy
 pip install maidenhead
 pip install beautifulsoup4
 pip install dadjokes
+pip install schedule
+pip install wikipedia
 ```
 
-To enable emoji in the Debian console, install the fonts `sudo apt-get install fonts-noto-color-emoji`
+For the Ollama LLM:
 
-# Recognition
-I used ideas and snippets from other responder bots and want to call them out!
-- https://github.com/Murturtle/MeshLink
-- https://github.com/pdxlocations/Meshtastic-Python-Examples
-- https://github.com/geoffwhittington/meshtastic-matrix-relay
+```sh
+pip install googlesearch-python
+```
 
-GitHub user 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!
+To enable emoji in the Debian console, install the fonts:
 
+```sh
+sudo apt-get install fonts-noto-color-emoji
+```
+
+Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various licenses, see GitHub for details. No warranty is provided - use at your own risk.

config.template

@@ -8,39 +8,120 @@
 type = serial
 port = /dev/ttyACM0
 # port = /dev/ttyUSB0
-# port = COM1
-# hostname = 192.168.0.1
+# hostname = meshtastic.local
 # mac = 00:11:22:33:44:55
 
-# Additional interface for dual radio support
+# Additional interface for multi radio support
 [interface2]
 enabled = False
 type = serial
 port = /dev/ttyUSB0
-#port = /dev/ttyACM1
+# port = /dev/ttyACM1
 # port = COM1
-# hostname = meshtastic.local
+# hostname = localhost
 # mac = 00:11:22:33:44:55
 
+# example, the third interface would be [interface3] up to 9
+
 [general]
 # if False will respond on all channels but the default channel
 respond_by_dm_only = True
-# defaultChannel is the meshtastic default public channel
+# Allows auto-ping feature in a channel, False forces to 1 ping only
+autoPingInChannel = False
+# defaultChannel is the meshtastic default public channel, e.g. LongFast (if none use -1)
 defaultChannel = 0
+# ignoreDefaultChannel, the bot will ignore the default channel set above
+ignoreDefaultChannel = False
+# ignoreChannels is a comma separated list of channels to ignore, e.g. 4,5
+ignoreChannels = 
+# require ! to be the first character in a command
+cmdBang = False
+# require explicit command, the message will only be processed if it starts with a command word
+explicitCmd = True
+
 # motd is reset to this value on boot
 motd = Thanks for using MeshBOT! Have a good day!
 welcome_message = MeshBot, here for you like a friend who is not. Try sending: ping @foo or, cmd
+
+# whoami
+whoami = True
+
 # enable or disable the Joke module
 DadJokes = True
+DadJokesEmoji = False
+
+# 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 gemma3:270m)
+# ollamaModel = gemma3:latest
+# server instance to use (defaults to local machine install)
+ollamaHostName = http://localhost:11434
+# Produce LLM replies to messages that aren't commands?
+# If False, the LLM only replies to the "ask:" and "askai" commands.
+llmReplyToNonCommands = True
+# if True, the input is sent raw to the LLM, if False uses legacy template query
+rawLLMQuery = True 
+
 # StoreForward Enabled and Limits
 StoreForward = True
 StoreLimit = 3
+
+# history command 
+enableCmdHistory = True
+# command history ignore list ex: 2813308004,4258675309
+lheardCmdIgnoreNodes =
+
 # 24 hour clock
-zuluTime = True
+zuluTime = False
 # wait time for URL requests
-URL_TIMEOUT = 10
+urlTimeout = 10
+
 # logging to file of the non Bot messages
 LogMessagesToFile = False
+# Logging of system messages to file
+SyslogToFile = True
+# logging level for the bot (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+sysloglevel = DEBUG
+# Number of log files to keep in days, 0 to keep all
+log_backup_count = 32
+
+#Do not retry enabling interface if it fails, just exit to let OS restart the bot
+dont_retry_disconnect = False
+
+[emergencyHandler]
+# enable or disable the emergency response handler
+enabled = False
+# channel to send a message to when the emergency handler is triggered
+alert_channel = 2
+alert_interface = 1
+
+[sentry]
+# detect anyone close to the bot
+SentryEnabled = True
+emailSentryAlerts = False
+# radius in meters to detect someone close to the bot
+SentryRadius = 100
+# channel to send a message to when the watchdog is triggered
+SentryChannel = 2
+# holdoff time multiplied by seconds(20) of the watchdog
+SentryHoldoff = 9
+# list of ignored nodes numbers ex: 2813308004,4258675309
+sentryIgnoreList =
+
+# HighFlying Node alert
+highFlyingAlert = True
+# Altitude in meters to trigger the alert
+highFlyingAlertAltitude = 2000
+# Channel to send Alert when the high flying node is detected
+highFlyingAlertChannel = 2
+# list of nodes numbers to ignore high flying alert ex: 2813308004,4258675309
+highFlyingIgnoreList =
 
 [bbs]
 enabled = True
@@ -48,20 +129,98 @@ enabled = True
 bbs_ban_list = 
 # list of admin nodes numbers ex: 2813308004,4258675309
 bbs_admin_list = 
+# enable bbs synchronization with other nodes
+bbslink_enabled = False
+# list of whitelisted nodes numbers ex: 2813308004,4258675309 empty list allows all
+bbslink_whitelist = 
 
 # location module
 [location]
 enabled = True
 lat = 48.50
 lon = -123.0
-# weather forecast days, the first two rows are today and tonight
-DAYS_OF_WEATHER = 4
-# number of weather alerts to display
-ALERT_COUNT = 2
 
-# solar module
-[solar]
-enabled = True
+# Default to metric units rather than imperial
+useMetric = False
+
+# repeaterList lookup location (rbook / artsci)
+repeaterLookup = rbook
+
+# NOAA weather forecast days
+NOAAforecastDuration = 3
+# number of weather alerts to display
+NOAAalertCount = 2
+
+# use Open-Meteo API for weather data not NOAA useful for non US locations
+UseMeteoWxAPI = False
+
+# NOAA Coastal Data Enable NOAA Coastal Waters Forecasts and Tide
+coastalEnabled = False
+# Find the correct costal weather directory at https://tgftp.nws.noaa.gov/data/forecasts/marine/coastal/
+# pz = Puget Sound, ph = Honolulu HI, gm = Florida Keys, pk = Alaska
+# this map can help https://www.weather.gov/marine select location and then look at the 'Forecast-by-Zone Map'
+# myCoastalZone is the .txt file with the forecast data
+myCoastalZone = https://tgftp.nws.noaa.gov/data/forecasts/marine/coastal/pz/pzz135.txt
+# number of data points to return, default is 3
+coastalForecastDays = 3
+
+# NOAA USGS Hydrology river identifiers, LID or USGS ID https://waterdata.usgs.gov
+riverList = 
+
+# NOAA EAS Alert Broadcast
+wxAlertBroadcastEnabled = False
+#  Enable Ignore any message that includes following word list
+ignoreEASenable = False
+ignoreEASwords = test,advisory
+# EAS Alert Broadcast Channels
+wxAlertBroadcastCh = 2
+# Add extra location to the weather alert
+enableExtraLocationWx = False
+
+# Goverment Alert Broadcast defaults to FEMA IPAWS
+eAlertBroadcastEnabled = False
+# comma separated list of FIPS codes to trigger local alert. find your FIPS codes at https://en.wikipedia.org/wiki/Federal_Information_Processing_Standard_state_code
+myFIPSList = 57,58,53
+# find your SAME https://www.weather.gov/nwr/counties comma separated list of SAME code to further refine local alert.
+mySAMEList = 053029,053073
+# Goverment Alert Broadcast Channels
+eAlertBroadcastCh = 2
+#  Enable Ignore, headline that includes following word list
+ignoreFEMAenable = True
+ignoreFEMAwords = test,exercise
+
+# USGS Volcano alerts Enable USGS Volcano Alert Broadcast
+volcanoAlertBroadcastEnabled = False
+volcanoAlertBroadcastCh = 2
+# Enable Ignore any message that includes following word list
+ignoreUSGSEnable = False
+ignoreUSGSWords = test,advisory
+
+# Use DE Alert Broadcast Data
+enableDEalerts = False
+# comma separated list of regional codes trigger local alert.
+# find your regional codet at https://www.xrepository.de/api/xrepository/urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs_2021-07-31/download/Regionalschl_ssel_2021-07-31.json
+myRegionalKeysDE = 110000000000,120510000000
+
+# Satalite Pass Prediction
+# Register for free API https://www.n2yo.com/login/
+n2yoAPIKey = 
+# NORAD list https://www.n2yo.com/satellites/
+satList = 25544,7530
+
+# CheckList Checkin/Checkout
+[checklist]
+enabled = False
+checklist_db = data/checklist.db
+reverse_in_out = False
+
+[qrz]
+# QRZ Hello to new nodes with message
+enabled = False
+qrz_db = data/qrz.db
+qrz_hello_string = "MeshBot says Hello! DM for more info."
+# Training mode will not send the hello message to new nodes
+training = True
 
 # repeater module
 [repeater]
@@ -70,14 +229,29 @@ enabled = False
 # and rebroadcasted on the same channel on the other device/node/interface
 # with great power comes great responsibility, danger could be lurking in use of this feature
 # if you have the two nodes on the same radio configurations, you could create a feedback loop
-repeater_channels = 
+repeater_channels =
+
+[scheduler]
+# enable or disable the scheduler module
+enabled = False
+# interface to send the message to
+interface = 1
+# channel to send the message to
+channel = 2
+message = "MeshBot says Hello! DM for more info."
+# value can be min,hour,day,mon,tue,wed,thu,fri,sat,sun
+value =
+# interval to use when time is not set (e.g. every 2 days)
+interval = 
+# time of day in 24:00 hour format when value is 'day' and interval is not set
+time =
 
 [radioMon]
 # 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 also be  = 2,3
+sigWatchBroadcastCh = 2
 # minimum SNR as reported by radio via hamlib
 signalDetectionThreshold = -10
 # hold time for high SNR
@@ -85,3 +259,69 @@ signalHoldTime = 10
 # the following are combined to reset the monitor
 signalCooldown = 5
 signalCycleLimit = 5
+
+[fileMon]
+filemon_enabled = False
+file_path = alert.txt
+broadcastCh = 2
+enable_read_news = False
+news_file_path = news.txt
+# only return a single random line from the news file
+news_random_line = False
+# enable the use of exernal shell commands
+enable_runShellCmd = False
+
+[smtp]
+# enable or disable the SMTP module
+enableSMTP = False
+# enable or disable the IMAP module for inbound email
+enableImap = False
+# list of Sysop Emails seperate with commas
+sysopEmails =
+SMTP_SERVER = smtp.gmail.com
+# 587 SMTP over TLS/STARTTLS, 25 legacy SMTP, 465 SMTP over SSL
+SMTP_PORT = 587
+# Sender email: be mindful of public access, don't use your personal email
+FROM_EMAIL = none@gmail.com
+SMTP_AUTH = True
+SMTP_USERNAME = none@gmail.com
+SMTP_PASSWORD = none
+EMAIL_SUBJECT = Meshtastic✉️
+
+# IMAP not implimented yet
+IMAP_SERVER = imap.gmail.com
+# 993 IMAP over TLS/SSL, 143 legacy IMAP
+IMAP_PORT = 993
+# IMAP login usually same as SMTP
+IMAP_USERNAME = none@gmail.com
+IMAP_PASSWORD = none
+IMAP_FOLDER = inbox
+
+[games]
+# if hop limit for the user exceeds this value, the message will be dropped
+game_hop_limit = 5
+# enable or disable the games module(s)
+dopeWars = True
+lemonade = True
+blackjack = True
+videopoker = True
+mastermind = True
+golfsim = True
+hangman = True
+hamtest = True
+
+[messagingSettings]
+# delay in seconds for response to avoid message collision /throttling
+responseDelay = 2.2
+# delay in seconds for splits in messages to avoid message collision /throttling
+splitDelay = 2.5
+# message chunk size for sending at high success rate, chunkr allows exceeding by 3 characters
+MESSAGE_CHUNK_SIZE = 160
+# Request Acknowledgement of message OTA
+wantAck = False
+# Max limit buffer for radio testing
+maxBuffer = 200
+#Enable Extra logging of Hop count data
+enableHopLogs = False
+
+

data/README.md

@@ -0,0 +1 @@
+database admin tool is in [./etc/db_admin.py](../etc/db_admin.py)

etc/bbsdb_admin.py

@@ -1,21 +0,0 @@
-# Load the bbs messages from the database file to screen for admin functions
-import pickle # pip install pickle
-
-
-# load the bbs messages from the database file
-try:
-    with open('../bbsdb.pkl', 'rb') as f:
-        bbs_messages = pickle.load(f)
-except:
-    print ("\nSystem: bbsdb.pkl not found")
-
-try:
-    with open('../bbsdm.pkl', 'rb') as f:
-        bbs_dm = pickle.load(f)
-except:
-    print ("\nSystem: bbsdm.pkl not found")
-
-print ("\nSystem: bbs_messages")
-print (bbs_messages)
-print ("\nSystem: bbs_dm")
-print (bbs_dm)

etc/db_admin.py

@@ -0,0 +1,125 @@
+# Load the bbs messages from the database file to screen for admin functions
+import pickle # pip install pickle
+
+
+# load the bbs messages from the database file
+try:
+    with open('../data/bbsdb.pkl', 'rb') as f:
+        bbs_messages = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/bbsdb.pkl', 'rb') as f:
+            bbs_messages = pickle.load(f)
+    except Exception as e:
+        bbs_messages = "System: data/bbsdb.pkl not found"
+
+try:
+    with open('../data/bbsdm.pkl', 'rb') as f:
+        bbs_dm = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/bbsdm.pkl', 'rb') as f:
+            bbs_dm = pickle.load(f)
+    except Exception as e:
+        bbs_dm = "System: data/bbsdm.pkl not found"
+
+try:
+    with open('../data/email_db.pickle', 'rb') as f:
+        email_db = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/email_db.pickle', 'rb') as f:
+            email_db = pickle.load(f)
+    except Exception as e:
+        email_db = "System: data/email_db.pickle not found"
+
+try:
+    with open('../data/sms_db.pickle', 'rb') as f:
+        sms_db = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/sms_db.pickle', 'rb') as f:
+            sms_db = pickle.load(f)
+    except Exception as e:
+        sms_db = "System: data/sms_db.pickle not found"
+
+
+# Game HS tables
+try:
+    with open('../data/lemonstand.pkl', 'rb') as f:
+       lemon_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/lemonstand.pkl', 'rb') as f:
+            lemon_score = pickle.load(f)
+    except Exception as e:
+        lemon_score = "System: data/lemonstand.pkl not found"
+
+try:
+    with open('../data/dopewar_hs.pkl', 'rb') as f:
+        dopewar_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/dopewar_hs.pkl', 'rb') as f:
+            dopewar_score = pickle.load(f)
+    except Exception as e:
+        dopewar_score = "System: data/dopewar_hs.pkl not found"
+
+try:
+    with open('../data/blackjack_hs.pkl', 'rb') as f:
+        blackjack_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/blackjack_hs.pkl', 'rb') as f:
+            blackjack_score = pickle.load(f)
+    except Exception as e:
+        blackjack_score = "System: data/blackjack_hs.pkl not found"
+
+try:
+    with open('../data/videopoker_hs.pkl', 'rb') as f:
+        videopoker_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/videopoker_hs.pkl', 'rb') as f:
+            videopoker_score = pickle.load(f)
+    except Exception as e:
+        videopoker_score = "System: data/videopoker_hs.pkl not found"
+
+try:
+    with open('../mmind_hs.pkl', 'rb') as f:
+        mmind_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('mmind_hs.pkl', 'rb') as f:
+            mmind_score = pickle.load(f)
+    except Exception as e:
+        mmind_score = "System: mmind_hs.pkl not found"
+
+try:
+    with open('../data/golfsim_hs.pkl', 'rb') as f:
+        golfsim_score = pickle.load(f)
+except Exception as e:
+    try:
+        with open('data/golfsim_hs.pkl', 'rb') as f:
+            golfsim_score = pickle.load(f)
+    except Exception as e:
+        golfsim_score = "System: data/golfsim_hs.pkl not found"
+
+
+print ("\n Meshing-Around Database Admin Tool\n")
+print ("System: bbs_messages")
+print (bbs_messages)
+print ("\nSystem: bbs_dm")
+print (bbs_dm)
+print ("\nSystem: email_db")
+print (email_db)
+print ("\nSystem: sms_db")
+print (sms_db)
+print (f"\n\nGame HS tables\n")
+print (f"lemon:{lemon_score}")
+print (f"dopewar:{dopewar_score}")
+print (f"blackjack:{blackjack_score}")
+print (f"videopoker:{videopoker_score}")
+print (f"mmind:{mmind_score}")
+print (f"golfsim:{golfsim_score}")
+print ("\n")

etc/eas_alert_parser.py

@@ -0,0 +1,49 @@
+# Super sloppy multimon-ng output cleaner for processing by EAS2Text
+# I maed dis, sorta, mostly just mashed code I found or that chatGPT hallucinated
+# by Mike O'Connell/skrrt, no licence or whatever just be chill yo
+# enhanced by sheer.cold
+
+import re
+from EAS2Text import EAS2Text
+
+buff=[] # store messages for writing
+seen=set()
+pattern = re.compile(r'ZCZC.*?NWS-')
+
+# alternate regex for parsing multimon-ng output
+# provided by https://github.com/A-c0rN
+#reg = r"^.*?(NNNN|ZCZC)(?:-([A-Za-z0-9]{3})-([A-Za-z0-9]{3})-((?:-?[0-9]{6})+)\+([0-9]{4})-([0-9]{7})-(.{8})-)?.*?$"
+#prog = re.compile(reg, re.MULTILINE)
+#groups = prog.match(sameData).groups()
+
+while True:
+  try:
+    # Handle piped input
+    inp=input().strip()
+  except EOFError:
+    break
+  # potentially take multiple lines in one buffered input
+  for line in inp.splitlines():
+    # only want EAS lines
+    if line.startswith("EAS:") or line.startswith("EAS (part):"):
+      content=line.split(":", maxsplit=1)[1].strip()
+      if content=="NNNN": # end of EAS message
+        # write if we have something
+        if buff:
+          print("writing")
+          with open("alert.txt","w") as fh:
+            fh.write('\n'.join(buff))
+          # prepare for new data
+          buff.clear()
+          seen.clear()
+      elif content in seen:
+        # don't need repeats
+        continue
+      else:
+        # check for national weather service
+        match=pattern.search(content)
+        if match:
+          seen.add(content)
+          msg=EAS2Text(content).EASText
+          print("got message", msg)
+          buff.append(msg)

etc/mesh_bot.tmp

@@ -1,5 +1,6 @@
 # /etc/systemd/system/mesh_bot.service
 # sudo systemctl daemon-reload
+# sudo systemctl enable mesh_bot.service
 # sudo systemctl start mesh_bot.service
 
 [Unit]
@@ -7,8 +8,12 @@ Description=MESH-BOT
 After=network.target
 
 [Service]
+Type=simple
+User=pi
+Group=pi
 WorkingDirectory=/dir/
-ExecStart=/usr/bin/python /dir/launch.sh mesh
+ExecStart=python3 mesh_bot.py
+ExecStop=pkill -f mesh_bot.py
 
 # Disable Python's buffering of STDOUT and STDERR, so that output from the
 # service shows up immediately in systemd's logs

etc/mesh_bot_reporting.timer

@@ -0,0 +1,10 @@
+[Unit]
+Description=MeshingAround-ReportingTask
+
+[Timer]
+OnUnitActiveSec=1h
+OnbootSec=5min
+Unit=mesh_bot_reporting.service
+
+[Install]
+WantedBy=timers.target

etc/mesh_bot_reporting.tmp

@@ -0,0 +1,26 @@
+# /etc/systemd/system/mesh_bot_reporting.service
+# sudo systemctl daemon-reload
+# sudo systemctl enable mesh_bot_reporting.service
+# sudo systemctl start mesh_bot_reporting.service
+
+[Unit]
+Description=MeshingAround-Reporting
+After=network.target
+
+[Service]
+Type=oneshot
+User=pi
+Group=pi
+WorkingDirectory=/dir/
+ExecStart=python3 etc/report_generator5.py
+ExecStop=pkill -f report_generator5.py
+
+# Disable Python's buffering of STDOUT and STDERR, so that output from the
+# service shows up immediately in systemd's logs
+Environment=PYTHONUNBUFFERED=1
+
+Restart=on-failure
+Type=notify #try simple if any problems
+
+[Install]
+WantedBy=default.target

etc/mesh_bot_w3.tmp

@@ -0,0 +1,23 @@
+# /etc/systemd/system/mesh_bot_w3.service
+# sudo systemctl daemon-reload
+# sudo systemctl enable mesh_bot_w3.service
+# sudo systemctl start mesh_bot_w3.service
+
+[Unit]
+Description=MeshingAround-W3Server
+After=network.target
+
+[Service]
+Type=simple
+User=pi
+Group=pi
+WorkingDirectory=/dir/
+ExecStart=python3 modules/web.py
+ExecStop=pkill -f mesh_bot_w3.py
+
+# Disable Python's buffering of STDOUT and STDERR, so that output from the
+# service shows up immediately in systemd's logs
+Environment=PYTHONUNBUFFERED=1
+
+Restart=on-failure
+Type=notify #try simple if any problems

etc/pong_bot.tmp

@@ -1,5 +1,6 @@
 # /etc/systemd/system/pong_bot.service
 # sudo systemctl daemon-reload
+# sudo systemctl enable pong_bot.service
 # sudo systemctl start pong_bot.service
 
 [Unit]
@@ -7,8 +8,12 @@ Description=PONG-BOT
 After=network.target
 
 [Service]
+Type=simple
+User=pi
+Group=pi
 WorkingDirectory=/dir/
-ExecStart=/usr/bin/python /dir/launch.sh pong
+ExecStart=python3 pong_bot.py
+ExecStop=pkill -f pong_bot.py
 
 # Disable Python's buffering of STDOUT and STDERR, so that output from the
 # service shows up immediately in systemd's logs

etc/simulator.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+# # Simulate meshing-around de K7MHI 2024
+from modules.log import * # Import the logger; ### --> If you are reading this put the script in the project root <-- ###
+import time
+import random
+
+# Initialize the tool
+projectName = "example_handler" # name of _handler function to match the function name under test
+randomNode = False # Set to True to use random node IDs
+
+# bot.py Simulated functions
+def get_NodeID():
+    nodeList = [4258675309, 1212121212, 1234567890, 9876543210]
+    if randomNode: 
+        nodeID = random.choice(nodeList) # get a random node ID
+    else:
+        nodeID = nodeList[0]
+    return nodeID
+def get_name_from_number(nodeID, length='short', interface=1):
+    # return random name for nodeID
+    names = ["Max","Molly","Jake","Kelly"]
+    return names[nodeID % len(names)]
+# # end Initialization of the tool
+
+# # Function to handle, or the project in test
+
+
+def example_handler(message, nodeID, deviceID):
+    readableTime = time.ctime(time.time())
+    msg = "Hello World! "
+    msg += f" You are Node ID: {nodeID} "
+    msg += f" Its: {readableTime} "
+    msg += f" You just sent: {message}"
+    return msg
+
+
+# # end of function test code
+
+# # Simulate the meshing-around mesh-bot for prototyping new projects
+if __name__ == '__main__': # represents the bot's main loop
+    packet = ""
+    nodeInt = 1 # represents the device/node number
+    logger.info(f"System: Meshing-Around Simulator Starting for {projectName}")
+    nodeID = get_NodeID() # assign a nodeID
+    projectResponse = globals()[projectName]("", nodeID, nodeInt) # Call the project handler under test
+    while True: # represents the onReceive() loop in the bot.py
+        projectResponse = ""
+        responseLength = 0
+        if randomNode:
+            nodeID = get_NodeID() # assign a random nodeID
+        packet = input(f"CLIENT {nodeID} INPUT: " ) # Emulate the client input
+        if packet != "":
+            #try:
+            projectResponse = globals()[projectName](message = packet, nodeID = nodeID, deviceID = nodeInt)
+            # except Exception as e:
+            #     logger.error(f"System: Handler: {e}")
+            #     projectResponse = "Error in handler"
+            if projectResponse:
+                responseLength = len(projectResponse) # Evaluate the response length
+                logger.info(f"Device:{nodeInt} " + CustomFormatter.red + f"Sending {responseLength} long DM: " +\
+                        CustomFormatter.white + projectResponse + CustomFormatter.purple + " To: " + CustomFormatter.white + str(nodeID))
+        time.sleep(0.5)
+        nodeID = get_NodeID() # assign a nodeID
+# # End of launcher

etc/www/localscripts/css2

@@ -0,0 +1,252 @@
+/* cyrillic-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
+}
+/* cyrillic */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+/* greek-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+/* greek */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;
+}
+/* vietnamese */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+/* cyrillic-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
+}
+/* cyrillic */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+/* greek-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+/* greek */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;
+}
+/* vietnamese */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+/* cyrillic-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
+}
+/* cyrillic */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+/* greek-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+/* greek */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;
+}
+/* vietnamese */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 600;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+/* cyrillic-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;
+}
+/* cyrillic */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;
+}
+/* greek-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+1F00-1FFF;
+}
+/* greek */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;
+}
+/* vietnamese */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;
+}
+/* latin-ext */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7W0Q5n-wU.woff2) format('woff2');
+  unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
+}
+/* latin */
+@font-face {
+  font-family: 'Inter';
+  font-style: normal;
+  font-weight: 700;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}

etc/www/localscripts/leaflet.css

@@ -0,0 +1,640 @@
+/* required styles */
+
+.leaflet-pane,
+.leaflet-tile,
+.leaflet-marker-icon,
+.leaflet-marker-shadow,
+.leaflet-tile-container,
+.leaflet-pane > svg,
+.leaflet-pane > canvas,
+.leaflet-zoom-box,
+.leaflet-image-layer,
+.leaflet-layer {
+	position: absolute;
+	left: 0;
+	top: 0;
+	}
+.leaflet-container {
+	overflow: hidden;
+	}
+.leaflet-tile,
+.leaflet-marker-icon,
+.leaflet-marker-shadow {
+	-webkit-user-select: none;
+	   -moz-user-select: none;
+	        user-select: none;
+	  -webkit-user-drag: none;
+	}
+/* Prevents IE11 from highlighting tiles in blue */
+.leaflet-tile::selection {
+	background: transparent;
+}
+/* Safari renders non-retina tile on retina better with this, but Chrome is worse */
+.leaflet-safari .leaflet-tile {
+	image-rendering: -webkit-optimize-contrast;
+	}
+/* hack that prevents hw layers "stretching" when loading new tiles */
+.leaflet-safari .leaflet-tile-container {
+	width: 1600px;
+	height: 1600px;
+	-webkit-transform-origin: 0 0;
+	}
+.leaflet-marker-icon,
+.leaflet-marker-shadow {
+	display: block;
+	}
+/* .leaflet-container svg: reset svg max-width decleration shipped in Joomla! (joomla.org) 3.x */
+/* .leaflet-container img: map is broken in FF if you have max-width: 100% on tiles */
+.leaflet-container .leaflet-overlay-pane svg,
+.leaflet-container .leaflet-marker-pane img,
+.leaflet-container .leaflet-shadow-pane img,
+.leaflet-container .leaflet-tile-pane img,
+.leaflet-container img.leaflet-image-layer,
+.leaflet-container .leaflet-tile {
+	max-width: none !important;
+	max-height: none !important;
+	}
+
+.leaflet-container.leaflet-touch-zoom {
+	-ms-touch-action: pan-x pan-y;
+	touch-action: pan-x pan-y;
+	}
+.leaflet-container.leaflet-touch-drag {
+	-ms-touch-action: pinch-zoom;
+	/* Fallback for FF which doesn't support pinch-zoom */
+	touch-action: none;
+	touch-action: pinch-zoom;
+}
+.leaflet-container.leaflet-touch-drag.leaflet-touch-zoom {
+	-ms-touch-action: none;
+	touch-action: none;
+}
+.leaflet-container {
+	-webkit-tap-highlight-color: transparent;
+}
+.leaflet-container a {
+	-webkit-tap-highlight-color: rgba(51, 181, 229, 0.4);
+}
+.leaflet-tile {
+	filter: inherit;
+	visibility: hidden;
+	}
+.leaflet-tile-loaded {
+	visibility: inherit;
+	}
+.leaflet-zoom-box {
+	width: 0;
+	height: 0;
+	-moz-box-sizing: border-box;
+	     box-sizing: border-box;
+	z-index: 800;
+	}
+/* workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=888319 */
+.leaflet-overlay-pane svg {
+	-moz-user-select: none;
+	}
+
+.leaflet-pane         { z-index: 400; }
+
+.leaflet-tile-pane    { z-index: 200; }
+.leaflet-overlay-pane { z-index: 400; }
+.leaflet-shadow-pane  { z-index: 500; }
+.leaflet-marker-pane  { z-index: 600; }
+.leaflet-tooltip-pane   { z-index: 650; }
+.leaflet-popup-pane   { z-index: 700; }
+
+.leaflet-map-pane canvas { z-index: 100; }
+.leaflet-map-pane svg    { z-index: 200; }
+
+.leaflet-vml-shape {
+	width: 1px;
+	height: 1px;
+	}
+.lvml {
+	behavior: url(#default#VML);
+	display: inline-block;
+	position: absolute;
+	}
+
+
+/* control positioning */
+
+.leaflet-control {
+	position: relative;
+	z-index: 800;
+	pointer-events: visiblePainted; /* IE 9-10 doesn't have auto */
+	pointer-events: auto;
+	}
+.leaflet-top,
+.leaflet-bottom {
+	position: absolute;
+	z-index: 1000;
+	pointer-events: none;
+	}
+.leaflet-top {
+	top: 0;
+	}
+.leaflet-right {
+	right: 0;
+	}
+.leaflet-bottom {
+	bottom: 0;
+	}
+.leaflet-left {
+	left: 0;
+	}
+.leaflet-control {
+	float: left;
+	clear: both;
+	}
+.leaflet-right .leaflet-control {
+	float: right;
+	}
+.leaflet-top .leaflet-control {
+	margin-top: 10px;
+	}
+.leaflet-bottom .leaflet-control {
+	margin-bottom: 10px;
+	}
+.leaflet-left .leaflet-control {
+	margin-left: 10px;
+	}
+.leaflet-right .leaflet-control {
+	margin-right: 10px;
+	}
+
+
+/* zoom and fade animations */
+
+.leaflet-fade-anim .leaflet-tile {
+	will-change: opacity;
+	}
+.leaflet-fade-anim .leaflet-popup {
+	opacity: 0;
+	-webkit-transition: opacity 0.2s linear;
+	   -moz-transition: opacity 0.2s linear;
+	        transition: opacity 0.2s linear;
+	}
+.leaflet-fade-anim .leaflet-map-pane .leaflet-popup {
+	opacity: 1;
+	}
+.leaflet-zoom-animated {
+	-webkit-transform-origin: 0 0;
+	    -ms-transform-origin: 0 0;
+	        transform-origin: 0 0;
+	}
+.leaflet-zoom-anim .leaflet-zoom-animated {
+	will-change: transform;
+	}
+.leaflet-zoom-anim .leaflet-zoom-animated {
+	-webkit-transition: -webkit-transform 0.25s cubic-bezier(0,0,0.25,1);
+	   -moz-transition:    -moz-transform 0.25s cubic-bezier(0,0,0.25,1);
+	        transition:         transform 0.25s cubic-bezier(0,0,0.25,1);
+	}
+.leaflet-zoom-anim .leaflet-tile,
+.leaflet-pan-anim .leaflet-tile {
+	-webkit-transition: none;
+	   -moz-transition: none;
+	        transition: none;
+	}
+
+.leaflet-zoom-anim .leaflet-zoom-hide {
+	visibility: hidden;
+	}
+
+
+/* cursors */
+
+.leaflet-interactive {
+	cursor: pointer;
+	}
+.leaflet-grab {
+	cursor: -webkit-grab;
+	cursor:    -moz-grab;
+	cursor:         grab;
+	}
+.leaflet-crosshair,
+.leaflet-crosshair .leaflet-interactive {
+	cursor: crosshair;
+	}
+.leaflet-popup-pane,
+.leaflet-control {
+	cursor: auto;
+	}
+.leaflet-dragging .leaflet-grab,
+.leaflet-dragging .leaflet-grab .leaflet-interactive,
+.leaflet-dragging .leaflet-marker-draggable {
+	cursor: move;
+	cursor: -webkit-grabbing;
+	cursor:    -moz-grabbing;
+	cursor:         grabbing;
+	}
+
+/* marker & overlays interactivity */
+.leaflet-marker-icon,
+.leaflet-marker-shadow,
+.leaflet-image-layer,
+.leaflet-pane > svg path,
+.leaflet-tile-container {
+	pointer-events: none;
+	}
+
+.leaflet-marker-icon.leaflet-interactive,
+.leaflet-image-layer.leaflet-interactive,
+.leaflet-pane > svg path.leaflet-interactive,
+svg.leaflet-image-layer.leaflet-interactive path {
+	pointer-events: visiblePainted; /* IE 9-10 doesn't have auto */
+	pointer-events: auto;
+	}
+
+/* visual tweaks */
+
+.leaflet-container {
+	background: #ddd;
+	outline: 0;
+	}
+.leaflet-container a {
+	color: #0078A8;
+	}
+.leaflet-container a.leaflet-active {
+	outline: 2px solid orange;
+	}
+.leaflet-zoom-box {
+	border: 2px dotted #38f;
+	background: rgba(255,255,255,0.5);
+	}
+
+
+/* general typography */
+.leaflet-container {
+	font: 12px/1.5 "Helvetica Neue", Arial, Helvetica, sans-serif;
+	}
+
+
+/* general toolbar styles */
+
+.leaflet-bar {
+	box-shadow: 0 1px 5px rgba(0,0,0,0.65);
+	border-radius: 4px;
+	}
+.leaflet-bar a,
+.leaflet-bar a:hover {
+	background-color: #fff;
+	border-bottom: 1px solid #ccc;
+	width: 26px;
+	height: 26px;
+	line-height: 26px;
+	display: block;
+	text-align: center;
+	text-decoration: none;
+	color: black;
+	}
+.leaflet-bar a,
+.leaflet-control-layers-toggle {
+	background-position: 50% 50%;
+	background-repeat: no-repeat;
+	display: block;
+	}
+.leaflet-bar a:hover {
+	background-color: #f4f4f4;
+	}
+.leaflet-bar a:first-child {
+	border-top-left-radius: 4px;
+	border-top-right-radius: 4px;
+	}
+.leaflet-bar a:last-child {
+	border-bottom-left-radius: 4px;
+	border-bottom-right-radius: 4px;
+	border-bottom: none;
+	}
+.leaflet-bar a.leaflet-disabled {
+	cursor: default;
+	background-color: #f4f4f4;
+	color: #bbb;
+	}
+
+.leaflet-touch .leaflet-bar a {
+	width: 30px;
+	height: 30px;
+	line-height: 30px;
+	}
+.leaflet-touch .leaflet-bar a:first-child {
+	border-top-left-radius: 2px;
+	border-top-right-radius: 2px;
+	}
+.leaflet-touch .leaflet-bar a:last-child {
+	border-bottom-left-radius: 2px;
+	border-bottom-right-radius: 2px;
+	}
+
+/* zoom control */
+
+.leaflet-control-zoom-in,
+.leaflet-control-zoom-out {
+	font: bold 18px 'Lucida Console', Monaco, monospace;
+	text-indent: 1px;
+	}
+
+.leaflet-touch .leaflet-control-zoom-in, .leaflet-touch .leaflet-control-zoom-out  {
+	font-size: 22px;
+	}
+
+
+/* layers control */
+
+.leaflet-control-layers {
+	box-shadow: 0 1px 5px rgba(0,0,0,0.4);
+	background: #fff;
+	border-radius: 5px;
+	}
+.leaflet-control-layers-toggle {
+	background-image: url(images/layers.png);
+	width: 36px;
+	height: 36px;
+	}
+.leaflet-retina .leaflet-control-layers-toggle {
+	background-image: url(images/layers-2x.png);
+	background-size: 26px 26px;
+	}
+.leaflet-touch .leaflet-control-layers-toggle {
+	width: 44px;
+	height: 44px;
+	}
+.leaflet-control-layers .leaflet-control-layers-list,
+.leaflet-control-layers-expanded .leaflet-control-layers-toggle {
+	display: none;
+	}
+.leaflet-control-layers-expanded .leaflet-control-layers-list {
+	display: block;
+	position: relative;
+	}
+.leaflet-control-layers-expanded {
+	padding: 6px 10px 6px 6px;
+	color: #333;
+	background: #fff;
+	}
+.leaflet-control-layers-scrollbar {
+	overflow-y: scroll;
+	overflow-x: hidden;
+	padding-right: 5px;
+	}
+.leaflet-control-layers-selector {
+	margin-top: 2px;
+	position: relative;
+	top: 1px;
+	}
+.leaflet-control-layers label {
+	display: block;
+	}
+.leaflet-control-layers-separator {
+	height: 0;
+	border-top: 1px solid #ddd;
+	margin: 5px -10px 5px -6px;
+	}
+
+/* Default icon URLs */
+.leaflet-default-icon-path {
+	background-image: url(images/marker-icon.png);
+	}
+
+
+/* attribution and scale controls */
+
+.leaflet-container .leaflet-control-attribution {
+	background: #fff;
+	background: rgba(255, 255, 255, 0.7);
+	margin: 0;
+	}
+.leaflet-control-attribution,
+.leaflet-control-scale-line {
+	padding: 0 5px;
+	color: #333;
+	}
+.leaflet-control-attribution a {
+	text-decoration: none;
+	}
+.leaflet-control-attribution a:hover {
+	text-decoration: underline;
+	}
+.leaflet-container .leaflet-control-attribution,
+.leaflet-container .leaflet-control-scale {
+	font-size: 11px;
+	}
+.leaflet-left .leaflet-control-scale {
+	margin-left: 5px;
+	}
+.leaflet-bottom .leaflet-control-scale {
+	margin-bottom: 5px;
+	}
+.leaflet-control-scale-line {
+	border: 2px solid #777;
+	border-top: none;
+	line-height: 1.1;
+	padding: 2px 5px 1px;
+	font-size: 11px;
+	white-space: nowrap;
+	overflow: hidden;
+	-moz-box-sizing: border-box;
+	     box-sizing: border-box;
+
+	background: #fff;
+	background: rgba(255, 255, 255, 0.5);
+	}
+.leaflet-control-scale-line:not(:first-child) {
+	border-top: 2px solid #777;
+	border-bottom: none;
+	margin-top: -2px;
+	}
+.leaflet-control-scale-line:not(:first-child):not(:last-child) {
+	border-bottom: 2px solid #777;
+	}
+
+.leaflet-touch .leaflet-control-attribution,
+.leaflet-touch .leaflet-control-layers,
+.leaflet-touch .leaflet-bar {
+	box-shadow: none;
+	}
+.leaflet-touch .leaflet-control-layers,
+.leaflet-touch .leaflet-bar {
+	border: 2px solid rgba(0,0,0,0.2);
+	background-clip: padding-box;
+	}
+
+
+/* popup */
+
+.leaflet-popup {
+	position: absolute;
+	text-align: center;
+	margin-bottom: 20px;
+	}
+.leaflet-popup-content-wrapper {
+	padding: 1px;
+	text-align: left;
+	border-radius: 12px;
+	}
+.leaflet-popup-content {
+	margin: 13px 19px;
+	line-height: 1.4;
+	}
+.leaflet-popup-content p {
+	margin: 18px 0;
+	}
+.leaflet-popup-tip-container {
+	width: 40px;
+	height: 20px;
+	position: absolute;
+	left: 50%;
+	margin-left: -20px;
+	overflow: hidden;
+	pointer-events: none;
+	}
+.leaflet-popup-tip {
+	width: 17px;
+	height: 17px;
+	padding: 1px;
+
+	margin: -10px auto 0;
+
+	-webkit-transform: rotate(45deg);
+	   -moz-transform: rotate(45deg);
+	    -ms-transform: rotate(45deg);
+	        transform: rotate(45deg);
+	}
+.leaflet-popup-content-wrapper,
+.leaflet-popup-tip {
+	background: white;
+	color: #333;
+	box-shadow: 0 3px 14px rgba(0,0,0,0.4);
+	}
+.leaflet-container a.leaflet-popup-close-button {
+	position: absolute;
+	top: 0;
+	right: 0;
+	padding: 4px 4px 0 0;
+	border: none;
+	text-align: center;
+	width: 18px;
+	height: 14px;
+	font: 16px/14px Tahoma, Verdana, sans-serif;
+	color: #c3c3c3;
+	text-decoration: none;
+	font-weight: bold;
+	background: transparent;
+	}
+.leaflet-container a.leaflet-popup-close-button:hover {
+	color: #999;
+	}
+.leaflet-popup-scrolled {
+	overflow: auto;
+	border-bottom: 1px solid #ddd;
+	border-top: 1px solid #ddd;
+	}
+
+.leaflet-oldie .leaflet-popup-content-wrapper {
+	-ms-zoom: 1;
+	}
+.leaflet-oldie .leaflet-popup-tip {
+	width: 24px;
+	margin: 0 auto;
+
+	-ms-filter: "progid:DXImageTransform.Microsoft.Matrix(M11=0.70710678, M12=0.70710678, M21=-0.70710678, M22=0.70710678)";
+	filter: progid:DXImageTransform.Microsoft.Matrix(M11=0.70710678, M12=0.70710678, M21=-0.70710678, M22=0.70710678);
+	}
+.leaflet-oldie .leaflet-popup-tip-container {
+	margin-top: -1px;
+	}
+
+.leaflet-oldie .leaflet-control-zoom,
+.leaflet-oldie .leaflet-control-layers,
+.leaflet-oldie .leaflet-popup-content-wrapper,
+.leaflet-oldie .leaflet-popup-tip {
+	border: 1px solid #999;
+	}
+
+
+/* div icon */
+
+.leaflet-div-icon {
+	background: #fff;
+	border: 1px solid #666;
+	}
+
+
+/* Tooltip */
+/* Base styles for the element that has a tooltip */
+.leaflet-tooltip {
+	position: absolute;
+	padding: 6px;
+	background-color: #fff;
+	border: 1px solid #fff;
+	border-radius: 3px;
+	color: #222;
+	white-space: nowrap;
+	-webkit-user-select: none;
+	-moz-user-select: none;
+	-ms-user-select: none;
+	user-select: none;
+	pointer-events: none;
+	box-shadow: 0 1px 3px rgba(0,0,0,0.4);
+	}
+.leaflet-tooltip.leaflet-clickable {
+	cursor: pointer;
+	pointer-events: auto;
+	}
+.leaflet-tooltip-top:before,
+.leaflet-tooltip-bottom:before,
+.leaflet-tooltip-left:before,
+.leaflet-tooltip-right:before {
+	position: absolute;
+	pointer-events: none;
+	border: 6px solid transparent;
+	background: transparent;
+	content: "";
+	}
+
+/* Directions */
+
+.leaflet-tooltip-bottom {
+	margin-top: 6px;
+}
+.leaflet-tooltip-top {
+	margin-top: -6px;
+}
+.leaflet-tooltip-bottom:before,
+.leaflet-tooltip-top:before {
+	left: 50%;
+	margin-left: -6px;
+	}
+.leaflet-tooltip-top:before {
+	bottom: 0;
+	margin-bottom: -12px;
+	border-top-color: #fff;
+	}
+.leaflet-tooltip-bottom:before {
+	top: 0;
+	margin-top: -12px;
+	margin-left: -6px;
+	border-bottom-color: #fff;
+	}
+.leaflet-tooltip-left {
+	margin-left: -6px;
+}
+.leaflet-tooltip-right {
+	margin-left: 6px;
+}
+.leaflet-tooltip-left:before,
+.leaflet-tooltip-right:before {
+	top: 50%;
+	margin-top: -6px;
+	}
+.leaflet-tooltip-left:before {
+	right: 0;
+	margin-right: -12px;
+	border-left-color: #fff;
+	}
+.leaflet-tooltip-right:before {
+	left: 0;
+	margin-left: -12px;
+	border-right-color: #fff;
+	}

install.sh

@@ -1,78 +1,360 @@
 #!/bin/bash
+# meshing-around install helper script
 
 # install.sh
 cd "$(dirname "$0")"
-
-# add user to groups for serial access
-sudo usermod -a -G dialout $USER
-sudo usermod -a -G tty $USER
-
-# generate config file
-cp config.template config.ini
-
-# set virtual environment and install dependencies
+program_path=$(pwd)
+chronjob="0 1 * * * /usr/bin/python3 $program_path/etc/report_generator5.py"
+printf "\n########################"
 printf "\nMeshing Around Installer\n"
-echo "Do you want to install the bot in a virtual environment? (y/n)"
-read venv
+printf "########################\n"
+printf "\nThis script will try and install the Meshing Around Bot and its dependencies.\n"
+printf "Installer works best in raspian/debian/ubuntu or foxbuntu embedded systems.\n"
+printf "If there is a problem, try running the installer again.\n"
+printf "\nChecking for dependencies...\n"
 
-if [ $venv == "y" ]; then
-    # set virtual environment
-    echo "Creating virtual environment..."
-    python3 -m venv venv
-    source venv/bin/activate
-
-    # install dependencies
-    pip install -U -r requirements.txt
-else
-    printf "\nSkipping virtual environment...\n"
-    # install dependencies
-    echo "Are you on Raspberry Pi? should we add --break-system-packages to the pip install command? (y/n)"
-    read rpi
-    if [ $rpi == "y" ]; then
-        pip install -U -r requirements.txt --break-system-packages
-    else
-        pip install -U -r requirements.txt
+# check if we are in /opt/meshing-around
+if [ $program_path != "/opt/meshing-around" ]; then
+    printf "\nIt is suggested to project path to /opt/meshing-around\n"
+    printf "Do you want to move the project to /opt/meshing-around? (y/n)"
+    read move
+    if [[ $(echo "$move" | grep -i "^y") ]]; then
+        sudo mv $program_path /opt/meshing-around
+        cd /opt/meshing-around
+        printf "\nProject moved to /opt/meshing-around. re-run the installer\n"
+        exit 0
     fi
 fi
 
-printf "\n\n"
-echo "Which bot do you want to install as a service? (pong/mesh/n)"
-read bot
+# check write access to program path
+if [[ ! -w ${program_path} ]]; then
+    printf "\nInstall path not writable, try running the installer with sudo\n"
+    exit 1
+fi
 
-#set the correct path in the service file
-program_path=$(pwd)
+# if hostname = femtofox, then we are on embedded
+if [[ $(hostname) == "femtofox" ]]; then
+    printf "\nDetected femtofox embedded system\n"
+    embedded="y"
+else
+    # check if running on embedded
+    printf "\nAre You installing into an embedded system like a luckfox or -native? most should say no here (y/n)"
+    read embedded
+fi
+
+if [[ $(echo "${embedded}" | grep -i "^y") ]]; then
+    printf "\nDetected embedded skipping dependency installation\n"
+else
+    # Check and install dependencies
+    if ! command -v python3 &> /dev/null
+    then
+        printf "python3 not found, trying 'apt-get install python3 python3-pip'\n"
+        sudo apt-get install python3 python3-pip
+    fi
+    if ! command -v pip &> /dev/null
+    then
+        printf "pip not found, trying 'apt-get install python3-pip'\n"
+        sudo apt-get install python3-pip
+    fi
+
+    # double check for python3 and pip
+    if ! command -v python3 &> /dev/null
+    then
+        printf "python3 not found, please install python3 with your OS\n"
+        exit 1
+    fi
+    if ! command -v pip &> /dev/null
+    then
+        printf "pip not found, please install pip with your OS\n"
+        exit 1
+    fi
+    printf "\nDependencies installed\n"
+fi
+
+# add user to groups for serial access
+printf "\nAdding user to dialout, bluetooth, and tty groups for serial access\n"
+sudo usermod -a -G dialout $USER
+sudo usermod -a -G tty $USER
+sudo usermod -a -G bluetooth $USER
+
+# copy service files
 cp etc/pong_bot.tmp etc/pong_bot.service
 cp etc/mesh_bot.tmp etc/mesh_bot.service
+cp etc/mesh_bot_reporting.tmp etc/mesh_bot_reporting.service
+cp etc/mesh_bot_w3.tmp etc/mesh_bot_w3.service
+
+# generate config file, check if it exists
+if [[ -f config.ini ]]; then
+    printf "\nConfig file already exists, moving to backup config.old\n"
+    mv config.ini config.old
+fi
+
+cp config.template config.ini
+printf "\nConfig files generated!\n"
+
+# update lat,long in config.ini 
+latlong=$(curl --silent --max-time 20 https://ipinfo.io/loc || echo "48.50,-123.0")
+IFS=',' read -r lat lon <<< "$latlong"
+sed -i "s|lat = 48.50|lat = $lat|g" config.ini
+sed -i "s|lon = -123.0|lon = $lon|g" config.ini
+echo "lat,long updated in config.ini to $latlong"
+
+# check if running on embedded
+if [[ $(echo "${embedded}" | grep -i "^y") ]]; then
+    printf "\nDetected embedded skipping venv\n"
+else
+    printf "\nRecomended install is in a python virtual environment, do you want to use venv? (y/n)"
+    read venv
+
+    if [[ $(echo "${venv}" | grep -i "^y") ]]; then
+        # set virtual environment
+        if ! python3 -m venv --help &> /dev/null; then
+            printf "Python3/venv error, please install python3-venv with your OS\n"
+            exit 1
+        else
+            echo "The Following could be messy, or take some time on slower devices."
+            echo "Creating virtual environment..."
+            #check if python3 has venv module
+            if [[ -f venv/bin/activate ]]; then
+                printf "\nFound virtual environment for python\n"
+                python3 -m venv venv
+                source venv/bin/activate
+            else
+                printf "\nVirtual environment not found, trying `sudo apt-get install python3-venv`\n"
+                sudo apt-get install python3-venv
+            fi
+            # create virtual environment
+            python3 -m venv venv
+
+            # double check for python3-venv
+            if [[ -f venv/bin/activate ]]; then
+                printf "\nFound virtual environment for python\n"
+                source venv/bin/activate
+            else
+                printf "\nPython3 venv module not found, please install python3-venv with your OS\n"
+                exit 1
+            fi
+
+            printf "\nVirtual environment created\n"
+
+            # config service files for virtual environment
+            replace="s|python3 mesh_bot.py|/usr/bin/bash launch.sh mesh|g"
+            sed -i "$replace" etc/mesh_bot.service
+            replace="s|python3 pong_bot.py|/usr/bin/bash launch.sh pong|g"
+            sed -i "$replace" etc/pong_bot.service
+
+            # install dependencies to venv
+            pip install -U -r requirements.txt
+        fi
+    else
+        printf "\nSkipping virtual environment...\n"
+        # install dependencies to system
+        printf "Are you on Raspberry Pi(debian/ubuntu)?\nshould we add --break-system-packages to the pip install command? (y/n)"
+        read rpi
+        if [[ $(echo "${rpi}" | grep -i "^y") ]]; then
+            pip install -U -r requirements.txt --break-system-packages
+        else
+            pip install -U -r requirements.txt
+        fi
+    fi
+fi
+
+# if $1 is passed
+if [[ $1 == "pong" ]]; then
+    bot="pong"
+elif [[ $1 == "mesh" ]] || [[ $(echo "${embedded}" | grep -i "^y") ]]; then
+    bot="mesh"
+else
+    printf "\n\n"
+    echo "Which bot do you want to install as a service? Pong Mesh or None? (pong/mesh/n)"
+    echo "Pong bot is a simple bot for network testing"
+    echo "Mesh bot is a more complex bot more suited for meshing around"
+    echo "None will skip the service install"
+    read bot
+fi
+
+# set the correct path in the service file
 replace="s|/dir/|$program_path/|g"
 sed -i $replace etc/pong_bot.service
 sed -i $replace etc/mesh_bot.service
+sed -i $replace etc/mesh_bot_reporting.service
+sed -i $replace etc/mesh_bot_w3.service
+# set the correct user in the service file?
+
+#ask if we should add a user for the bot
+if [[ $(echo "${embedded}" | grep -i "^n") ]]; then
+    printf "\nDo you want to add a local user (meshbot) no login, for the bot? (y/n)"
+    read meshbotservice
+fi
+
+if [[ $(echo "${meshbotservice}" | grep -i "^y") ]] || [[ $(echo "${embedded}" | grep -i "^y") ]]; then
+    sudo useradd -M meshbot
+    sudo usermod -L meshbot
+    sudo groupadd meshbot
+    sudo usermod -a -G meshbot meshbot
+    whoami="meshbot"
+    echo "Added user meshbot with no home directory"
+else
+    whoami=$(whoami)
+fi
+# set basic permissions for the bot user
+sudo usermod -a -G dialout $whoami
+sudo usermod -a -G tty $whoami
+sudo usermod -a -G bluetooth $whoami
+echo "Added user $whoami to dialout, tty, and bluetooth groups"
+
+sudo chown -R $whoami:$whoami $program_path/logs
+sudo chown -R $whoami:$whoami $program_path/data
+echo "Permissions set for meshbot on logs and data directories"
+
+# set the correct user in the service file
+replace="s|User=pi|User=$whoami|g"
+sed -i $replace etc/pong_bot.service
+sed -i $replace etc/mesh_bot.service
+sed -i $replace etc/mesh_bot_reporting.service
+sed -i $replace etc/mesh_bot_w3.service
+replace="s|Group=pi|Group=$whoami|g"
+sed -i $replace etc/pong_bot.service
+sed -i $replace etc/mesh_bot.service
+sed -i $replace etc/mesh_bot_reporting.service
+sed -i $replace etc/mesh_bot_w3.service
 printf "\n service files updated\n"
 
-# ask if emoji font should be installed for linux
-echo "Do you want to install the emoji font for debian linux? (y/n)"
-read emoji
-if [ $emoji == "y" ]; then
-    sudo apt-get install fonts-noto-color-emoji
-    echo "Emoji font installed!, reboot to load the font"
-fi
-
-if [ $bot == "pong" ]; then
+if [[ $(echo "${bot}" | grep -i "^p") ]]; then
     # install service for pong bot
     sudo cp etc/pong_bot.service /etc/systemd/system/
-    exit 0
+    sudo systemctl enable pong_bot.service
+    sudo systemctl daemon-reload
+    echo "to start pong bot service: systemctl start pong_bot"
+    service="pong_bot"
 fi
 
-if [ $bot == "mesh" ]; then
+if [[ $(echo "${bot}" | grep -i "^m") ]]; then
     # install service for mesh bot
     sudo cp etc/mesh_bot.service /etc/systemd/system/
-    exit 0
+    sudo systemctl enable mesh_bot.service
+    sudo systemctl daemon-reload
+    echo "to start mesh bot service: systemctl start mesh_bot"
+    service="mesh_bot"
 fi
 
-if [ $bot == "n" ]; then
-    if [ -f launch.sh ]; then
-        printf "\nTo run the bot, use the command: ./launch.sh\n"
-        ./launch.sh
+# check if running on embedded for final steps
+if [[ $(echo "${embedded}" | grep -i "^n") ]]; then
+    # ask if emoji font should be installed for linux
+    printf "\nDo you want to install the emoji font for debian/ubuntu linux? (y/n)"
+    read emoji
+    if [[ $(echo "${emoji}" | grep -i "^y") ]]; then
+        sudo apt-get install -y fonts-noto-color-emoji
+        echo "Emoji font installed!, reboot to load the font"
+    fi
+
+    printf "\nOptionally if you want to install the multi gig LLM Ollama compnents we will execute the following commands\n"
+    printf "\ncurl -fsSL https://ollama.com/install.sh | sh\n"
+    printf "ollama pull gemma3:latest\n"
+    printf "Total download is multi GB, recomend pi5/8GB or better for this\n"
+    # ask if the user wants to install the LLM Ollama components
+    printf "\nDo you want to install the LLM Ollama components? (y/n)"
+    read ollama
+    if [[ $(echo "${ollama}" | grep -i "^y") ]]; then
+        curl -fsSL https://ollama.com/install.sh | sh
+
+        # ask if want to install gemma3:latest
+        printf "\n Ollama install done now we can install the gemma3:latest components\n"
+        echo "Do you want to install the gemma3:latest components? (y/n)"
+        read gemma
+        if [[ $(echo "${gemma}" | grep -i "^y") ]]; then
+            ollama pull gemma3:latest
+        fi
+    fi
+
+    # document the service install
+    printf "To install the %s service and keep notes, reference following commands:\n\n" "$service" > install_notes.txt
+    printf "sudo cp %s/etc/%s.service /etc/systemd/system/etc/%s.service\n" "$program_path" "$service" "$service" >> install_notes.txt
+    printf "sudo systemctl daemon-reload\n" >> install_notes.txt
+    printf "sudo systemctl enable %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl start %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl status %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl restart %s.service\n\n" "$service" >> install_notes.txt
+    printf "To see logs and stop the service:\n" >> install_notes.txt
+    printf "sudo journalctl -u %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl stop %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl disable %s.service\n" "$service" >> install_notes.txt
+    printf "Reporting chron job added to run report_generator5.py\n" >> install_notes.txt
+    printf "chronjob: %s\n" "$chronjob" >> install_notes.txt
+    
+    if [[ $(echo "${venv}" | grep -i "^y") ]]; then
+        printf "\nFor running on venv, virtual launch bot with './launch.sh mesh' in path $program_path\n" >> install_notes.txt
+    fi
+
+    read -p "Press enter to complete the installation, these commands saved to install_notes.txt"
+
+    printf "\nGood time to reboot? (y/n)"
+    read reboot
+    if [[ $(echo "${reboot}" | grep -i "^y") ]]; then
+        sudo reboot
+    fi
+else
+    # we are on embedded
+    # replace "type = serial" with "type = tcp" in config.ini
+    replace="s|type = serial|type = tcp|g"
+    sed -i "$replace" config.ini
+    # replace "# hostname = meshtastic.local" with "hostname = localhost" in config.ini
+    replace="s|# hostname = meshtastic.local|hostname = localhost|g"
+    sed -i "$replace" config.ini
+    printf "\nConfig file updated for embedded\n"
+    # add service dependency for meshtasticd into service file
+    #replace="s|After=network.target|After=network.target meshtasticd.service|g"
+
+    # Set up the meshing around service
+    sudo cp /opt/meshing-around/etc/$service.service /etc/systemd/system/$service.service
+    sudo systemctl daemon-reload
+    sudo systemctl enable $service.service
+    sudo systemctl start $service.service
+    # check if the cron job already exists
+    if ! crontab -l | grep -q "$chronjob"; then
+        # add the cron job to run the report_generator5.py script
+        (crontab -l 2>/dev/null; echo "$chronjob") | crontab -
+        printf "\nAdded cron job to run report_generator5.py\n"
+    else
+        printf "\nCron job already exists, skipping\n"
+    fi
+    printf "Reference following commands:\n\n" "$service" > install_notes.txt
+    printf "sudo systemctl status %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl start %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl restart %s.service\n\n" "$service" >> install_notes.txt
+    printf "To see logs and stop the service:\n" >> install_notes.txt
+    printf "sudo journalctl -u %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl stop %s.service\n" "$service" >> install_notes.txt
+    printf "sudo systemctl disable %s.service\n" "$service" >> install_notes.txt
 fi
 
-echo "Goodbye!"
+printf "\nInstallation complete!\n"
+
 exit 0
+
+# to uninstall the product run the following commands as needed
+
+# sudo systemctl stop mesh_bot
+# sudo systemctl disable mesh_bot
+# sudo systemctl stop pong_bot
+# sudo systemctl disable pong_bot
+# sudo systemctl stop mesh_bot_reporting
+# sudo systemctl disable mesh_bot_reporting
+# sudo rm /etc/systemd/system/mesh_bot.service
+# sudo rm /etc/systemd/system/mesh_bot_w3.service
+# sudo rm /etc/systemd/system/pong_bot.service
+# sudo systemctl daemon-reload
+# sudo systemctl reset-failed
+
+# sudo gpasswd -d meshbot dialout
+# sudo gpasswd -d meshbot tty
+# sudo gpasswd -d meshbot bluetooth
+# sudo groupdel meshbot
+# sudo userdel meshbot
+
+# sudo rm -rf /opt/meshing-around
+
+
+# after install shenannigans
+# add 'bee = True' to config.ini General section.
+# wget https://gist.github.com/MattIPv4/045239bc27b16b2bcf7a3a9a4648c08a -O bee.txt

launch.sh

@@ -1,24 +1,34 @@
 #!/bin/bash
+# This script launches the meshing-around bot or the report generator in python virtual environment
 
 # launch.sh
 cd "$(dirname "$0")"
 
-# activate the virtual environment if it exists
-if [ -d "venv" ]; then
-    source venv/bin/activate
-fi
 
 if [ ! -f "config.ini" ]; then
     cp config.template config.ini
 fi
 
-# launch the application
-if [ "$1" == "pong" ]; then
-    python pong_bot.py
-elif [ "$1" == "mesh" ]; then
-    python mesh_bot.py
+# activate the virtual environment if it exists
+if [ -d "venv" ]; then
+    source venv/bin/activate
 else
-    printf "\nPlease provide a bot to launch (pong/mesh)"
+    echo "Virtual environment not found, this tool just launches the .py in venv"
+    exit 1
+fi
+
+# launch the application
+if [[ "$1" == pong* ]]; then
+    python3 pong_bot.py
+elif [[ "$1" == mesh* ]]; then
+    python3 mesh_bot.py
+elif [ "$1" == "html" ]; then
+    python3 etc/report_generator.py
+elif [ "$1" == "html5" ]; then
+    python3 etc/report_generator5.py
+else
+    echo "Please provide a bot to launch (pong/mesh) or a report to generate (html/html5)"
+    exit 1
 fi
 
 deactivate

logs/README.md

@@ -0,0 +1,41 @@
+# Logs and Reports
+Logs will collect here. Give a day of logs or a bunch of messages to have good reports.
+
+## Reporting Note
+Reporting is via [../etc/report_generator5.py](../etc/report_generator5.py). The report_generator5 has newer feel and HTML5 coding. The index.html output is published in [../etc/www](../etc/www) there is a .cfg file created on first run for configuring values as needed (like moving web root)
+ - Make sure to have `SyslogToFile = True` and default of DEBUG log level to fully enable reporting! ‼️
+ - If you are in a venv and using launch.sh you can `launch.sh html5`
+
+![reportView](../etc/reporting.jpg)
+
+## Settings
+Logging messages to disk or 'Syslog' to disk uses the python native logging function.
+```conf
+[general]
+# logging to file of the non Bot messages only
+LogMessagesToFile = False
+# Logging of system messages to file, needed for reporting engine
+SyslogToFile = True
+# logging level for the bot (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+sysloglevel = DEBUG
+# Number of log files to keep in days, 0 to keep all
+log_backup_count = 32
+```
+## Web Reporting WebServer
+There is a web-server module. You can run `python3 modules/web.py` from the project root directory and it will serve up the web content.
+
+find it at. http://localhost:8420
+
+If you have linux-native running and errors such as..
+```bash
+  File "/usr/lib/python3.11/http/server.py", line 136, in server_bind
+    socketserver.TCPServer.server_bind(self)
+  File "/usr/lib/python3.11/socketserver.py", line 472, in server_bind
+    self.socket.bind(self.server_address)
+```
+modify the modules/web.py to use a real IP address, meshtasticD-native is binding to 127.0.0.1
+
+```python
+# Set the desired IP address
+server_ip = '127.0.0.1'
+```

modules/README.md

@@ -0,0 +1,54 @@
+# Modules and Adding stuff
+
+To help with code testing see `etc/simulator.py` to simulate a bot. I also enjoy meshtasticd(linux-native) in noradio with MQTT server and client to just emulate a mesh.
+
+## By following these steps, you can add a new bbs option to the bot.
+
+1. **Define the Command Handler**:
+   Add a new function in mesh_bot.py to handle the new command. For example, if you want to add a command `newcommand`:
+   ```python
+   def handle_newcommand(message, message_from_id, deviceID):
+       return "This is a response from the new command."
+   ```
+   Additionally you can add a whole new module.py, I recommend doing this if you need to import more stuff, try and wedge it into similar spots if you can. You will need to import the file as well, look further at `modules/system.py` for more.
+2. **Add the Command to the Auto Response**:
+   Update the auto_response function in mesh_bot.py to include the new command:
+   ```python
+   def auto_response(message, snr, rssi, hop, pkiStatus, message_from_id, channel_number, deviceID, isDM):
+       #...
+       "newcommand": lambda: handle_newcommand(message, message_from_id, deviceID),
+       #...
+   ```
+3. **Update the Trap List and Help**:
+    A quick way to do this is to edit the line 16/17 in `modules/system.py` to include the new command:
+    ```python
+    #...
+    trap_list = ("cmd", "cmd?", "newcommand")  # default trap list, with the new command added
+    help_message = "Bot CMD?:newcommand, "
+    #...
+    ```
+
+    **If looking to merge** the prefered way would be to update `modules/system.py` Adding this block below `ping` which ends around line 28:
+    ```python
+    # newcommand Configuration
+    newcommand_enabled = True  # settings.py handles the config.ini values; this is a placeholder
+    if newcommand_enabled:
+         trap_list_newcommand = ("newcommand",)
+         trap_list = trap_list + trap_list_newcommand
+         help_message = help_message + ", newcommand"
+    ```
+
+5. **Test the New Command**:
+   Run MeshBot and test the new command by sending a message with the command `newcommand` to ensure it responds correctly.
+
+
+### Running a Shell command
+
+Using the above example and enabling the filemon module, you can make a command which calls a bash file to do things on the system.
+
+```python
+def auto_response(message, snr, rssi, hop, pkiStatus, message_from_id, channel_number, deviceID, isDM):
+    #...
+    "switchON": lambda: call_external_script(message)
+```
+This would call the default script located in script/runShell.sh and return its output.

modules/bbstools.py

@@ -3,8 +3,9 @@
 
 import pickle # pip install pickle
 from modules.log import *
+import time
 
-trap_list_bbs = ("bbslist", "bbspost", "bbsread", "bbsdelete", "bbshelp")
+trap_list_bbs = ("bbslist", "bbspost", "bbsread", "bbsdelete", "bbshelp", "bbsinfo", "bbslink", "bbsack")
 
 # global message list, later we will use a pickle on disk
 bbs_messages = []
@@ -14,19 +15,19 @@ def load_bbsdb():
     global bbs_messages
     # load the bbs messages from the database file
     try:
-        with open('bbsdb.pkl', 'rb') as f:
+        with open('data/bbsdb.pkl', 'rb') as f:
             bbs_messages = pickle.load(f)
-    except:
+    except Exception as e:
         bbs_messages = [[1, "Welcome to meshBBS", "Welcome to the BBS, please post a message!",0]]
-        logger.debug("\nSystem: Creating new bbsdb.pkl")
-        with open('bbsdb.pkl', 'wb') as f:
+        logger.debug("System: Creating new data/bbsdb.pkl")
+        with open('data/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")
-    with open('bbsdb.pkl', 'wb') as f:
+    logger.debug("System: Saving data/bbsdb.pkl")
+    with open('data/bbsdb.pkl', 'wb') as f:
         pickle.dump(bbs_messages, f)
 
 def bbs_help():
@@ -77,6 +78,12 @@ def bbs_post_message(subject, message, fromNode):
     if str(fromNode) in bbs_ban_list:
         logger.warning(f"System: Naughty node {fromNode}, tried to post a message: {subject}, {message} and was dropped.")
         return "Message posted. ID is: " + str(messageID)
+    
+    # validate not a duplicate message
+    for msg in bbs_messages:
+        if msg[1].strip().lower() == subject.strip().lower() and msg[2].strip().lower() == message.strip().lower():
+            messageID = msg[0]
+            return "Message posted. ID is: " + str(messageID)
 
     # append the message to the list
     bbs_messages.append([messageID, subject, message, fromNode])
@@ -100,20 +107,20 @@ def bbs_read_message(messageID = 0):
 def save_bbsdm():
     global bbs_dm
     # save the bbs messages to the database file
-    logger.debug("System: Saving Updated BBS Direct Messages bbsdm.pkl")
-    with open('bbsdm.pkl', 'wb') as f:
+    logger.debug("System: Saving Updated BBS Direct Messages data/bbsdm.pkl")
+    with open('data/bbsdm.pkl', 'wb') as f:
         pickle.dump(bbs_dm, f)
 
 def load_bbsdm():
     global bbs_dm
     # load the bbs messages from the database file
     try:
-        with open('bbsdm.pkl', 'rb') as f:
+        with open('data/bbsdm.pkl', 'rb') as f:
             bbs_dm = pickle.load(f)
     except:
         bbs_dm = [[1234567890, "Message", 1234567890]]
-        logger.debug("\nSystem: Creating new bbsdm.pkl")
-        with open('bbsdm.pkl', 'wb') as f:
+        logger.debug("System: Creating new data/bbsdm.pkl")
+        with open('data/bbsdm.pkl', 'wb') as f:
             pickle.dump(bbs_dm, f)
 
 def bbs_post_dm(toNode, message, fromNode):
@@ -130,6 +137,11 @@ def bbs_post_dm(toNode, message, fromNode):
     save_bbsdm()
     return "BBS DM Posted for node " + str(toNode)
 
+def get_bbs_stats():
+    global bbs_messages, bbs_dm
+    # Return some stats on the bbs pending messages and total posted messages
+    return f"📡BBSdb has {len(bbs_messages)} messages.\nDirect ✉️ Messages waiting: {(len(bbs_dm) - 1)}"
+
 def bbs_check_dm(toNode):
     global bbs_dm
     # Check for any messages for toNode
@@ -151,6 +163,48 @@ def bbs_delete_dm(toNode, message):
             return "System: cleared mail for" + str(toNode)
     return "System: No DM found for node " + str(toNode)
 
+def bbs_sync_posts(input, peerNode, RxNode):
+    messageID =  0
+
+    # check if the bbs link is enabled
+    if bbs_link_whitelist != ['']:
+        if str(peerNode) not in bbs_link_whitelist:
+            logger.warning(f"System: BBS Link is disabled for node {peerNode}.")
+            return "System: BBS Link is disabled for your node."
+    if bbs_link_enabled == False:
+        return "System: BBS Link is disabled."
+    
+    # respond when another bot asks for the bbs posts to sync
+    if "bbslink" in input.lower():
+        if "$" in input and "#" in input:
+            #store the message
+            subject = input.split("$")[1].split("#")[0]
+            body = input.split("#")[1]
+            bbs_post_message(subject, body, peerNode)
+            messageID = input.split(" ")[1]
+            return f"bbsack {messageID}"
+    elif "bbsack" in input.lower():
+        # increment the messageID
+        if len(input.split(" ")) > 1:
+            try:
+                messageID = int(input.split(" ")[1]) + 1
+            except:
+                return "link error"
+        else:
+            return "link error"
+
+    # send message with delay to keep chutil happy
+    if messageID < len(bbs_messages):
+        logger.debug(f"System: Sending bbslink message {messageID} to peer " + str(peerNode))
+        time.sleep(5 + responseDelay)
+        # every 5 messages add extra delay
+        if messageID % 5 == 0:
+            time.sleep(10 + responseDelay)
+        return f"bbslink {messageID} ${bbs_messages[messageID][1]} #{bbs_messages[messageID][2]}"
+    else:
+        logger.debug("System: bbslink sync complete with peer " + str(peerNode))
+
+
 #initialize the bbsdb's
 load_bbsdb()
 load_bbsdm()

modules/checklist.py

@@ -0,0 +1,160 @@
+# Checkin Checkout database module for the bot
+# K7MHI Kelly Keeton 2024
+
+import sqlite3
+from modules.log import *
+import time
+
+trap_list_checklist = ("checkin", "checkout", "checklist", "purgein", "purgeout")
+
+def initialize_checklist_database():
+    # create the database
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    # Check if the checkin table exists, and create it if it doesn't
+    c.execute('''CREATE TABLE IF NOT EXISTS checkin
+                 (checkin_id INTEGER PRIMARY KEY, checkin_name TEXT, checkin_date TEXT, checkin_time TEXT, location TEXT, checkin_notes TEXT)''')
+    # Check if the checkout table exists, and create it if it doesn't
+    c.execute('''CREATE TABLE IF NOT EXISTS checkout
+                 (checkout_id INTEGER PRIMARY KEY, checkout_name TEXT, checkout_date TEXT, checkout_time TEXT, location TEXT, checkout_notes TEXT)''')
+    conn.commit()
+    conn.close()
+    logger.debug("System: Ensured data/checklist.db exists with required tables")
+
+def checkin(name, date, time, location, notes):
+    location = ", ".join(map(str, location))
+    # checkin a user
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    try:
+        c.execute("INSERT INTO checkin (checkin_name, checkin_date, checkin_time, location, checkin_notes) VALUES (?, ?, ?, ?, ?)", (name, date, time, location, notes))
+        # # remove any checkouts that are older than the checkin
+        # c.execute("DELETE FROM checkout WHERE checkout_date < ? OR (checkout_date = ? AND checkout_time < ?)", (date, date, time))
+    except sqlite3.OperationalError as e:
+        if "no such table" in str(e):
+            initialize_checklist_database()
+            c.execute("INSERT INTO checkin (checkin_name, checkin_date, checkin_time, location, checkin_notes) VALUES (?, ?, ?, ?, ?)", (name, date, time, location, notes))
+        else:
+            raise
+    conn.commit()
+    conn.close()
+    if reverse_in_out:
+        return "Checked✅Out: " + str(name)
+    else:
+        return "Checked✅In: " + str(name)
+
+def delete_checkin(checkin_id):
+    # delete a checkin
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    c.execute("DELETE FROM checkin WHERE checkin_id = ?", (checkin_id,))
+    conn.commit()
+    conn.close()
+    return "Checkin deleted." + str(checkin_id)
+
+def checkout(name, date, time_str, location, notes):
+    location = ", ".join(map(str, location))
+    # checkout a user
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    try:
+        # Check if the user has a checkin before checking out
+        c.execute("""
+            SELECT checkin_id FROM checkin 
+            WHERE checkin_name = ? 
+            AND NOT EXISTS (
+            SELECT 1 FROM checkout 
+            WHERE checkout_name = checkin_name 
+            AND (checkout_date > checkin_date OR (checkout_date = checkin_date AND checkout_time > checkin_time))
+            )
+            ORDER BY checkin_date DESC, checkin_time DESC 
+            LIMIT 1
+        """, (name,))
+        checkin_record = c.fetchone()
+        if checkin_record:
+            c.execute("INSERT INTO checkout (checkout_name, checkout_date, checkout_time, location, checkout_notes) VALUES (?, ?, ?, ?, ?)", (name, date, time_str, location, notes))
+            # calculate length of time checked in
+            c.execute("SELECT checkin_time FROM checkin WHERE checkin_id = ?", (checkin_record[0],))
+            checkin_time = c.fetchone()[0]
+            checkin_datetime = time.strptime(date + " " + checkin_time, "%Y-%m-%d %H:%M:%S")
+            time_checked_in_seconds = time.time() - time.mktime(checkin_datetime)
+            timeCheckedIn = time.strftime("%H:%M:%S", time.gmtime(time_checked_in_seconds))
+            # # remove the checkin record older than the checkout
+            # c.execute("DELETE FROM checkin WHERE checkin_date < ? OR (checkin_date = ? AND checkin_time < ?)", (date, date, time_str))
+    except sqlite3.OperationalError as e:
+        if "no such table" in str(e):
+            initialize_checklist_database()
+            c.execute("INSERT INTO checkout (checkout_name, checkout_date, checkout_time, location, checkout_notes) VALUES (?, ?, ?, ?, ?)", (name, date, time_str, location, notes))
+        else:
+            raise
+    conn.commit()
+    conn.close()
+    if checkin_record:
+        if reverse_in_out:
+            return "Checked⌛️In: " + str(name) + " duration " + timeCheckedIn
+        else:
+            return "Checked⌛️Out: " + str(name) + " duration " + timeCheckedIn
+    else:
+        return "None found for " + str(name)
+
+def delete_checkout(checkout_id):
+    # delete a checkout
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    c.execute("DELETE FROM checkout WHERE checkout_id = ?", (checkout_id,))
+    conn.commit()
+    conn.close()
+    return "Checkout deleted." + str(checkout_id)
+
+def list_checkin():
+    # list checkins
+    conn = sqlite3.connect(checklist_db)
+    c = conn.cursor()
+    c.execute("""
+        SELECT * FROM checkin
+        WHERE checkin_id NOT IN (
+            SELECT checkin_id FROM checkout
+            WHERE checkout_date > checkin_date OR (checkout_date = checkin_date AND checkout_time > checkin_time)
+        )
+    """)
+    rows = c.fetchall()
+    conn.close()
+    timeCheckedIn = ""
+    checkin_list = ""
+    for row in rows:
+        #calculate length of time checked in
+        timeCheckedIn = time.strftime("%H:%M:%S", time.gmtime(time.time() - time.mktime(time.strptime(row[2] + " " + row[3], "%Y-%m-%d %H:%M:%S"))))
+        checkin_list += "ID: " + row[1] + " checked-In for " + timeCheckedIn
+        if row[5] != "":
+            checkin_list += "📝" + row[5]
+        if row != rows[-1]:
+            checkin_list += "\n"
+    # if empty list
+    if checkin_list == "":
+        return "No data to display."
+    return checkin_list
+
+def process_checklist_command(nodeID, message, name="none", location="none"):
+    current_date = time.strftime("%Y-%m-%d")
+    current_time = time.strftime("%H:%M:%S")
+    # if user on bbs_ban_list reject command
+    if str(nodeID) in bbs_ban_list:
+        logger.warning("System: Checklist attempt from the ban list")
+        return "unable to process command"
+    try:
+        comment = message.split(" ", 1)[1]
+    except IndexError:
+        comment = ""
+    # handle checklist commands
+    if ("checkin" in message.lower() and not reverse_in_out) or ("checkout" in message.lower() and reverse_in_out):
+        return checkin(name, current_date, current_time, location, comment)
+    elif ("checkout" in message.lower() and not reverse_in_out) or ("checkin" in message.lower() and reverse_in_out):
+        return checkout(name, current_date, current_time, location, comment)
+    elif "purgein" in message.lower():
+        return delete_checkin(nodeID)
+    elif "purgeout" in message.lower():
+        return delete_checkout(nodeID)
+    elif "checklist" in message.lower():
+        return list_checkin()
+    else:
+        return "Invalid command."

modules/filemon.py

@@ -0,0 +1,84 @@
+# File monitor module for the meshing-around bot
+# 2024 Kelly Keeton K7MHI
+
+from modules.log import *
+import asyncio
+import random
+import os
+
+trap_list_filemon = ("readnews",)
+
+def read_file(file_monitor_file_path, random_line_only=False):
+
+    try:
+        if not os.path.exists(file_monitor_file_path):
+            logger.warning(f"FileMon: File not found: {file_monitor_file_path}")
+            if file_monitor_file_path == "bee.txt":
+                return "🐝buzz 💐buzz buzz🍯"
+        if random_line_only:
+            # read a random line from the file
+            with open(file_monitor_file_path, 'r', encoding='utf-8') as f:
+                lines = f.readlines()
+                return random.choice(lines)
+        else:
+            # read the whole file
+            with open(file_monitor_file_path, 'r', encoding='utf-8') 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, news_random_line_only)
+
+
+def write_news(content, append=False):
+    # write the news file on demand
+    try:
+        with open(news_file_path, 'a' if append else 'w', encoding='utf-8') as f:
+            f.write(content)
+            logger.info(f"FileMon: Updated {news_file_path}")
+        return True
+    except Exception as e:
+        logger.warning(f"FileMon: Error writing file: {news_file_path}")
+        return False
+
+async def watch_file():
+    
+    if not os.path.exists(file_monitor_file_path):
+        return None
+    else:
+        last_modified_time = os.path.getmtime(file_monitor_file_path)
+        while True:
+            current_modified_time = os.path.getmtime(file_monitor_file_path)
+            if current_modified_time != last_modified_time:
+                # File has been modified
+                content = read_file(file_monitor_file_path)
+                last_modified_time = current_modified_time
+                # Cleanup the content
+                content = content.replace('\n', ' ').replace('\r', '').strip()
+                if content:
+                    return content
+            await asyncio.sleep(1)  # Check every
+
+def call_external_script(message, script="script/runShell.sh"):
+    try:
+        # Debugging: Print the current working directory and resolved script path
+        current_working_directory = os.getcwd()
+        script_path = os.path.join(current_working_directory, script)
+
+        if not os.path.exists(script_path):
+            # try the raw script name
+            script_path = script
+            if not os.path.exists(script_path):
+                logger.warning(f"FileMon: Script not found: {script_path}")
+                return "sorry I can't do that"
+            
+        output = os.popen(f"bash {script_path} {message}").read().encode('utf-8').decode('utf-8')
+        return output
+    except Exception as e:
+        logger.warning(f"FileMon: Error calling external script: {e}")
+        return None
+    

modules/games/blackjack.py

@@ -0,0 +1,473 @@
+# Port of https://github.com/Himan10/BlackJack
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+
+from random import choices, shuffle
+from modules.log import *
+import time
+import pickle
+
+jack_starting_cash = 100  # Replace 100 with your desired starting cash value
+jackTracker= [{'nodeID': 0, 'cmd': 'new', 'time': time.time(), 'cash': jack_starting_cash,\
+                'bet': 0, 'gameStats': {'p_win': 0, 'd_win': 0, 'draw': 0}, 'p_cards':[], 'd_cards':[], 'p_hand':[], 'd_hand':[], 'next_card':[]}]
+
+SUITS = ("♥️", "♦️", "♠️", "♣️")
+RANKS = (
+    "2",
+    "3",
+    "4",
+    "5",
+    "6",
+    "7",
+    "8",
+    "9",
+    "10",
+    "J",
+    "Q",
+    "K",
+    "A",
+)
+VALUES = {
+    "2": 2,
+    "3": 3,
+    "4": 4,
+    "5": 5,
+    "6": 6,
+    "7": 7,
+    "8": 8,
+    "9": 9,
+    "10": 10,
+    "J": 10,
+    "Q": 10,
+    "K": 10,
+    "A": 11,
+}
+
+class jackCard:
+    def __init__(self, suit, rank):
+        self.suit = suit
+        self.rank = rank
+
+    def __str__(self):
+        return self.rank + " of " + self.suit
+
+class jackDeck:
+    """ Creating a Deck of cards and Deal two cards to both player and dealer. """
+
+    def __init__(self):
+        self.deck = []
+        self.player = []
+        self.dealer = []
+        for suit in SUITS:
+            for rank in RANKS:
+                self.deck.append((suit, rank))
+
+    def shuffle(self):
+        shuffle(self.deck)
+
+    def deal_cards(self):
+        self.player = choices(self.deck, k=2)
+        self.delete_cards(self.player)
+        self.dealer = choices(self.deck, k=2)
+        self.delete_cards(self.dealer)  # Delete Drawn Cards
+        return self.player, self.dealer
+
+    def delete_cards(self, total_drawn):
+        """ Delete Drawn cards from the Decks """
+        try:
+            for i in total_drawn:
+                self.deck.remove(i)
+        except ValueError:
+            pass
+
+class jackHand:
+    """ Adding the values of player/dealer cards and change the values of Aces acc. to situation. """
+    def __init__(self):
+        self.cards = []
+        self.value = 0
+        self.aces = 0
+
+    def add_cards(self, card):
+        self.cards.extend(card)
+        for count, ele in enumerate(card, 0):
+            if ele[1] == "A":
+                self.aces += 1
+            self.value += VALUES[ele[1]]
+        self.adjust_for_ace()
+
+    def adjust_for_ace(self):
+        while self.aces > 0 and self.value > 21:
+            self.value -= 10
+            self.aces -= 1
+
+class jackChips:
+    """ Player/dealer chips for making bets and Adding/Deducting amount in/from Player's total. """
+    def __init__(self):
+        self.total = jack_starting_cash
+        self.bet = 0
+        self.winnings = 0
+
+    def win_bet(self):
+        self.total += self.bet
+        self.winnings += 1
+
+    def loss_bet(self):
+        self.total -= self.bet
+        self.winnings -= 1
+
+def success_rate(card, obj_h):
+    """ Calculate Success rate of 'HIT' new cards """
+    msg = ""
+    rate = 0
+    diff = 21 - obj_h.value
+    if diff != 0:
+        rate = (VALUES[card[0][1]] / diff) * 100
+
+    if rate < 100:
+        msg += f"If Hit, chance {int(rate)}% failure, {100-int(rate)}% success."
+    else:
+        l_rate = int(rate - (rate - 99))  # Round to 99
+        if card[0][1] == "A":
+            l_rate -= 99
+        msg += f"If Hit, chance {100-l_rate}% failure, and {l_rate}% success"
+    return msg
+
+def hits(obj_de):
+    new_card = [obj_de.deal_cards()[0][0]]
+    # obj_h.add_cards(new_card)
+    return new_card
+
+def display_hand(hand):
+    # Display the cards in the hand nicely
+    d = "" # display
+    for card in hand:
+        d += f"{card[1]}{card[0]}"
+        if card != hand[-1]:
+            d += ", "
+    return d
+
+def show_some(player_cards, dealer_cards, obj_h):
+    msg = f"Player[{obj_h.value}] {display_hand(player_cards)}  "
+    msg += f"Dealer[{VALUES[dealer_cards[1][1]]}] {dealer_cards[1][1]}{dealer_cards[1][0]} "
+    return msg
+
+def show_all(player_cards, dealer_cards, obj_h, obj_d):
+    msg = f"Player[{obj_h.value}] {display_hand(player_cards)}  "
+    msg += f"Dealer[{obj_d.value}] {display_hand(dealer_cards)}"
+    return msg
+
+def player_bust(obj_h, obj_c):
+    if obj_h.value > 21:
+        obj_c.loss_bet()
+        return True
+    return False
+
+def player_wins(obj_h, obj_d, obj_c):
+    if any((obj_h.value == 21, obj_h.value > obj_d.value and obj_h.value < 21)):
+        obj_c.win_bet()
+        return True
+    return False
+
+def dealer_bust(obj_d, obj_h, obj_c):
+    if obj_d.value > 21:
+        if obj_h.value < 21:
+            obj_c.win_bet()
+        return True
+    return False
+
+def dealer_wins(obj_h, obj_d, obj_c):
+    if any((obj_d.value == 21, obj_d.value > obj_h.value and obj_d.value < 21)):
+        obj_c.loss_bet()
+        return True
+    return False
+
+def push(obj_h, obj_d):
+    if obj_h.value == obj_d.value:
+        return True
+    return False
+
+def player_surrender(obj_c):
+    obj_c.loss_bet()
+    return True
+
+def gameStats(p_count, d_count, draw_c):
+    msg = f"\n📊🏆P:{p_count},D:{d_count},T:{draw_c}"
+    return msg
+
+def getLastCmdJack(nodeID):
+    for i in range(len(jackTracker)):
+        if jackTracker[i]['nodeID'] == nodeID:
+            return jackTracker[i]['cmd']
+    return None
+
+def setLastCmdJack(nodeID, cmd):
+    for i in range(len(jackTracker)):
+        if jackTracker[i]['nodeID'] == nodeID:
+            jackTracker[i]['cmd'] = cmd
+            return True
+    return False
+
+def saveHSJack(nodeID, highScore):
+    # Save the game state to pickle
+    highScore = {'nodeID': nodeID, 'highScore': highScore}
+    try:
+        with open('data/blackjack_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+    except FileNotFoundError:
+        logger.debug("System: BlackJack: Creating new data/blackjack_hs.pkl file")
+        with open('data/blackjack_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+
+def loadHSJack():
+    try:
+        with open('data/blackjack_hs.pkl', 'rb') as file:
+            highScore = pickle.load(file)
+            return highScore
+    except FileNotFoundError:
+        logger.debug("System: BlackJack: Creating new data/blackjack_hs.pkl file")
+        highScore = {'nodeID': 0, 'highScore': 0}
+        with open('data/blackjack_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+        return 0
+
+def playBlackJack(nodeID, message):
+    # Initalize the Game
+    msg, last_cmd = '', None
+    blackJack = False
+    p_win, d_win, draw = 0, 0, 0
+    p_chips = jackChips()
+    p_hand = jackHand()
+    d_hand = jackHand()
+    p_cards, d_cards = [], []
+    bet_money = 0
+    # Initalize the Cards
+    cards_deck = jackDeck()
+    cards_deck.shuffle()
+    p_cards, d_cards = cards_deck.deal_cards()
+    # Deal the cards to player and dealer
+    p_hand.add_cards(p_cards)
+    d_hand.add_cards(d_cards)
+    next_card = hits(cards_deck)
+
+    # Check if player, use tracking
+    for i in range(len(jackTracker)):
+        if jackTracker[i]['nodeID'] == nodeID:
+            last_cmd = jackTracker[i]['cmd']
+            p_chips.total = jackTracker[i]['cash']
+            p_win = jackTracker[i]['gameStats']['p_win']
+            d_win = jackTracker[i]['gameStats']['d_win']
+            draw = jackTracker[i]['gameStats']['draw']
+            bet_money = jackTracker[i]['bet']
+            if last_cmd == "playing":
+                p_chips.bet = bet_money
+                p_cards = jackTracker[i]['p_cards']
+                d_cards = jackTracker[i]['d_cards']
+                p_hand = jackTracker[i]['p_hand']
+                d_hand = jackTracker[i]['d_hand']
+                next_card = jackTracker[i]['next_card']
+
+    if last_cmd is None:
+        # create new player if not in tracker
+        logger.debug(f"System: BlackJack: New Player {nodeID}")
+        jackTracker.append({'nodeID': nodeID, 'cmd': 'new', 'time': time.time(), 'cash': jack_starting_cash,\
+            'bet': 0, 'gameStats': {'p_win': p_win, 'd_win': d_win, 'draw': draw}, 'p_cards':p_cards, 'd_cards':d_cards, 'p_hand':p_hand.cards, 'd_hand':d_hand.cards, 'next_card':next_card})
+        return f"Welcome to ♠️♥️BlackJack♣️♦️ you have {p_chips.total} chips.   Whats your bet?"
+
+    if getLastCmdJack(nodeID) == "new":
+        # Place Bet
+        try:
+            # handle B letter
+            if message.lower() == "b":
+                if bet_money == 0:
+                    bet_money = 5
+            elif message.lower() == "r":
+                #resend the hand
+                msg += show_some(p_cards, d_cards, p_hand)
+                return msg
+            else:
+                try:
+                    bet_money = int(message)
+                except ValueError:
+                    return "Invalid Bet, please enter a valid number."
+
+            if bet_money <= p_chips.total and bet_money >= 1:
+                p_chips.bet = bet_money
+            else:
+                return f"Invalid Bet, the maximum bet you can place is {p_chips.total} and the minimum bet is 1."
+        except ValueError:
+            return f"Invalid Bet, the maximum bet, {p_chips.total}"
+
+        # Show the cards
+        msg += show_some(p_cards, d_cards, p_hand)
+        # check for blackjack 21 and only two cards
+        if p_hand.value == 21 and len(p_hand.cards) == 2:
+            msg += "Player 🎰 BLAAAACKJACKKKK 💰"
+            p_chips.total += round(p_chips.bet * 1.5)
+            setLastCmdJack(nodeID, "dealerTurn")
+            blackJack = True
+            # Save the game state
+            for i in range(len(jackTracker)):
+                if jackTracker[i]['nodeID'] == nodeID:
+                    jackTracker[i]['cash'] = int(p_chips.total)
+                    break
+        else:
+            # Display the statistics
+            stats = success_rate(next_card, p_hand)
+            msg += stats
+            setLastCmdJack(nodeID, "betPlaced")
+
+    if getLastCmdJack(nodeID) == "betPlaced":
+        setLastCmdJack(nodeID, "playing")
+        msg += "(H)it,(S)tand,(F)orfit,(D)ouble,(R)esend,(L)eave table"
+
+        # save the game state
+        for i in range(len(jackTracker)):
+            if jackTracker[i]['nodeID'] == nodeID:
+                jackTracker[i]['cash'] = p_chips.total
+                jackTracker[i]['bet'] = p_chips.bet
+                jackTracker[i]['p_cards'] = p_cards
+                jackTracker[i]['d_cards'] = d_cards
+                jackTracker[i]['p_hand'] = p_hand
+                jackTracker[i]['d_hand'] = d_hand
+                jackTracker[i]['next_card'] = next_card
+        return msg
+
+
+    while getLastCmdJack(nodeID) == "playing":  # Recall var. from hit and stand function
+        next_card = hits(cards_deck)
+        
+        # Get the statistics
+        stats = success_rate(next_card, p_hand)
+
+        # Player's Turn
+        choice = message.lower()
+
+        if choice == "hit" or choice == "h":
+            # hits(obj_de, p_hand)
+            p_hand.add_cards(next_card)
+            msg += show_some(p_hand.cards, d_cards, p_hand)
+        elif choice == "stand" or choice == "s":
+            setLastCmdJack(nodeID, "dealerTurn")
+        elif choice == "forfit" or choice == "f":
+            p_chips.bet = p_chips.bet / 2
+            setLastCmdJack(nodeID, "dealerTurn")
+            p_hand.value += 21
+        elif choice == "double" or choice == "d":
+            if p_chips.bet * 2 <= p_chips.total:
+                p_chips.bet *= 2
+                next_d_card = hits(cards_deck)
+                p_hand.add_cards(next_d_card)
+                setLastCmdJack(nodeID, "dealerTurn")
+            else:
+                return "You can't Double Down, dont have enough chips"
+        elif choice == "resend" or choice == "r":
+            msg += show_some(p_hand.cards, d_cards, p_hand)
+        else:
+            return "(H)it,(S)tand,(F)orfit,(D)ouble,(R)esend,(L)eave table"
+
+        # Check if player bust
+        if player_bust(p_hand, p_chips):
+            d_win += 1
+            msg += "💥PlayerBUST💥"
+            setLastCmdJack(nodeID, "dealerTurn")
+        
+        if getLastCmdJack(nodeID) == "playing":
+            msg += stats
+            msg += "[H,S,F,D]"
+
+        # Save the game state
+        for i in range(len(jackTracker)):
+            if jackTracker[i]['nodeID'] == nodeID:
+                jackTracker[i]['cash'] = int(p_chips.total)
+                jackTracker[i]['bet'] = int(p_chips.bet)
+                jackTracker[i]['gameStats']['p_win'] = int(p_win)
+                jackTracker[i]['gameStats']['d_win'] = int(d_win)
+                jackTracker[i]['gameStats']['draw'] = int(draw)
+                jackTracker[i]['p_cards'] = p_cards
+                jackTracker[i]['d_cards'] = d_cards
+                jackTracker[i]['p_hand'] = p_hand
+                jackTracker[i]['d_hand'] = d_hand
+                break
+
+        # Exit player's turn
+        if getLastCmdJack(nodeID) == "dealerTurn":
+            break
+        
+        return msg
+
+    if getLastCmdJack(nodeID) == "dealerTurn":
+        # Dealers Turn
+        if not blackJack:
+        # recall the game state
+            for i in range(len(jackTracker)):
+                if jackTracker[i]['nodeID'] == nodeID:
+                    p_chips.total = jackTracker[i]['cash']
+                    p_chips.bet = jackTracker[i]['bet']
+                    p_win = jackTracker[i]['gameStats']['p_win']
+                    d_win = jackTracker[i]['gameStats']['d_win']
+                    draw = jackTracker[i]['gameStats']['draw']
+                    p_cards = jackTracker[i]['p_cards']
+                    d_cards = jackTracker[i]['d_cards']
+                    p_hand = jackTracker[i]['p_hand']
+                    d_hand = jackTracker[i]['d_hand']
+                    next_card = jackTracker[i]['next_card']
+                    break
+
+        if p_hand.value <= 21:
+            # Dealer's Turn
+            while d_hand.value < 17:
+                d_card = hits(cards_deck)
+                d_hand.add_cards(d_card)
+                if dealer_bust(d_hand, p_hand, p_chips):
+                    p_win += 1
+                    msg += "💰DealerBUST💥"
+                    break
+            # Show all cards
+            msg += show_all(p_hand.cards, d_hand.cards, p_hand, d_hand)
+
+            # Check who wins
+            if push(p_hand, d_hand):
+                draw += 1
+                msg += "👌PUSH"
+            elif player_wins(p_hand, d_hand, p_chips):
+                p_win += 1
+                msg += "🎉PLAYER WINS🎰"
+            elif dealer_wins(p_hand, d_hand, p_chips):
+                d_win += 1
+                msg += "👎DEALER WINS"
+        else:
+            msg += "👎DEALER WINS"
+
+        # Display the Game Stats
+        msg += gameStats(str(p_win), str(d_win), str(draw))
+
+        # Display the chips left
+        if p_chips.total < 1:
+            if p_chips.total > 0:
+                msg += "🪙Keep the change you filthy animal!"
+            else:
+                msg += "💸NO MORE CHIPS!🏧💳"
+                p_chips.total = jack_starting_cash
+        else:
+            # check high score
+            highScore = loadHSJack()
+            if highScore != 0 and p_chips.total > highScore['highScore']:
+                msg += f"💰HighScore💰{p_chips.total} "
+                saveHSJack(nodeID, p_chips.total)
+            else:
+                msg += f"💰You have {p_chips.total} chips "
+
+        msg += " Bet or Leave?"
+
+        # Reset the game
+        setLastCmdJack(nodeID, "new")
+        jackTracker[i]['cash'] = p_chips.total
+        jackTracker[i]['gameStats']['p_win'] = p_win
+        jackTracker[i]['gameStats']['d_win'] = d_win
+        jackTracker[i]['gameStats']['draw'] = draw
+        jackTracker[i]['p_cards'] = []
+        jackTracker[i]['d_cards'] = []
+        jackTracker[i]['p_hand'] = []
+        jackTracker[i]['d_hand'] = []
+        jackTracker[i]['time'] = time.time()
+
+    return msg

modules/games/dopewar.py

@@ -0,0 +1,688 @@
+# Port of https://github.com/Reconfirefly/drugwars/tree/master
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+
+import random
+import time
+import pickle
+from modules.log import *
+
+# Global variables
+total_days = 7 # number of days or rotations the player has to play
+starting_cash = 5000
+# Database for the game reset on boot
+dwInventoryDb = [{'userID': 1234567890, 'inventory': 0, 'priceList': [], 'amount': []}]
+dwCashDb = [{'userID': 1234567890, 'cash': starting_cash},]
+dwGameDayDb = [{'userID': 1234567890, 'day': 0},]
+dwLocationDb = [{'userID': 1234567890, 'location': 'USA', 'loc_choice': 0},]
+dwPlayerTracker = [{'userID': 1234567890, 'last_played': time.time(), 'cmd': 'start'},]
+# high score is saved in a pickle file
+dwHighScore = {}
+
+class Drugs:
+
+    def __init__(self, name, price_range):
+        self.name = name
+        self.price_range = price_range
+        self.price_check()
+
+    def price_check(self):
+        # the * is to unpack the touple of values that the random goes between
+        self.price = random.randint(*self.price_range)
+        # print("the price of " + self.name + " is " + str(self.price))
+        return self.price
+
+class Events:
+
+    def __init__(self, name, text, price_range):
+        self.name = name
+        self.price_range = price_range
+        self.text = text
+        self.price_mod()
+
+    def price_mod(self):
+        self.price = random.randint(*self.price_range)
+        return self.price
+
+my_drugs = [
+    # Drugs("Name", (min price, max price), amount)
+    Drugs("Cocaine", (15000, 28000)),
+    Drugs("Heroin", (2000, 10000)),
+    Drugs("Weed", (300, 1000)),
+    Drugs("Hash", (200, 1200)),
+    Drugs("Opium", (400, 1800)),
+    Drugs("Acid", (1000, 4200)),
+    Drugs("Ludes", (18, 75)),
+]
+
+event_list = [
+    # Events("Name", "Text", (min price, max price))
+    Events("Cocaine", 'El Chapo Arrested! 🚔 Coke price thru the roof! 📈', (40000, 110000)),
+    Events("Heroin", 'Trump cracks down on opiates! Heroin in high demand by addicts📈', (9000, 25000)),
+    Events("Weed", 'The DEA has fully legalized weed! Prices are at an all time low!📉', (50, 400)),
+    Events("Hash", 'Ricky\'s hash driveway burned down! 🚒 Look at the price boys!📈', (800, 2000)),
+    Events("Opium", 'Shenzhen 深圳 Opium 鸦片 Den 塔 was raided! 🚔 Street price is popping off!📈', (1800, 6000)),
+    Events("Acid", 'The Grateful Dead are on tour! Acid prices are skyrocketing!📈', (5000, 15000)),
+    Events("Ludes", 'The Wolf of Wall Street is back! Ludes are in demand!', (100, 300)),
+    Events("Cocaine", "The Biden administration has legalized cocaine! Prices are at an all time low!📉", (3000, 10000)),
+    Events("Heroin", "Oregon has legalized heroin! Prices are at an all time low!📉", (500, 2500)),
+    Events("Weed", "Prices are at an all time HIGH!📈", (1000, 5000)),
+    Events("Hash", "The Middle East has legalised hash! Prices are at an all time low!📉", (50, 1000)),
+    Events("Opium", "The Sackler's flood the market with cheap opium! Prices are at an all time low!📉", (300, 900)),
+    Events("Acid", "The FBI admits to dosing the water supply with LSD! Acid at an all time low!📉", (500, 2000)),
+    Events("Ludes", "The FDA approves ludes for sale! Prices are at an all time low!📉", (3, 45))
+]
+
+def generatelocations():
+    # dictionary of locations
+    locs = {'Canada': ('Red Deer', 'Edmonton', 'Calgary', 'Toronto', 'Vancouver', 'St. Johns'),
+            'USA': ('L.A.', 'NYC', 'Chicago', 'Miami', 'Houston', 'Phoenix'), 'Mexico': ('Tijuana', 'Mexico City', 'Cancun', 'Juarez', 'Acapulco', 'Guadalajara'),\
+            'South America': ('Bogota', 'Caracas', 'Lima', 'Santiago', 'Buenos Aires', 'Rio'), 'Europe': ('London', 'Paris', 'Berlin', 'Rome', 'Madrid', 'Moscow')}
+
+    country = list(locs.keys())
+    country = country[random.randint(0, len(country)-1)]
+
+    # return the location list for the user's country
+    location = []
+    for i in range(len(locs[country])):
+        location.append(locs[country][i])
+    return location
+
+def generate_event():
+    # roll to see if an event happens
+    event_choice = random.randint(0, len(event_list)-1)
+    if random.randint(0, 100) > 35:
+        return event_choice
+    else:
+        return -1
+
+def officer(nodeID):
+    global dwCashDb, dwInventoryDb
+
+    # get the inventory for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            inventory = dwInventoryDb[i].get('inventory')
+    amount = check_inv(nodeID)
+    
+    # get the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            cash = dwCashDb[i].get('cash')
+
+    # rolls to see if the officer takes drugs from you
+    if random.randint(0, 100) > 65: # confiscation chance is 35%
+        j, k = 0, 0
+        for i in range(0, len(my_drugs)):
+            j = amount[i]
+            amount[i] = 0
+            k += j
+        # set the cash_taken to conf for confiscation not of cash
+        cash_taken = 'conf'
+        # Update the inventory_db
+        inventory -= k
+        for i in range(0, len(dwInventoryDb)):
+            if dwInventoryDb[i].get('userID') == nodeID:
+                dwInventoryDb[i]['inventory'] = inventory
+                amount = dwInventoryDb[i].get('amount')
+        return cash_taken
+    # rolls to see how much cash the officer takes
+    cash_taken = random.randint(1, cash-1)
+    cash -= cash_taken
+    # Update the cash_db and inventory_db
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            dwCashDb[i]['cash'] = cash
+    return cash_taken
+
+def get_found_items(nodeID):
+    global dwInventoryDb, dwCashDb
+    msg = ''
+    # get the inventory for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            inventory = dwInventoryDb[i].get('inventory')
+    amount = check_inv(nodeID)
+
+    # get the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            cash = dwCashDb[i].get('cash')
+
+    if random.randint(0, 100) > 50: # 50% chance to find cash or drugs
+        if random.randint(0, 100) > 30: # 30% chance to find drugs
+            found = random.choice(range(len(my_drugs)))
+            # rolls to see how much of the drug the user finds
+            qty =random.randint(1, 80 - inventory)
+            amount[found] += qty
+            inventory += qty
+            for i in range(0, len(dwInventoryDb)):
+                if dwInventoryDb[i].get('userID') == nodeID:
+                    dwInventoryDb[i]['inventory'] = inventory
+                    dwInventoryDb[i]['amount'] = amount
+            msg = f"💊You found {qty} {my_drugs[found].name}"
+    else:
+        # rolls to see how much cash the user finds
+        cash_found = random.randint(1, 977)
+        cash += cash_found
+        # Update the cash_db
+        for i in range(0, len(dwCashDb)):
+            if dwCashDb[i].get('userID') == nodeID:
+                dwCashDb[i]['cash'] = cash
+        msg = "You found $" + str(cash_found) + "💸"
+        
+    return msg
+
+
+def price_change(event_number):
+    price_list = []
+    for i in range(0, len(my_drugs)):
+        j = my_drugs[i]
+        k = j.price_check()
+        price_list.append(k)
+    
+    # check if IndexError will be thrown and find a new event_number with generate_event
+    while event_number > len(price_list)-1:
+        event_number = generate_event()
+    
+    if event_number != -1:
+        price_list[event_number] = event_list[event_number].price_mod()
+
+    return price_list
+
+def check_inv(nodeID):
+    global dwInventoryDb
+
+    # get the inventory ammount for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            amount = dwInventoryDb[i].get('amount')
+
+    # if ammount is empty list initialize it
+    if not amount:
+        amount = []
+        for i in range(0, len(my_drugs)):
+            amount.append(0,)
+        
+        # save the amount to the inventory_db
+        for i in range(0, len(dwInventoryDb)):
+            if dwInventoryDb[i].get('userID') == nodeID:
+                dwInventoryDb[i]['amount'] = amount
+    
+    return amount
+
+def buy_func(nodeID, price_list, choice=0, value='0'):
+    global dwCashDb, dwInventoryDb, dwPlayerTracker
+    msg = ''
+                 
+    # get the inventory for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            inventory = dwInventoryDb[i].get('inventory')
+    amount = check_inv(nodeID)
+    
+    # get the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            cash = dwCashDb[i].get('cash')
+
+    drug_choice = choice
+    if choice == 0:
+       msg = f"Didnt see a drug chouce. ex: s,1,10 sells 10 of drug 1{my_drugs[1].name}, or p for price list"
+       return msg
+    else:
+        if drug_choice in range(1, len(my_drugs) + 1):
+            drug_choice = drug_choice - 1
+            cost = price_list[drug_choice]
+            msg = my_drugs[drug_choice].name + ": you have🎒 " + str(amount[drug_choice]) + " "
+            msg += " The going price is: $" + "{:,}".format(cost) + " "
+
+    buy_amount = value
+    if buy_amount == 'm':
+        buy_amount = cash // price_list[drug_choice]
+        if buy_amount > 100 - inventory:
+            buy_amount = 100 - inventory
+        if buy_amount == 0:
+            return "You don\'t have any empty inventory slots.🎒"
+    # set the buy amount to the max if the user enters m
+    buy_amount = int(buy_amount)
+    
+    if buy_amount == 0:
+        msg = f"Didnt see a qty. ex: b,1,10 buys 10 of {my_drugs[1].name}, can also use m for max"
+        return msg
+    elif buy_amount not in range(1, 101):
+        msg = "Enter qty or m for max"
+        return msg
+    elif buy_amount > 100 - inventory:
+        msg = "You don\'t have enough space for all that.🎒"
+        return msg
+    elif buy_amount * price_list[drug_choice] <= cash:
+        amount[drug_choice] += buy_amount
+        cash -= buy_amount * price_list[drug_choice]
+        inventory += buy_amount
+        msg += "You bought " + str(buy_amount) + " " + my_drugs[drug_choice].name + '. Remaining cash: $' + str(cash)
+        msg += f"\nBuy💸, Sell💰, Fly🛫?"
+    else:
+        msg = "You don't have enough cash!😭"
+        return msg
+
+    # update the cash_db and inventory_db values
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            dwCashDb[i]['cash'] = cash
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            dwInventoryDb[i]['inventory'] = inventory
+    # save the last command as ask_bsf
+    for i in range(0, len(dwPlayerTracker)):
+        if dwPlayerTracker[i].get('userID') == nodeID:
+            dwPlayerTracker[i]['cmd'] = 'ask_bsf'
+
+    return msg
+
+
+def sell_func(nodeID, price_list, choice=0, value='0'):
+    global dwCashDb, dwInventoryDb, dwPlayerTracker
+    msg = ''
+
+    # get the inventory for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            inventory = dwInventoryDb[i].get('inventory')
+    amount = check_inv(nodeID)
+    
+    # get the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            cash = dwCashDb[i].get('cash')
+
+    # get the drug choice and amount to sell
+    drug_choice = choice
+    sell_amount = value
+
+    try:
+        if sell_amount == 'm':
+            sell_amount = amount[drug_choice - 1]
+        else:
+            sell_amount = int(sell_amount)
+            if sell_amount not in range(1, 101):
+                msg = "You can only sell between 1 and 100"
+                return msg
+    except ValueError:
+        msg = "Enter qty or m for max"
+        return msg
+    
+    # check if the user has any of the drug they are trying to sell
+    if choice == 0:
+        msg = "Enter b or s and the drug number and qty you want to buy or sell. ex: b,1,10 buys 10 of drug 1"
+        return msg
+    else:
+        if drug_choice in range(1, len(my_drugs) + 1) and amount[drug_choice - 1] > 0:
+            drug_choice = drug_choice - 1
+            cost = price_list[drug_choice]
+            msg = my_drugs[drug_choice].name + ": you have " + str(amount[drug_choice]) +\
+                " The going price is: $" + str("{:,}".format(cost))
+            # check if the user has enough of the drug to sell
+            if sell_amount <= amount[drug_choice]:
+                amount[drug_choice] -= sell_amount
+                cash += sell_amount * price_list[drug_choice]
+                inventory -= sell_amount
+                profit = sell_amount * price_list[drug_choice]
+                msg += " You sold " + str(sell_amount) + " " + my_drugs[drug_choice].name +\
+                     ' for $' + "{:,}".format(profit) + '. Total cash: $' + "{:,}".format(cash)
+            else:
+                msg = "You don't have that much"
+                return msg
+        else:
+            msg = "You don't have any " + my_drugs[drug_choice - 1].name
+            return msg
+
+    # update the cash_db and inventory_db values
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            dwCashDb[i]['cash'] = cash
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            dwInventoryDb[i]['inventory'] = inventory
+            dwInventoryDb[i]['amount'] = amount
+    # save the last command as ask_bsf
+    for i in range(0, len(dwPlayerTracker)):
+        if dwPlayerTracker[i].get('userID') == nodeID:
+            dwPlayerTracker[i]['cmd'] = 'ask_bsf'
+    
+    return msg
+
+def get_location_table(nodeID, choice=0):
+    global dwLocationDb
+    # get the location for the user
+    for i in range(0, len(dwLocationDb)):
+        if dwLocationDb[i].get('userID') == nodeID:
+            loc = dwLocationDb[i].get('location')
+            
+    # list the lcaitons and their index in two columns
+    loc_table_string = ''
+    for i in range(len(loc)):
+            loc_table_string += str(i+1) + '. ' + loc[i] + '  ' 
+    loc_table_string += ' Where do you want to 🛫?#'
+    return loc_table_string
+
+def endGameDw(nodeID):
+    global dwCashDb, dwInventoryDb, dwLocationDb, dwGameDayDb, dwHighScore
+    msg = ''
+    dwHighScore = getHighScoreDw()
+    # Confirm the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            cash = dwCashDb[i].get('cash')
+    logger.debug("System: DopeWars: Game Over for user: " + str(nodeID) + " with cash: " + str(cash))
+
+    # remove the player from the game databases
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == nodeID:
+            dwCashDb.pop(i)
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            dwInventoryDb.pop(i)
+    for i in range(0, len(dwLocationDb)):
+        if dwLocationDb[i].get('userID') == nodeID:
+            dwLocationDb.pop(i)
+    for i in range(0, len(dwGameDayDb)):
+        if dwGameDayDb[i].get('userID') == nodeID:
+            dwGameDayDb.pop(i)
+    for i in range(0, len(dwPlayerTracker)):
+        if dwPlayerTracker[i].get('userID') == nodeID:
+            dwPlayerTracker.pop(i)
+
+    # checks if the player's score is higher than the high score and writes a new high score if it is
+    if cash > dwHighScore.get('cash'):
+        dwHighScore = ({'userID': nodeID, 'cash': round(cash, 2)})
+        with open('data/dopewar_hs.pkl', 'wb') as file:
+            pickle.dump(dwHighScore, file)
+            msg = "You finished with $" + "{:,}".format(cash) + " and beat the high score!🎉💰"
+        return msg
+    if cash > starting_cash:
+        msg = 'You made money! 💵 Up ' + str((cash/starting_cash).__round__()) + 'x! Well done.'
+        return msg
+    if cash == starting_cash:
+        msg = 'You broke even... hope you at least had fun 💉💊'
+        return msg
+    if cash < starting_cash:
+        msg = "You lost money, better go get a real job.💸"
+    
+    return msg
+
+def getHighScoreDw():
+    global dwHighScore
+    # Load high score table
+    try:
+        with open('data/dopewar_hs.pkl', 'rb') as file:
+            dwHighScore = pickle.load(file)
+    except FileNotFoundError:
+        logger.debug("System: DopeWars: No high score table found")
+        # high score pickle file is a touple of the nodeID and the high score
+        dwHighScore = ({"userID": 4258675309, "cash": 100})
+        # write a new high score file if one is not found
+        with open('data/dopewar_hs.pkl', 'wb') as file:
+            pickle.dump(dwHighScore, file)
+    return dwHighScore
+
+def render_game_screen(userID, day_play, total_day, loc_choice, event_number, price_list, cash_stolen, found_items):
+    global dwCashDb, dwInventoryDb, dwLocationDb
+    msg = ''
+    # get the location for the user
+    for i in range(0, len(dwLocationDb)):
+        if dwLocationDb[i].get('userID') == userID:
+            loc = dwLocationDb[i].get('location')
+
+    if event_number != -1:
+        msg += event_list[event_number].text + f"\n"
+    elif event_number == -1 and cash_stolen != 0 and cash_stolen != 'conf':
+        msg += random.choice([f"You got high and spent ${str(cash_stolen)}💊💸\n", 
+                              f"You got mugged and lost ${str(cash_stolen)}💸🔫\n",
+                              f"You got a new tattoo and spent ${str(cash_stolen)}💉💸\n",])
+    elif event_number == -1 and cash_stolen == 'conf':
+        msg += f"🚔Officer Bob stopped you and took all of your drugs.🚭\n"
+    elif event_number == -1 and found_items != 'nothing':
+        msg += found_items + f"\n"
+
+    # get the inventory for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == userID:
+            inventory = dwInventoryDb[i].get('inventory') 
+
+    amount = check_inv(userID)
+    # get the cash for the user
+    for i in range(0, len(dwCashDb)):
+        if dwCashDb[i].get('userID') == userID:
+            cash = dwCashDb[i].get('cash')
+
+    msg += "🗺️" + loc[int(loc_choice) - 1] + " 📆" + str(day_play) + '/' + str(total_day) +  " 🎒" + str(inventory) + "/100" + " 💵" + "{:,}".format(cash) + f"\n"
+    
+    for i, drug in enumerate(my_drugs, 1):
+        qty = amount[i-1]
+        msg += f'#{str(i)}.{drug.name}${"{:,}".format(price_list[i-1])}({qty})    '
+
+    return msg
+
+def dopeWarGameDay(nodeID, day_play, total_day):
+    global dwCashDb, dwLocationDb, dwInventoryDb
+    cash_stolen = 0
+    found_items = 'nothing'
+
+    # roll for the event of the day
+    event_number = generate_event()
+
+    # get the location for the user
+    for i in range(0, len(dwLocationDb)):
+        if dwLocationDb[i].get('userID') == nodeID:
+            loc = dwLocationDb[i].get('location')
+            loc_choice = dwLocationDb[i].get('loc_choice')
+
+    # rolls to see if event happens
+    if event_number == -1 and random.randint(0, 100) > 80: # 20% chance to have an event
+        if random.randint(0, 100) > 50: # 50% chance to have an officer encounter
+            cash_stolen = officer(nodeID)
+        else:
+            # find items
+            found_items = get_found_items(nodeID)
+
+
+    price_list = price_change(event_number)
+
+    # set the price_list for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            dwInventoryDb[i]['priceList'] = price_list
+
+    check_inv(nodeID)
+
+    # main game display print
+    msg = render_game_screen(nodeID, day_play, total_day, loc_choice, event_number, price_list, cash_stolen, found_items)
+    
+    return msg
+
+def playDopeWars(nodeID, cmd):
+    global dwGameDayDb, dwPlayerTracker, dwCashDb, dwInventoryDb, dwLocationDb, dwHighScore
+    
+    inGame = False
+    msg = '' 
+
+    # check if the player is currently playing the game
+    for i in range(0, len(dwGameDayDb)):
+        if dwGameDayDb[i].get('userID') == nodeID:
+            inGame = True
+
+    if not inGame:
+        # initalize player in the database
+        loc = generatelocations()
+        dwInventoryDb.append({'userID': nodeID, 'inventory': 0, 'priceList': []})
+        dwCashDb.append({'userID': nodeID, 'cash': starting_cash})
+        dwLocationDb.append({'userID': nodeID, 'location': loc, 'loc_choice': 0})
+        dwGameDayDb.append({'userID': nodeID, 'day': 0})
+        dwPlayerTracker.append({'userID': nodeID, 'last_played': time.time(), 'cmd': 'start'})
+        logger.debug("System: DopeWars: New player: " + str(nodeID))
+    
+    # get the day for the user
+    for i in range(0, len(dwGameDayDb)):
+        if dwGameDayDb[i].get('userID') == nodeID:
+            game_day = dwGameDayDb[i].get('day')
+
+    # get the player's last command
+    for i in range(0, len(dwPlayerTracker)):
+        if dwPlayerTracker[i].get('userID') == nodeID:
+            last_cmd = dwPlayerTracker[i].get('cmd')
+
+    # get the price_list for the user
+    for i in range(0, len(dwInventoryDb)):
+        if dwInventoryDb[i].get('userID') == nodeID:
+            price_list = dwInventoryDb[i].get('priceList')
+
+    # get the location for the user
+    for i in range(0, len(dwLocationDb)):
+        if dwLocationDb[i].get('userID') == nodeID:
+            loc_choice = dwLocationDb[i].get('loc_choice')
+    
+    # Pick Starting City
+    if last_cmd == 'start':
+        # print the location table 
+        msg = get_location_table(nodeID)
+
+        # set the player's last command to location to start the game
+        for i in range(0, len(dwPlayerTracker)):
+            if dwPlayerTracker[i].get('userID') == nodeID:
+                dwPlayerTracker[i]['cmd'] = 'location'
+
+    if last_cmd == 'ask_bsf':
+        msg = f'example buy:\nb,drug#,qty# or Sell: s,1,10 qty can be (m)ax\n f,p or end'
+        menu_choice = cmd.lower()
+        if ',' in menu_choice or '.' in menu_choice:
+            #split the choice into a letter and a number for the buy/sell functions
+            try:
+                if '.' in menu_choice:
+                    menu_choice = menu_choice.split('.')
+                if ',' in menu_choice:
+                    menu_choice = menu_choice.split(',')
+
+                if int(menu_choice[1]) not in range(1, 8):
+                    raise ValueError
+                else:
+                    menu_choice[1] = int(menu_choice[1])
+                if menu_choice[0] not in ['b', 's']:
+                    raise ValueError
+                if menu_choice[2] != 'm':
+                    if int(menu_choice[2]) not in range(1, 101):
+                        raise ValueError
+                    else:
+                        menu_choice[2] = int(menu_choice[2])
+                
+            except ValueError:
+                msg = f'a value was bad, example dopeware Buy or Sell\n b,1,10 or s,1,m'
+                return msg
+
+            if menu_choice[0] == 'b':
+                # set last command to ask_bsf and buy
+                for i in range(0, len(dwPlayerTracker)):
+                    if dwPlayerTracker[i].get('userID') == nodeID:
+                        dwPlayerTracker[i]['cmd'] = 'ask_bsf'
+                msg = buy_func(nodeID, price_list, menu_choice[1], menu_choice[2])
+                return msg
+
+            if menu_choice[0] == 's':
+                # set last command to ask_bsf and sell
+                for i in range(0, len(dwPlayerTracker)):
+                    if dwPlayerTracker[i].get('userID') == nodeID:
+                        dwPlayerTracker[i]['cmd'] = 'ask_bsf'
+                msg = sell_func(nodeID, price_list, menu_choice[1], menu_choice[2])
+                return msg
+        elif 's' in menu_choice:
+            msg = ''
+            # sell everything we have in backpack
+            for i in range(0, len(dwInventoryDb)):
+                if dwInventoryDb[i].get('userID') == nodeID:
+                    inventory = dwInventoryDb[i].get('inventory')
+            if inventory == 0:
+                msg = "You don't have anything to sell🚭"
+            else:
+                for i in range(1, (len(my_drugs) +1)):
+                    sell =  sell_func(nodeID, price_list, i, 'm')
+                    # ignore starts with "You don't have any"
+                    if not sell.startswith("You don't have any"):
+                        msg += sell + '\n'
+            # trim the last newline
+            msg = msg[:-1]
+            return msg
+        elif 'f' in menu_choice:
+                # set last command to location
+                for i in range(0, len(dwPlayerTracker)):
+                    if dwPlayerTracker[i].get('userID') == nodeID:
+                        dwPlayerTracker[i]['cmd'] = 'location'
+                last_cmd = 'location'
+
+        elif 'p' in menu_choice:
+                # render_game_screen
+                msg = render_game_screen(nodeID, game_day, total_days, loc_choice, -1, price_list, 0, 'nothing')
+                return msg
+        elif 'e' in menu_choice:
+                msg = endGameDw(nodeID)
+                return msg
+        else:
+            msg = f'example buy:\nb,drug#,qty# or Sell: s,1,10 qty can be (m)ax\n f,p or end'
+            return msg
+        
+    # Buy
+    if last_cmd == 'buy':
+        # ned to collect which drug # and qty to buy
+        msg = buy_func(nodeID, price_list)
+        return msg
+
+    # Sell
+    if last_cmd == 'sell':
+        msg = sell_func(nodeID, price_list)
+        return msg
+        
+        # Pick Location, and display main game screen
+    if last_cmd == 'location':
+        # validate the location choice
+        try:
+            loc_choice = int(cmd)
+            if loc_choice not in range(1, 6):
+                raise ValueError
+        except ValueError:
+            loc_choice = random.randint(1, 6)
+
+        # set the player's location choice
+        for i in range(0, len(dwLocationDb)):
+            if dwLocationDb[i].get('userID') == nodeID:
+                dwLocationDb[i]['loc_choice'] = loc_choice
+        
+        # set the player's last command
+        for i in range(0, len(dwPlayerTracker)):
+            if dwPlayerTracker[i].get('userID') == nodeID:
+                dwPlayerTracker[i]['cmd'] = 'display_main'
+        
+        # increment the game_day
+        game_day += 1
+        for i in range(0, len(dwGameDayDb)):
+            if dwGameDayDb[i].get('userID') == nodeID:
+                dwGameDayDb[i]['day'] = game_day
+        
+        # update the player's last played time
+        for i in range(0, len(dwPlayerTracker)):
+            if dwPlayerTracker[i].get('userID') == nodeID:
+                dwPlayerTracker[i]['last_played'] = time.time()
+
+        last_cmd = 'display_main'
+    
+    # Display Main Game Screen and ask for buy, sell, or fly
+    if last_cmd == 'display_main':
+        msg = dopeWarGameDay(nodeID, game_day, total_days)
+        msg += f"\nBuy💸, Sell💰, (F)ly🛫? (P)riceList?"
+        # set the player's last command
+        for i in range(0, len(dwPlayerTracker)):
+            if dwPlayerTracker[i].get('userID') == nodeID:
+                dwPlayerTracker[i]['cmd'] = 'ask_bsf'
+    
+    # Game end
+    if game_day == total_days + 1:
+        msg = endGameDw(nodeID)
+    
+    return msg

modules/games/golfsim.py

@@ -0,0 +1,409 @@
+# https://github.com/danfriedman30/pythongame
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+
+import random
+import time
+import pickle
+from modules.log import *
+
+# Clubs setup
+driver_distances = list(range(230, 280, 5))
+low_distances = list(range(185, 215, 5))
+mid_distances = list(range(130, 185, 5))
+high_distances = list(range(90, 135, 5))
+gap_wedge_distances = list(range(50, 85, 5))
+lob_wedge_distances = list(range(10, 50, 5))
+putt_outcomes = [1, 2, 3]
+
+# Hole/Course Setup
+full_hole_range = list(range(130, 520, 5))
+par3_range = list(range(130, 255, 5))
+par4_range = list(range(255, 445, 5))
+par5_range = list(range(445, 520, 5))
+par3_4_range = par3_range + par4_range
+par3_5_range = par3_range + par5_range
+par4_5_range = par4_range + par5_range
+
+# Player setup
+playingHole = False
+golfTracker = [{'nodeID': 0, 'last_played': time.time(), 'cmd': '', 'hole': 0, 'distance_remaining': 0, 'hole_shots': 0, 'hole_strokes': 0, 'hole_to_par': 0, 'total_strokes': 0, 'total_to_par': 0, 'par': 0, 'hazard': ''}]
+
+# Club functions
+def hit_driver():
+    club_distance = random.choice(driver_distances)
+    return club_distance
+
+def hit_low_iron():
+    club_distance = random.choice(low_distances)
+    return club_distance
+
+def hit_mid_iron():
+    club_distance = random.choice(mid_distances)
+    return club_distance
+
+def hit_high_iron():
+    club_distance = random.choice(high_distances)
+    return club_distance
+
+def hit_gap_wedge():
+    club_distance = random.choice(gap_wedge_distances)
+    return club_distance
+
+def hit_lob_wedge():
+    club_distance = random.choice(lob_wedge_distances)
+    return club_distance
+
+def finish_hole():
+    finish = random.choice(putt_outcomes)
+    return finish
+
+def endGameGolf(nodeID):
+    # pop player from tracker
+    for i in range(len(golfTracker)):
+        if golfTracker[i]['nodeID'] == nodeID:
+            golfTracker.pop(i)
+    logger.debug("System: GolfSim: Player " + str(nodeID) + " has ended their round.")
+
+def getScorecardGolf(scorecard):
+    # Scorecard messages, convert score to message comment
+    msg = ""
+    if scorecard == 8:
+        # Quadruple bogey
+        msg += " +Quad Bogey☃️ "
+    elif scorecard == 7:
+        # Triple bogey
+        msg += " +Triple Bogey "
+    elif scorecard == 6:
+        # Double bogey
+        msg += " +Double Bogey "
+    elif scorecard == 5:
+        # Bogey
+        msg += " +Bogey "
+    elif scorecard > 0:
+        # Over par
+        msg += f" +Par {str(scorecard)} "
+    elif scorecard == 0:
+        # Even par
+        msg += " Even Par💪 "
+    elif scorecard == -1:
+        # Birdie
+        msg += " -Birdie🐦 "
+    elif scorecard == -2:
+        # Eagle
+        msg += " -Eagle🦅 "
+    elif scorecard == -3:
+        # Albatross
+        msg += " -Albatross🦅🦅 "
+    else:
+        # Under par
+        msg += f" -Par {str(abs(scorecard))} "
+    return msg
+
+def getHighScoreGolf(nodeID, strokes, par):
+    # check if player is in high score list
+    try:
+        with open('data/golfsim_hs.pkl', 'rb') as f:
+            golfHighScore = pickle.load(f)
+    except:
+        logger.debug("System: GolfSim: High Score file not found.")
+        golfHighScore = [{'nodeID': nodeID, 'strokes': strokes, 'par': par}]
+        with open('data/golfsim_hs.pkl', 'wb') as f:
+            pickle.dump(golfHighScore, f)
+
+    if strokes < golfHighScore[0]['strokes']:
+        # player got new low score which is high score
+        golfHighScore[0]['nodeID'] = nodeID
+        golfHighScore[0]['strokes'] = strokes
+        golfHighScore[0]['par'] = par
+        with open('data/golfsim_hs.pkl', 'wb') as f:
+            pickle.dump(golfHighScore, f)
+        return golfHighScore
+    
+    return 0
+
+# Main game loop
+def playGolf(nodeID, message, finishedHole=False):
+    msg = ''
+    global golfTracker
+    # Course setup
+    par3_count = 0
+    par4_count = 0
+    par5_count = 0
+    # Scorecard setup
+    total_strokes = 0
+    total_to_par = 0
+    par = 0
+
+    # get player's last command from tracker if not new player
+    last_cmd = ""
+    for i in range(len(golfTracker)):
+        if golfTracker[i]['nodeID'] == nodeID:
+            last_cmd = golfTracker[i]['cmd']
+            hole = golfTracker[i]['hole']
+            distance_remaining = golfTracker[i]['distance_remaining']
+            hole_shots = golfTracker[i]['hole_shots']
+            par = golfTracker[i]['par']
+            total_strokes = golfTracker[i]['total_strokes']
+            total_to_par = golfTracker[i]['total_to_par']
+
+    if last_cmd == "" or last_cmd == "new":
+        # Start a new hole
+        if hole <= 9:
+            # Set up hole count restrictions on par
+            if par3_count < 2 and par4_count < 5 and par5_count < 2:
+                hole_length = random.choice(full_hole_range)
+            if par3_count >= 2 and par4_count < 5 and par5_count < 2:
+                hole_length = random.choice(par4_5_range)
+            if par3_count >= 2 and par4_count < 5 and par5_count >= 2:
+                hole_length = random.choice(par4_range)
+            if par3_count < 2 and par4_count < 5 and par5_count >= 2:
+                hole_length = random.choice(par3_4_range)
+            if par3_count < 2 and par4_count >= 5 and par5_count >= 2:
+                hole_length = random.choice(par3_range)
+            if par3_count >= 2 and par4_count >= 5 and par5_count < 2:
+                hole_length = random.choice(par5_range)
+            if par3_count < 2 and par4_count >= 5 and par5_count < 2:
+                hole_length = random.choice(par3_5_range)
+
+            # Set up par for the hole
+            if hole_length <= 250:
+                par = 3
+                par3_count += 1
+            elif hole_length > 250 and hole_length <= 440:
+                par = 4
+                par4_count += 1
+            elif hole_length > 440:
+                par = 5
+                par5_count += 1
+
+            # roll for chance of hazard
+            hazard_chance = random.randint(1, 100)
+            weather_chance = random.randint(1, 100)
+            # have low chances of hazards and weather
+            hasHazard = False
+            hazard = ""
+            if hazard_chance < 25:
+                # Further reduce chance of hazards with weather
+                if weather_chance < 15:
+                    # randomly calculate a hazard for the hole sand, 🌊, 🌲, 🏘️, etc
+                    hazard = random.choice(["🏖️", "🌊", "🌲", "🏘️"])
+                    hasHazard = True
+                    
+
+            # Set initial parameters before starting a hole
+            distance_remaining = hole_length
+            hole_shots = 0
+
+            # save player's current game state
+            for i in range(len(golfTracker)):
+                if golfTracker[i]['nodeID'] == nodeID:
+                    golfTracker[i]['distance_remaining'] = distance_remaining
+                    golfTracker[i]['cmd'] = 'stroking'
+                    golfTracker[i]['par'] = par
+                    golfTracker[i]['total_strokes'] = total_strokes
+                    golfTracker[i]['total_to_par'] = total_to_par
+                    golfTracker[i]['hazard'] = hazard
+                    golfTracker[i]['hole'] = hole
+                    golfTracker[i]['last_played'] = time.time()
+                    golfTracker[i]['hole_shots'] = hole_shots
+
+            # Show player the hole information
+            msg += "⛳️#" + str(hole) + " is a " + str(hole_length) + "-yard Par " + str(par) + "."
+            if hasHazard: 
+                msg += "⚠️" + hazard + "."
+            else:
+                # add weather conditions with random choice from list, this is fluff
+                msg += random.choice(["☀️", "💨", "☀️", "☀️", "⛅️", "☁️", "☀️"])
+
+            if not finishedHole:
+                msg += f"\nChoose your club."
+
+            return msg
+
+    if last_cmd == 'stroking':
+
+        # Get player's current game state
+        for i in range(len(golfTracker)):
+            if golfTracker[i]['nodeID'] == nodeID:
+                distance_remaining = golfTracker[i]['distance_remaining']
+                hole = golfTracker[i]['hole']
+                hole_shots = golfTracker[i]['hole_shots']
+                par = golfTracker[i]['par']
+                total_strokes = golfTracker[i]['total_strokes']
+                total_to_par = golfTracker[i]['total_to_par']
+                hazard = golfTracker[i]['hazard']
+
+        # Start loop to be able to choose clubs while at least 20 yards away
+        if distance_remaining >= 20:
+            msg = ""
+            club = message.lower()
+            shot_distance = 0
+
+            pin_distance = distance_remaining
+
+            if club == "driver" or club.startswith("d"):
+                shot_distance = hit_driver()
+                msg += "🏌️Hit D " + str(shot_distance) + "yd. "
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif "low" in club or club.startswith("l"):
+                shot_distance = hit_low_iron()
+                msg += "🏌️Hit L Iron " + str(shot_distance) + "yd. "
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif "mid" in club or club.startswith("m"):
+                shot_distance = hit_mid_iron()
+                msg += "🏌️Hit M Iron " + str(shot_distance) + "yd. "
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif "high" in club or club.startswith("h"):
+                shot_distance = hit_high_iron()
+                msg += "🏌️Hit H Iron " + str(shot_distance) + "yd. "
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif "gap" in club or club.startswith("g"):
+                shot_distance = hit_gap_wedge()
+                msg += "🏌️Hit G Wedge " + str(shot_distance) + "yd ."
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif "wedge" in club or club.startswith("w"):
+                shot_distance = hit_lob_wedge()
+                msg += "🏌️Hit L Wedge " + str(shot_distance) + "yd. "
+                distance_remaining = abs(distance_remaining - shot_distance)
+                hole_shots += 1
+            elif club == "caddy" or club.startswith("c"):
+                # Show player the club distances
+                msg += f"Caddy Guess:\nD:{hit_driver()} L:{hit_low_iron()} M:{hit_mid_iron()} H:{hit_high_iron()} G:{hit_gap_wedge()} W:{hit_lob_wedge()}"
+            else:
+                msg += f"Didnt get your club 🥪♣️🪩 choice, you have {distance_remaining}yds. to ⛳️"
+                return msg
+
+            if distance_remaining - pin_distance > pin_distance or shot_distance > pin_distance:
+                # Check for over-shooting the hole
+                if distance_remaining > 20:
+                    # did it go off the "green"?
+                    msg += "Overshot the green!🚀"
+            if distance_remaining == 0:
+                msg += "🎯Perfect shot! "
+                last_cmd = 'putt'
+            elif distance_remaining < 20:
+                # Roll Dice
+                hole_in_one_chance = random.randint(1, 100)
+                wind_factor = random.randint(1, 10)
+                skill_factor = random.randint(1, 10)
+                critter_factor = random.randint(1, 50)
+
+                # Check for hole in one
+                if hole_in_one_chance <= 5 and wind_factor > 7 and skill_factor > 8:
+                    distance_remaining = 0
+                # Check for critters
+                if skill_factor > 8 and critter_factor < 40 and wind_factor > 2 and hole_in_one_chance > 5:
+                    msg += random.choice(["A 🐿️ steals your ball!😡 ","You Hit a 🦅 soring past ", "🐊 need we say more? ", "hit a 🪟 of a 🏡 "])
+                    distance_remaining = -1
+                # Handle hazard
+                if hazard == "🌊" and skill_factor < 7:
+                    msg += "In the water!🌊"
+                    distance_remaining = -1
+                if hazard == "🏖️" and skill_factor < 5:
+                    msg += "In the sand!🏖️"
+                    distance_remaining = random.randint(5, 10)
+                if hazard == "🌲" and skill_factor < 3:
+                    msg += "In the trees!🌲"
+                    distance_remaining += random.randint(5, 20)
+                if hazard == "🏘️" and skill_factor < 2:
+                    msg += "In the parking lot!🚗"
+                    distance_remaining += random.randint(10, 30)
+                
+                # Check we didnt go off the green or into a hazard
+                if distance_remaining < 20:
+                    last_cmd = 'putt'
+                else:
+                    last_cmd = 'stroking'
+            else:
+                msg += "\nYou have " + str(distance_remaining) + "yd. ⛳️"
+                msg += "\nClub?[D, L, M, H, G, W]🏌️"
+
+
+                # save player's current game state, keep stroking
+                for i in range(len(golfTracker)):
+                    if golfTracker[i]['nodeID'] == nodeID:
+                        golfTracker[i]['distance_remaining'] = distance_remaining
+                        golfTracker[i]['hole_shots'] = hole_shots
+                        golfTracker[i]['total_strokes'] = total_strokes
+                        golfTracker[i]['cmd'] = 'stroking'
+
+                return msg
+
+    if last_cmd == 'putt':
+        # Finish the hole by putting
+        critter = False
+        if distance_remaining < 20:
+            if distance_remaining == 0:
+                putts = 0
+            elif distance_remaining == -1:
+                putts = 0
+                critter = True
+            else:
+                putts = finish_hole()
+
+            # Calculate hole and round scores
+            hole_strokes = hole_shots + putts
+            hole_to_par = hole_strokes - par
+            total_strokes += hole_strokes
+            total_to_par += hole_to_par
+
+
+            if not critter:
+                # Show player hole/round scoring info
+                if putts == 0 and hole_strokes == 1:
+                    msg += "🎯Hole in one!⛳️"
+                elif putts == 0:
+                    msg += "You're in the hole at " + str(hole_strokes) + " strokes!"
+                else:
+                    msg += "You're on the green! After " + str(putts) + " putt(s), you're in for " + str(hole_strokes) + " strokes."
+                msg += getScorecardGolf(hole_to_par)
+
+                if hole not in [1, 10]:
+                    # Show player total scoring info for the round, except hole 1 and 10
+                    msg += "\nYou've hit a total of " + str(total_strokes) + " strokes today, for"
+                    msg += getScorecardGolf(total_to_par)
+
+                # Move to next hole
+                hole += 1
+            else:
+                msg += f"Got a new ball at Pro-Shop, marshal put you @" # flow into same hole haha
+
+            # Scorecard reset
+            hole_to_par = 0
+            hole_strokes = 0
+            hole_shots = 0
+        
+        # Save player's current game state
+        for i in range(len(golfTracker)):
+            if golfTracker[i]['nodeID'] == nodeID:
+                golfTracker[i]['hole_strokes'] = hole_strokes
+                golfTracker[i]['hole_to_par'] = hole_to_par
+                golfTracker[i]['total_strokes'] = total_strokes
+                golfTracker[i]['total_to_par'] = total_to_par
+                golfTracker[i]['hole'] = hole
+                golfTracker[i]['cmd'] = 'new'
+                golfTracker[i]['last_played'] = time.time()
+
+        if hole >= 9:
+            # Final score messages & exit prompt
+            msg += f"🎉Finished 9-hole round⛳️"
+            #HighScore Display
+            highscore = getHighScoreGolf(nodeID, total_strokes, total_to_par)
+            if highscore != 0:
+                msg += " 🏆New Club Record🏆"
+            # pop player from tracker
+            for i in range(len(golfTracker)):
+                if golfTracker[i]['nodeID'] == nodeID:
+                    golfTracker.pop(i)
+            logger.debug("System: GolfSim: Player " + str(nodeID) + " has finished their round.")
+        else:
+            # Show player the next hole
+            msg += playGolf(nodeID, 'new', True)
+            msg += "\n🏌️[D, L, M, H, G, W, End]🏌️"
+            
+    return msg

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', encoding='utf-8') 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}\nQuestions left: {total}\nArea 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 out of 50
+            passing = 37
+        else:
+            # passing score for technician and general is 26 out of 35
+            passing = 26
+
+        if score >= passing:
+            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/games/hangman.py

@@ -0,0 +1,203 @@
+# Written for Meshtastic mesh-bot by ZR1RF Johannes le Roux 2025
+import random
+
+class Hangman:
+    WORDS = [
+    "ability","able","about","above","accept","according","account","across",
+    "act","action","activity","actually","add","address","administration","admit",
+    "adult","affect","after","again","against","age","agency","agent","ago",
+    "agree","agreement","ahead","air","all","allow","almost","alone","along",
+    "already","also","although","always","American","among","amount","analysis",
+    "and","animal","another","answer","any","anyone","anything","appear","apply",
+    "approach","area","argue","arm","around","arrive","art","article","artist",
+    "as","ask","assume","at","attack","attention","attorney","audience","author",
+    "authority","available","avoid","away","baby","back","bad","bag","ball",
+    "bank","bar","base","be","beat","beautiful","because","become","bed","before",
+    "begin","behavior","behind","believe","benefit","best","better","between",
+    "beyond","big","bill","billion","bit","black","blood","blue","board","body",
+    "book","born","both","box","boy","break","bring","brother","budget","build",
+    "building","business","but","buy","by","call","camera","campaign","can",
+    "cancer","candidate","capital","car","card","care","career","carry","case",
+    "catch","cause","cell","center","central","century","certain","certainly",
+    "chair","challenge","chance","change","character","charge","check","child",
+    "choice","choose","church","citizen","city","civil","claim","class","clear",
+    "clearly","close","coach","cold","collection","college","color","come",
+    "commercial","common","community","company","compare","computer","concern",
+    "condition","conference","Congress","consider","consumer","contain","continue",
+    "control","cost","could","country","couple","course","court","cover","create",
+    "crime","cultural","culture","cup","current","customer","cut","dark","data",
+    "daughter","day","dead","deal","death","debate","decade","decide","decision",
+    "deep","defense","degree","democrat","democratic","describe","design",
+    "despite","detail","determine","develop","development","die","difference",
+    "different","difficult","dinner","direction","director","discover","discuss",
+    "discussion","disease","do","doctor","dog","door","down","draw","dream","drive",
+    "drop","drug","during","each","early","east","easy","eat","economic","economy",
+    "edge","education","effect","effort","eight","either","election","else",
+    "employee","end","energy","enjoy","enough","enter","entire","environment",
+    "environmental","especially","establish","even","evening","event","ever",
+    "every","everybody","everyone","everything","evidence","exactly","example",
+    "executive","exist","expect","experience","expert","explain","eye","face",
+    "fact","factor","fail","fall","family","far","fast","father","fear","federal",
+    "feel","feeling","few","field","fight","figure","fill","film","final","finally",
+    "financial","find","fine","finger","finish","fire","firm","first","fish","five",
+    "floor","fly","focus","follow","food","foot","for","force","foreign","forget",
+    "form","former","forward","four","free","friend","from","front","full","fund",
+    "future","game","garden","gas","general","generation","get","girl","give",
+    "glass","go","goal","good","government","great","green","ground","group","grow",
+    "growth","guess","gun","guy","hair","half","hand","hang","happen","happy",
+    "hard","have","he","head","health","hear","heart","heat","heavy","help","her",
+    "here","herself","high","him","himself","his","history","hit","hold","home",
+    "hope","hospital","hot","hotel","hour","house","how","however","huge","human",
+    "hundred","husband","I","idea","identify","if","image","imagine","impact",
+    "important","improve","in","include","including","increase","indeed","indicate",
+    "individual","industry","information","inside","instead","institution","interest",
+    "interesting","international","interview","into","investment","involve","issue",
+    "it","item","its","itself","job","join","just","keep","key","kid","kill","kind",
+    "kitchen","know","knowledge","land","language","large","last","late","later",
+    "laugh","law","lawyer","lay","lead","leader","learn","least","leave","left",
+    "leg","legal","less","let","letter","level","lie","life","light","like","likely",
+    "line","list","listen","little","live","local","long","look","lose","loss",
+    "lot","love","low","machine","magazine","main","maintain","major","majority",
+    "make","man","manage","management","manager","many","market","marriage",
+    "material","matter","may","maybe","me","mean","measure","media","medical","meet",
+    "meeting","member","memory","mention","message","method","middle","might",
+    "military","million","mind","minute","miss","mission","model","modern","moment",
+    "money","month","more","morning","most","mother","mouth","move","movement",
+    "movie","Mr","Mrs","much","music","must","my","myself","name","nation",
+    "national","natural","nature","near","nearly","necessary","need","network",
+    "never","new","news","newspaper","next","nice","night","no","none","nor",
+    "north","not","note","nothing","notice","now","number","occur","of","off",
+    "offer","office","officer","official","often","oh","oil","ok","old","on",
+    "once","one","only","onto","open","operation","opportunity","option","or",
+    "order","organization","other","others","our","out","outside","over","own",
+    "owner","page","pain","painting","paper","parent","part","participant",
+    "particular","particularly","partner","party","pass","past","patient","pattern",
+    "pay","peace","people","per","perform","performance","perhaps","period",
+    "person","personal","phone","physical","pick","picture","piece","place","plan",
+    "plant","play","player","point","police","policy","political","politics",
+    "poor","popular","population","position","positive","possible","power",
+    "practice","prepare","present","president","pressure","pretty","prevent","price",
+    "private","probably","problem","process","produce","product","production",
+    "professional","professor","program","project","property","protect","prove",
+    "provide","public","pull","purpose","push","put","quality","question","quickly",
+    "quite","race","radio","raise","range","rate","rather","reach","read","ready",
+    "real","reality","realize","really","reason","receive","recent","recently",
+    "recognize","record","red","reduce","reflect","region","relate","relationship",
+    "religious","remain","remember","remove","report","represent","republican",
+    "require","research","resource","respond","response","responsibility","rest",
+    "result","return","reveal","rich","right","rise","risk","road","rock","role",
+    "room","rule","run","safe","same","save","say","scene","school","science",
+    "scientist","score","sea","season","seat","second","section","security","see",
+    "seek","seem","sell","send","senior","sense","series","serious","serve",
+    "service","set","seven","several","shake","share","she","shoot","short","shot",
+    "should","shoulder","show","side","sign","significant","similar","simple",
+    "simply","since","sing","single","sister","sit","site","situation","six","size",
+    "skill","skin","small","smile","so","social","society","soldier","some",
+    "somebody","someone","something","sometimes","son","song","soon","sort","sound",
+    "source","south","southern","space","speak","special","specific","speech",
+    "spend","sport","spring","staff","stage","stand","standard","star","start",
+    "state","statement","station","stay","step","still","stock","stop","store",
+    "story","strategy","street","strong","structure","student","study","stuff",
+    "style","subject","success","successful","such","suddenly","suffer","suggest",
+    "summer","support","sure","surface","system","table","take","talk","task","tax",
+    "teach","teacher","team","technology","television","tell","ten","tend","term",
+    "test","than","thank","that","the","their","them","themselves","then","theory",
+    "there","these","they","thing","think","third","this","those","though","thought",
+    "thousand","threat","three","through","throughout","throw","thus","time","to",
+    "today","together","tonight","too","top","total","tough","toward","town","trade",
+    "traditional","training","travel","treat","treatment","tree","trial","trip",
+    "trouble","true","truth","try","turn","TV","two","type","under","understand",
+    "unit","until","up","upon","us","use","usually","value","various","very",
+    "victim","view","violence","visit","voice","vote","wait","walk","wall","want",
+    "war","watch","water","way","we","weapon","wear","week","weight","well","west",
+    "western","what","whatever","when","where","whether","which","while","white",
+    "who","whole","whom","whose","why","wide","wife","will","win","wind","window",
+    "wish","with","within","without","woman","wonder","word","work","worker","world",
+    "worry","would","write","writer","wrong","yard","yeah","year","yes","yet","you",
+    "young","your","yourself","meshtastic","node","lora","mesh"]
+
+    def __init__(self):
+        self.game = {}
+
+    def new_game(self, id):
+        games = won = 0
+        ret = ""
+        if id in self.game:
+            games = self.game[id]["games"]
+            won = self.game[id]["won"]
+            ret += f"Total Games: {games}, Won: {won}\n"
+
+        self.game[id] = {
+            "word": self.random_word(),
+            "guesses": [],
+            "games": games+1,
+            "won": won
+        }
+        ret += self.game_continue(id)
+        return ret
+
+    def guess(self, id, input):
+        g = self.game[id]
+        if not input:
+            return
+        letter = input[0].lower()
+        if letter.isalpha() and letter not in g["guesses"]:
+            g["guesses"].append(letter)
+
+    def wrong_guesses(self, id):
+        g = self.game[id]
+        wrong = 0
+        for letter in g["guesses"]:
+            if letter not in g["word"]:
+                wrong += 1
+        return wrong
+
+    def won(self, id):
+        g = self.game[id]
+        for letter in g["word"]:
+            if letter not in g["guesses"]:
+                return False
+        return True
+
+    def mask(self, id):
+        g = self.game[id]
+        return " ".join([a if a in g["guesses"] else "_" for a in g["word"]])
+
+    def game_board(self, id):
+        g = self.game[id]
+        emotions = "😀🙂😐😑😕😔💀"
+        wrong = self.wrong_guesses(id)
+        ret = ""
+        if self.won(id):
+            ret += "🥳" + "\n"
+            g["won"] += 1
+        else:
+            ret += emotions[wrong] + "\n"
+        ret += hangman.mask(id) + "\n"
+        if g["guesses"]:
+            ret += ",".join(g["guesses"]) + "\n"
+        return ret
+
+    def game_continue(self, id):
+        return self.game_board(id) + "Guess a letter"
+
+    def game_over(self, id):
+        return self.game_board(id) + "Game over, the word was " + self.game[id]["word"]
+
+    def play(self, id, input):
+        if id not in self.game:
+            return self.new_game(id)
+        self.guess(id, input)
+        wrong = self.wrong_guesses(id)
+        if wrong >= 6 or self.won(id):
+            return self.game_over(id) + "\n" + self.new_game(id)
+        return self.game_continue(id)
+
+    def end(self, id):
+        del self.game[id]
+
+    def random_word(self):
+        return random.choice(self.WORDS)
+
+hangmanTracker = []
+hangman = Hangman()

modules/games/joke.py

@@ -0,0 +1,126 @@
+# This module is used to tell jokes to the user
+# The emoji table of contents is used to replace words in the joke with emojis
+# As a Ham, is this obsecuring the meaning of the joke? Or is it enhancing it?
+from dadjokes import Dadjoke # pip install dadjokes
+from modules.log import *
+
+def tableOfContents():
+    wordToEmojiMap = {
+        'love': '❤️', 'heart': '❤️', 'happy': '😊', 'smile': '😊', 'sad': '😢', 'angry': '😠', 'mad': '😠', 'cry': '😢', 'laugh': '😂', 'funny': '😂', 'cool': '😎',
+        'joy': '😂', 'kiss': '😘', 'hug': '🤗', 'wink': '😉', 'grin': '😁', 'bored': '😐', 'tired': '😴', 'sleepy': '😴', 'shocked': '😲', 'surprised': '😲',
+        'confused': '😕', 'thinking': '🤔', 'sick': '🤢', 'party': '🎉', 'celebrate': '🎉', 'clap': '👏', 'thumbs up': '👍', 'thumbs down': '👎',
+        'ok': '👌', 'wave': '👋', 'pray': '🙏', 'muscle': '💪', 'fire': '🔥', 'star': '⭐', 'sun': '☀️', 'moon': '🌙', 'rain': '🌧️', 'snow': '❄️', 'cloud': '☁️',
+        'dog': '🐶', 'cat': '🐱', 'mouse': '🐭', 'rabbit': '🐰', 'fox': '🦊', 'bear': '🐻', 'panda': '🐼', 'koala': '🐨', 'tiger': '🐯', 'lion': '🦁', 'cow': '🐮',
+        'pig': '🐷', 'frog': '🐸', 'monkey': '🐵', 'chicken': '🐔', 'penguin': '🐧', 'bird': '🐦', 'fish': '🐟', 'whale': '🐋', 'dolphin': '🐬', 'octopus': '🐙',
+        'apple': '🍎', 'orange': '🍊', 'banana': '🍌', 'watermelon': '🍉', 'grape': '🍇', 'strawberry': '🍓', 'cherry': '🍒', 'peach': '🍑', 'pineapple': '🍍', 'mango': '🥭', 'coconut': '🥥',
+        'tomato': '🍅', 'eggplant': '🍆', 'avocado': '🥑', 'broccoli': '🥦', 'cucumber': '🥒', 'corn': '🌽', 'carrot': '🥕', 'potato': '🥔', 'sweet potato': '🍠', 'chili': '🌶️', 'garlic': '🧄',
+        'pizza': '🍕', 'burger': '🍔', 'fries': '🍟', 'hotdog': '🌭', 'popcorn': '🍿', 'donut': '🍩', 'cookie': '🍪', 'cake': '🎂', 'pie': '🍰', 'cupcake': '🧁', 'chocolate': '🍫',
+        'candy': '🍬', 'lollipop': '🍭', 'pudding': '🍮', 'honey': '🍯', 'milk': '🍼', 'coffee': '☕', 'tea': '🍵', 'sake': '🍶', 'beer': '🍺', 'cheers': '🍻', 'champagne': '🥂',
+        'wine': '🍷', 'whiskey': '🥃', 'cocktail': '🍸', 'tropical drink': '🍹', 'bottle': '🍾', 'soda': '🥤', 'chopsticks': '🥢', 'fork': '🍴', 'knife': '🔪', 'spoon': '🥄', 'kitchen knife': '🔪',
+        'house': '🏠', 'home': '🏡', 'office': '🏢', 'post office': '🏣', 'hospital': '🏥', 'bank': '🏦', 'hotel': '🏨', 'love hotel': '🏩', 'convenience store': '🏪', 'school': '🏫', 'department store': '🏬',
+        'factory': '🏭', 'castle': '🏯', 'palace': '🏰', 'church': '💒', 'tower': '🗼', 'statue of liberty': '🗽', 'mosque': '🕌', 'synagogue': '🕍', 'hindu temple': '🛕', 'kaaba': '🕋', 'shinto shrine': '⛩️',
+        'railway': '🛤️', 'highway': '🛣️', 'map': '🗾', 'carousel': '🎠', 'ferris wheel': '🎡', 'roller coaster': '🎢', 'circus': '🎪', 'theater': '🎭', 'art': '🎨', 'slot machine': '🎰', 'dice': '🎲',
+        'bowling': '🎳', 'video game': '🎮', 'dart': '🎯', 'billiard': '🎱', 'medal': '🎖️', 'trophy': '🏆', 'gold medal': '🥇', 'silver medal': '🥈', 'bronze medal': '🥉', 'soccer': '⚽', 'baseball': '⚾',
+        'basketball': '🏀', 'volleyball': '🏐', 'football': '🏈', 'rugby': '🏉', 'tennis': '🎾', 'frisbee': '🥏', 'ping pong': '🏓', 'badminton': '🏸', 'boxing': '🥊', 'martial arts': '🥋',
+        'goal': '🥅', 'golf': '⛳', 'skating': '⛸️', 'fishing': '🎣', 'diving': '🤿', 'running': '🎽', 'skiing': '🎿', 'sledding': '🛷', 'curling': '🥌', 'climbing': '🧗', 'yoga': '🧘',
+        'surfing': '🏄', 'swimming': '🏊', 'water polo': '🤽', 'cycling': '🚴', 'mountain biking': '🚵', 'horse riding': '🏇', 'kneeling': '🧎', 'weightlifting': '🏋️', 'gymnastics': '🤸', 'wrestling': '🤼', 'handball': '🤾',
+        'juggling': '🤹', 'meditation': '🧘', 'sauna': '🧖', 'rock climbing': '🧗', 'stop': '🛑', 'computer': '💻', 'phone': '📱', 'email': '📧', 'camera': '📷', 'video': '📹', 'music': '🎵',
+        'guitar': '🎸', 'piano': '🎹', 'drum': '🥁', 'microphone': '🎤', 'headphone': '🎧', 'book': '📚', 'newspaper': '📰', 'magazine': '📖', 'pen': '🖊️', 'pencil': '✏️', 'paintbrush': '🖌️',
+        'scissors': '✂️', 'ruler': '📏', 'globe': '🌍', 'earth': '🌎', 'star': '🌟', 'comet': '☄️', 'rocket': '🚀', 'airplane': '✈️', 'car': '🚗', 'bus': '🚌', 'train': '🚆',
+        'bicycle': '🚲', 'motorcycle': '🏍️', 'boat': '🚤', 'ship': '🚢', 'helicopter': '🚁', 'tractor': '🚜', 'ambulance': '🚑', 'fire truck': '🚒', 'police car': '🚓', 'taxi': '🚕', 'truck': '🚚',
+        'construction': '🚧', 'traffic light': '🚦', 'stop sign': '🛑', 'fuel': '⛽', 'battery': '🔋', 'light bulb': '💡', 'flashlight': '🔦', 'candle': '🕯️', 'lamp': '🛋️',
+        'bed': '🛏️', 'sofa': '🛋️', 'chair': '🪑', 'table': '🛋️', 'toilet': '🚽', 'shower': '🚿', 'bathtub': '🛁', 'sink': '🚰', 'mirror': '🪞', 'door': '🚪', 'window': '🪟',
+        'key': '🔑', 'lock': '🔒', 'hammer': '🔨', 'wrench': '🔧', 'screwdriver': '🪛', 'saw': '🪚', 'drill': '🛠️', 'toolbox': '🧰', 'paint roller': '🖌️', 'brush': '🖌️', 'broom': '🧹',
+        'mop': '🧽', 'bucket': '🪣', 'vacuum': '🧹', 'washing machine': '🧺', 'dryer': '🧺', 'iron': '🧺', 'hanger': '🧺', 'laundry': '🧺', 'basket': '🧺', 'trash': '🗑️', 'recycle': '♻️',
+        'plant': '🌱', 'tree': '🌳', 'flower': '🌸', 'leaf': '🍃', 'cactus': '🌵', 'mushroom': '🍄', 'herb': '🌿', 'bamboo': '🎍', 'rose': '🌹', 'tulip': '🌷', 'sunflower': '🌻',
+        'hibiscus': '🌺', 'cherry blossom': '🌸', 'bouquet': '💐', 'seedling': '🌱', 'palm tree': '🌴', 'evergreen tree': '🌲', 'deciduous tree': '🌳', 'fallen leaf': '🍂', 'maple leaf': '🍁',
+        'ear of rice': '🌾', 'shamrock': '☘️', 'four leaf clover': '🍀', 'grapes': '🍇', 'melon': '🍈', 'watermelon': '🍉', 'tangerine': '🍊', 'lemon': '🍋', 'banana': '🍌', 'pineapple': '🍍',
+        'mango': '🥭', 'apple': '🍎', 'green apple': '🍏', 'pear': '🍐', 'peach': '🍑', 'cherries': '🍒', 'strawberry': '🍓', 'kiwi': '🥝', 'tomato': '🍅', 'coconut': '🥥', 'avocado': '🥑',
+        'eggplant': '🍆', 'potato': '🥔', 'carrot': '🥕', 'corn': '🌽', 'hot pepper': '🌶️', 'cucumber': '🥒', 'leafy green': '🥬', 'broccoli': '🥦', 'garlic': '🧄', 'onion': '🧅',
+        'peanuts': '🥜', 'chestnut': '🌰', 'bread': '🍞', 'croissant': '🥐', 'baguette': '🥖', 'flatbread': '🥙', 'pretzel': '🥨', 'bagel': '🥯', 'pancakes': '🥞', 'waffle': '🧇', 'cheese': '🧀',
+        'meat': '🍖', 'poultry': '🍗', 'bacon': '🥓', 'hamburger': '🍔', 'fries': '🍟', 'pizza': '🍕', 'hot dog': '🌭', 'sandwich': '🥪', 'taco': '🌮', 'burrito': '🌯', 'tamale': '🫔',
+        'stuffed flatbread': '🥙', 'falafel': '🧆', 'egg': '🥚', 'fried egg': '🍳', 'shallow pan of food': '🥘', 'pot of food': '🍲', 'fondue': '🫕', 'bowl with spoon': '🥣', 'green salad': '🥗',
+        'popcorn': '🍿', 'butter': '🧈', 'salt': '🧂', 'canned food': '🥫', 'bento box': '🍱', 'rice cracker': '🍘', 'rice ball': '🍙', 'cooked rice': '🍚', 'curry rice': '🍛', 'steaming bowl': '🍜',
+        'spaghetti': '🍝', 'roasted sweet potato': '🍠', 'oden': '🍢', 'sushi': '🍣', 'fried shrimp': '🍤', 'fish cake': '🍥', 'moon cake': '🥮', 'dango': '🍡', 'dumpling': '🥟', 'fortune cookie': '🥠',
+        'takeout box': '🥡', 'crab': '🦀', 'lobster': '🦞', 'shrimp': '🦐', 'squid': '🦑', 'oyster': '🦪', 'ice cream': '🍨', 'shaved ice': '🍧', 'ice cream cone': '🍦', 'doughnut': '🍩', 'cookie': '🍪',
+        'birthday cake': '🎂', 'shortcake': '🍰', 'cupcake': '🧁', 'pie': '🥧', 'chocolate bar': '🍫', 'candy': '🍬', 'lollipop': '🍭', 'custard': '🍮', 'honey pot': '🍯', 'baby bottle': '🍼',
+        'glass of milk': '🥛', 'hot beverage': '☕', 'teapot': '🫖', 'teacup without handle': '🍵', 'sake': '🍶', 'bottle with popping cork': '🍾', 'wine glass': '🍷', 'cocktail glass': '🍸', 'tropical drink': '🍹',
+        'beer mug': '🍺', 'clinking beer mugs': '🍻', 'clinking glasses': '🥂', 'tumbler glass': '🥃', 'cup with straw': '🥤', 'bubble tea': '🧋', 'beverage box': '🧃', 'mate': '🧉', 'ice': '🧊',
+        'chopsticks': '🥢', 'fork and knife': '🍴', 'spoon': '🥄', 'kitchen knife': '🔪', 'amphora': '🏺', 'globe showing Europe-Africa': '🌍', 'globe showing Americas': '🌎', 'globe showing Asia-Australia': '🌏',
+        'globe with meridians': '🌐', 'world map': '🗺️', 'mountain': '⛰️', 'volcano': '🌋', 'mount fuji': '🗻', 'camping': '🏕️', 'beach with umbrella': '🏖️', 'desert': '🏜️', 'desert island': '🏝️',
+        'national park': '🏞️', 'stadium': '🏟️', 'classical building': '🏛️', 'building construction': '🏗️', 'brick': '🧱', 'rock': '🪨', 'wood': '🪵', 'hut': '🛖', 'houses': '🏘️', 'derelict house': '🏚️',
+        'house with garden': '🏡', 'office building': '🏢', 'japanese post office': '🏣', 'post office': '🏤', 'hospital': '🏥', 'bank': '🏦', 'hotel': '🏨', 'love hotel': '🏩', 'convenience store': '🏪',
+        'school': '🏫', 'department store': '🏬', 'factory': '🏭', 'japanese castle': '🏯', 'castle': '🏰', 'wedding': '💒', 'tokyo tower': '🗼', 'statue of liberty': '🗽', 'church': '⛪', 'mosque': '🕌',
+        'hindu temple': '🛕', 'synagogue': '🕍', 'shinto shrine': '⛩️', 'kaaba': '🕋', 'fountain': '⛲', 'tent': '⛺', 'foggy': '🌁', 'night with stars': '🌃', 'sunrise over mountains': '🌄', 'sunrise': '🌅',
+        'cityscape at dusk': '🌆', 'sunset': '🌇', 'cityscape': '🏙️', 'bridge at night': '🌉', 'hot springs': '♨️', 'carousel horse': '🎠', 'ferris wheel': '🎡', 'roller coaster': '🎢', 'barber pole': '💈',
+        'robot': '🤖', 'alien': '👽', 'ghost': '👻', 'skull': '💀', 'pumpkin': '🎃', 'clown': '🤡', 'wizard': '🧙', 'elf': '🧝', 'fairy': '🧚', 'mermaid': '🧜', 'vampire': '🧛',
+        'zombie': '🧟', 'genie': '🧞', 'superhero': '🦸', 'supervillain': '🦹', 'mage': '🧙', 'knight': '🛡️', 'ninja': '🥷', 'pirate': '🏴‍☠️', 'angel': '👼', 'devil': '😈', 'dragon': '🐉',
+        'unicorn': '🦄', 'phoenix': '🦅', 'griffin': '🦅', 'centaur': '🐎', 'minotaur': '🐂', 'cyclops': '👁️', 'medusa': '🐍', 'sphinx': '🦁', 'kraken': '🦑', 'yeti': '❄️', 'sasquatch': '🦧',
+        'loch ness monster': '🦕', 'chupacabra': '🐐', 'banshee': '👻', 'golem': '🗿', 'djinn': '🧞', 'basilisk': '🐍', 'hydra': '🐉', 'cerberus': '🐶', 'chimera': '🐐', 'manticore': '🦁', 'wyvern': '🐉',
+        'pegasus': '🦄', 'hippogriff': '🦅', 'kelpie': '🐎', 'selkie': '🦭', 'kitsune': '🦊', 'tanuki': '🦝', 'tengu': '🦅', 'oni': '👹', 'yokai': '👻', 'kappa': '🐢', 'yurei': '👻',
+        'kami': '👼', 'shinigami': '💀', 'bakemono': '👹', 'tsukumogami': '🧸', 'noppera-bo': '👤', 'rokurokubi': '🧛', 'yuki-onna': '❄️', 'jorogumo': '🕷️', 'nue': '🐍', 'ubume': '👼',
+        'atom': '⚛️', 'dna': '🧬', 'microscope': '🔬', 'telescope': '🔭', 'rocket': '🚀', 'satellite': '🛰️', 'spaceship': '🛸', 'planet': '🪐', 'black hole': '🕳️', 'galaxy': '🌌',
+        'comet': '☄️', 'constellation': '🌠', 'lightning': '⚡', 'magnet': '🧲', 'battery': '🔋', 'computer': '💻', 'keyboard': '⌨️', 'mouse': '🖱️', 'printer': '🖨️', 'floppy disk': '💾',
+        'cd': '💿', 'dvd': '📀', 'smartphone': '📱', 'tablet': '📲', 'watch': '⌚', 'camera': '📷', 'video camera': '📹', 'projector': '📽️', 'radio': '📻', 'television': '📺',
+        'satellite dish': '📡', 'game controller': '🎮', 'joystick': '🕹️', 'vr headset': '🕶️', 'headphones': '🎧', 'speaker': '🔊', 'flashlight': '🔦', 'circuit': '🔌', 'chip': '💻',
+        'server': '🖥️', 'database': '💾', 'cloud': '☁️', 'network': '🌐', 'code': '💻', 'bug': '🐛', 'virus': '🦠', 'bacteria': '🦠', 'lab coat': '🥼', 'safety goggles': '🥽',
+        'test tube': '🧪', 'petri dish': '🧫', 'beaker': '🧪', 'bunsen burner': '🔥', 'graduated cylinder': '🧪', 'pipette': '🧪', 'scalpel': '🔪', 'syringe': '💉', 'pill': '💊',
+        'stethoscope': '🩺', 'thermometer': '🌡️', 'x-ray': '🩻', 'brain': '🧠', 'heart': '❤️', 'lung': '🫁', 'bone': '🦴', 'muscle': '💪', 'robot arm': '🦾', 'robot leg': '🦿',
+        'prosthetic arm': '🦾', 'prosthetic leg': '🦿', 'wheelchair': '🦽', 'crutch': '🦯', 'hearing aid': '🦻', 'glasses': '👓', 'magnifying glass': '🔍', 'circus tent': '🎪',
+        'duck': '🦆', 'eagle': '🦅', 'owl': '🦉', 'bat': '🦇', 'shark': '🦈', 'butterfly': '🦋', 'snail': '🐌', 'bee': '🐝', 'beetle': '🐞', 'ant': '🐜', 'cricket': '🦗', 
+        'spider': '🕷️', 'scorpion': '🦂', 'turkey': '🦃', 'peacock': '🦚', 'parrot': '🦜', 'swan': '🦢', 'flamingo': '🦩', 'dodo': '🦤', 'sloth': '🦥', 'otter': '🦦', 
+        'skunk': '🦨', 'kangaroo': '🦘', 'badger': '🦡', 'beaver': '🦫', 'bison': '🦬', 'mammoth': '🦣', 'raccoon': '🦝', 'hedgehog': '🦔', 'squirrel': '🐿️', 'chipmunk': '🐿️', 
+        'porcupine': '🦔', 'llama': '🦙', 'giraffe': '🦒', 'zebra': '🦓', 'hippopotamus': '🦛', 'rhinoceros': '🦏', 'gorilla': '🦍', 'orangutan': '🦧', 'elephant': '🐘', 'camel': '🐫', 
+        'llama': '🦙', 'alpaca': '🦙', 'buffalo': '🐃', 'ox': '🐂', 'deer': '🦌', 'moose': '🦌', 'reindeer': '🦌', 'goat': '🐐', 'sheep': '🐑', 'ram': '🐏', 'lamb': '🐑', 'horse': '🐴', 
+        'unicorn': '🦄', 'zebra': '🦓', 'cow': '🐄', 'pig': '🐖', 'boar': '🐗', 'mouse': '🐁', 'rat': '🐀', 'hamster': '🐹', 'rabbit': '🐇', 'chipmunk': '🐿️', 'beaver': '🦫', 'hedgehog': '🦔', 
+        'bat': '🦇', 'bear': '🐻', 'koala': '🐨', 'panda': '🐼', 'sloth': '🦥', 'otter': '🦦', 'skunk': '🦨', 'kangaroo': '🦘', 'badger': '🦡', 'turkey': '🦃', 'chicken': '🐔', 'rooster': '🐓', 
+        'peacock': '🦚', 'parrot': '🦜', 'swan': '🦢', 'flamingo': '🦩', 'dodo': '🦤', 'crocodile': '🐊', 'turtle': '🐢', 'lizard': '🦎', 'snake': '🐍', 'dragon': '🐉', 'sauropod': '🦕', 't-rex': '🦖', 
+        'whale': '🐋', 'dolphin': '🐬', 'fish': '🐟', 'blowfish': '🐡', 'shark': '🦈', 'octopus': '🐙', 'shell': '🐚', 'crab': '🦀', 'lobster': '🦞', 'shrimp': '🦐', 'squid': '🦑', 'snail': '🐌', 'butterfly': '🦋', 
+        'bee': '🐝', 'beetle': '🐞', 'ant': '🐜', 'cricket': '🦗', 'spider': '🕷️', 'scorpion': '🦂', 'mosquito': '🦟', 'microbe': '🦠', 'locomotive': '🚂', 'arm': '💪', 'leg': '🦵', 'sponge': '🧽',
+        'toothbrush': '🪥', 'broom': '🧹', 'basket': '🧺', 'roll of paper': '🧻', 'bucket': '🪣', 'soap': '🧼', 'toilet paper': '🧻', 'shower': '🚿', 'bathtub': '🛁', 'razor': '🪒', 'lotion': '🧴',
+        'letter': '✉️', 'envelope': '✉️', 'mail': '📬', 'post': '📮', 'golf': '⛳️', 'golfing': '⛳️', 'office': '🏢', 'meeting': '📅', 'presentation': '📊', 'report': '📄', 'document': '📄',
+        'file': '📁', 'folder': '📂', 'sports': '🏅', 'athlete': '🏃', 'competition': '🏆', 'race': '🏁', 'tournament': '🏆', 'champion': '🏆', 'medal': '🏅', 'victory': '🏆', 'win': '🏆', 'lose': '😞',
+        'draw': '🤝', 'team': '👥', 'player': '👤', 'coach': '👨‍🏫', 'referee': '🧑‍⚖️', 'stadium': '🏟️', 'arena': '🏟️', 'field': '🏟️', 'court': '🏟️', 'track': '🏟️', 'gym': '🏋️', 'fitness': '🏋️', 'exercise': '🏋️', 
+        'workout': '🏋️', 'training': '🏋️', 'practice': '🏋️', 'game': '🎮', 'match': '🎮', 'score': '🏅', 'goal': '🥅', 'point': '🏅', 'basket': '🏀', 'home run': '⚾️', 'strike': '🎳', 'spare': '🎳', 'frame': '🎳', 
+        'inning': '⚾️', 'quarter': '🏈', 'half': '🏈', 'overtime': '🏈', 'penalty': '⚽️', 'foul': '⚽️', 'timeout': '⏱️', 'substitute': '🔄', 'bench': '🪑', 'sideline': '🏟️', 'dugout': '⚾️', 'locker room': '🚪', 'shower': '🚿', 
+        'uniform': '👕', 'jersey': '👕', 'cleats': '👟', 'helmet': '⛑️', 'pads': '🛡️', 'gloves': '🧤', 'bat': '⚾️', 'ball': '⚽️', 'puck': '🏒', 'stick': '🏒', 'net': '🥅', 'hoop': '🏀', 'goalpost': '🥅', 'whistle': '🔔', 
+        'scoreboard': '📊', 'fans': '👥', 'crowd': '👥', 'cheer': '📣', 'boo': '😠', 'applause': '👏', 'celebration': '🎉', 'parade': '🎉', 'trophy': '🏆', 'medal': '🏅', 'ribbon': '🎀', 'cup': '🏆', 'championship': '🏆', 
+        'league': '🏆', 'season': '🏆', 'playoffs': '🏆', 'finals': '🏆', 'champion': '🏆', 'runner-up': '🥈', 'third place': '🥉', 'snowman': '☃️', 'snowmen': '⛄️'
+    }
+
+    return wordToEmojiMap
+
+def sendWithEmoji(message):
+    # this will take a string of text and replace any word or phrase that is in the word list with the corresponding emoji
+    wordToEmojiMap = tableOfContents()
+    # type format to clean it up
+    words = message.split()
+    i = 0
+    while i < len(words):
+        for phrase in sorted(wordToEmojiMap.keys(), key=len, reverse=True):
+            phrase_words = phrase.split()
+            # Strip punctuation from the words
+            stripped_words = [word.lower().strip('.,!?') for word in words[i:i+len(phrase_words)]]
+            if stripped_words == phrase_words:
+                logger.debug(f"System: Replaced the phrase '{phrase}' with '{wordToEmojiMap[phrase]}'")
+                words[i:i+len(phrase_words)] = [wordToEmojiMap[phrase]]
+                i += len(phrase_words) - 1
+                break
+            # Check for plural forms
+            elif stripped_words == [word + 's' for word in phrase_words]:
+                logger.debug(f"System: Replaced the plural phrase '{' '.join([word + 's' for word in phrase_words])}' with '{wordToEmojiMap[phrase]}'")
+                words[i:i+len(phrase_words)] = [wordToEmojiMap[phrase]]
+                i += len(phrase_words) - 1
+                break
+        i += 1
+    return ' '.join(words)
+
+def tell_joke(nodeID=0):
+    dadjoke = Dadjoke()
+
+    if dad_jokes_emojiJokes:
+        renderedLaugh = sendWithEmoji(dadjoke.joke)
+    else:
+        renderedLaugh = dadjoke.joke
+    return renderedLaugh
+

modules/games/lemonade.py

@@ -0,0 +1,577 @@
+# Port of https://github.com/tigerpointe/Lemonade-Stand/blob/main/lemonade.py MIT License Copyright (c) 2023 TigerPointe Software, LLC
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+
+from collections import OrderedDict   # ordered dictionaries
+from random import randrange, uniform # random numbers
+from types import SimpleNamespace     # namespaces support
+import pickle                         # pickle file support
+import time                           # time functions
+from modules.log import *             # mesh-bot logging
+
+import locale # culture specific locale
+import math   # math functions
+import re     # regular expressions
+
+# Set all of the locale category elements as default
+# ex. print(locale.currency(12345.67, grouping=True))
+locale.setlocale(locale.LC_ALL, '')
+lemon_starting_cash = 30.00
+lemon_total_weeks = 7
+
+lemonadeTracker = [{'nodeID': 0, 'cups': 0, 'lemons': 0, 'sugar': 0, 'cash': lemon_starting_cash, 'start': lemon_starting_cash, 'cmd': 'new', 'time': time.time()}]
+lemonadeCups = [{'nodeID': 0, 'cost': 2.50, 'count': 25, 'min': 0.99, 'unit': 0.00}]
+lemonadeLemons = [{'nodeID': 0, 'cost': 4.00, 'count': 8, 'min': 2.00, 'unit': 0.00}]
+lemonadeSugar = [{'nodeID': 0, 'cost': 3.00, 'count': 15, 'min': 1.50, 'unit': 0.00}]
+lemonadeWeeks = [{'nodeID': 0, 'current': 1, 'total': lemon_total_weeks, 'sales': 99, 'potential': 0, 'unit': 0.00, 'price': 0.00, 'total_sales': 0}]
+lemonadeScore = [{'nodeID': 0, 'value': 0.00, 'total': 0.00}]
+
+def get_sales_amount(potential, unit, price):
+    """Gets the sales amount.
+    Multiply the potential sales by a ratio of unit cost to actual price; the
+    exponent results in the values falling along a curve, rather than along a
+    straight line, resulting in more realistic sales values at each price.
+    Parameters
+    potential : Potential sales
+    unit      : Unit cost
+    price     : Actual price
+    """
+    return math.floor(potential * (unit / (price ** 1.5)))
+
+def getHighScoreLemon():
+    high_score = {"userID": 0, "cash": 0, "success": 0}
+    # Load high score table
+    try:
+        with open('data/lemonstand.pkl', 'rb') as file:
+            high_score = pickle.load(file)
+    except FileNotFoundError:
+        logger.debug("System: Lemonade: No high score table found")
+        # write a new high score file if one is not found
+        with open('data/lemonstand.pkl', 'wb') as file:
+            pickle.dump(high_score, file)
+    return high_score
+
+def start_lemonade(nodeID, message, celsius=False):
+    global lemonadeTracker, lemonadeCups, lemonadeLemons, lemonadeSugar, lemonadeWeeks, lemonadeScore
+    potential = 0
+    unit = 0.0
+    price = 0.0
+    total_sales = 0
+
+    high_score = getHighScoreLemon()
+
+    def saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score):
+        # save playerDB values
+        for i in range(len(lemonadeTracker)):
+            if lemonadeTracker[i]['nodeID'] == nodeID:
+                lemonadeTracker[i]['cups'] = inventory.cups
+                lemonadeTracker[i]['lemons'] = inventory.lemons
+                lemonadeTracker[i]['sugar'] = inventory.sugar
+                lemonadeTracker[i]['cash'] = inventory.cash
+                lemonadeTracker[i]['start'] = inventory.start
+        for i in range(len(lemonadeCups)):
+            if lemonadeCups[i]['nodeID'] == nodeID:
+                lemonadeCups[i]['cost'] = cups.cost
+                lemonadeCups[i]['unit'] = cups.unit
+        for i in range(len(lemonadeLemons)):
+            if lemonadeLemons[i]['nodeID'] == nodeID:
+                lemonadeLemons[i]['cost'] = lemons.cost
+                lemonadeLemons[i]['unit'] = lemons.unit
+        for i in range(len(lemonadeSugar)):
+            if lemonadeSugar[i]['nodeID'] == nodeID:
+                lemonadeSugar[i]['cost'] = sugar.cost
+                lemonadeSugar[i]['unit'] = sugar.unit
+        for i in range(len(lemonadeWeeks)):
+            if lemonadeWeeks[i]['nodeID'] == nodeID:
+                lemonadeWeeks[i]['current'] = weeks.current
+                lemonadeWeeks[i]['total'] = weeks.total
+                lemonadeWeeks[i]['sales'] = weeks.sales
+                lemonadeWeeks[i]['potential'] = potential
+                lemonadeWeeks[i]['unit'] = unit
+                lemonadeWeeks[i]['price'] = price
+                lemonadeWeeks[i]['total_sales'] = weeks.total_sales
+        for i in range(len(lemonadeScore)):
+            if lemonadeScore[i]['nodeID'] == nodeID:
+                lemonadeScore[i]['value'] = score.value
+                lemonadeScore[i]['total'] = score.total
+
+    def endGame(nodeID):
+        # remove the player from the tracker
+        for i in range(len(lemonadeTracker)):
+            if lemonadeTracker[i]['nodeID'] == nodeID:
+                lemonadeTracker.pop(i)
+        for i in range(len(lemonadeCups)):
+            if lemonadeCups[i]['nodeID'] == nodeID:
+                lemonadeCups.pop(i)
+        for i in range(len(lemonadeLemons)):
+            if lemonadeLemons[i]['nodeID'] == nodeID:
+                lemonadeLemons.pop(i)
+        for i in range(len(lemonadeSugar)):
+            if lemonadeSugar[i]['nodeID'] == nodeID:
+                lemonadeSugar.pop(i)
+        for i in range(len(lemonadeWeeks)):
+            if lemonadeWeeks[i]['nodeID'] == nodeID:
+                lemonadeWeeks.pop(i)
+        for i in range(len(lemonadeScore)):
+            if lemonadeScore[i]['nodeID'] == nodeID:
+                lemonadeScore.pop(i)
+        logger.debug("System: Lemonade: Game Over for " + str(nodeID))
+
+    # Check for end of game
+    if message.lower().startswith("e"):
+        endGame(nodeID)
+        return "Goodbye!👋"
+
+    title="LemonStand🍋"
+    # Define the temperature unit symbols
+    fahrenheit_unit = "ºF"
+    celsius_unit    = "ºC"
+
+    # Inventory data (contains the item levels)
+    inventoryd = {
+        'cups'   : 0,
+        'lemons' : 0,
+        'sugar'  : 0,
+        'cash'   : lemon_starting_cash,
+        'start'  : lemon_starting_cash
+    }
+    inventory = SimpleNamespace(**inventoryd)
+
+    # Cups data (includes a calculated cost per unit)
+    cupsd = {
+        'cost'  : 2.50, # current price
+        'count' : 25,   # servings per box
+        'min'   : 0.99, # minimum price
+        'unit'  : 0.00  # unit price
+    }
+    cups = SimpleNamespace(**cupsd)
+    cups.unit = round(cups.cost / cups.count, 2)
+
+    # Lemons data (includes a calculated cost per unit)
+    lemonsd = {
+        'cost'  : 4.00, # current price
+        'count' : 8,    # servings per bag
+        'min'   : 2.00, # minimum price
+        'unit'  : 0.00  # unit price
+    }
+    lemons = SimpleNamespace(**lemonsd)
+    lemons.unit = round(lemons.cost / lemons.count, 2)
+
+    # Sugar data (includes a calculated cost per unit)
+    sugard = {
+        'cost'  : 3.00, # current price
+        'count' : 15,   # servings per bag
+        'min'   : 1.50, # minimum price
+        'unit'  : 0.00  # unit price
+    }
+    sugar = SimpleNamespace(**sugard)
+    sugar.unit  = round(sugar.cost / sugar.count, 2)
+
+    # Weeks data (measures the session duration)
+    weeksd = {
+        'current' : 1,   # start with the 1st week
+        'total'   : 12,  # span the 12 weeks of Summer
+        'sales'   : 99,  # 99 maximum sales per week
+        'total_sales' : 0, # total sales
+        'summary' : []   # empty array
+    }
+    weeks = SimpleNamespace(**weeksd)
+
+    # Forecast data (includes percentage values, UTF8 glyphs and display names)
+    forecastd = OrderedDict()
+    forecastd['sunny']  = [1.00, 0x2600, "Sunny"]
+    forecastd['partly'] = [0.90, 0x26C5, "Partly Sunny"]
+    forecastd['cloudy'] = [0.70, 0x2601, "Mostly Cloudy"]
+    forecastd['rainy']  = [0.40, 0x2602, "Rainy"]
+    forecastd['stormy'] = [0.10, 0x26C8, "Stormy"]
+
+    # Temperature data (uses Fahrenheit as the percentage values)
+    temperatured = {
+        'min'      : 69,
+        'max'      : 100,
+        'units'    : fahrenheit_unit,
+        'forecast' : None,
+        'value'    : None
+    }
+    temperature = SimpleNamespace(**temperatured)
+
+    # Score data (based on actual vs. maximum net sales)
+    scored = {
+        'value' : 0.00,
+        'total' : 0.00
+    }
+    score = SimpleNamespace(**scored)
+
+    # Check for Celsius
+    if (celsius):
+        temperature.units = celsius_unit
+
+    # load playerDB values
+    for i in range(len(lemonadeTracker)):
+        if lemonadeTracker[i]['nodeID'] == nodeID:
+            inventory.cups = lemonadeTracker[i]['cups']
+            inventory.lemons = lemonadeTracker[i]['lemons']
+            inventory.sugar = lemonadeTracker[i]['sugar']
+            inventory.cash = lemonadeTracker[i]['cash']
+            inventory.start = lemonadeTracker[i]['start']
+            last_cmd = lemonadeTracker[i]['cmd']
+    for i in range(len(lemonadeCups)):
+        if lemonadeCups[i]['nodeID'] == nodeID:
+            cups.cost = lemonadeCups[i]['cost']
+            cups.unit = lemonadeCups[i]['unit']
+    for i in range(len(lemonadeLemons)):
+        if lemonadeLemons[i]['nodeID'] == nodeID:
+            lemons.cost = lemonadeLemons[i]['cost']
+            lemons.unit = lemonadeLemons[i]['unit']
+    for i in range(len(lemonadeSugar)):
+        if lemonadeSugar[i]['nodeID'] == nodeID:
+            sugar.cost = lemonadeSugar[i]['cost']
+            sugar.unit = lemonadeSugar[i]['unit']
+    for i in range(len(lemonadeWeeks)):
+        if lemonadeWeeks[i]['nodeID'] == nodeID:
+            weeks.current = lemonadeWeeks[i]['current']
+            weeks.total = lemonadeWeeks[i]['total']
+            weeks.sales = lemonadeWeeks[i]['sales']
+            potential = lemonadeWeeks[i]['potential']
+            unit = lemonadeWeeks[i]['unit']
+            price = lemonadeWeeks[i]['price']
+            weeks.total_sales = lemonadeWeeks[i]['total_sales']
+    for i in range(len(lemonadeScore)):
+        if lemonadeScore[i]['nodeID'] == nodeID:
+            score.value = lemonadeScore[i]['value']
+            score.total = lemonadeScore[i]['total']
+
+    # Start the main loop
+    if (weeks.current <= weeks.total):
+
+        if "new" in last_cmd:
+            # set the last command to cups in the inventory db
+            for i in range(len(lemonadeTracker)):
+                if lemonadeTracker[i]['nodeID'] == nodeID:
+                    lemonadeTracker[i]['cmd'] = "cups"
+            # Create a new display buffer for the text messages
+            buffer= ""
+    
+            # the current week number
+            buffer += title + "Week #" + str(weeks.current) + "of" + str(weeks.total)
+
+            # Generate a random weather forecast and temperature and display
+            temperature.forecast = randrange(0, len(forecastd))
+            temperature.value = randrange(temperature.min, temperature.max)
+            formatted = str(temperature.value)
+            if (temperature.units == celsius_unit):
+                formatted = str(round(((temperature.value - 32) * (5/9))))
+            glyph = chr(forecastd[list(forecastd)[temperature.forecast]][1])
+            buffer += ". " + \
+                        formatted + temperature.units + " " + \
+                        forecastd[list(forecastd)[temperature.forecast]][2] + \
+                        " " + glyph
+
+            # Calculate the potential sales as a percentage of the maximum value
+            # (lower temperature = fewer sales, severe weather = fewer sales)
+            forecast  = forecastd[list(forecastd)[temperature.forecast]][0]
+            potential = math.floor(weeks.sales * \
+                                (temperature.value / 100) * \
+                                forecast)
+
+            # Update the cups cost
+            cups.cost = cups.cost + round(uniform(-1.50, 1.50), 2)
+            if (cups.cost < cups.min):
+                cups.cost = cups.min
+            cups.unit = round(cups.cost / cups.count, 2)
+
+            # Update the lemons cost
+            lemons.cost = lemons.cost + round(uniform(-1.50, 1.50), 2)
+            if (lemons.cost < lemons.min):
+                lemons.cost = lemons.min
+            lemons.unit = round(lemons.cost / lemons.count, 2)
+
+            # Update the sugar cost
+            sugar.cost = sugar.cost + round(uniform(-1.50, 1.50), 2)
+            if (sugar.cost < sugar.min):
+                sugar.cost = sugar.min
+            sugar.unit = round(sugar.cost / sugar.count, 2)
+
+            # Calculate the unit cost and display the estimated sales from the forecast potential
+            unit = cups.unit + lemons.unit + sugar.unit
+            buffer += " SupplyCost" + locale.currency(unit, grouping=True) + " a cup."
+            buffer += " Sales Potential:" + str(potential) + " cups."
+
+            # Display the current inventory
+            buffer += " Inventory:"
+            buffer += "🥤:" + str(inventory.cups)
+            buffer += "🍋:" + str(inventory.lemons)
+            buffer += "🍚:" + str(inventory.sugar)
+
+            # Display the updated item prices
+            buffer += f"\nPrices: "
+            buffer += "🥤:" + \
+                        locale.currency(cups.cost, grouping=True) + " 📦 of " + str(cups.count) + "."
+            buffer += " 🍋:" + \
+                        locale.currency(lemons.cost, grouping=True) + " 🧺 of " + str(lemons.count) + "."
+            buffer += " 🍚:" + \
+                        locale.currency(sugar.cost, grouping=True) + " bag for " + str(sugar.count) + "🥤."
+
+            # Display the current cash
+            gainloss   = inventory.cash - inventory.start
+            buffer += " 💵:" + \
+                        locale.currency(inventory.cash, grouping=True)
+            
+            
+            # if the player is in the red
+            pnl = locale.currency(gainloss, grouping=True)
+            if "0.00" not in pnl:
+                if pnl.startswith("-"):
+                    buffer += "📊P&L📉" + pnl
+                else:
+                    buffer += "📊P&L📈" + pnl
+
+            buffer += f"\n🥤 to buy? Have {inventory.cups} Cost {locale.currency(cups.cost, grouping=True)} a 📦 of {str(cups.count)}"
+            saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+            return buffer
+        
+        if "cups" in last_cmd:
+            # Read the number of cup boxes to purchase
+            newcups = -1
+            if "n" in message.lower():
+                message = "0"
+            try:
+                newcups = int(message)
+                if (newcups > 0):
+                    cost = round(newcups * cups.cost, 2)
+                    if (cost > inventory.cash):
+                        return "You do not have enough 💵."
+                    inventory.cups += (newcups * cups.count)
+                    inventory.cash -= cost
+                    msg = "Purchased " + str(newcups) + " 📦 "
+                    msg += str(inventory.cups) + " 🥤  in inventory. "  + locale.currency(inventory.cash, grouping=True) + f" remaining"
+                else:
+                    msg =  "No 🥤 were purchased"
+            except Exception as e:
+                return "invalid input, enter the number of 🥤 to purchase or (N)one"
+                
+            # set the last command to lemons in the inventory db
+            for i in range(len(lemonadeTracker)):
+                if lemonadeTracker[i]['nodeID'] == nodeID:
+                    lemonadeTracker[i]['cmd'] = "lemons"
+            saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+            msg += f"\n 🍋 to buy? Have {inventory.lemons}🥤 of 🍋 Cost {locale.currency(lemons.cost, grouping=True)} a 🧺 for {str(lemons.count)}🥤"
+            return msg
+                
+
+        if "lemons" in last_cmd:
+            # Read the number of lemon bags to purchase
+            newlemons = -1
+            if "n" in message.lower():
+                message = "0"
+            try:
+                newlemons = int(message)
+                if (newlemons > 0):
+                    cost = round(newlemons * lemons.cost, 2)
+                    if (cost > inventory.cash):
+                        return "You do not have enough cash."
+                    inventory.lemons += (newlemons * lemons.count)
+                    inventory.cash   -= cost
+                    msg = "Purchased " + str(newlemons) + " 🧺 "
+                    msg += str(inventory.lemons) + " 🍋  in inventory. "  + locale.currency(inventory.cash, grouping=True) + f" remaining"
+                else:
+                    msg =  "No 🍋 were purchased"
+            except Exception as e:
+                newlemons = -1
+                return "⛔️invalid input, enter the number of 🍋 to purchase"
+                
+            # set the last command to sugar in the inventory db
+            for i in range(len(lemonadeTracker)):
+                if lemonadeTracker[i]['nodeID'] == nodeID:
+                    lemonadeTracker[i]['cmd'] = "sugar"
+            saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+            msg += f"\n 🍚 to buy? You have {inventory.sugar}🥤 of 🍚, Cost {locale.currency(sugar.cost, grouping=True)} a bag for {str(sugar.count)}🥤"
+            return msg
+
+        if "sugar" in last_cmd:
+            # Read the number of sugar bags to purchase
+            newsugar = -1
+            if "n" in message.lower():
+                message = "0"
+            try:
+                newsugar = int(message)
+                if (newsugar > 0):
+                    cost = round(newsugar * sugar.cost, 2)
+                    if (cost > inventory.cash):
+                        return "You do not have enough cash."
+                    inventory.sugar += (newsugar * sugar.count)
+                    inventory.cash  -= cost
+                    msg = " Purchased " + str(newsugar) + " bag(s) of 🍚 for " + locale.currency(cost, grouping=True)
+                    msg += ". " + str(inventory.sugar) + f"🥤🍚 in inventory."
+                else:
+                    msg =  "No additional 🍚 was purchased"
+            except Exception as e:
+                return "⛔️invalid input, enter the number of 🍚 bags to purchase"
+
+            msg += f"Cost of goods is {locale.currency(unit, grouping=True)}"
+            msg += f"per 🥤 {locale.currency(inventory.cash, grouping=True)} 💵 remaining."
+            msg += f"\nPrice to Sell? or (G)rocery to buy more 🥤🍋🍚"
+
+            # set the last command to price in the inventory db
+            for i in range(len(lemonadeTracker)):
+                if lemonadeTracker[i]['nodeID'] == nodeID:
+                    lemonadeTracker[i]['cmd'] = "price"
+            saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+            return msg
+    
+        if "price" in last_cmd:
+            # set the last command to sales in the inventory db
+            for i in range(len(lemonadeTracker)):
+                if lemonadeTracker[i]['nodeID'] == nodeID:
+                    lemonadeTracker[i]['cmd'] = "sales"
+                    if "g" in message.lower():
+                        lemonadeTracker[i]['cmd'] = "cups"
+                        msg = f"#of🥤 to buy? Have {inventory.cups} Cost {locale.currency(cups.cost, grouping=True)} a 📦 of {str(cups.count)}"
+                        return msg
+                    else:
+                        last_cmd = "sales"
+            
+            # Read the actual price
+            price = 0.00
+            while (price <= 0.00):
+                try:
+                    raw   = message
+                    price = float(re.sub("[^0-9.-]", "", raw) or 0.00)
+                    if (price <= 0.00):
+                        return "The price must be greater than zero."
+                except Exception as e:
+                    price = 0.00
+                    last_cmd = "price"
+                    return "⛔️Invalid input, enter the price of the lemonade per 🥤"
+            
+            # this isnt sent to the user, not needed
+            #msg = "  Setting the price at " + locale.currency(price, grouping=True)
+            saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+        
+
+        if "sales" in last_cmd:
+            # Calculate the weekly sales based on price and lowest inventory level
+            # (higher markup price = fewer sales, limited by the inventory on-hand)
+            sales  = get_sales_amount(potential, unit, price)
+            sales  = min(potential, sales, \
+                        inventory.cups, inventory.lemons, \
+                        inventory.sugar) # "min" returns lowest value
+            margin = price - unit
+            gross  = sales * price
+            net    = sales * margin
+            
+            # Add a new row to the summary
+            weeks.summary.append({ 'sales' : sales, 'price' : price })
+                    
+            # Update the inventory levels to reflect consumption
+            inventory.cups   = inventory.cups   - sales
+            inventory.lemons = inventory.lemons - sales
+            inventory.sugar  = inventory.sugar  - sales
+            inventory.cash   = inventory.cash   + gross
+            gainloss= inventory.cash - inventory.start
+    
+            # Display the calculated sales information
+            msg = "Results Week📊#" + str(weeks.current) + "of" + str(weeks.total)
+            msg += " Cost/Price:" + locale.currency(unit, grouping=True) + "/" + locale.currency(price, grouping=True)
+            msg += " P.Margin:" + locale.currency(margin, grouping=True)
+            msg += " T.Sales:" + str(sales) + "@" + locale.currency(price, grouping=True)
+            msg += " G.Profit: " + locale.currency(gross, grouping=True)
+            msg += " N.Profit:" + locale.currency(net, grouping=True)
+
+            # Display the updated inventory levels
+            msg += "\nRemaining"
+            msg += " 🥤:" + str(inventory.cups)
+            msg += " 🍋:" + str(inventory.lemons)
+            msg += " 🍚:" + str(inventory.sugar)
+            msg += " 💵:" + locale.currency(inventory.cash, grouping=True)
+            # Display the gain/loss
+            pnl = locale.currency(gainloss, grouping=True)
+            if "0.00" not in pnl:
+                if pnl.startswith("-"):
+                    msg += "📊P&L📉" + pnl
+                else:
+                    msg += "📊P&L📈" + pnl
+    
+            # Display the weekly sales summary
+            pad_week = len(str(weeks.total))
+            pad_sale = len(str(weeks.sales))
+            total = 0
+            msg += "\nWeekly📊"
+            for i in range(len(weeks.summary)):
+                msg += "#" + str(weeks.current).rjust(pad_week) + ".  " + str(weeks.summary[i]['sales']).rjust(pad_sale) + \
+                    " sold x " + locale.currency(weeks.summary[i]['price'], grouping=True) + "ea. "
+                total = total + weeks.summary[i]['sales']
+
+            # Update the total sales for the game
+            weeks.total_sales += total
+            
+            # Loop through a range of prices to find the highest net profit
+            maxsales = 0
+            maxprice = 0.00
+            maxgross = 0.00
+            maxnet   = 0.00
+            minnet   = net
+            for i in range(25, 2500, 25):
+                price  = i / 100 # range uses integers, not currency (floats)
+                sales  = get_sales_amount(potential, unit, price)
+                margin = price - unit
+                gross  = sales * price
+                net    = sales * margin
+                if (sales  >  0) and \
+                    (sales <= potential) and \
+                    (unit  <= price):
+                        if (net > maxnet):
+                            maxsales = sales
+                            maxprice = price
+                            maxgross = gross
+                            maxnet   = net
+            if (maxnet > minnet):
+                msg += "Sales could have been:"
+                msg += "  " + str(maxsales) + " sold x " + locale.currency(maxprice, grouping=True) + "ea. @" + \
+                    locale.currency(maxgross, grouping=True) + " for a net profit of " + locale.currency(maxnet, grouping=True)
+                if (inventory.cups <= 0):
+                    msg += " You ran out of cups.🥤"
+                if (inventory.lemons <= 0):
+                    msg += " You ran out of lemons.🍋"
+                if (inventory.sugar <= 0):
+                    msg += " You ran out of sugar.🍚"
+            else:
+                msg += "\nCongratulations 🍋🍋 your sales were perfect!🎉"
+            
+            # Increment the score counters
+            score.value = score.value + minnet
+            score.total = score.total + maxnet
+
+
+            # Increment the week number
+            if (weeks.current == weeks.total):
+                # end of the game
+                success = round((score.value / score.total) * 100)
+                msg += "\nYou've made " + locale.currency(score.value, grouping=True) + " out of a possible " + \
+                    locale.currency(score.total, grouping=True) + " for a score of " + str(success) + "% "
+                msg += "You've sold " + str(weeks.total_sales) + " total 🥤🍋"
+
+                # check for high score
+                high_score = getHighScoreLemon()
+                if (inventory.cash > int(high_score['cash'])):
+                    msg += "\nCongratulations! You've set a new high score!🎉💰🍋"
+                    high_score['cash'] = inventory.cash
+                    high_score['success'] = success
+                    high_score['userID'] = nodeID
+                    with open('data/lemonstand.pkl', 'wb') as file:
+                        pickle.dump(high_score, file)
+                endGame(nodeID)
+
+            else:
+                # keep playing
+                # set the last command to new in the inventory db
+                for i in range(len(lemonadeTracker)):
+                    if lemonadeTracker[i]['nodeID'] == nodeID:
+                        lemonadeTracker[i]['cmd'] = "new"
+                        lemonadeTracker[i]['time'] = time.time()
+                
+                weeks.current = weeks.current + 1
+
+                msg += f"Play another week🥤? or (E)nd Game"
+                
+                saveValues(nodeID, inventory, cups, lemons, sugar, weeks, score)
+            return msg

modules/games/meshtrekker.py

@@ -0,0 +1,255 @@
+"""
+Mesh Trekker Game
+Game Rules:
+1. Players compete to cover the most distance over time using their Meshtastic devices.
+2. The game tracks players' movements via GPS coordinates sent by their devices.
+3. Total distance traveled is calculated and summed over time for each player.
+4. Leaderboards show top distances for daily, weekly, and all-time periods.
+5. Players can form teams, with team distances being the sum of all team members' distances.
+6. Special achievements are awarded for milestones (e.g., 10km, 50km, 100km total distance).
+7. The game runs continuously, allowing players to participate at their own pace.
+8. Players can use the 'whereami' command to check their current location and update their position in the game.
+"""
+
+import pickle
+from modules.log import *
+from datetime import datetime, timedelta
+from geopy.distance import geodesic
+
+class MeshTrekkerError(Exception):
+    """Base class for exceptions in this module."""
+    pass
+
+class DataLoadError(MeshTrekkerError):
+    """Raised when there's an error loading data."""
+    pass
+
+class DataSaveError(MeshTrekkerError):
+    """Raised when there's an error saving data."""
+    pass
+
+class InvalidGPSDataError(MeshTrekkerError):
+    """Raised when invalid GPS data is provided."""
+    pass
+
+class MeshTrekker:
+    def __init__(self, data_file='mesh_trekker_data.pkl'):
+        self.data_file = data_file
+        try:
+            self.data = self.load_data()
+        except DataLoadError as e:
+            logger.error(f"Failed to load data: {e}")
+            self.data = self.initialize_data()
+
+    def initialize_data(self):
+        return {
+            'gps_data': {},
+            'user_distances': {},
+            'teams': {},
+            'achievements': {},
+        }
+
+    def load_data(self):
+        try:
+            with open(self.data_file, 'rb') as f:
+                return pickle.load(f)
+        except (pickle.PickleError, EOFError, FileNotFoundError) as e:
+            logger.info(f"Data file {self.data_file} not found. Initializing new data.")
+            return self.initialize_data()
+
+    def save_data(self):
+        try:
+            with open(self.data_file, 'wb') as f:
+                pickle.dump(self.data, f)
+        except (pickle.PickleError, IOError) as e:
+            raise DataSaveError(f"Error saving data: {e}")
+
+    def validate_gps_data(self, latitude, longitude, timestamp):
+        try:
+            lat = float(latitude)
+            lon = float(longitude)
+            if not -90 <= lat <= 90:
+                raise InvalidGPSDataError(f"Invalid latitude: {latitude}")
+            if not -180 <= lon <= 180:
+                raise InvalidGPSDataError(f"Invalid longitude: {longitude}")
+            if not isinstance(timestamp, datetime):
+                raise InvalidGPSDataError(f"Invalid timestamp: {timestamp}")
+        except ValueError:
+            raise InvalidGPSDataError(f"Invalid GPS data: latitude={latitude}, longitude={longitude}")
+
+    def process_gps_data(self, user_id, latitude, longitude, timestamp):
+        try:
+            self.validate_gps_data(latitude, longitude, timestamp)
+
+            if user_id not in self.data['gps_data']:
+                self.data['gps_data'][user_id] = []
+
+            self.data['gps_data'][user_id].append((float(latitude), float(longitude), timestamp))
+
+            if len(self.data['gps_data'][user_id]) > 1:
+                last_lat, last_lon, last_time = self.data['gps_data'][user_id][-2]
+                last_point = (last_lat, last_lon)
+                new_point = (float(latitude), float(longitude))
+
+                distance = geodesic(last_point, new_point).kilometers
+
+                if user_id not in self.data['user_distances']:
+                    self.data['user_distances'][user_id] = (0, timestamp)
+
+                total_distance, _ = self.data['user_distances'][user_id]
+                new_total_distance = total_distance + distance
+                self.data['user_distances'][user_id] = (new_total_distance, timestamp)
+
+                self.check_achievements(user_id, new_total_distance)
+
+            self.save_data()
+            return new_total_distance
+        except InvalidGPSDataError as e:
+            logger.error(f"Invalid GPS data for user {user_id}: {e}")
+        except DataSaveError as e:
+            logger.error(f"Failed to save data after processing GPS for user {user_id}: {e}")
+        except Exception as e:
+            logger.error(f"Unexpected error processing GPS data for user {user_id}: {e}")
+        return None
+
+    def get_leaderboard(self, timeframe='all'):
+        try:
+            now = datetime.now()
+            if timeframe == 'daily':
+                start_time = now - timedelta(days=1)
+            elif timeframe == 'weekly':
+                start_time = now - timedelta(weeks=1)
+            else:
+                start_time = datetime.min
+
+            leaderboard = []
+            for user_id, (distance, last_updated) in self.data['user_distances'].items():
+                if last_updated > start_time:
+                    leaderboard.append((user_id, distance))
+
+            return sorted(leaderboard, key=lambda x: x[1], reverse=True)[:10]
+        except Exception as e:
+            logger.error(f"Error generating leaderboard: {e}")
+            return []
+
+    def get_team_leaderboard(self):
+        try:
+            team_distances = {}
+            for team_name, members in self.data['teams'].items():
+                team_distance = sum(self.data['user_distances'].get(member, (0, None))[0] for member in members)
+                team_distances[team_name] = team_distance
+
+            return sorted(team_distances.items(), key=lambda x: x[1], reverse=True)[:10]
+        except Exception as e:
+            logger.error(f"Error generating team leaderboard: {e}")
+            return []
+
+    def get_user_stats(self, user_id):
+        try:
+            distance, last_updated = self.data['user_distances'].get(user_id, (0, None))
+            achievements = self.data['achievements'].get(user_id, [])
+            return {
+                'distance': distance,
+                'last_updated': last_updated,
+                'achievements': achievements
+            }
+        except Exception as e:
+            logger.error(f"Error retrieving stats for user {user_id}: {e}")
+            return None
+
+    def create_team(self, team_name, user_id):
+        try:
+            if team_name not in self.data['teams']:
+                self.data['teams'][team_name] = [user_id]
+                self.save_data()
+                return True
+            return False
+        except DataSaveError as e:
+            logger.error(f"Failed to save data after creating team {team_name}: {e}")
+            return False
+        except Exception as e:
+            logger.error(f"Error creating team {team_name}: {e}")
+            return False
+
+    def join_team(self, team_name, user_id):
+        try:
+            if team_name in self.data['teams'] and user_id not in self.data['teams'][team_name]:
+                self.data['teams'][team_name].append(user_id)
+                self.save_data()
+                return True
+            return False
+        except DataSaveError as e:
+            logger.error(f"Failed to save data after user {user_id} joined team {team_name}: {e}")
+            return False
+        except Exception as e:
+            logger.error(f"Error joining team {team_name} for user {user_id}: {e}")
+            return False
+
+    def check_achievements(self, user_id, total_distance):
+        try:
+            if user_id not in self.data['achievements']:
+                self.data['achievements'][user_id] = []
+
+            milestones = [10, 50, 100, 500, 1000]  # in km
+            new_achievements = []
+            for milestone in milestones:
+                if total_distance >= milestone and milestone not in self.data['achievements'][user_id]:
+                    self.data['achievements'][user_id].append(milestone)
+                    new_achievements.append(milestone)
+                    logger.info(f"User {user_id} achieved {milestone}km milestone!")
+            return new_achievements
+        except Exception as e:
+            logger.error(f"Error checking achievements for user {user_id}: {e}")
+            return []
+
+    def get_achievements(self, user_id):
+        try:
+            return self.data['achievements'].get(user_id, [])
+        except Exception as e:
+            logger.error(f"Error retrieving achievements for user {user_id}: {e}")
+            return []
+        
+# Initialize the game
+game = MeshTrekker()
+
+def handle_meshtrekker(user_id, deviceID, channel_number, location_info=(0,0)):
+    # Process GPS data from Meshtastic devices
+    latitude, longitude = location_info.split(": ")[1].split(", ")
+    
+    current_time = datetime.now()
+    new_distance = game.process_gps_data(user_id, latitude, longitude, current_time)
+
+
+    # # Create and join teams
+    # game.create_team("Team A", "user1")
+    # game.join_team("Team A", "user2")
+
+    # # Get individual leaderboard
+    # print("\nAll-time individual leaderboard:")
+    # for user, distance in game.get_leaderboard():
+    #     print(f"{user}: {distance:.2f} km")
+
+    # # Get team leaderboard
+    # print("\nTeam leaderboard:")
+    # for team, distance in game.get_team_leaderboard():
+    #     print(f"{team}: {distance:.2f} km")
+
+    # # Get user stats
+    # user_stats = game.get_user_stats("user1")
+    # print(f"\nUser1 stats: {user_stats}")
+
+    # # Get achievements
+    # achievements = game.get_achievements("user1")
+    # print(f"User1 achievements: {achievements}")
+
+    
+    if new_distance is not None:
+        new_achievements = game.check_achievements(user_id, new_distance)
+        response = f"{location_info}\nTotal distance: {new_distance:.2f} km"
+        if new_achievements:
+            response += f"\nNew achievements: {', '.join([f'{a}km' for a in new_achievements])}"
+    else:
+        response = f"{location_info}\nFailed to update distance. Please try again."
+    
+    return response
+

modules/games/mmind.py

@@ -0,0 +1,340 @@
+# https://github.com/pwdkramer/pythonMastermind/blob/main/main.py
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+
+import random
+import time
+import pickle
+from modules.log import *
+
+mindTracker = [{'nodeID': 0, 'last_played': time.time(), 'cmd': '', 'secret_code': '', 'diff': 'n', 'turns': 1}]
+
+def chooseDifficultyMMind(message):
+    usrInput = message.lower()
+    msg = ''
+    valid_colorsMMind = "RYGB"
+    
+    if not usrInput.startswith("n") and not usrInput.startswith("h") and not usrInput.startswith("x"):
+        # default to normal difficulty
+        usrInput = "n"
+    
+    if usrInput == "n":
+        msg += f"The colors to choose from are:\nR🔴, Y🟡, G🟢, B🔵"
+    elif usrInput == "h":
+        valid_colorsMMind += "OP"
+        msg += f"The colors to choose from are\nR🔴, Y🟡, G🟢, B🔵, O🟠, P🟣"
+    elif usrInput == "x":
+        valid_colorsMMind += "OPWK"
+        msg += f"The colors to choose from are\nR🔴, Y🟡, G🟢, B🔵, O🟠, P🟣, W⚪, K⚫"
+    return msg
+
+
+#possible colors on nomral: Red, Yellow, Green, Blue
+#added colors on hard: Orange, Purple
+def makeCodeMMind(diff):
+    secret_code = ""
+    for i in range(4):
+        if diff == "n":
+            roll = random.randrange(1, 5)
+        elif diff == "h":
+            roll = random.randrange(1,7)
+        elif diff == "x":
+            roll = random.randrange(1,9)
+        else:
+            print("Difficulty error in makeCode()")
+        if roll == 1:
+            secret_code += "R"
+        elif roll == 2:
+            secret_code += "Y"
+        elif roll == 3:
+            secret_code += "G"
+        elif roll == 4:
+            secret_code += "B"
+        elif roll == 5:
+            secret_code += "O"
+        elif roll == 6:
+            secret_code += "P"
+        elif roll == 7:
+            secret_code += "W"
+        elif roll == 8:
+            secret_code += "K"
+        else:
+            print("Error with range of roll in makeCode()")
+    return secret_code
+
+#get guess from user
+def getGuessMMind(diff, guess):
+    msg = ''
+    if diff == "n":
+        valid_colorsMMind = "RYGB"
+    elif diff == "h":
+        valid_colorsMMind = "RYGBOP"
+    elif diff == "x":
+        valid_colorsMMind = "RYGBOPWK"
+        
+    user_guess = guess.upper()
+    valid_guess = True
+    if len(user_guess) != 4:
+        valid_guess = False
+    for i in range(len(user_guess)):
+        if user_guess[i] not in valid_colorsMMind:
+            valid_guess = False
+    if valid_guess == False:
+        user_guess = "XXXX"
+    return user_guess
+
+def getHighScoreMMind(nodeID, turns, diff):
+    # check if player is in high score list and pick the lowest score
+    try:
+        with open('mmind_hs.pkl', 'rb') as f:
+            mindHighScore = pickle.load(f)
+    except:
+        logger.debug("System: MasterMind: High Score file not found.")
+        mindHighScore = [{'nodeID': nodeID, 'turns': turns, 'diff': diff}]
+        with open('mmind_hs.pkl', 'wb') as f:
+            pickle.dump(mindHighScore, f)
+
+    if nodeID == 0:
+        # just return the high score
+        return mindHighScore
+
+    # calculate lowest score
+    lowest_score = mindHighScore[0]['turns']
+
+    if mindHighScore[0]['diff'] == "n" and diff == "n":
+        if lowest_score > turns:
+            # update the high score for normal if new score is lower
+            mindHighScore[0]['nodeID'] = nodeID
+            mindHighScore[0]['turns'] = turns
+            mindHighScore[0]['diff'] = diff
+            
+            # write new high score to file
+            with open('mmind_hs.pkl', 'wb') as f:
+                pickle.dump(mindHighScore, f)
+            return mindHighScore
+    elif mindHighScore[0]['diff'] == "n" and diff == "h":
+        # update the high score for hard if normal is the only high score
+        mindHighScore[0]['nodeID'] = nodeID
+        mindHighScore[0]['turns'] = turns
+        mindHighScore[0]['diff'] = diff
+        
+        # write new high score to file
+        with open('mmind_hs.pkl', 'wb') as f:
+            pickle.dump(mindHighScore, f)
+        return mindHighScore
+    elif mindHighScore[0]['diff'] == "h" and diff == "h":
+        if lowest_score > turns:
+            # update the high score for hard if new score is lower
+            mindHighScore[0]['nodeID'] = nodeID
+            mindHighScore[0]['turns'] = turns
+            mindHighScore[0]['diff'] = diff
+            
+            # write new high score to file
+            with open('mmind_hs.pkl', 'wb') as f:
+                pickle.dump(mindHighScore, f)
+            return mindHighScore
+    elif mindHighScore[0]['diff'] == "n" or mindHighScore[0]['diff'] == "h" and diff == "x":
+        # update the high score for expert if normal or high is the only high score
+        mindHighScore[0]['nodeID'] = nodeID
+        mindHighScore[0]['turns'] = turns
+        mindHighScore[0]['diff'] = diff
+        
+        # write new high score to file
+        with open('mmind_hs.pkl', 'wb') as f:
+            pickle.dump(mindHighScore, f)
+        return mindHighScore
+    elif mindHighScore[0]['diff'] == "x" and diff == "x":
+        if lowest_score > turns:
+            # update the high score for expert if new score is lower
+            mindHighScore[0]['nodeID'] = nodeID
+            mindHighScore[0]['turns'] = turns
+            mindHighScore[0]['diff'] = diff
+            
+            # write new high score to file
+            with open('mmind_hs.pkl', 'wb') as f:
+                pickle.dump(mindHighScore, f)
+            return mindHighScore
+    return 0
+
+
+def getEmojiMMind(secret_code):
+    # for each letter in the secret code, convert to emoji for display
+    secret_code = secret_code.upper()
+    secret_code_emoji = ""
+    for i in range(len(secret_code)):
+        if secret_code[i] == "R":
+            secret_code_emoji += "🔴"
+        elif secret_code[i] == "Y":
+            secret_code_emoji += "🟡"
+        elif secret_code[i] == "G":
+            secret_code_emoji += "🟢"
+        elif secret_code[i] == "B":
+            secret_code_emoji += "🔵"
+        elif secret_code[i] == "O":
+            secret_code_emoji += "🟠"
+        elif secret_code[i] == "P":
+            secret_code_emoji += "🟣"
+        elif secret_code[i] == "W":
+            secret_code_emoji += "⚪"
+        elif secret_code[i] == "K":
+            secret_code_emoji += "⚫"
+        elif secret_code[i] == "X":
+            secret_code_emoji += "❌"
+    return secret_code_emoji
+
+#compare userGuess with secret code and provide feedback
+def compareCodeMMind(secret_code, user_guess):
+    game_won = False
+    perfect_pins = 0
+    wrong_position = 0
+    msg = ''
+    #logger.debug("System: MasterMind: secret_code: " + str(secret_code) + " user_guess: " + str(user_guess))
+    if secret_code == user_guess: #correct guess, user wins
+        perfect_pins = 4
+        game_won = True
+    else:
+        # check for perfect pins and right color wrong position
+        temp_code = []
+        temp_guess = []
+        # Check for perfect pins
+        for i in range(len(user_guess)):
+            if user_guess[i] == secret_code[i]:
+                perfect_pins += 1
+            else:
+                temp_code.append(secret_code[i])
+                temp_guess.append(user_guess[i])
+
+        # Check for right color wrong position
+        for guess in temp_guess:
+            if guess in temp_code:
+                wrong_position += 1
+                temp_code.remove(guess)  # Remove the first occurrence of the matched color
+    # display feedback
+    if game_won:
+        msg += f"Correct{getEmojiMMind(user_guess)}\n"
+    else:
+        msg += f"Guess{getEmojiMMind(user_guess)}\n"
+
+    if perfect_pins > 0 and game_won == False:
+        msg += "✅ color ✅ position: {}".format(perfect_pins)
+
+    if wrong_position > 0:
+        if "✅" in msg: msg += f"\n"
+        msg += "✅ color 🚫 position: {}".format(wrong_position)
+    
+    if "✅" not in msg and game_won == False:
+        msg += "🚫No pins in your guess😿 are in the code!"
+
+    return msg
+
+#game loop with turn counter
+def playGameMMind(diff, secret_code, turn_count, nodeID, message):
+    msg = ''
+    won = False
+    if turn_count <= 10:
+        user_guess = getGuessMMind(diff, message)
+        if user_guess == "XXXX":
+            msg += f"⛔️Invalid guess. Please enter 4 valid colors letters.\n🔴🟢🔵🔴 is RGBR"
+            return msg
+        check_guess = compareCodeMMind(secret_code, user_guess)
+
+        # display turn count and feedback
+        msg += "Turn {}:".format(turn_count)
+        if check_guess.startswith("Correct"):
+            won = True
+        msg += check_guess
+    
+        if won == True:
+            msg += f"\n🎉🧠 you win 🥷🤯"
+            # get high score
+            high_score = getHighScoreMMind(nodeID, turn_count, diff)
+            if high_score != 0:
+                msg += f"\n🏆 High Score:{high_score[0]['turns']} turns, Difficulty:{high_score[0]['diff'].upper()}"
+            
+            msg += "\nWould you like to play again?\n(N)ormal, (H)ard, e(X)pert (E)nd?"
+            # reset turn count in tracker
+            for i in range(len(mindTracker)):
+                if mindTracker[i]['nodeID'] == nodeID:
+                    mindTracker[i]['turns'] = 1
+                    mindTracker[i]['secret_code'] = ''
+                    mindTracker[i]['cmd'] = 'new'
+        else:
+            # increment turn count and keep playing
+            turn_count += 1
+            # store turn count in tracker
+            for i in range(len(mindTracker)):
+                if mindTracker[i]['nodeID'] == nodeID:
+                    mindTracker[i]['turns'] = turn_count
+    elif won == False:
+        msg += f"🙉Game Over🙈\nThe code was: {getEmojiMMind(secret_code)}"
+        msg += "\nYou have run out of turns.😿"
+        msg += "\nWould you like to play again? (N)ormal, (H)ard, or e(X)pert?"
+        # reset turn count in tracker
+        for i in range(len(mindTracker)):
+            if mindTracker[i]['nodeID'] == nodeID:
+                mindTracker[i]['turns'] = 1
+                mindTracker[i]['secret_code'] = ''
+                mindTracker[i]['cmd'] = 'new'
+
+    return msg
+
+def endGameMMind(nodeID):
+    global mindTracker
+    # remove player from tracker
+    for i in range(len(mindTracker)):
+        if mindTracker[i]['nodeID'] == nodeID:
+            del mindTracker[i]
+            logger.debug("System: MasterMind: Player removed: " + str(nodeID))
+            break
+
+#main game
+def start_mMind(nodeID, message):
+    global mindTracker
+    last_cmd = ""
+    msg = ''
+
+    # get player's last command from tracker if not new player
+    for i in range(len(mindTracker)):
+        if mindTracker[i]['nodeID'] == nodeID:
+            last_cmd = mindTracker[i]['cmd']
+
+    if last_cmd == "new":
+        if message.lower().startswith("n") or message.lower().startswith("h") or message.lower().startswith("x"):
+            diff = message.lower()[0]
+        else:
+            diff = "n"
+
+        # set player's last command to makeCode
+        for i in range(len(mindTracker)):
+            if mindTracker[i]['nodeID'] == nodeID:
+                mindTracker[i]['cmd'] = 'makeCode'
+                mindTracker[i]['diff'] = diff
+        # Return color message to player
+        msg += chooseDifficultyMMind(message.lower()[0])
+        return msg
+    
+    if last_cmd == "makeCode":
+        # get difficulty from tracker
+        for i in range(len(mindTracker)):
+            if mindTracker[i]['nodeID'] == nodeID:
+                diff = mindTracker[i]['diff']
+
+        secret_code = makeCodeMMind(diff)
+        last_cmd = "playGame"
+        # set player's last command to playGame
+        for i in range(len(mindTracker)):
+            if mindTracker[i]['nodeID'] == nodeID:
+                mindTracker[i]['cmd'] = 'playGame'
+                mindTracker[i]['secret_code'] = secret_code
+                mindTracker[i]['last_played'] = time.time()
+    
+    if last_cmd == "playGame":
+        # get difficulty, secret code, and turn count from tracker
+        for i in range(len(mindTracker)):
+            if mindTracker[i]['nodeID'] == nodeID:
+                diff = mindTracker[i]['diff']
+                secret_code = mindTracker[i]['secret_code']
+                turn_count = mindTracker[i]['turns']
+
+        msg += playGameMMind(diff, secret_code, turn_count, nodeID=nodeID, message=message)
+
+    return msg

modules/games/videopoker.py

@@ -0,0 +1,450 @@
+# Port of https://github.com/devtronvarma/Video-Poker-Terminal-Game
+# Adapted for Meshtastic mesh-bot by K7MHI Kelly Keeton 2024
+import random
+import time
+import pickle
+from modules.log import *
+
+vpStartingCash = 20
+vpTracker= [{'nodeID': 0, 'cmd': 'new', 'time': time.time(), 'cash': vpStartingCash, 'player': None, 'deck': None, 'highScore': 0, 'drawCount': 0}]
+
+# Define the Card class
+class CardVP:
+
+    card_values = {  # value of the ace is high until it needs to be low
+        2: 2,
+        3: 3,
+        4: 4,
+        5: 5,
+        6: 6,
+        7: 7,
+        8: 8,
+        9: 9,
+        10: 10,
+        'Jack': 11,
+        'Queen': 12,
+        'King': 13,
+        'Ace': 14
+    }
+
+    def __init__(self, suit, rank):
+        """
+        :param suit: The face of the card, e.g. Spade or Diamond
+        :param rank: The value of the card, e.g 3 or King
+        """
+        self.suit = suit.capitalize()
+        self.rank = rank
+        self.points = self.card_values[rank]
+
+# Function to output ascii version of the cards in a hand in the terminal
+def drawCardsVp(*cards, return_string=True):
+    """
+    Instead of a boring text version of the card we render an ASCII image of the card.
+    :param cards: One or more card objects
+    :param return_string: By default we return the string version of the card, but the dealer hide the 1st card and we
+    keep it as a list so that the dealer can add a hidden card in front of the list
+    """
+    # we will use this to prints the appropriate icons for each card
+    suits_name = ['Spades', 'Diamonds', 'Hearts', 'Clubs']
+    suits_symbols = ['♠️', '♦️', '♥️', '♣️']
+
+    # create an empty list of list, each sublist is a line 2 lines for the card
+    lines = [[] for i in range(1)]
+
+    for index, card in enumerate(cards):
+        # "King" should be "K" and "10" should still be "10"
+        if card.rank == 10:  # ten is the only one who's rank is 2 char long
+            rank = str(card.rank)
+        else:
+            rank = str(card.rank)[0]  # some have a rank of 'King' this changes that to a simple 'K' ("King" doesn't fit)
+        # get the cards suit in two steps
+        suit = suits_name.index(card.suit)
+        suit = suits_symbols[suit]
+
+        # add the individual card on a line by line basis
+        lines[0].append('{}{} '.format(rank, suit))
+
+    result = []
+    #result.append('1       2       3       4      5')  # add the index for the cards to top row
+    for index, line in enumerate(lines):
+        result.append(''.join(lines[index]))
+
+    # hidden cards do not use string
+    if return_string:
+        return '\n'.join(result)
+    else:
+        return result
+
+# Define Deck class 
+class DeckVP:
+    
+    def __init__(self):
+        self.cards = []
+        self.build()
+
+    # method for building the deck
+    def build(self):
+        for s in ['Spades', 'Diamonds', 'Hearts', 'Clubs']:
+            for v in range(2, 11):
+                self.cards.append(CardVP(s,v))
+            for c in ["Jack", "Queen", "King", "Ace"]:
+                self.cards.append(CardVP(s,c))
+
+    # method to show cards in deck
+    def display(self):
+        for c in self.cards:
+            print(drawCardsVp(c))
+
+    # method to shuffle cards in deck
+    def shuffle(self):
+        for i in range(len(self.cards) - 1, 0, -1):
+            r = random.randint(0, i)
+            self.cards[i], self.cards[r] = self.cards[r], self.cards[i]
+
+    # method to draw card from the deck
+    def draw_card(self):
+        return self.cards.pop()
+
+# Define Player Class
+class PlayerVP:
+    def __init__(self):
+        self.hand = []
+        self.bankroll = 20
+
+    # Method for initial five-card draw
+    def draw_cards(self, deck):
+        for i in range(5):
+            self.hand.append(deck.draw_card())
+        return self
+
+    # Method for displaying player's hand
+    def show_hand(self):
+        msg = (drawCardsVp(
+                self.hand[0],
+                self.hand[1],
+                self.hand[2],
+                self.hand[3],
+                self.hand[4]))
+        return msg
+
+    # Method for placing a bet
+    def bet(self, ammount=0):
+        bet = int(ammount)
+        self.bet_size = bet
+        self.bankroll -= self.bet_size
+
+    # Method for selecting cards to redraw
+    def redraw(self, deck, message):
+        # if message has single digit, then it is the card to redraw, else it is the list of cards to redraw with a comma
+        if len(message) == 1:
+            try:
+                # if single digit is the letter a redraw all cards
+                if message.lower() == "a":
+                    for i in range(5):
+                        self.hand[i] = deck.draw_card()
+                else:
+                    # error trap for bad input
+                    redraw_index = int(message) - 1
+                    self.hand[redraw_index] = deck.draw_card()
+
+                return self.show_hand()
+            except Exception as e:
+                pass
+        else:
+            try:
+                # error trap for bad input
+                if "," in message:
+                    redraw_list = [int(x) - 1 for x in message.split(',')]
+                if "." in message:
+                    redraw_list = [int(x) - 1 for x in message.split('.')]
+                if " " in message:
+                    redraw_list = [int(x) - 1 for x in message.split(' ')]
+                for i in redraw_list:
+                    self.hand[i] = deck.draw_card()
+                return self.show_hand()    
+            except Exception as e:
+                pass
+
+        return "ex:1,3,4 deals them new, and keeps 2,5 or (N)o to keep current (H)and"
+
+    # Method for scoring hand, calculating winnings, and outputting message
+    def score_hand(self, resetHand = True):
+        points = sorted([self.hand[i].points for i in range(5)])
+        suits = [self.hand[i].suit for i in range(5)]
+        points_repeat = [points.count(i) for i in points]
+        suits_repeat = [suits.count(i) for i in suits]
+        diff = max(points) - min(points)
+        hand_name = ""
+        msg = ""
+        payoff = {
+            "👑Royal Flush🚽": 10,
+            "🧻Straight Flush🚽": 9,
+            "Flush🚽": 8,
+            "Full House🏠": 7,
+            "Four of a Kind👯👯": 6,
+            "Three of a Kind☘️": 5,
+            "Two Pair👯👯": 4,
+            "Straight📏": 3,
+            "Pair👯": 2,
+            "Bad Hand 🙈": -1,
+        }
+
+        if 5 in suits_repeat:
+            if points == [10, 11, 12, 13, 14]: #find royal flush
+                hand_name = "👑Royal Flush🚽"
+                if resetHand:
+                    self.bankroll += self.bet_size * payoff[hand_name]
+            elif diff == 4 and max(points_repeat) == 1: # find straight flush w/o ace low
+                hand_name = "🧻Straight Flush🚽"
+                if resetHand:
+                    self.bankroll += self.bet_size * payoff[hand_name]
+            elif diff == 12 and points[4] == 14: # find straight flush w/ace low
+                check = 0
+                for i in range(1, 4):
+                    check += points[i] - points[i - 1]
+                if check == 3:
+                    hand_name =  "🧻Straight Flush🚽"
+                    if resetHand:
+                        self.bankroll += self.bet_size * payoff[hand_name]
+                else:
+                    hand_name =  "Flush🚽"
+                    if resetHand:
+                        self.bankroll += self.bet_size * payoff[hand_name]
+            else:
+                hand_name = "Flush🚽"
+                if resetHand:
+                    self.bankroll += self.bet_size * payoff[hand_name]
+        elif sorted(points_repeat) == [2,2,3,3,3]: # find full house
+            hand_name = "Full House🏠"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif 4 in points_repeat: # find four of a kind
+            hand_name = "Four of a Kind👯👯"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif 3 in points_repeat: # find three of a kind
+            hand_name = "Three of a Kind☘️"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif points_repeat.count(2) == 4: # find two-pair
+            hand_name = "Two Pair👯👯"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif 2 in points_repeat: # find pair
+            hand_name = "Pair👯"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif diff == 4 and max(points_repeat) == 1: # find straight w/o ace low
+            hand_name = "Straight📏"
+            if resetHand:
+                self.bankroll += self.bet_size * payoff[hand_name]
+        elif diff == 12 and points[4] == 14: # find straight w/ace low
+            check = 0
+            for i in range(1, 4):
+                check += points[i] - points[i - 1]
+                if check == 3:
+                    hand_name = "Straight📏"
+                    if resetHand:
+                        self.bankroll += self.bet_size * payoff[hand_name]
+                else:
+                    hand_name = "Bad Hand 🙈"
+        else: # for everything Hand
+            hand_name = "Bad Hand 🙈"
+
+        if resetHand:
+            self.hand = []
+            msg = f"\nYour hand, {hand_name}. Your bankroll is now {self.bankroll} coins."
+        else:
+            if hand_name != "":
+                msg = f"\nShowing:{hand_name}"
+        return msg
+
+
+def getLastCmdVp(nodeID):
+    last_cmd = ""
+    for i in range(len(vpTracker)):
+        if vpTracker[i]['nodeID'] == nodeID:
+            last_cmd = vpTracker[i]['cmd']
+    return last_cmd
+
+def setLastCmdVp(nodeID, cmd):
+    for i in range(len(vpTracker)):
+        if vpTracker[i]['nodeID'] == nodeID:
+            vpTracker[i]['cmd'] = cmd
+
+def saveHSVp(nodeID, highScore):
+    # Save the game high_score to pickle
+    highScore = {'nodeID': nodeID, 'highScore': highScore}
+    try:
+        with open('data/videopoker_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+    except FileNotFoundError:
+        logger.debug("System: BlackJack: Creating new data/videopoker_hs.pkl file")
+        with open('data/videopoker_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+
+def loadHSVp():
+    # Load the game high_score from pickle
+    try:
+        with open('data/videopoker_hs.pkl', 'rb') as file:
+            highScore = pickle.load(file)
+            return highScore
+    except FileNotFoundError:
+        logger.debug("System: VideoPoker: Creating new data/videopoker_hs.pkl file")
+        highScore = {'nodeID': 0, 'highScore': 0}
+        with open('data/videopoker_hs.pkl', 'wb') as file:
+            pickle.dump(highScore, file)
+        return 0
+
+def playVideoPoker(nodeID, message):
+    msg = ""
+
+    # Initialize the player
+    if getLastCmdVp(nodeID) is None or getLastCmdVp(nodeID=nodeID) == "":
+        # create new player if not in tracker
+        logger.debug(f"System: VideoPoker: New Player {nodeID}")
+        vpTracker.append({'nodeID': nodeID, 'cmd': 'new', 'time': time.time(), 'cash': vpStartingCash, 'player': None, 'deck': None, 'highScore': 0, 'drawCount': 0})
+        return f"Welcome to 🎰VideoPoker♥️ you have {vpStartingCash} coins, Whats your bet?"
+    
+    # Gather the player's bet
+    if getLastCmdVp(nodeID) == "new" or getLastCmdVp(nodeID) == "gameOver":
+        # Initialize shuffled Deck and Player
+        player = PlayerVP()
+        deck = DeckVP()
+        deck.shuffle()
+        drawCount = 1
+        bet = 0
+        msg = ''
+
+        # load the player bankroll from tracker
+        for i in range(len(vpTracker)):
+            if vpTracker[i]['nodeID'] == nodeID:
+                player.bankroll = vpTracker[i]['cash']
+                vpTracker[i]['time'] = time.time()
+
+        # Detect if message is a bet
+        try:
+            bet = int(message)
+        except ValueError:
+            msg += f"Please enter a valid bet, 1 to 5 coins. you have {player.bankroll} coins."
+
+        # Check if bet is valid
+        if bet > player.bankroll:
+            msg += f"You can only bet the money you have. {player.bankroll} coins, No strip poker here..."
+        elif bet < 1:
+            msg += "You must bet at least 1 coin.🪙"
+        elif bet > 5:
+            msg += "The 🎰 coin slot only fits 5 coins max."
+
+        # if msg contains an error, return it
+        if msg is not None and msg != '':
+            return msg
+        else:
+            # Take the bet
+            player.bet(str(message))
+            # Bet placed, start the game
+            setLastCmdVp(nodeID, "playing")
+
+            # save player and deck to tracker
+            for i in range(len(vpTracker)):
+                if vpTracker[i]['nodeID'] == nodeID:
+                    vpTracker[i]['player'] = player
+                    vpTracker[i]['deck'] = deck
+                    vpTracker[i]['cash'] = player.bankroll
+
+    # Play the game
+    if getLastCmdVp(nodeID) == "playing":
+        msg = ''
+    
+        player.draw_cards(deck)
+        msg += player.show_hand()
+        # give hint to player
+        msg += player.score_hand(resetHand=False)
+        
+        # save player and deck to tracker
+        for i in range(len(vpTracker)):
+            if vpTracker[i]['nodeID'] == nodeID:
+                vpTracker[i]['player'] = player
+                vpTracker[i]['deck'] = deck
+                vpTracker[i]['drawCount'] = drawCount
+
+        msg += f"\nDeal new card? \nex: 1,3,4 or (N)o,(A)ll (H)and"
+        setLastCmdVp(nodeID, "redraw")
+        return msg
+    
+    if getLastCmdVp(nodeID) == "redraw":
+        msg = ''
+        # load the player and deck from tracker
+        for i in range(len(vpTracker)):
+            if vpTracker[i]['nodeID'] == nodeID:
+                player = vpTracker[i]['player']
+                deck = vpTracker[i]['deck']
+                drawCount  = vpTracker[i]['drawCount']
+
+        # if player wants to redraw cards, and not done already
+        if message.lower().startswith("n"):
+            setLastCmdVp(nodeID, "endGame")
+        if message.lower().startswith("h"):
+            msg = player.show_hand()
+            return msg
+        else:
+            if drawCount <= 1:
+                msg = player.redraw(deck, message)
+                if msg.startswith("ex:"):
+                    # if returned error message, return it
+                    return msg
+                drawCount += 1
+                # save player and deck to tracker
+                for i in range(len(vpTracker)):
+                    if vpTracker[i]['nodeID'] == nodeID:
+                        vpTracker[i]['player'] = player
+                        vpTracker[i]['deck'] = deck
+                        vpTracker[i]['drawCount'] = drawCount
+                if drawCount == 2:
+                    # this is the last draw will carry on to endGame for scoring
+                    msg = player.redraw(deck, message) + f"\n"
+                    if msg.startswith("ex:"):
+                        # if returned error message, return it
+                        return msg
+                    # redraw done
+                    setLastCmdVp(nodeID, "endGame")
+                else:
+                    # show redrawn hand
+                    return msg
+            else:
+                # redraw already done
+                setLastCmdVp(nodeID, "endGame")
+                
+    if getLastCmdVp(nodeID) == "endGame":
+        # load the player and deck from tracker
+        for i in range(len(vpTracker)):
+            if vpTracker[i]['nodeID'] == nodeID:
+                player = vpTracker[i]['player']
+                deck = vpTracker[i]['deck']
+
+        msg += player.score_hand()
+
+        if player.bankroll < 1:
+            player.bankroll = vpStartingCash
+            msg += "\nLooks 💸 like you're out of money. 💳 resetting ballance 🏧"
+        elif player.bankroll > vpTracker[i]['highScore']:
+            vpTracker[i]['highScore'] = player.bankroll
+            msg += " 🎉HighScore!"
+            # save high score
+            saveHSVp(nodeID, vpTracker[i]['highScore'])
+
+        msg += f"\nPlace your Bet, or (L)eave Table."
+
+        setLastCmdVp(nodeID, "gameOver")
+        # reset player and deck in tracker
+        for i in range(len(vpTracker)):
+            if vpTracker[i]['nodeID'] == nodeID:
+                vpTracker[i]['player'] = None
+                vpTracker[i]['deck'] = None
+                vpTracker[i]['drawCount'] = 0
+                # save bankroll
+                vpTracker[i]['cash'] = player.bankroll
+
+        return msg
+
+ 

modules/globalalert.py

@@ -0,0 +1,77 @@
+# helper functions to use location data for data outside US/north america
+# K7MHI Kelly Keeton 2024
+
+import json # pip install json
+from geopy.geocoders import Nominatim # pip install geopy
+import maidenhead as mh # pip install maidenhead
+import requests # pip install requests
+import bs4 as bs # pip install beautifulsoup4
+import xml.dom.minidom 
+from modules.log import *
+
+trap_list_location_eu = ("ukalert", "ukwx", "ukflood")
+trap_list_location_de = ("dealert", "dewx", "deflood")
+
+def get_govUK_alerts(lat, lon):
+    try:
+        # get UK.gov alerts
+        url = 'https://www.gov.uk/alerts'
+        response = requests.get(url)
+        soup = bs.BeautifulSoup(response.text, 'html.parser')
+        # the alerts are in <h2 class="govuk-heading-m" id="alert-status">
+        alert = soup.find('h2', class_='govuk-heading-m', id='alert-status')
+    except Exception as e:
+        logger.warning("Error getting UK alerts: " + str(e))
+        return NO_ALERTS
+    
+    if alert:
+        return "🚨" + alert.get_text(strip=True)
+    else:
+        return NO_ALERTS
+
+def get_nina_alerts():
+    try:
+        # get api.bund.dev alerts
+        alerts = []
+        for regionalKey in myRegionalKeysDE:
+            url = ("https://nina.api.proxy.bund.dev/api31/dashboard/" + regionalKey + ".json")
+            response = requests.get(url)
+            data = response.json()
+
+            for item in data:
+                title = item["i18nTitle"]["de"]
+                alerts.append(f"🚨 {title}")
+        return "\n".join(alerts) if alerts else NO_ALERTS
+    except Exception as e:
+        logger.warning("Error getting NINA DE alerts: " + str(e))
+        return NO_ALERTS
+
+def get_wxUKgov():
+    # get UK weather warnings
+    url = 'https://www.metoffice.gov.uk/weather/guides/rss'
+    url = 'https://www.metoffice.gov.uk/public/data/PWSCache/WarningsRSS/Region/nw'
+    try:
+        # get UK weather warnings
+        url = 'https://www.metoffice.gov.uk/weather/guides/rss'
+        response = requests.get(url)
+        soup = bs.BeautifulSoup(response.content, 'xml')
+        
+        items = soup.find_all('item')
+        alerts = []
+        
+        for item in items:
+            title = item.find('title').get_text(strip=True)
+            description = item.find('description').get_text(strip=True)
+            alerts.append(f"🚨 {title}: {description}")
+        
+        return "\n".join(alerts) if alerts else NO_ALERTS
+    except Exception as e:
+        logger.warning("Error getting UK weather warnings: " + str(e))
+        return NO_ALERTS
+    
+    
+def get_floodUKgov():
+    # get UK flood warnings
+    url = 'https://environment.data.gov.uk/flood-widgets/rss/feed-England.xml'
+    
+    return NO_ALERTS

modules/gpio.py

@@ -0,0 +1,73 @@
+# GPIO module for MeshLink, concept code, not implemented
+# K7MHI Kelly Keeton 2024
+
+# https://pypi.org/project/gpio/
+#import gpio
+
+# https://pythonhosted.org/RPIO/
+import RPIO
+
+from modules.log import *
+trap_list_gpio = ("gpio", "pin", "relay", "switch", "pwm")
+
+# set up input channel without pull-up
+RPIO.setup(7, RPIO.IN)
+
+# set up input channel with pull-up
+RPIO.setup(8, RPIO.IN, pull_up_down=RPIO.PUD_UP)
+
+# set up GPIO output channel
+RPIO.setup(8, RPIO.OUT)
+
+# change to BOARD numbering schema
+RPIO.setmode(RPIO.BOARD)
+
+# set up PWM channel
+RPIO.setup(12, RPIO.OUT)
+p = RPIO.PWM(12)
+
+def gpio_status():
+    # get status of GPIO pins
+    gpio_status = ""
+    gpio_status += "GPIO 7: " + str(RPIO.input(7)) + "\n"
+    gpio_status += "GPIO 8: " + str(RPIO.input(8)) + "\n"
+    gpio_status += "GPIO 12: " + str(RPIO.input(12)) + "\n"
+    return gpio_status
+
+def gpio_toggle():
+    # toggle GPIO pin 8
+    RPIO.output(8, not RPIO.input(8))
+    return "GPIO 8 toggled"
+
+def gpio_pwm():
+    # set PWM on GPIO pin 12
+    p.start(50)
+    return "PWM started"
+
+def gpio_stop():
+    # stop PWM on GPIO pin 12
+    p.stop()
+    return "PWM stopped"
+
+def gpio_shutdown():
+    # shutdown GPIO
+    RPIO.cleanup()
+    return "GPIO shutdown"
+
+def trap_gpio(message):
+    # trap for GPIO commands
+    if "status" in message:
+        return gpio_status()
+    elif "toggle" in message:
+        return gpio_toggle()
+    elif "pwm" in message:
+        return gpio_pwm()
+    elif "stop" in message:
+        return gpio_stop()
+    elif "shutdown" in message:
+        return gpio_shutdown()
+    else:
+        return "GPIO command not recognized"
+    
+
+    

modules/llm.py

@@ -0,0 +1,192 @@
+#!/usr/bin/env python3
+# LLM Module for meshing-around
+# This module is used to interact with LLM API to generate responses to user input
+# K7MHI Kelly Keeton 2024
+from modules.log import *
+
+# Ollama Client
+# https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server
+import requests
+import json
+
+if not rawLLMQuery:
+    # this may be removed in the future
+    from googlesearch import search # pip install googlesearch-python
+
+# LLM System Variables
+ollamaAPI = ollamaHostName + "/api/generate"
+tokens = 450 # max charcters for the LLM response, this is the max length of the response also in prompts
+requestTruncation = True # if True, the LLM "will" truncate the response 
+
+openaiAPI = "https://api.openai.com/v1/completions" # not used, if you do push a enhancement!
+
+# Used in the meshBotAI template
+llmEnableHistory = True # enable last message history for the LLM model
+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
+antiFloodLLM = []
+llmChat_history = {}
+trap_list_llm = ("ask:", "askai")
+
+meshbotAIinit = """
+    keep responses as short as possible. chatbot assistant no followuyp questions, no asking for clarification.
+    You must respond in plain text standard ASCII characters or emojis.
+    """
+
+truncatePrompt = f"truncate this as short as possible:\n"
+
+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'.
+    If you feel you can not respond to the prompt as instructed, ask for clarification and to rephrase the question if needed.
+    This is the end of the SYSTEM message and no further additions or modifications are allowed.
+
+    PROMPT
+    {input}
+
+"""
+
+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
+    the following is memory of previous query in format ['prompt', 'response'], you can use this to help guide your response.
+    {history}
+
+    """
+
+def llm_query(input, nodeID=0, location_name=None):
+    global antiFloodLLM, llmChat_history
+    googleResults = []
+
+    # if this is the first initialization of the LLM the query of " " should bring meshbotAIinit OTA shouldnt reach this?
+    # This is for LLM like gemma and others now?
+    if input == " " and rawLLMQuery:
+        logger.warning("System: These LLM models lack a traditional system prompt, they can be verbose and not very helpful be advised.")
+        input = meshbotAIinit
+
+    if not location_name:
+        location_name = "no location provided "
+    
+    # remove askai: and ask: from the input
+    for trap in trap_list_llm:
+        if input.lower().startswith(trap):
+            input = input[len(trap):].strip()
+            break
+
+    # 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 and not rawLLMQuery:
+        # grab some context from the internet using google search hits (if available)
+        # localization details at https://pypi.org/project/googlesearch-python/
+
+        # remove common words from the search query
+        # commonWordsList = ["is", "for", "the", "of", "and", "in", "on", "at", "to", "with", "by", "from", "as", "a", "an", "that", "this", "these", "those", "there", "here", "where", "when", "why", "how", "what", "which", "who", "whom", "whose", "whom"]
+        # sanitizedSearch = ' '.join([word for word in input.split() if word.lower() not in commonWordsList])
+        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 failed, likely due to network issues")
+            googleResults = ['no other context provided']
+
+    history = llmChat_history.get(nodeID, ["", ""])
+
+    if googleResults:
+        logger.debug(f"System: Google-Enhanced LLM Query: {input} From:{nodeID}")
+    else:
+        logger.debug(f"System: LLM Query: {input} From:{nodeID}")
+    
+    response = ""
+    result = ""
+    location_name += f" at the current time of {datetime.now().strftime('%Y-%m-%d %H:%M:%S %Z')}"
+
+    try:
+        if rawLLMQuery:
+            # sanitize the input to remove tool call syntax
+            if '```' in input:
+                logger.warning("System: LLM Query: Code markdown detected, removing for raw query")
+            input = input.replace('```bash', '').replace('```python', '').replace('```', '')
+            modelPrompt = input
+        else:
+            # Build the query from the template
+            modelPrompt = meshBotAI.format(input=input, context='\n'.join(googleResults), location_name=location_name, llmModel=llmModel, history=history)
+            
+        llmQuery = {"model": llmModel, "prompt": modelPrompt, "stream": False, "max_tokens": tokens}
+        # Query the model via Ollama web API
+        result = requests.post(ollamaAPI, data=json.dumps(llmQuery))
+        # Condense the result to just needed
+        if result.status_code == 200:
+            result_json = result.json()
+            result = result_json.get("response", "")
+
+            # deepseek-r1 has added <think> </think> tags to the response
+            if "<think>" in result:
+                result = result.split("</think>")[1]
+        else:
+            raise Exception(f"HTTP Error: {result.status_code}")
+
+        #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."
+    
+    # cleanup for message output
+    response = result.strip().replace('\n', ' ')
+    
+    if rawLLMQuery and requestTruncation and len(response) > 450:
+        #retryy loop to truncate the response
+        logger.warning(f"System: LLM Query: Response exceeded {tokens} characters, requesting truncation")
+        truncateQuery = {"model": llmModel, "prompt": truncatePrompt + response, "stream": False, "max_tokens": tokens}
+        truncateResult = requests.post(ollamaAPI, data=json.dumps(truncateQuery))
+        if truncateResult.status_code == 200:
+            truncate_json = truncateResult.json()
+            result = truncate_json.get("response", "")
+
+        else:
+            #use the original result if truncation fails
+            logger.warning("System: LLM Query: Truncation failed, using original response")
+        
+        # cleanup for message output
+        response = result.strip().replace('\n', ' ')
+
+    # done with the query, remove the user from the anti flood list
+    antiFloodLLM.remove(nodeID)
+
+    if llmEnableHistory:
+        llmChat_history[nodeID] = [input, response]
+
+    return response

modules/locationdata.py

@@ -1,4 +1,4 @@
-# helper functions to use location data
+# helper functions to use location data for the API for NOAA weather, FEMA iPAWS, and repeater data
 # K7MHI Kelly Keeton 2024
 
 import json # pip install json
@@ -7,40 +7,165 @@ import maidenhead as mh # pip install maidenhead
 import requests # pip install requests
 import bs4 as bs # pip install beautifulsoup4
 import xml.dom.minidom 
-from modules.settings import *
+from modules.log import *
 
-trap_list_location = ("whereami", "tide", "moon", "wx", "wxc", "wxa", "wxalert")
+trap_list_location = ("whereami", "wx", "wxa", "wxalert", "rlist", "ea", "ealert", "riverflow", "valert")
 
-def where_am_i(lat=0, lon=0):
+def where_am_i(lat=0, lon=0, short=False, zip=False):
     whereIam = ""
     grid = mh.to_maiden(float(lat), float(lon))
     
-    if float(lat) == 0 and float(lon) == 0:
+    if int(float(lat)) == 0 and int(float(lon)) == 0:
+        logger.error("Location: No GPS data, try sending location")
         return NO_DATA_NOGPS
     
     # initialize Nominatim API
     geolocator = Nominatim(user_agent="mesh-bot")
     
-    # Nomatim API call to get address
-    if float(lat) == latitudeValue and float(lon) == longitudeValue:
-        # redacted address when no GPS and using default location
-        location = geolocator.reverse(lat + ", " + lon)
-        address = location.raw['address']
-        address_components = ['city', 'state', 'postcode', 'county', 'country']
-        whereIam += ' '.join([address.get(component, '') for component in address_components if component in address])
-        whereIam += " Grid: " + grid
+    try:
+        # 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 zip:
+            # return a string with zip code only
+            location = geolocator.reverse(str(lat) + ", " + str(lon))
+            whereIam = location.raw['address'].get('postcode', '')
+            return whereIam
+        
+        if float(lat) == latitudeValue and float(lon) == longitudeValue:
+            # redacted address when no GPS and using default location
+            location = geolocator.reverse(str(lat) + ", " + str(lon))
+            address = location.raw['address']
+            address_components = {
+                'city': 'City',
+                'state': 'State',
+                'postcode': 'Zip',
+                'county': 'County',
+                'country': 'Country'
+            }
+            whereIam += ', '.join([f"{label}: {address.get(component, '')}" for component, label in address_components.items() if component in address])
+        else:
+            location = geolocator.reverse(lat + ", " + lon)
+            address = location.raw['address']
+            address_components = {
+                'house_number': 'Number',
+                'road': 'Road',
+                'city': 'City',
+                'state': 'State',
+                'postcode': 'Zip',
+                'county': 'County',
+                'country': 'Country'
+            }
+            whereIam += ', '.join([f"{label}: {address.get(component, '')}" for component, label in address_components.items() if component in address])
+            whereIam += f", Grid: " + grid
         return whereIam
+    except Exception as e:
+        logger.debug("Location:Error fetching location data with whereami, likely network error")
+        return ERROR_FETCHING_DATA
+    
+def getRepeaterBook(lat=0, lon=0):
+    grid = mh.to_maiden(float(lat), float(lon))
+    data = []
+    # check if in the US or not
+    usapi ="https://www.repeaterbook.com/repeaters/prox_result.php?"
+    elsewhereapi = "https://www.repeaterbook.com/row_repeaters/prox2_result.php?"
+    if grid[:2] in ['CN', 'DN', 'EN', 'FN', 'CM', 'DM', 'EM', 'FM', 'DL', 'EL', 'FL']:
+        repeater_url = usapi
     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
+        repeater_url = elsewhereapi
+    
+    repeater_url += f"city={grid}&lat=&long=&distance=50&Dunit=m&band%5B%5D=4&band%5B%5D=16&freq=&call=&mode%5B%5D=1&mode%5B%5D=2&mode%5B%5D=4&mode%5B%5D=64&status_id=1&use=%25&use=OPEN&order=distance_calc%2C+state_id+ASC"
+    
+    try:
+        msg = ''
+        response = requests.get(repeater_url)
+        soup = bs.BeautifulSoup(response.text, 'html.parser')
+        table = soup.find('table', attrs={'class': 'w3-table w3-striped w3-responsive w3-mobile w3-auto sortable'})
+        if table is not None:
+            cells = table.find_all('td')
+            data = []
+            for i in range(0, len(cells), 11):
+                if i + 10 < len(cells):  #avoid IndexError
+                    repeater = {
+                        'frequency': cells[i].text.strip() if i < len(cells) else 'N/A',
+                        'offset': cells[i + 1].text.strip() if i + 1 < len(cells) else 'N/A',
+                        'tone': cells[i + 2].text.strip() if i + 2 < len(cells) else 'N/A',
+                        'call_sign': cells[i + 3].text.strip() if i + 3 < len(cells) else 'N/A',
+                        'location': cells[i + 4].text.strip() if i + 4 < len(cells) else 'N/A',
+                        'state': cells[i + 5].text.strip() if i + 5 < len(cells) else 'N/A',
+                        'use': cells[i + 6].text.strip() if i + 6 < len(cells) else 'N/A',
+                        'mode': cells[i + 7].text.strip() if i + 7 < len(cells) else 'N/A',
+                        'distance': cells[i + 8].text.strip() if i + 8 < len(cells) else 'N/A',
+                        'direction': cells[i + 9].text.strip() if i + 9 < len(cells) else 'N/A'
+                    }
+                    data.append(repeater)
+        else:
+            msg = "No Data for your Region"
+    except Exception as e:
+        msg = "No repeaters found 😔"
+    # Limit the output to the first 4 repeaters
+    for repeater in data[:4]:
+        tmpTone = repeater['tone'].replace(" /", "")
+        msg += f"{repeater['call_sign']}📶{repeater['frequency']}{repeater['offset']},{tmpTone}.{repeater['mode']}"
+        if repeater != data[:4][-1]: msg += '\n'
+    return msg
 
-def get_tide(lat=0, lon=0):
+def getArtSciRepeaters(lat=0, lon=0):
+    # UK api_url = "https://api-beta.rsgb.online/all/systems"
+    #grid = mh.to_maiden(float(lat), float(lon))
+    repeaters = []
+    zipCode = where_am_i(lat, lon, zip=True)
+    if zipCode == NO_DATA_NOGPS or zipCode == ERROR_FETCHING_DATA:
+        return zipCode
+
+    if zipCode.isnumeric():
+        try:
+            artsci_url = f"http://www.artscipub.com/mobile/showstate.asp?zip={zipCode}"
+            response = requests.get(artsci_url)
+            soup = bs.BeautifulSoup(response.text, 'html.parser')
+            # results needed xpath is /html/body/table[2]/tbody/tr/td/table/tbody/tr[2]/td/table
+            table = soup.find_all('table')[1]
+            rows = table.find_all('tr')
+            for row in rows:
+                cols = row.find_all('td')
+                cols = [ele.text.strip() for ele in cols]
+                # if no elements have the word 'located' then append
+                if not any('located' in ele for ele in cols):
+                    if not any('Location' in ele for ele in cols):
+                        repeaters.append([ele for ele in cols if ele])
+        except Exception as e:
+            logger.error(f"Error fetching data from {artsci_url}: {e}")
+
+    if repeaters != []:
+        msg = f"Found:{len(repeaters)} in {zipCode}\n"
+        for repeater in repeaters:
+            # format is ['City', 'Frequency', 'Offset', 'PL', 'Call', 'Notes']
+            # there might be missing elements or only one element
+            if len(repeater) == 2:
+                msg += f"Freq:{repeater[1]}"
+            elif len(repeater) == 3:
+                msg += f"Freq:{repeater[1]}, PL:{repeater[2]}"
+            elif len(repeater) == 4:
+                msg += f"Freq:{repeater[1]}, PL:{repeater[2]}, ID: {repeater[3]}"
+            elif len(repeater) == 5:
+                msg += f"Freq:{repeater[1]}, PL:{repeater[2]}, ID:{repeater[3]}"
+            elif len(repeater) == 6:
+                msg += f"Freq:{repeater[1]}, PL:{repeater[2]}, ID:{repeater[3]}. {repeater[5]}"
+            if repeater != repeaters[-1]:
+                msg += "\n"
+    else:
+        msg = f"no results.. sorry"
+    return msg
+
+def get_NOAAtide(lat=0, lon=0):
     station_id = ""
     if float(lat) == 0 and float(lon) == 0:
+        logger.error("Location:No GPS data, try sending location for tide")
         return NO_DATA_NOGPS
     station_lookup_url = "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/tidepredstations.json?lat=" + str(lat) + "&lon=" + str(lon) + "&radius=50"
     try:
@@ -48,88 +173,104 @@ def get_tide(lat=0, lon=0):
         if station_data.ok:
             station_json = station_data.json()
         else:
+            logger.error("Location:Error fetching tide station table from NOAA")
             return ERROR_FETCHING_DATA
         
         if station_json['stationList'] == [] or station_json['stationList'] is None:
-            return ERROR_FETCHING_DATA
+            logger.error("Location:No tide station found")
+            return "No tide station found with info provided"
         
         station_id = station_json['stationList'][0]['stationId']
 
     except (requests.exceptions.RequestException, json.JSONDecodeError):
+        logger.error("Location:Error fetching tide station table from NOAA")
         return ERROR_FETCHING_DATA
     
-    station_url = "https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=" + station_id
-    if zuluTime:
-        station_url += "&clock=24hour"
+    station_url = "https://api.tidesandcurrents.noaa.gov/api/prod/datagetter?date=today&time_zone=lst_ldt&datum=MLLW&product=predictions&interval=hilo&format=json&station=" + station_id
+
+    if use_metric:
+        station_url += "&units=metric"
+    else:
+        station_url += "&units=english"
 
     try:
-        station_data = requests.get(station_url, timeout=urlTimeoutSeconds)
-        if not station_data.ok:
+        tide_data = requests.get(station_url, timeout=urlTimeoutSeconds)
+        if tide_data.ok:
+            tide_json = tide_data.json()
+        else:
+            logger.error("Location:Error fetching tide data from NOAA")
             return ERROR_FETCHING_DATA
-    except (requests.exceptions.RequestException):
-        return ERROR_FETCHING_DATA
-    
-    # extract table class="table table-condensed"
-    soup = bs.BeautifulSoup(station_data.text, 'html.parser')
-    table = soup.find('table', class_='table table-condensed')
 
-    # extract rows
-    rows = table.find_all('tr')
-    # extract data from rows
-    tide_data = []
-    for row in rows:
-        row_text = ""
-        cols = row.find_all('td')
-        for col in cols:
-            row_text += col.text + " "
-        tide_data.append(row_text)
-    # format tide data into a string
-    tide_string = ""
-    for data in tide_data:
-        tide_string += data + "\n"
-    # trim off last newline
-    tide_string = tide_string[:-1]
-    return tide_string
+    except (requests.exceptions.RequestException, json.JSONDecodeError):
+        logger.error("Location:Error fetching tide data from NOAA")
+        return ERROR_FETCHING_DATA
+
+    tide_data = tide_json['predictions']
+
+    # format tide data into a table string for mesh
+    # get the date out of the first t value 
+    tide_date = tide_data[0]['t'].split(" ")[0]
+    tide_table = "Tide Data for " + tide_date + "\n"
+    for tide in tide_data:
+        tide_time = tide['t'].split(" ")[1]
+        if not zuluTime:
+            # convert to 12 hour clock
+            if int(tide_time.split(":")[0]) > 12:
+                tide_time = str(int(tide_time.split(":")[0]) - 12) + ":" + tide_time.split(":")[1] + " PM"
+            else:
+                tide_time = tide_time + " AM"
+                
+        tide_table +=  tide['type'] + " " + tide_time + ", " + tide['v'] + "\n"
+    # remove last newline
+    tide_table = tide_table[:-1]
+    return tide_table
     
-def get_weather(lat=0, lon=0, unit=0):
+def get_NOAAweather(lat=0, lon=0, unit=0):
     # get weather report from NOAA for forecast detailed
     weather = ""
     if float(lat) == 0 and float(lon) == 0:
         return NO_DATA_NOGPS
     
-    # get weather data from NOAA units for metric
+    # get weather data from NOAA units for metric unit = 1 is metric
+    if use_metric:
+        unit = 1
+        logger.debug("Location: new API metric units not implemented yet")
+        
     weather_url = "https://forecast.weather.gov/MapClick.php?FcstType=text&lat=" + str(lat) + "&lon=" + str(lon)
-    if unit == 1:
-        weather_url += "&unit=1"
-    
+    weather_api = "https://api.weather.gov/points/" + str(lat) + "," + str(lon)
+    # extract the "forecast": property from the JSON response
     try:
-        weather_data = requests.get(weather_url, timeout=urlTimeoutSeconds)
+        weather_data = requests.get(weather_api, timeout=urlTimeoutSeconds)
         if not weather_data.ok:
+            logger.warning("Location:Error fetching weather data from NOAA for location")
             return ERROR_FETCHING_DATA
     except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching weather data from NOAA for location")
+        return ERROR_FETCHING_DATA
+    # get the forecast URL from the JSON response
+    weather_json = weather_data.json()
+    forecast_url = weather_json['properties']['forecast']
+    try:
+        forecast_data = requests.get(forecast_url, timeout=urlTimeoutSeconds)
+        if not forecast_data.ok:
+            logger.warning("Location:Error fetching weather forecast from NOAA")
+            return ERROR_FETCHING_DATA
+    except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching weather forecast from NOAA")
         return ERROR_FETCHING_DATA
     
-    soup = bs.BeautifulSoup(weather_data.text, 'html.parser')
-    table = soup.find('div', id="detailed-forecast-body")
+    # from periods, get the detailedForecast from number of days in NOAAforecastDuration
+    forecast_json = forecast_data.json()
+    forecast = forecast_json['properties']['periods']
+    for day in forecast[:forecastDuration]:
+        # abreviate the forecast
 
-    if table is None:
-        return ERROR_FETCHING_DATA
-    else:
-        # get rows
-        rows = table.find_all('div', class_="row")
-
-    # extract data from rows
-    for row in rows:
-        # shrink the text
-        line = abbreviate_weather(row.text)
-        # only grab a few days of weather
-        if len(weather.split("\n")) < forecastDuration:
-            weather += line + "\n"
-    # trim off last newline
+        weather += abbreviate_noaa(day['name']) + ": " + abbreviate_noaa(day['detailedForecast']) + "\n"
+    # remove last newline
     weather = weather[:-1]
 
     # get any alerts and return the count
-    alerts = getWeatherAlerts(lat, lon)
+    alerts = getWeatherAlertsNOAA(lat, lon)
 
     if alerts == ERROR_FETCHING_DATA or alerts == NO_DATA_NOGPS or alerts == NO_ALERTS:
         alert = ""
@@ -144,23 +285,16 @@ def get_weather(lat=0, lon=0, unit=0):
 
     return weather
 
-def abbreviate_weather(row):
+def abbreviate_noaa(row):
     # replace long strings with shorter ones for display
     replacements = {
-        "Monday": "Mon ",
-        "Tuesday": "Tue ",
-        "Wednesday": "Wed ",
-        "Thursday": "Thu ",
-        "Friday": "Fri ",
-        "Saturday": "Sat ",
-        "Sunday": "Sunday ",
-        "Today": "Today ",
-        "Night": "Night ",
-        "Tonight": "Tonight ",
-        "Tomorrow": "Tomorrow ",
-        "Day": "Day ",
-        "This Afternoon": "Afternoon ",
-        "Overnight": "Overnight ",
+        "monday": "Mon",
+        "tuesday": "Tue",
+        "wednesday": "Wed",
+        "thursday": "Thu",
+        "friday": "Fri",
+        "saturday": "Sat",
+        "sunday": "Sun",
         "northwest": "NW",
         "northeast": "NE",
         "southwest": "SW",
@@ -169,48 +303,71 @@ def abbreviate_weather(row):
         "south": "S",
         "east": "E",
         "west": "W",
-        "Northwest": "NW",
-        "Northeast": "NE",
-        "Southwest": "SW",
-        "Southeast": "SE",
-        "North": "N",
-        "South": "S",
-        "East": "E",
-        "West": "W",
         "precipitation": "precip",
         "showers": "shwrs",
-        "thunderstorms": "t-storms"
+        "thunderstorms": "t-storms",
+        "thunderstorm": "t-storm",
+        "quarters": "qtrs",
+        "quarter": "qtr",
+        "january": "Jan",
+        "february": "Feb",
+        "march": "Mar",
+        "april": "Apr",
+        "may": "May",
+        "june": "Jun",
+        "july": "Jul",
+        "august": "Aug",
+        "september": "Sep",
+        "october": "Oct",
+        "november": "Nov",
+        "december": "Dec",
+        "degrees": "°",
+        "percent": "%",
+        "department": "Dept.",
+        "amounts less than a tenth of an inch possible.": "< 0.1in",
+        "temperatures": "temps.",
+        "temperature": "temp.",
     }
 
     line = row
     for key, value in replacements.items():
-        line = line.replace(key, value)
+        # case insensitive replace
+        line = line.replace(key, value).replace(key.capitalize(), value).replace(key.upper(), value)
                     
     return line
 
-def getWeatherAlerts(lat=0, lon=0):
+def getWeatherAlertsNOAA(lat=0, lon=0, useDefaultLatLon=False):
     # get weather alerts from NOAA limited to ALERT_COUNT with the total number of alerts found
     alerts = ""
-    if float(lat) == 0 and float(lon) == 0:
+    if float(lat) == 0 and float(lon) == 0 and not useDefaultLatLon:
         return NO_DATA_NOGPS
+    else:
+        if useDefaultLatLon:
+            lat = latitudeValue
+            lon = longitudeValue
 
     alert_url = "https://api.weather.gov/alerts/active.atom?point=" + str(lat) + "," + str(lon)
     #alert_url = "https://api.weather.gov/alerts/active.atom?area=WA"
+    #logger.debug("Location:Fetching weather alerts from NOAA for " + str(lat) + ", " + str(lon))
     
     try:
         alert_data = requests.get(alert_url, timeout=urlTimeoutSeconds)
         if not alert_data.ok:
+            logger.warning("Location:Error fetching weather alerts from NOAA")
             return ERROR_FETCHING_DATA
     except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching weather alerts from NOAA")
         return ERROR_FETCHING_DATA
     
     alerts = ""
     alertxml = xml.dom.minidom.parseString(alert_data.text)
-
     for i in alertxml.getElementsByTagName("entry"):
-        alerts += (
-            i.getElementsByTagName("title")[0].childNodes[0].nodeValue + "\n"
-        )
+        title = i.getElementsByTagName("title")[0].childNodes[0].nodeValue
+        area_desc = i.getElementsByTagName("cap:areaDesc")[0].childNodes[0].nodeValue
+        if enableExtraLocationWx:
+            alerts += f"{title}. {area_desc.replace(' ', '')}\n"
+        else:
+            alerts += f"{title}\n"
 
     if alerts == "" or alerts == None:
         return NO_ALERTS
@@ -223,26 +380,56 @@ def getWeatherAlerts(lat=0, lon=0):
     alert_num = 0
     alert_num = len(alerts.split("\n"))
 
-    alerts = abbreviate_weather(alerts)
+    alerts = abbreviate_noaa(alerts)
 
     # return the first ALERT_COUNT alerts
     data = "\n".join(alerts.split("\n")[:numWxAlerts]), alert_num
     return data
 
-def getActiveWeatherAlertsDetail(lat=0, lon=0):
+wxAlertCacheNOAA = ""
+def alertBrodcastNOAA():
+    # get the latest weather alerts and broadcast them if there are any
+    global wxAlertCacheNOAA
+    currentAlert = getWeatherAlertsNOAA(latitudeValue, longitudeValue)
+    # check if any reason to discard the alerts
+    if currentAlert == ERROR_FETCHING_DATA or currentAlert == NO_DATA_NOGPS:
+        return False
+    elif currentAlert == NO_ALERTS:
+        wxAlertCacheNOAA = ""
+        return False
+    if ignoreEASenable:
+        # check if the alert is in the ignoreEAS list
+        for word in ignoreEASwords:
+            if word.lower() in currentAlert[0].lower():
+                logger.debug(f"Location:Ignoring NOAA Alert: {currentAlert[0]} containing {word}")
+                return False
+    # broadcast the alerts send to wxBrodcastCh
+    elif currentAlert[0] not in wxAlertCacheNOAA:
+        # Check if the current alert is not in the weather alert cache
+        logger.debug("Location:Broadcasting weather alerts")
+        wxAlertCacheNOAA = currentAlert[0]
+        return currentAlert
+    
+    return False
+
+def getActiveWeatherAlertsDetailNOAA(lat=0, lon=0):
     # get the latest details of weather alerts from NOAA
     alerts = ""
     if float(lat) == 0 and float(lon) == 0:
+        logger.warning("Location:No GPS data, try sending location for weather alerts")
         return NO_DATA_NOGPS
 
     alert_url = "https://api.weather.gov/alerts/active.atom?point=" + str(lat) + "," + str(lon)
     #alert_url = "https://api.weather.gov/alerts/active.atom?area=WA"
+    #logger.debug("Location:Fetching weather alerts detailed from NOAA for " + str(lat) + ", " + str(lon))
     
     try:
         alert_data = requests.get(alert_url, timeout=urlTimeoutSeconds)
         if not alert_data.ok:
+            logger.warning("Location:Error fetching weather alerts from NOAA")
             return ERROR_FETCHING_DATA
     except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching weather alerts from NOAA")
         return ERROR_FETCHING_DATA
     
     alerts = ""
@@ -260,13 +447,13 @@ def getActiveWeatherAlertsDetail(lat=0, lon=0):
             "\n***\n"
         )
 
-    alerts = abbreviate_weather(alerts)
+    alerts = abbreviate_noaa(alerts)
 
     # trim the alerts to the first ALERT_COUNT
     alerts = alerts.split("\n***\n")[:numWxAlerts]
     
     if alerts == "" or alerts == ['']:
-        return ERROR_FETCHING_DATA
+        return NO_ALERTS
 
     # trim off last newline
     if alerts[-1] == "\n":
@@ -275,3 +462,302 @@ def getActiveWeatherAlertsDetail(lat=0, lon=0):
     alerts = "\n".join(alerts)
     
     return alerts
+
+def getIpawsAlert(lat=0, lon=0, shortAlerts = False):
+    # get the latest IPAWS alert from FEMA
+    alert = ''
+    alerts = []
+    linked_data = ''
+    
+    # set the API URL for IPAWS
+    namespace = "urn:oasis:names:tc:emergency:cap:1.2"
+    alert_url = "https://apps.fema.gov/IPAWSOPEN_EAS_SERVICE/rest/feed"
+
+    # get the alerts from FEMA
+    try:
+        alert_data = requests.get(alert_url, timeout=urlTimeoutSeconds)
+        if not alert_data.ok:
+            logger.warning("System: iPAWS fetching IPAWS alerts from FEMA")
+            return ERROR_FETCHING_DATA
+    except (requests.exceptions.RequestException):
+        logger.warning("System: iPAWS fetching IPAWS alerts from FEMA")
+        return ERROR_FETCHING_DATA
+    
+    # main feed bulletins
+    alertxml = xml.dom.minidom.parseString(alert_data.text)
+
+    # extract alerts from main feed
+    for entry in alertxml.getElementsByTagName("entry"):
+        link = entry.getElementsByTagName("link")[0].getAttribute("href")
+
+        ## state FIPS
+        ## This logic is being added to reduce load on FEMA server.
+        stateFips = None
+        for cat in entry.getElementsByTagName("category"):
+            if cat.getAttribute("label") == "statefips":
+                stateFips = cat.getAttribute("term")
+                break
+
+        if stateFips is None:
+            # no stateFIPS found — skip
+            continue
+
+        # check if it matches your list
+        if stateFips not in myStateFIPSList:
+            #logger.debug(f"Skipping FEMA record link {link} with stateFIPS code of: {stateFips} because it doesn't match our StateFIPSList {myStateFIPSList}")
+            continue  # skip to next entry
+
+        try:
+            # get the linked alert data from FEMA
+            linked_data = requests.get(link, timeout=urlTimeoutSeconds)
+            if not linked_data.ok or not linked_data.text.strip():
+                # if the linked data is not ok, skip this alert
+                #logger.warning(f"System: iPAWS Error fetching linked alert data from {link}")
+                continue
+            else:
+                linked_xml = xml.dom.minidom.parseString(linked_data.text)
+                # this alert is a full CAP alert
+        except (requests.exceptions.RequestException):
+            logger.warning(f"System: iPAWS Error fetching embedded alert data from {link}")
+            continue
+        except xml.parsers.expat.ExpatError:
+            logger.warning(f"System: iPAWS Error parsing XML from {link}")
+            continue
+        except Exception as e:
+            logger.debug(f"System: iPAWS Error processing alert data from {link}: {e}")
+            continue
+
+        for info in linked_xml.getElementsByTagName("info"):
+            # only get en-US language alerts (alternative is es-US)
+            language_nodes = info.getElementsByTagName("language")
+            if not any(node.firstChild and node.firstChild.nodeValue.strip() == "en-US" for node in language_nodes):
+                    continue  # skip if not en-US
+            # extract values from XML
+            sameVal = "NONE"
+            geocode_value = "NONE"
+            description = ""
+            try:
+                eventCode_table = info.getElementsByTagName("eventCode")[0]
+                alertType = eventCode_table.getElementsByTagName("valueName")[0].childNodes[0].nodeValue
+                alertCode = eventCode_table.getElementsByTagName("value")[0].childNodes[0].nodeValue
+                headline = info.getElementsByTagName("headline")[0].childNodes[0].nodeValue
+                # use headline if no description
+                if info.getElementsByTagName("description") and info.getElementsByTagName("description")[0].childNodes:
+                    description = info.getElementsByTagName("description")[0].childNodes[0].nodeValue
+                else:
+                    description = headline
+
+                area_table = info.getElementsByTagName("area")[0]
+                areaDesc = area_table.getElementsByTagName("areaDesc")[0].childNodes[0].nodeValue
+                geocode_table = area_table.getElementsByTagName("geocode")[0]
+                geocode_type = geocode_table.getElementsByTagName("valueName")[0].childNodes[0].nodeValue
+                geocode_value = geocode_table.getElementsByTagName("value")[0].childNodes[0].nodeValue
+                if geocode_type == "SAME":
+                    sameVal = geocode_value
+                
+            except Exception as e:
+                logger.debug(f"System: iPAWS Error extracting alert data: {link}")
+                #print(f"DEBUG: {info.toprettyxml()}")
+                continue
+
+             # check if the alert is for the SAME location, if wanted keep alert
+            if (sameVal in mySAMEList) or (geocode_value in mySAMEList) or mySAMEList == ['']:
+                # ignore the FEMA test alerts
+                if ignoreFEMAenable:
+                    ignore_alert = False
+                    for word in ignoreFEMAwords:
+                        if word.lower() in headline.lower():
+                            logger.debug(f"System: Filtering FEMA Alert by WORD: {headline} containing {word} at {areaDesc}")
+                            ignore_alert = True
+                            break
+                if ignore_alert:
+                    continue
+
+                # add to alert list
+                alerts.append({
+                    'alertType': alertType,
+                    'alertCode': alertCode,
+                    'headline': headline,
+                    'areaDesc': areaDesc,
+                    'geocode_type': geocode_type,
+                    'geocode_value': geocode_value,
+                    'description': description
+                })
+            else:
+                logger.debug(f"System: iPAWS Alert not in SAME List: {sameVal} or {geocode_value} for {headline} at {areaDesc}")
+                continue
+
+    # return the numWxAlerts of alerts
+    if len(alerts) > 0:
+        for alertItem in alerts[:numWxAlerts]:
+            if shortAlerts:
+                alert += abbreviate_noaa(f"🚨FEMA Alert: {alertItem['headline']}")
+            else:
+                alert += abbreviate_noaa(f"🚨FEMA Alert: {alertItem['headline']}\n{alertItem['description']}")
+            # add a newline if not the last alert    
+            if alertItem != alerts[:numWxAlerts][-1]:
+                alert += "\n"
+    else:
+        alert = NO_ALERTS
+
+    return alert
+
+def get_flood_noaa(lat=0, lon=0, uid=0):
+    # get the latest flood alert from NOAA
+    api_url = "https://api.water.noaa.gov/nwps/v1/gauges/"
+    headers = {'accept': 'application/json'}
+    if uid == 0:
+        return "No flood gauge data found"
+    try:
+        response = requests.get(api_url + str(uid), headers=headers, timeout=urlTimeoutSeconds)
+        if not response.ok:
+            logger.warning("Location:Error fetching flood gauge data from NOAA for " + str(uid))
+            return ERROR_FETCHING_DATA
+    except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching flood gauge data from NOAA for " + str(uid))
+        return ERROR_FETCHING_DATA
+    
+    data = response.json()
+    if not data:
+        return "No flood gauge data found"
+    
+    # extract values from JSON
+    try:
+        name = data['name']
+        status_observed_primary = data['status']['observed']['primary']
+        status_observed_primary_unit = data['status']['observed']['primaryUnit']
+        status_observed_secondary = data['status']['observed']['secondary']
+        status_observed_secondary_unit = data['status']['observed']['secondaryUnit']
+        status_observed_floodCategory = data['status']['observed']['floodCategory']
+        status_forecast_primary = data['status']['forecast']['primary']
+        status_forecast_primary_unit = data['status']['forecast']['primaryUnit']
+        status_forecast_secondary = data['status']['forecast']['secondary']
+        status_forecast_secondary_unit = data['status']['forecast']['secondaryUnit']
+        status_forecast_floodCategory = data['status']['forecast']['floodCategory']
+
+        # except KeyError as e:
+        #     print(f"Missing key in data: {e}")
+        # except TypeError as e:
+        #     print(f"Type error in data: {e}")
+    except Exception as e:
+        logger.debug("Location:Error extracting flood gauge data from NOAA for " + str(uid))
+        return ERROR_FETCHING_DATA
+    
+    # format the flood data
+    logger.debug(f"System: NOAA Flood data for {str(uid)}")
+    flood_data = f"Flood Data {name}:\n"
+    flood_data += f"Observed: {status_observed_primary}{status_observed_primary_unit}({status_observed_secondary}{status_observed_secondary_unit}) risk: {status_observed_floodCategory}"
+    flood_data += f"\nForecast: {status_forecast_primary}{status_forecast_primary_unit}({status_forecast_secondary}{status_forecast_secondary_unit}) risk: {status_forecast_floodCategory}"
+
+    return flood_data
+
+def get_volcano_usgs(lat=0, lon=0):
+    alerts = ''
+    if lat == 0 and lon == 0:
+        lat = latitudeValue
+        lon = longitudeValue
+    # get the latest volcano alert from USGS from CAP feed
+    usgs_volcano_url = "https://volcanoes.usgs.gov/hans-public/api/volcano/getCapElevated"
+    try:
+        volcano_data = requests.get(usgs_volcano_url, timeout=urlTimeoutSeconds)
+        if not volcano_data.ok:
+            logger.warning("System: Issue with fetching volcano alerts from USGS")
+            return ERROR_FETCHING_DATA
+    except (requests.exceptions.RequestException):
+        logger.warning("System: Issue with fetching volcano alerts from USGS")
+        return ERROR_FETCHING_DATA
+    volcano_json = volcano_data.json()
+    # extract alerts from main feed
+    if volcano_json and isinstance(volcano_json, list):
+        for alert in volcano_json:
+            # check ignore list
+            if ignoreUSGSEnable:
+                for word in ignoreUSGSwords:
+                    if word.lower() in alert['volcano_name_appended'].lower():
+                        logger.debug(f"System: Ignoring USGS Alert: {alert['volcano_name_appended']} containing {word}")
+                        continue
+            # check if the alert lat long is within the range of bot latitudeValue and longitudeValue
+            if (alert['latitude'] >= latitudeValue - 10 and alert['latitude'] <= latitudeValue + 10) and (alert['longitude'] >= longitudeValue - 10 and alert['longitude'] <= longitudeValue + 10):
+                volcano_name = alert['volcano_name_appended']
+                alert_level = alert['alert_level']
+                color_code = alert['color_code']
+                cap_severity = alert['cap_severity']
+                synopsis = alert['synopsis']
+                # format Alert
+                alerts += f"🌋🚨: {volcano_name}, {alert_level} {color_code}, {cap_severity}.\n{synopsis}\n"
+            else:
+                #logger.debug(f"System: USGS volcano alert not in range: {alert['volcano_name_appended']}")
+                continue
+    else:
+        logger.debug("Location:Error fetching volcano data from USGS")
+        return NO_ALERTS
+    if alerts == "":
+        return NO_ALERTS
+    # trim off last newline
+    if alerts[-1] == "\n":
+        alerts = alerts[:-1]
+    # return the alerts
+    alerts = abbreviate_noaa(alerts)
+    return alerts
+
+def get_nws_marine(zone, days=3):
+    # forcast from NWS coastal products
+    try:
+        marine_pz_data = requests.get(zone, timeout=urlTimeoutSeconds)
+        if not marine_pz_data.ok:
+            logger.warning("Location:Error fetching NWS Marine PZ data")
+            return ERROR_FETCHING_DATA
+    except (requests.exceptions.RequestException):
+        logger.warning("Location:Error fetching NWS Marine PZ data")
+        return ERROR_FETCHING_DATA
+    
+    marine_pz_data = marine_pz_data.text
+    #validate data
+    todayDate = today.strftime("%Y%m%d")
+    if marine_pz_data.startswith("Expires:"):
+        expires = marine_pz_data.split(";;")[0].split(":")[1]
+        expires_date = expires[:8]
+        if expires_date < todayDate:
+            logger.debug("Location: NWS Marine PZ data expired")
+            return ERROR_FETCHING_DATA
+    else:
+        logger.debug("Location: NWS Marine PZ data not valid")
+        return ERROR_FETCHING_DATA
+    
+    # process the marine forecast data
+    marine_pzz_lines = marine_pz_data.split("\n")
+    marine_pz_report = ""
+    day_blocks = []
+    current_block = ""
+    in_forecast = False
+
+    for line in marine_pzz_lines:
+        if line.startswith(".") and "..." in line:
+            in_forecast = True
+            if current_block:
+                day_blocks.append(current_block.strip())
+                current_block = ""
+            current_block += line.strip() + " "
+        elif in_forecast and line.strip() != "":
+            current_block += line.strip() + " "
+    if current_block:
+        day_blocks.append(current_block.strip())
+
+    # Only keep up to pzDays blocks
+    for block in day_blocks[:days]:
+        marine_pz_report += block + "\n"
+
+    # remove last newline
+    if marine_pz_report.endswith("\n"):
+        marine_pz_report = marine_pz_report[:-1]
+
+    # remove NOAA EOF $$
+    if marine_pz_report.endswith("$$"):
+        marine_pz_report = marine_pz_report[:-2].strip()
+
+    # abbreviate the report
+    marine_pz_report = abbreviate_noaa(marine_pz_report)
+    if marine_pz_report == "":
+        return NO_DATA_NOGPS
+    return marine_pz_report
+

modules/log.py

@@ -1,6 +1,13 @@
 import logging
+from logging.handlers import TimedRotatingFileHandler
+import re
 from datetime import datetime
 from modules.settings import *
+# if LOGGING_LEVEL is not set in settings.py, default to DEBUG
+if not LOGGING_LEVEL:
+    LOGGING_LEVEL = "DEBUG"
+
+LOGGING_LEVEL = getattr(logging, LOGGING_LEVEL)
 
 class CustomFormatter(logging.Formatter):
     grey = '\x1b[38;21m'
@@ -29,10 +36,17 @@ class CustomFormatter(logging.Formatter):
         log_fmt = self.FORMATS.get(record.levelno)
         formatter = logging.Formatter(log_fmt)
         return formatter.format(record)
+    
+class plainFormatter(logging.Formatter):
+    ansi_escape = re.compile(r'\x1b\[([0-9]+)(;[0-9]+)*m')
+
+    def format(self, record):
+        message = super().format(record)
+        return self.ansi_escape.sub('', message)
 
 # Create logger
 logger = logging.getLogger("MeshBot System Logger")
-logger.setLevel(logging.DEBUG)
+logger.setLevel(LOGGING_LEVEL)
 logger.propagate = False
 
 msgLogger = logging.getLogger("MeshBot Messages Logger")
@@ -42,21 +56,41 @@ msgLogger.propagate = False
 # Define format for logs
 logFormat = '%(asctime)s | %(levelname)8s | %(message)s'
 msgLogFormat = '%(asctime)s | %(message)s'
+today = datetime.now()
 
 # Create stdout handler for logging to the console
 stdout_handler = logging.StreamHandler()
 # Set level for stdout handler (logs DEBUG level and above)
-stdout_handler.setLevel(logging.DEBUG)
+stdout_handler.setLevel(LOGGING_LEVEL)
 # Set format for stdout handler
 stdout_handler.setFormatter(CustomFormatter(logFormat))
-
-# Create file handler for logging to a file
-today = datetime.now()
-file_handler = logging.FileHandler('messages{}.log'.format(today.strftime('%Y_%m_%d')))
-file_handler.setLevel(logging.INFO)
-file_handler.setFormatter(logging.Formatter(msgLogFormat))
-
 # Add handlers to the logger
 logger.addHandler(stdout_handler)
+
+if syslog_to_file:
+    # Create file handler for logging to a file
+    file_handler_sys = TimedRotatingFileHandler('logs/meshbot.log', when='midnight', backupCount=log_backup_count, encoding='utf-8')
+    file_handler_sys.setLevel(LOGGING_LEVEL) # DEBUG used by default for system logs to disk
+    file_handler_sys.setFormatter(plainFormatter(logFormat))
+    logger.addHandler(file_handler_sys)
+
 if log_messages_to_file:
+    # Create file handler for logging to a file
+    file_handler = TimedRotatingFileHandler('logs/messages.log', when='midnight', backupCount=log_backup_count, encoding='utf-8')
+    file_handler.setLevel(logging.INFO) # INFO used for messages to disk
+    file_handler.setFormatter(logging.Formatter(msgLogFormat))
     msgLogger.addHandler(file_handler)
+
+# Pretty Timestamp
+def getPrettyTime(seconds):
+    # convert unix time to minutes, hours, days, or years for simple display
+    if seconds < 60:
+        return f"{int(seconds)}s"
+    elif seconds < 3600:
+        return f"{int(round(seconds / 60))}m"
+    elif seconds < 86400:
+        return f"{int(round(seconds / 3600))}h"
+    elif seconds < 31536000:
+        return f"{int(round(seconds / 86400))}d"
+    else:
+        return f"{int(round(seconds / 31536000))}y"

modules/qrz.py

@@ -0,0 +1,57 @@
+# Module to respomnd to new nodes we havent seen before with a hello message
+# K7MHI Kelly Keeton 2024
+
+import sqlite3
+from modules.log import *
+
+def initalize_qrz_database():
+    # create the database
+    conn = sqlite3.connect(qrz_db)
+    c = conn.cursor()
+    # Check if the qrz table exists, and create it if it doesn't
+    c.execute('''CREATE TABLE IF NOT EXISTS qrz
+                 (qrz_id INTEGER PRIMARY KEY, qrz_call TEXT, qrz_name TEXT, qrz_qth TEXT, qrz_notes TEXT)''')
+    conn.commit()
+    conn.close()
+
+def never_seen_before(nodeID):
+    # check if we have seen this node before and sent a hello message
+    conn = sqlite3.connect(qrz_db)
+    c = conn.cursor()
+    try:
+        c.execute("SELECT * FROM qrz WHERE qrz_call = ?", (nodeID,))
+        row = c.fetchone()
+        conn.close()
+        if row is None:
+            # we have not seen this node before
+            return True
+        else:
+            # we have seen this node before
+            return False
+    except sqlite3.OperationalError as e:
+        if "no such table" in str(e):
+            initalize_qrz_database()
+            logger.warning("QRZ database table not found, created new table")
+            # we have not seen this node before
+            return True
+        else:
+            raise
+    
+def hello(nodeID, name):
+    # send a hello message
+    conn = sqlite3.connect(qrz_db)
+    c = conn.cursor()
+    try:
+        c.execute("INSERT INTO qrz (qrz_call, qrz_name) VALUES (?, ?)", (nodeID, str(name)))
+    except sqlite3.OperationalError as e:
+        if "no such table" in str(e):
+            initalize_qrz_database()
+            c.execute("INSERT INTO qrz (qrz_call, qrz_name) VALUES (?, ?)", (nodeID, str(name)))
+        else:
+            raise
+    conn.commit()
+    conn.close()
+    return True
+
+
+    

modules/radio.py

@@ -5,7 +5,7 @@
 
 import socket
 import asyncio
-from modules.settings import *
+from modules.log import *
 
 def get_hamlib(msg="f"):
     try:
@@ -13,7 +13,7 @@ def get_hamlib(msg="f"):
         rigControlSocket.settimeout(2)
         rigControlSocket.connect((rigControlServerAddress.split(":")[0],int(rigControlServerAddress.split(":")[1])))
     except Exception as e:
-        print(f"\nSystem: Error connecting to rigctld: {e}")
+        logger.error(f"RadioMon: Error connecting to rigctld: {e}")
         return ERROR_FETCHING_DATA
 
     try:
@@ -27,7 +27,7 @@ def get_hamlib(msg="f"):
         data = data.replace(b'\n',b'')
         return data.decode("utf-8").rstrip()
     except Exception as e:
-        print(f"\nSystem: Error fetching data from rigctld: {e}")
+        logger.error(f"RadioMon: Error fetching data from rigctld: {e}")
         return ERROR_FETCHING_DATA
 
 def get_freq_common_name(freq):
@@ -140,6 +140,7 @@ async def signalWatcher():
         signalStrength = int(get_sig_strength())
         if signalStrength >= previousStrength and signalStrength > signalDetectionThreshold:
             message = f"Detected {get_freq_common_name(get_hamlib('f'))} active. S-Meter:{signalStrength}dBm"
+            logger.debug(f"RadioMon: {message}. Waiting for {signalHoldTime} seconds")
             previousStrength = signalStrength
             signalCycle = 0
             await asyncio.sleep(signalHoldTime)

modules/settings.py

@@ -1,14 +1,16 @@
+# Settings for MeshBot and PongBot
+# 2024 Kelly Keeton K7MHI
 import configparser
 
 # messages
 NO_DATA_NOGPS = "No location data: does your device have GPS?"
 ERROR_FETCHING_DATA = "error fetching data"
-WELCOME_MSG = 'MeshBot, here for you like a friend who is not. Try sending: ping @foo  or, cmd? for more'
+WELCOME_MSG = 'MeshBot, here for you like a friend who is not. Try sending: ping @foo  or, CMD? for more'
+EMERGENCY_RESPONSE = "MeshBot detected a possible request for Emergency Assistance and alerted a wider audience."
 MOTD = 'Thanks for using MeshBOT! Have a good day!'
-NO_ALERTS = "No weather alerts found."
+NO_ALERTS = "No alerts found."
 
 # setup the global variables
-MESSAGE_CHUNK_SIZE = 160 # message chunk size for sending at high success rate
 SITREP_NODE_COUNT = 3 # number of nodes to report in the sitrep
 msg_history = [] # message history for the store and forward feature
 bbs_ban_list = [] # list of banned users, imported from config
@@ -18,33 +20,89 @@ antiSpam = True # anti-spam feature to prevent flooding public channel
 ping_enabled = True # ping feature to respond to pings, ack's etc.
 sitrep_enabled = True # sitrep feature to respond to sitreps
 lastHamLibAlert = 0 # last alert from hamlib
-max_retry_count1 = 4 # max retry count for interface 1
-max_retry_count2 = 4 # max retry count for interface 2
+lastFileAlert = 0 # last alert from file monitor
+max_retry_count1 = max_retry_count2 = max_retry_count3 = max_retry_count4 = max_retry_count5 = max_retry_count6 = max_retry_count7 = max_retry_count8 = max_retry_count9 = 4 # default retry count for interfaces
 retry_int1 = False
 retry_int2 = False
+wiki_return_limit = 3 # limit the number of sentences returned off the first paragraph first hit
+GAMEDELAY = 28800 # 8 hours in seconds for game mode holdoff
+cmdHistory = [] # list to hold the last commands
+seenNodes = [] # list to hold the last seen nodes
 
 # Read the config file, if it does not exist, create basic config file
 config = configparser.ConfigParser() 
 config_file = "config.ini"
 
 try:
-    config.read(config_file)
+    config.read(config_file, encoding='utf-8')
 except Exception as e:
     print(f"System: Error reading config file: {e}")
 
 if config.sections() == []:
     print(f"System: Error reading config file: {config_file} is empty or does not exist.")
     config['interface'] = {'type': 'serial', 'port': "/dev/ttyACM0", 'hostname': '', 'mac': ''}
-    config['general'] = {'respond_by_dm_only': 'True', 'defaultChannel': '0', 'motd': MOTD,
-                         'welcome_message': WELCOME_MSG, 'zuluTime': 'False'}
+    config['general'] = {'respond_by_dm_only': 'True', 'defaultChannel': '0', 'motd': MOTD, 'welcome_message': WELCOME_MSG, 'zuluTime': 'False'}
     config.write(open(config_file, 'w'))
     print (f"System: Config file created, check {config_file} or review the config.template")
 
+if 'sentry' not in config:
+    config['sentry'] = {'SentryEnabled': 'False', 'SentryChannel': '2', 'SentryHoldoff': '9', 'sentryIgnoreList': '', 'SentryRadius': '100'}
+    config.write(open(config_file, 'w'))
+
+if 'location' not in config:
+    config['location'] = {'enabled': 'True', 'lat': '48.50', 'lon': '-123.0', 'UseMeteoWxAPI': 'False', 'useMetric': 'False', 'NOAAforecastDuration': '4', 'NOAAalertCount': '2', 'NOAAalertsEnabled': 'True', 'wxAlertBroadcastEnabled': 'False', 'wxAlertBroadcastChannel': '2', 'repeaterLookup': 'rbook'}
+    config.write(open(config_file, 'w'))
+
+if 'bbs' not in config:
+    config['bbs'] = {'enabled': 'False', 'bbsdb': 'data/bbsdb.pkl', 'bbs_ban_list': '', 'bbs_admin_list': ''}
+    config.write(open(config_file, 'w'))
+
+if 'repeater' not in config:
+    config['repeater'] = {'enabled': 'False', 'repeater_channels': ''}
+    config.write(open(config_file, 'w'))
+
+if 'radioMon' not in config:
+    config['radioMon'] = {'enabled': 'False', 'rigControlServerAddress': 'localhost:4532', 'sigWatchBrodcastCh': '2', 'signalDetectionThreshold': '-10', 'signalHoldTime': '10', 'signalCooldown': '5', 'signalCycleLimit': '5'}
+    config.write(open(config_file, 'w'))
+
+if 'games' not in config:
+    config['games'] = {'dopeWars': 'True', 'lemonade': 'True', 'blackjack': 'True', 'videoPoker': 'True'}
+    config.write(open(config_file, 'w'))
+
+if 'messagingSettings' not in config:
+    config['messagingSettings'] = {'responseDelay': '0.7', 'splitDelay': '0', 'MESSAGE_CHUNK_SIZE': '160'}
+    config.write(open(config_file, 'w'))
+
+if 'fileMon' not in config:
+    config['fileMon'] = {'enabled': 'False', 'file_path': 'alert.txt', 'broadcastCh': '2'}
+    config.write(open(config_file, 'w'))
+
+if 'scheduler' not in config:
+    config['scheduler'] = {'enabled': 'False'}
+    config.write(open(config_file, 'w'))
+
+if 'emergencyHandler' not in config:
+    config['emergencyHandler'] = {'enabled': 'False', 'alert_channel': '2', 'alert_interface': '1', 'email': ''}
+    config.write(open(config_file, 'w'))
+
+if 'smtp' not in config:
+    config['smtp'] = {'sysopEmails': '', 'enableSMTP': 'False', 'enableImap': 'False'}
+    config.write(open(config_file, 'w'))
+
+if 'checklist' not in config:
+    config['checklist'] = {'enabled': 'False', 'checklist_db': 'data/checklist.db'}
+    config.write(open(config_file, 'w'))
+
+if 'qrz' not in config:
+    config['qrz'] = {'enabled': 'False', 'qrz_db': 'data/qrz.db', 'qrz_hello_string': 'send CMD or DM me for more info.'}
+    config.write(open(config_file, 'w'))
+
 # interface1 settings
 interface1_type = config['interface'].get('type', 'serial')
 port1 = config['interface'].get('port', '')
 hostname1 = config['interface'].get('hostname', '')
 mac1 = config['interface'].get('mac', '')
+interface1_enabled = True # gotta have at least one interface
 
 # interface2 settings
 if 'interface2' in config:
@@ -56,38 +114,258 @@ if 'interface2' in config:
 else:
     interface2_enabled = False
 
-# variables
+# interface3 settings
+if 'interface3' in config:
+    interface3_type = config['interface3'].get('type', 'serial')
+    port3 = config['interface3'].get('port', '')
+    hostname3 = config['interface3'].get('hostname', '')
+    mac3 = config['interface3'].get('mac', '')
+    interface3_enabled = config['interface3'].getboolean('enabled', False)
+else:
+    interface3_enabled = False
+
+# interface4 settings
+if 'interface4' in config:
+    interface4_type = config['interface4'].get('type', 'serial')
+    port4 = config['interface4'].get('port', '')
+    hostname4 = config['interface4'].get('hostname', '')
+    mac4 = config['interface4'].get('mac', '')
+    interface4_enabled = config['interface4'].getboolean('enabled', False)
+else:
+    interface4_enabled = False
+
+# interface5 settings
+if 'interface5' in config:
+    interface5_type = config['interface5'].get('type', 'serial')
+    port5 = config['interface5'].get('port', '')
+    hostname5 = config['interface5'].get('hostname', '')
+    mac5 = config['interface5'].get('mac', '')
+    interface5_enabled = config['interface5'].getboolean('enabled', False)
+else:
+    interface5_enabled = False
+
+# interface6 settings
+if 'interface6' in config:
+    interface6_type = config['interface6'].get('type', 'serial')
+    port6 = config['interface6'].get('port', '')
+    hostname6 = config['interface6'].get('hostname', '')
+    mac6 = config['interface6'].get('mac', '')
+    interface6_enabled = config['interface6'].getboolean('enabled', False)
+else:
+    interface6_enabled = False
+
+# interface7 settings
+if 'interface7' in config:
+    interface7_type = config['interface7'].get('type', 'serial')
+    port7 = config['interface7'].get('port', '')
+    hostname7 = config['interface7'].get('hostname', '')
+    mac7 = config['interface7'].get('mac', '')
+    interface7_enabled = config['interface7'].getboolean('enabled', False)
+else:
+    interface7_enabled = False
+
+# interface8 settings
+if 'interface8' in config:
+    interface8_type = config['interface8'].get('type', 'serial')
+    port8 = config['interface8'].get('port', '')
+    hostname8 = config['interface8'].get('hostname', '')
+    mac8 = config['interface8'].get('mac', '')
+    interface8_enabled = config['interface8'].getboolean('enabled', False)
+else:
+    interface8_enabled = False
+
+# interface9 settings
+if 'interface9' in config:
+    interface9_type = config['interface9'].get('type', 'serial')
+    port9 = config['interface9'].get('port', '')
+    hostname9 = config['interface9'].get('hostname', '')
+    mac9 = config['interface9'].get('mac', '')
+    interface9_enabled = config['interface9'].getboolean('enabled', False)
+else:
+    interface9_enabled = False
+
+multiple_interface = False
+if interface2_enabled or interface3_enabled or interface4_enabled or interface5_enabled or interface6_enabled or interface7_enabled or interface8_enabled or interface9_enabled:
+    multiple_interface = True
+    
+
+# variables from the config.ini file
 try:
-    storeFlimit = config['general'].getint('StoreLimit', 3) # default 3 messages for S&F
+    # general
     useDMForResponse = config['general'].getboolean('respond_by_dm_only', True)
     publicChannel = config['general'].getint('defaultChannel', 0) # the meshtastic public channel
-    location_enabled = config['location'].getboolean('enabled', False)
+    ignoreChannels = config['general'].get('ignoreChannels', '').split(',') # ignore these channels
+    ignoreDefaultChannel = config['general'].getboolean('ignoreDefaultChannel', False)
+    cmdBang = config['general'].getboolean('cmdBang', False) # default off
+    explicitCmd = config['general'].getboolean('explicitCmd', True) # default on
+    zuluTime = config['general'].getboolean('zuluTime', False) # aka 24 hour time
+    log_messages_to_file = config['general'].getboolean('LogMessagesToFile', False) # default off
+    log_backup_count = config['general'].getint('LogBackupCount', 32) # default 32 days
+    syslog_to_file = config['general'].getboolean('SyslogToFile', True) # default on
+    LOGGING_LEVEL = config['general'].get('sysloglevel', 'DEBUG') # default DEBUG
+    urlTimeoutSeconds = config['general'].getint('urlTimeout', 10) # default 10 seconds
+    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('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)
+    MOTD = config['general'].get('motd', MOTD)
+    autoPingInChannel = config['general'].getboolean('autoPingInChannel', False)
+    enableCmdHistory = config['general'].getboolean('enableCmdHistory', True)
+    lheardCmdIgnoreNode = config['general'].get('lheardCmdIgnoreNode', '').split(',')
+    whoami_enabled = config['general'].getboolean('whoami', True)
+    dad_jokes_enabled = config['general'].getboolean('DadJokes', False)
+    dad_jokes_emojiJokes = config['general'].getboolean('DadJokesEmoji', False)
+    bee_enabled = config['general'].getboolean('bee', False) # 🐝 off by default undocumented
+    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
+    ollamaHostName = config['general'].get('ollamaHostName', 'http://localhost:11434') # default localhost
+    llmModel = config['general'].get('ollamaModel', 'gemma3:270m') # default gemma3:270m
+    rawLLMQuery = config['general'].getboolean('rawLLMQuery', True) #default True
+    llmReplyToNonCommands = config['general'].getboolean('llmReplyToNonCommands', True)
+    dont_retry_disconnect = config['general'].getboolean('dont_retry_disconnect', False) # default False, retry on disconnect
+    # emergency response
+    emergency_responder_enabled = config['emergencyHandler'].getboolean('enabled', False)
+    emergency_responder_alert_channel = config['emergencyHandler'].getint('alert_channel', 2) # default 2
+    emergency_responder_alert_interface = config['emergencyHandler'].getint('alert_interface', 1) # default 1
+    emergency_responder_email = config['emergencyHandler'].get('email', '').split(',')
+
+    # sentry
+    sentry_enabled = config['sentry'].getboolean('SentryEnabled', False) # default False
+    secure_channel = config['sentry'].getint('SentryChannel', 2) # default 2
+    sentry_holdoff = config['sentry'].getint('SentryHoldoff', 9) # default 9
+    sentryIgnoreList = config['sentry'].get('sentryIgnoreList', '').split(',')
+    sentry_radius = config['sentry'].getint('SentryRadius', 100) # default 100 meters
+    email_sentry_alerts = config['sentry'].getboolean('emailSentryAlerts', False) # default False
+    highfly_enabled = config['sentry'].getboolean('highFlyingAlert', True) # default True
+    highfly_altitude = config['sentry'].getint('highFlyingAlertAltitude', 2000) # default 2000 meters
+    highfly_channel = config['sentry'].getint('highFlyingAlertChannel', 2) # default 2
+    highfly_ignoreList = config['sentry'].get('highFlyingIgnoreList', '').split(',') # default empty
+
+    # location
+    location_enabled = config['location'].getboolean('enabled', True)
     latitudeValue = config['location'].getfloat('lat', 48.50)
     longitudeValue = config['location'].getfloat('lon', -123.0)
-    zuluTime = config['general'].getboolean('zuluTime', False)
-    welcome_message = config['general'].get(f'welcome_message', WELCOME_MSG)
-    welcome_message = (f"{welcome_message}").replace('\\n', '\n') # allow for newlines in the welcome message
-    solar_conditions_enabled = config['solar'].getboolean('enabled', False)
+    use_meteo_wxApi = config['location'].getboolean('UseMeteoWxAPI', False) # default False use NOAA
+    use_metric = config['location'].getboolean('useMetric', False) # default Imperial units
+    repeater_lookup = config['location'].get('repeaterLookup', 'rbook') # default repeater lookup source
+    n2yoAPIKey = config['location'].get('n2yoAPIKey', '') # default empty
+    satListConfig = config['location'].get('satList', '25544').split(',') # default 25544 ISS
+    riverListDefault = config['location'].get('riverList', '').split(',') # default None
+    coastalEnabled = config['location'].getboolean('coastalEnabled', False) # default False
+    myCoastalZone = config['location'].get('myCoastalZone', None) # default None
+    coastalForecastDays = config['location'].getint('coastalForecastDays', 3) # default 3 days
+
+    # location alerts
+    emergencyAlertBrodcastEnabled = config['location'].getboolean('eAlertBroadcastEnabled', False) # default False
+    wxAlertBroadcastEnabled = config['location'].getboolean('wxAlertBroadcastEnabled', False) # default False
+    enableGBalerts = config['location'].getboolean('enableGBalerts', False) # default False
+    enableDEalerts = config['location'].getboolean('enableDEalerts', False) # default False
+    wxAlertsEnabled = config['location'].getboolean('NOAAalertsEnabled', True) # default True
+    ignoreEASenable = config['location'].getboolean('ignoreEASenable', False) # default False
+    ignoreEASwords = config['location'].get('ignoreEASwords', 'test,advisory').split(',') # default test,advisory
+    myRegionalKeysDE = config['location'].get('myRegionalKeysDE', '110000000000').split(',') # default city Berlin
+    forecastDuration = config['location'].getint('NOAAforecastDuration', 4) # NOAA forcast days
+    numWxAlerts = config['location'].getint('NOAAalertCount', 2) # default 2 alerts
+    enableExtraLocationWx = config['location'].getboolean('enableExtraLocationWx', False) # default False
+    myStateFIPSList = config['location'].get('myFIPSList', '').split(',') # default empty
+    mySAMEList = config['location'].get('mySAMEList', '').split(',') # default empty
+    ignoreFEMAenable = config['location'].getboolean('ignoreFEMAenable', True) # default True
+    ignoreFEMAwords = config['location'].get('ignoreFEMAwords', 'test,exercise').split(',') # default test,exercise
+    wxAlertBroadcastChannel = config['location'].get('wxAlertBroadcastCh', '2').split(',') # default Channel 2
+    emergencyAlertBroadcastCh = config['location'].get('eAlertBroadcastCh', '2').split(',') # default Channel 2
+    volcanoAlertBroadcastEnabled = config['location'].getboolean('volcanoAlertBroadcastEnabled', False) # default False
+    volcanoAlertBroadcastChannel = config['location'].get('volcanoAlertBroadcastCh', '2').split(',') # default Channel 2
+    ignoreUSGSEnable = config['location'].getboolean('ignoreVolcanoEnable', False) # default False
+    ignoreUSGSWords = config['location'].get('ignoreVolcanoWords', 'test,advisory').split(',') # default test,advisory
+    
+    # bbs
     bbs_enabled = config['bbs'].getboolean('enabled', False)
-    bbsdb = config['bbs'].get('bbsdb', 'bbsdb.pkl')
-    dad_jokes_enabled = config['general'].getboolean('DadJokes', False)
-    store_forward_enabled = config['general'].getboolean('StoreForward', False)
-    log_messages_to_file = config['general'].getboolean('LogMessagesToFile', True) # default True
-    config['general'].get('motd', MOTD)
-    urlTimeoutSeconds = config['general'].getint('URL_TIMEOUT', 10) # default 10 seconds
-    forecastDuration = config['general'].getint('DAYS_OF_WEATHER', 4) # default days of weather
-    numWxAlerts = config['general'].getint('ALERT_COUNT', 2) # default 2 alerts
+    bbsdb = config['bbs'].get('bbsdb', 'data/bbsdb.pkl')
     bbs_ban_list = config['bbs'].get('bbs_ban_list', '').split(',')
     bbs_admin_list = config['bbs'].get('bbs_admin_list', '').split(',')
+    bbs_link_enabled = config['bbs'].getboolean('bbslink_enabled', False)
+    bbs_link_whitelist = config['bbs'].get('bbslink_whitelist', '').split(',')
+    
+    # checklist
+    checklist_enabled = config['checklist'].getboolean('enabled', False)
+    checklist_db = config['checklist'].get('checklist_db', 'data/checklist.db')
+    reverse_in_out = config['checklist'].getboolean('reverse_in_out', False)
+
+    # qrz hello
+    qrz_hello_enabled = config['qrz'].getboolean('enabled', False)
+    qrz_db = config['qrz'].get('qrz_db', 'data/qrz.db')
+    qrz_hello_string = config['qrz'].get('qrz_hello_string', 'MeshBot says Hello! DM for more info.')
+    train_qrz = config['qrz'].getboolean('training', True)
+    
+    # E-Mail Settings
+    sysopEmails = config['smtp'].get('sysopEmails', '').split(',')
+    enableSMTP = config['smtp'].getboolean('enableSMTP', False)
+    enableImap = config['smtp'].getboolean('enableImap', False)
+    SMTP_SERVER = config['smtp'].get('SMTP_SERVER', 'smtp.gmail.com')
+    SMTP_PORT = config['smtp'].getint('SMTP_PORT', 587)
+    FROM_EMAIL = config['smtp'].get('FROM_EMAIL', 'none@gmail.com')
+    SMTP_AUTH = config['smtp'].getboolean('SMTP_AUTH', True)
+    SMTP_USERNAME = config['smtp'].get('SMTP_USERNAME', FROM_EMAIL)
+    SMTP_PASSWORD = config['smtp'].get('SMTP_PASSWORD', 'password')
+    EMAIL_SUBJECT = config['smtp'].get('EMAIL_SUBJECT', 'Meshtastic✉️')
+    IMAP_SERVER = config['smtp'].get('IMAP_SERVER', 'imap.gmail.com')
+    IMAP_PORT = config['smtp'].getint('IMAP_PORT', 993)
+    IMAP_USERNAME = config['smtp'].get('IMAP_USERNAME', SMTP_USERNAME)
+    IMAP_PASSWORD = config['smtp'].get('IMAP_PASSWORD', SMTP_PASSWORD)
+    IMAP_FOLDER = config['smtp'].get('IMAP_FOLDER', 'inbox')
+
+    # repeater
     repeater_enabled = config['repeater'].getboolean('enabled', False)
     repeater_channels = config['repeater'].get('repeater_channels', '').split(',')
-    radio_dectection_enabled = config['radioMon'].getboolean('enabled', False)
+
+    # scheduler
+    scheduler_enabled = config['scheduler'].getboolean('enabled', False)
+    schedulerInterface = config['scheduler'].getint('interface', 1) # default interface 1
+    schedulerChannel = config['scheduler'].getint('channel', 2) # default channel 2
+    schedulerMessage = config['scheduler'].get('message', 'Scheduled message') # default message
+    schedulerInterval = config['scheduler'].get('interval', '') # default empty
+    schedulerTime = config['scheduler'].get('time', '') # default empty
+    schedulerValue = config['scheduler'].get('value', '') # default empty
+
+    # radio monitoring
+    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
     signalCycleLimit = config['radioMon'].getint('signalCycleLimit', 5) # default 5 cycles, used with SIGNAL_COOLDOWN
+
+    # file monitor
+    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'].get('broadcastCh', '2').split(',') # default Channel 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
+    news_random_line_only = config['fileMon'].getboolean('news_random_line', False) # default False
+    enable_runShellCmd = config['fileMon'].getboolean('enable_runShellCmd', False) # default False
+
+    # games
+    game_hop_limit = config['messagingSettings'].getint('game_hop_limit', 5) # default 3 hops
+    dopewars_enabled = config['games'].getboolean('dopeWars', True)
+    lemonade_enabled = config['games'].getboolean('lemonade', True)
+    blackjack_enabled = config['games'].getboolean('blackjack', True)
+    videoPoker_enabled = config['games'].getboolean('videoPoker', True)
+    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
+    splitDelay = config['messagingSettings'].getfloat('splitDelay', 0) # default 0
+    MESSAGE_CHUNK_SIZE = config['messagingSettings'].getint('MESSAGE_CHUNK_SIZE', 160) # default 160
+    wantAck = config['messagingSettings'].getboolean('wantAck', False) # default False
+    maxBuffer = config['messagingSettings'].getint('maxBuffer', 200) # default 200
+    enableHopLogs = config['messagingSettings'].getboolean('enableHopLogs', False) # default False
+
 except KeyError as e:
     print(f"System: Error reading config file: {e}")
     print(f"System: Check the config.ini against config.template file for missing sections or values.")

modules/smtp.py

@@ -0,0 +1,266 @@
+# SMTP module for the meshing-around bot
+# 2024 Idea and code bits from https://github.com/tremmert81
+# https://avtech.com/articles/138/list-of-email-to-sms-addresses/
+# 2024 Kelly Keeton K7MHI
+
+from modules.log import *
+import pickle
+import time
+import smtplib
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+
+# System variables
+trap_list_smtp = ("email:", "setemail", "sms:", "setsms", "clearsms")
+smtpThrottle = {}
+SMTP_TIMEOUT = 10
+
+if enableImap:
+    # Import IMAP library
+    import imaplib
+    import email
+
+# Send email
+def send_email(to_email, message, nodeID=0):
+    global smtpThrottle
+    
+    # Clean up email address
+    to_email = to_email.strip()
+    
+    # Basic email validation
+    if "@" not in to_email or "." not in to_email:
+        logger.warning(f"System: Invalid email address format: {to_email}")
+        return False
+        
+    # throttle email to prevent abuse
+    if to_email in smtpThrottle:
+        if smtpThrottle[to_email] > time.time() - 120:
+            logger.warning("System: Email throttled for " + to_email[:-6])
+            return "⛔️Email throttled, try again later"
+    smtpThrottle[to_email] = time.time()
+
+    # check if email is in the ban list
+    if nodeID in bbs_ban_list:
+        logger.warning("System: Email blocked for " + str(nodeID))
+        return "⛔️Email throttled, try again later"
+    # Send email
+    try:
+        # Create message
+        msg = MIMEMultipart()
+        msg['From'] = FROM_EMAIL
+        msg['To'] = to_email
+        msg['Subject'] = EMAIL_SUBJECT
+        msg.attach(MIMEText(message, 'plain'))
+
+        # Connect to SMTP server
+        server = smtplib.SMTP(SMTP_SERVER, SMTP_PORT, timeout=SMTP_TIMEOUT)
+        try:
+            # login /auth
+            if SMTP_PORT == 587:
+                server.starttls()
+            if SMTP_AUTH:
+                server.login(SMTP_USERNAME, SMTP_PASSWORD)
+        except Exception as e:
+            logger.warning(f"System: Failed to login to SMTP server: {str(e)}")
+            return
+
+        # Send email; this command will hold the program until the email is sent
+        server.send_message(msg)
+        server.quit()
+
+        logger.info("System: Email sent to: " + to_email[:-6])
+        return True
+    except Exception as e:
+        logger.warning(f"System: Failed to send email: {str(e)}")
+        return False
+
+def check_email(nodeID, sysop=False):
+    if not enableImap:
+        return
+
+    try:
+        # Connect to IMAP server
+        mail = imaplib.IMAP4_SSL(IMAP_SERVER, IMAP_PORT, timeout=SMTP_TIMEOUT)
+        mail.login(IMAP_USERNAME, IMAP_PASSWORD)
+        mail.select(IMAP_FOLDER)
+
+        # Search for new emails
+        status, data = mail.search(None, 'UNSEEN')
+        if status == 'OK':
+            for num in data[0].split():
+                status, data = mail.fetch(num, '(RFC822)')
+                if status == 'OK':
+                    email_message = email.message_from_bytes(data[0][1])
+                    email_from = email_message['from']
+                    email_subject = email_message['subject']
+                    email_body = ""
+
+                    if not sysop:
+                        # Check if email is whitelisted by particpant in the mesh
+                        for address in sms_db[nodeID]:
+                            if address in email_from:
+                                email_body = email_message.get_payload()
+                                logger.info("System: Email received from: " + email_from[:-6] + " for " + str(nodeID))
+                                return email_body.strip()
+                    else:
+                        # Check if email is from sysop
+                        for address in sysopEmails:
+                            if address in email_from:
+                                email_body = email_message.get_payload()
+                                logger.info("System: SysOp Email received from: " + email_from[:-6] + " for sysop")
+                                return email_body.strip()
+                        
+    except Exception as e:
+        logger.warning("System: Failed to check email: " + str(e))
+        return False
+
+# initalize email db
+email_db = {}
+try:
+    with open('data/email_db.pickle', 'rb') as f:
+        email_db = pickle.load(f)
+except:
+    logger.warning("System: Email db not found, creating a new one")
+    with open('data/email_db.pickle', 'wb') as f:
+        pickle.dump(email_db, f)
+
+def store_email(nodeID, email):
+    global email_db
+
+    # if not in db, add it
+    logger.debug("System: Setting E-Mail for " + str(nodeID))
+    email_db[nodeID] = email
+
+    # save to a pickle for persistence, this is a simple db, be mindful of risk
+    with open('data/email_db.pickle', 'wb') as f:
+        pickle.dump(email_db, f)
+    f.close()
+    return True
+
+
+# initalize SMS db
+sms_db = [{'nodeID': 0, 'sms':[]}]
+try:
+    with open('data/sms_db.pickle', 'rb') as f:
+        sms_db = pickle.load(f)
+except:
+    logger.warning("System: SMS db not found, creating a new one")
+    with open('data/sms_db.pickle', 'wb') as f:
+        pickle.dump(sms_db, f)
+
+def store_sms(nodeID, sms):
+    global sms_db
+    try:
+        logger.debug("System: Setting SMS for " + str(nodeID))
+        # if not in db, add it
+        if nodeID not in sms_db:
+            sms_db.append({'nodeID': nodeID, 'sms': sms})
+        else:
+            # if in db, update it
+            for item in sms_db:
+                if item['nodeID'] == nodeID:
+                    item['sms'].append(sms)
+
+        # save to a pickle for persistence, this is a simple db, be mindful of risk
+        with open('data/sms_db.pickle', 'wb') as f:
+            pickle.dump(sms_db, f)
+        f.close()
+        return True
+    except Exception as e:
+        logger.warning("System: Failed to store SMS: " + str(e))
+        return False
+
+def handle_sms(nodeID, message):
+    global sms_db
+    # if clearsms, remove all sms for node
+    if message.lower().startswith("clearsms"):
+        if any(item['nodeID'] == nodeID for item in sms_db):
+            # remove record from db for nodeID
+            sms_db = [item for item in sms_db if item['nodeID'] != nodeID]
+            # update the pickle
+            with open('data/sms_db.pickle', 'wb') as f:
+                pickle.dump(sms_db, f)
+            f.close()
+            return "📲 address cleared"
+        return "📲No address to clear"
+    
+    # send SMS to SMS in db. if none ask for one
+    if message.lower().startswith("setsms"):
+        message = message.split(" ", 1)
+        if len(message[1]) < 5:
+            return "?📲setsms: example@phone.co"
+        if "@" not in message[1] and "." not in message[1]:
+            return "📲Please provide a valid email address"
+        if store_sms(nodeID, message[1]):
+            return "📲SMS address set 📪"
+        else:
+            return "⛔️Failed to set address"
+        
+    if message.lower().startswith("sms:"):
+        message = message.split(" ", 1)
+        if any(item['nodeID'] == nodeID for item in sms_db):
+            count = 0
+            # for all dict items maching nodeID in sms_db send sms
+            for item in sms_db:
+                if item['nodeID'] == nodeID:
+                    smsEmail = item['sms']
+                    logger.info("System: Sending SMS for " + str(nodeID) + " to " + smsEmail[:-6])
+                    if send_email(smsEmail, message[1], nodeID):
+                        count += 1
+                    else: 
+                        return "⛔️Failed to send SMS"
+            return "📲SMS sent " + str(count) + " addresses 📤"
+        else:
+            return "📲No address set, use 📲setsms"
+    
+    return "Error: ⛔️ not understood. use:setsms example@phone.co"
+
+def handle_email(nodeID, message):
+    global email_db
+    try:
+        # send email to email in db. if none ask for one
+        if message.lower().startswith("setemail"):
+            message = message.split(" ", 1)
+            if len(message) < 2:
+                return "📧Please provide an email address"
+            email_addr = message[1].strip()
+            if "@" not in email_addr or "." not in email_addr:
+                return "📧Please provide a valid email address"
+            if store_email(nodeID, email_addr):
+                return "📧Email address set 📪"
+            return "Error: ⛔️ Failed to set email address"
+            
+        if message.lower().startswith("email:"):
+            parts = message.split(" ", 1)
+            if len(parts) < 2:
+                return "Error: ⛔️ format should be: email: message  or, email: address@example.com #message"
+                
+            content = parts[1].strip()
+            
+            # Check if this is a direct email with address
+            if "@" in content and "#" in content:
+                # Split into email and message
+                addr_msg = content.split("#", 1)
+                if len(addr_msg) != 2:
+                    return "Error: ⛔️ Message format should be: email: address@example.com #message"
+                    
+                to_email = addr_msg[0].strip()
+                message_body = addr_msg[1].strip()
+                
+                logger.info(f"System: Sending email for {nodeID} to {to_email}")
+                if send_email(to_email, message_body, nodeID): 
+                    return "📧Email-sent 📤"
+                return "⛔️Failed to send email"
+                
+            # Using stored email address
+            elif nodeID in email_db:
+                logger.info(f"System: Sending email for {nodeID} to stored address")
+                if send_email(email_db[nodeID], content, nodeID):
+                    return "📧Email-sent 📤"
+                return "⛔️Failed to send email"
+        
+        return "Error: ⛔️ no email on file. use: setemail"
+            
+    except Exception as e:
+        logger.error(f"System: Email handling error: {str(e)}")
+        return "⛔️Failed to process email command"

modules/space.py

@@ -1,15 +1,15 @@
 # helper functions to get HF band conditions, DRAP X-ray flux, and sunrise/sunset times
-# some code from https://github.com/Murturtle/MeshLink
+# HF code from https://github.com/Murturtle/MeshLink
 # K7MHI Kelly Keeton 2024
 
 import requests # pip install requests
 import xml.dom.minidom
 from datetime import datetime
 import ephem # pip install pyephem
-from datetime import timedelta
-from modules.settings import *
+from datetime import timezone
+from modules.log import *
 
-trap_list_solarconditions = ("sun", "solar", "hfcond")
+trap_list_solarconditions = ("sun", "moon", "solar", "hfcond", "satpass")
 
 def hf_band_conditions():
     # ham radio HF band conditions
@@ -19,9 +19,11 @@ def hf_band_conditions():
         solarxml = xml.dom.minidom.parseString(band_cond.text)
         for i in solarxml.getElementsByTagName("band"):
             hf_cond += i.getAttribute("time")[0]+i.getAttribute("name") +"="+str(i.childNodes[0].data)+"\n"
+        hf_cond = hf_cond[:-1] # remove the last newline
     else:
-        hf_cond += ERROR_FETCHING_DATA
-    hf_cond = hf_cond[:-1] # remove the last newline
+        logger.error("Solar: Error fetching HF band conditions")
+        hf_cond = ERROR_FETCHING_DATA
+    
     return hf_cond
 
 def solar_conditions():
@@ -39,7 +41,8 @@ def solar_conditions():
             signalnoise = i.getElementsByTagName("signalnoise")[0].childNodes[0].data
         solar_cond = "A-Index: " + solar_a_index + "\nK-Index: " + solar_k_index + "\nSunspots: " + sunspots + "\nX-Ray Flux: " + solar_xray + "\nSolar Flux: " + solar_flux + "\nSignal Noise: " + signalnoise
     else:
-        solar_cond += ERROR_FETCHING_DATA
+        logger.error("Solar: Error fetching solar conditions")
+        solar_cond = ERROR_FETCHING_DATA
     return solar_cond
 
 def drap_xray_conditions():
@@ -53,13 +56,14 @@ def drap_xray_conditions():
             if x_filter in line:
                 xray_flux = line.split(": ")[1]
     else:
-        xray_flux += ERROR_FETCHING_DATA
+        logger.error("Error fetching DRAP X-ray flux")
+        xray_flux = ERROR_FETCHING_DATA
     return xray_flux
 
 def get_sun(lat=0, lon=0):
     # get sunrise and sunset times using callers location or default
     obs = ephem.Observer()
-    obs.date = datetime.now()
+    obs.date = datetime.now(timezone.utc)
     sun = ephem.Sun()
     if lat != 0 and lon != 0:
         obs.lat = str(lat)
@@ -70,9 +74,17 @@ def get_sun(lat=0, lon=0):
 
     sun.compute(obs)
     sun_table = {}
+
+    # get the sun azimuth and altitude
     sun_table['azimuth'] = sun.az
     sun_table['altitude'] = sun.alt
 
+    # sun is up include altitude
+    if sun_table['altitude'] > 0:
+        sun_table['altitude'] = sun.alt
+    else:
+        sun_table['altitude'] = 0
+
     # get the next rise and set times
     local_sunrise = ephem.localtime(obs.next_rising(sun))
     local_sunset = ephem.localtime(obs.next_setting(sun))
@@ -82,19 +94,25 @@ def get_sun(lat=0, lon=0):
     else:
         sun_table['rise_time'] = local_sunrise.strftime('%a %d %I:%M%p')
         sun_table['set_time'] = local_sunset.strftime('%a %d %I:%M%p')
-    # if sunset is before sunrise, then it's tomorrow
+    
+    # if sunset is before sunrise, then data will be for tomorrow format sunset first and sunrise second
     if local_sunset < local_sunrise:
-        local_sunset = ephem.localtime(obs.next_setting(sun)) + timedelta(1)
-        if zuluTime:
-            sun_table['set_time'] = local_sunset.strftime('%a %d %H:%M')
-        else:
-            sun_table['set_time'] = local_sunset.strftime('%a %d %I:%M%p')
-    sun_data = "SunRise: " + sun_table['rise_time'] + "\nSet: " + sun_table['set_time']
+        sun_data = "SunSet: " + sun_table['set_time'] + "\nRise: " + sun_table['rise_time']
+    else:
+        sun_data = "SunRise: " + sun_table['rise_time'] + "\nSet: " + sun_table['set_time']
+
+    sun_data += "\nDaylight: " + str((local_sunset - local_sunrise).seconds // 3600) + "h " + str(((local_sunset - local_sunrise).seconds // 60) % 60) + "m"
+    
+    if sun_table['altitude'] > 0:
+        sun_data += "\nRemaining: " + str((local_sunset - datetime.now()).seconds // 3600) + "h " + str(((local_sunset - datetime.now()).seconds // 60) % 60) + "m"
+    
+    sun_data += "\nAzimuth: " + str('{0:.2f}'.format(sun_table['azimuth'] * 180 / ephem.pi)) + "°"
+    if sun_table['altitude'] > 0:
+        sun_data += "\nAltitude: " + str('{0:.2f}'.format(sun_table['altitude'] * 180 / ephem.pi)) + "°"
     return sun_data
 
 def get_moon(lat=0, lon=0):
     # get moon phase and rise/set times using callers location or default
-    # the phase calculation mght not be accurate (followup later)
     obs = ephem.Observer()
     moon = ephem.Moon()
     if lat != 0 and lon != 0:
@@ -104,10 +122,28 @@ def get_moon(lat=0, lon=0):
         obs.lat = str(latitudeValue)
         obs.lon = str(longitudeValue)
     
-    obs.date = datetime.now()
+    obs.date = datetime.now(timezone.utc)
     moon.compute(obs)
     moon_table = {}
-    moon_phase = ['NewMoon', 'Waxing Crescent', 'First Quarter', 'Waxing Gibbous', 'FullMoon', 'Waning Gibbous', 'Last Quarter', 'Waning Crescent'][round(moon.phase / (2 * ephem.pi) * 8) % 8]
+    illum = moon.phase  # 0 = new, 50 = first/last quarter, 100 = full
+    
+    if illum < 1.0:
+        moon_phase = 'New Moon🌑'
+    elif illum < 49:
+        moon_phase = 'Waxing Crescent🌒'
+    elif 49 <= illum < 51:
+        moon_phase = 'First Quarter🌓'
+    elif illum < 99:
+        moon_phase = 'Waxing Gibbous🌔'
+    elif illum >= 99:
+        moon_phase = 'Full Moon🌕'
+    elif illum > 51:
+        moon_phase = 'Waning Gibbous🌖'
+    elif 51 >= illum > 49:
+        moon_phase = 'Last Quarter🌗'
+    else:
+        moon_phase = 'Waning Crescent🌘'
+    
     moon_table['phase'] = moon_phase
     moon_table['illumination'] = moon.phase
     moon_table['azimuth'] = moon.az
@@ -135,4 +171,49 @@ def get_moon(lat=0, lon=0):
         "\nPhase:" + moon_table['phase'] + " @:" + str('{0:.2f}'.format(moon_table['illumination'])) + "%" \
         + "\nFullMoon:" + moon_table['next_full_moon'] + "\nNewMoon:" + moon_table['next_new_moon']
     
+    # if moon is in the sky, add azimuth and altitude
+    if moon_table['altitude'] > 0:
+        moon_data += "\nAz: " + str('{0:.2f}'.format(moon_table['azimuth'] * 180 / ephem.pi)) + "°" + \
+            "\nAlt: " + str('{0:.2f}'.format(moon_table['altitude'] * 180 / ephem.pi)) + "°"
+    
     return moon_data
+
+def getNextSatellitePass(satellite, lat=0, lon=0):
+    pass_data = ''
+    # get the next satellite pass for a given satellite
+    visualPassAPI = "https://api.n2yo.com/rest/v1/satellite/visualpasses/"
+    if lat == 0 and lon == 0:
+        lat = latitudeValue
+        lon = longitudeValue
+    # API URL
+    if n2yoAPIKey == '':
+        logger.error("System: Missing API key free at https://www.n2yo.com/login/")
+        return "not configured, bug your sysop"
+    url = visualPassAPI + str(satellite) + "/" + str(lat) + "/" + str(lon) + "/0/2/300/" + "&apiKey=" + n2yoAPIKey
+    # get the next pass data
+    try:
+        if not int(satellite):
+            raise Exception("Invalid satellite number")
+        next_pass_data = requests.get(url, timeout=urlTimeoutSeconds)
+        if(next_pass_data.ok):
+            pass_json = next_pass_data.json()
+            if 'info' in pass_json and 'passescount' in pass_json['info'] and pass_json['info']['passescount'] > 0:
+                satname = pass_json['info']['satname']
+                pass_time = pass_json['passes'][0]['startUTC']
+                pass_duration = pass_json['passes'][0]['duration']
+                pass_maxEl = pass_json['passes'][0]['maxEl']
+                pass_rise_time = datetime.fromtimestamp(pass_time).strftime('%a %d %I:%M%p')
+                pass_startAzCompass = pass_json['passes'][0]['startAzCompass']
+                pass_set_time = datetime.fromtimestamp(pass_time + pass_duration).strftime('%a %d %I:%M%p')
+                pass__endAzCompass = pass_json['passes'][0]['endAzCompass']
+                pass_data = f"{satname} @{pass_rise_time} Az:{pass_startAzCompass} for{getPrettyTime(pass_duration)}, MaxEl:{pass_maxEl}° Set@{pass_set_time} Az:{pass__endAzCompass}"
+            elif pass_json['info']['passescount'] == 0:
+                satname = pass_json['info']['satname']
+                pass_data = f"{satname} has no upcoming passes"
+        else:
+            logger.error(f"System: Error fetching satellite pass data {satellite}")
+            pass_data = ERROR_FETCHING_DATA
+    except Exception as e:
+        logger.warning(f"System: User supplied value {satellite} unknown or invalid")
+        pass_data = "Provide NORAD# example use:🛰️satpass 25544,33591"
+    return pass_data

modules/web.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# This is a simple web server that serves up the content of the webRoot directory
+# The reporting data is all that is currently being served up
+# TODO - add interaction to mesh?
+# to use this today run it seperately and open a browser to http://localhost:8420
+
+import os
+import http.server
+
+# Set the desired IP address
+server_ip = '127.0.0.1'
+
+# Set the port for the server
+PORT = 8420
+
+# Generate with: openssl req -new -x509 -keyout server.pem -out server.pem -days 365 -nodes
+SSL = False
+
+# Set to True to enable logging sdtout
+webServerLogs = False
+
+# Determine the directory where this script is located.
+script_dir = os.path.dirname(os.path.realpath(__file__))
+
+# Go up one level from the modules directory to the project root.
+project_root = os.path.abspath(os.path.join(script_dir, ".."))
+
+# Build the absolute path to the webRoot folder; to where index.html is located.
+webRoot = os.path.join(project_root, "etc", "www")
+
+if SSL:
+    import ssl
+
+# disable logging
+class QuietHandler(http.server.SimpleHTTPRequestHandler):
+    def log_message(self, format, *args):
+        if webServerLogs:
+            super().log_message(format, *args)
+
+# Change the current working directory to webRoot
+os.chdir(webRoot)
+
+# Create the HTTP server instance with the desired IP address
+httpd = http.server.HTTPServer((server_ip, PORT), QuietHandler)
+
+if SSL:
+    ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
+    try:
+        ctx.load_cert_chain(certfile='./server.pem')
+    except FileNotFoundError:
+        print("SSL certificate file not found. Please generate it using the command provided in the comments.")
+        exit(1)
+    httpd.socket = ctx.wrap_socket(httpd.socket, server_side=True)
+    print(f"Serving reports at https://{server_ip}:{PORT} Press ^C to quit.\n\n")
+else:
+    print(f"Serving reports at http://{server_ip}:{PORT} Press ^C to quit.\n\n")
+
+if not webServerLogs:
+    print("Server Logs are disabled")
+# Serve forever, that is until the user interrupts the process
+httpd.serve_forever()
+exit(0)

modules/wx_meteo.py

@@ -0,0 +1,239 @@
+#import openmeteo_requests # pip install openmeteo-requests
+#from retry_requests import retry # pip install retry_requests
+
+import requests
+import json
+from modules.log import *
+
+def get_weather_data(api_url, params):
+    response = requests.get(api_url, params=params)
+    response.raise_for_status()  # Raise an error for bad status codes
+    return response.json()
+
+def get_wx_meteo(lat=0, lon=0, unit=0):
+	# set forcast days 1 or 3
+	forecastDays = 3
+
+	# Make sure all required weather variables are listed here
+	# The order of variables in hourly or daily is important to assign them correctly below
+	url = "https://api.open-meteo.com/v1/forecast"
+	params = {
+		"latitude": {lat},
+		"longitude": {lon},
+		"daily": ["weather_code", "temperature_2m_max", "temperature_2m_min", "precipitation_hours", "precipitation_probability_max", "wind_speed_10m_max", "wind_gusts_10m_max", "wind_direction_10m_dominant"],
+		"timezone": "auto",
+		"forecast_days": {forecastDays}
+	}
+
+	# Unit 0 is imperial, 1 is metric
+	if unit == 0:
+		params["temperature_unit"] = "fahrenheit"
+		params["wind_speed_unit"] = "mph"
+		params["precipitation_unit"] = "inch"
+		params["distance_unit"] = "mile"
+		params["pressure_unit"] = "inHg"
+
+	try:
+		# Fetch the weather data
+		weather_data = get_weather_data(url, params)
+	except Exception as e:
+		logger.error(f"Error fetching meteo weather data: {e}")
+		return ERROR_FETCHING_DATA
+
+	# Check if we got a response
+	try:
+		# Process location
+		logger.debug(f"System: Pulled from Open-Meteo in {weather_data['timezone']} {weather_data['timezone_abbreviation']}")
+		
+		# Ensure response is defined
+		response = weather_data
+		
+		# Process daily data. The order of variables needs to be the same as requested.
+		daily = response['daily']
+		daily_weather_code = daily['weather_code']
+		daily_temperature_2m_max = daily['temperature_2m_max']
+		daily_temperature_2m_min = daily['temperature_2m_min']
+		daily_precipitation_hours = daily['precipitation_hours']
+		daily_precipitation_probability_max = daily['precipitation_probability_max']
+		daily_wind_speed_10m_max = daily['wind_speed_10m_max']
+		daily_wind_gusts_10m_max = daily['wind_gusts_10m_max']
+		daily_wind_direction_10m_dominant = daily['wind_direction_10m_dominant']
+	except Exception as e:
+		logger.error(f"Error processing meteo weather data: {e}")
+		return ERROR_FETCHING_DATA
+
+	# convert wind value to cardinal directions
+	for value in daily_wind_direction_10m_dominant:
+		if value < 22.5:
+			wind_direction = "N"
+		elif value < 67.5:
+			wind_direction = "NE"
+		elif value < 112.5:
+			wind_direction = "E"
+		elif value < 157.5:
+			wind_direction = "SE"
+		elif value < 202.5:
+			wind_direction = "S"
+		elif value < 247.5:
+			wind_direction = "SW"
+		elif value < 292.5:
+			wind_direction = "W"
+		elif value < 337.5:
+			wind_direction = "NW"
+		else:
+			wind_direction = "N"
+
+	# create a weather report
+	weather_report = ""
+	for i in range(forecastDays):
+		if str(i + 1) == "1":
+			weather_report += "Today, "
+		elif str(i + 1) == "2":
+			weather_report += "Tomorrow, "
+		else:
+			weather_report += "Futurecast: "
+		
+		# report weather from WMO Weather interpretation codes (WW)
+		code_string = ""
+		if daily_weather_code[i] == 0:
+			code_string = "Clear sky"
+		elif daily_weather_code[i] == 1:
+			code_string = "Mostly Cloudy"
+		elif daily_weather_code[i] == 2:
+			code_string = "Partly Cloudy"
+		elif daily_weather_code[i] == 3:
+			code_string = "Overcast"
+		elif daily_weather_code[i] == 5:
+			code_string = "Haze"
+		elif daily_weather_code[i] == 10:
+			code_string = "Mist"
+		elif daily_weather_code[i] == 45:
+			code_string = "Fog"
+		elif daily_weather_code[i] == 48:
+			code_string = "Freezing Fog"
+		elif daily_weather_code[i] == 51:
+			code_string = "Drizzle: Light"
+		elif daily_weather_code[i] == 53:
+			code_string = "Drizzle: Moderate"
+		elif daily_weather_code[i] == 55:
+			code_string = "Drizzle: Heavy"
+		elif daily_weather_code[i] == 56:
+			code_string = "Freezing Drizzle: Light"
+		elif daily_weather_code[i] == 57:
+			code_string = "Freezing Drizzle: Moderate"
+		elif daily_weather_code[i] == 61:
+			code_string = "Rain: Slight"
+		elif daily_weather_code[i] == 63:
+			code_string = "Rain: Moderate"
+		elif daily_weather_code[i] == 65:
+			code_string = "Rain: Heavy"
+		elif daily_weather_code[i] == 66:
+			code_string = "Freezing Rain: Light"
+		elif daily_weather_code[i] == 67:
+			code_string = "Freezing Rain: Dense"
+		elif daily_weather_code[i] == 71:
+			code_string = "Snow: Light"
+		elif daily_weather_code[i] == 73:
+			code_string = "Snow: Moderate"
+		elif daily_weather_code[i] == 75:
+			code_string = "Snow: Heavy"
+		elif daily_weather_code[i] == 77:
+			code_string = "Snow Grains"
+		elif daily_weather_code[i] == 78:
+			code_string = "Ice Crystals"
+		elif daily_weather_code[i] == 79:
+			code_string = "Ice Pellets"
+		elif daily_weather_code[i] == 80:
+			code_string = "Rain showers: Slight"
+		elif daily_weather_code[i] == 81:
+			code_string = "Rain showers: Moderate"
+		elif daily_weather_code[i] == 82:
+			code_string = "Rain showers: Heavy"
+		elif daily_weather_code[i] == 85:
+			code_string = "Snow showers"
+		elif daily_weather_code[i] == 86:
+			code_string = "Snow showers: Heavy"
+		elif daily_weather_code[i] == 95:
+			code_string = "Thunderstorm"
+		elif daily_weather_code[i] == 96:
+			code_string = "Hailstorm"
+		elif daily_weather_code[i] == 97:
+			code_string = "Thunderstorm Heavy"
+		elif daily_weather_code[i] == 99:
+			code_string = "Hailstorm Heavy"
+
+		weather_report += "Cond: " + code_string + ". "
+
+		# report temperature
+		if unit == 0:
+			weather_report += "High: " + str(int(round(daily_temperature_2m_max[i]))) + "F, with a low of " + str(int(round(daily_temperature_2m_min[i]))) + "F. "
+		else:
+			weather_report += "High: " + str(int(round(daily_temperature_2m_max[i]))) + "C, with a low of " + str(int(round(daily_temperature_2m_min[i]))) + "C. "
+
+		# check for precipitation
+		if daily_precipitation_hours[i] > 0:
+			if unit == 0:
+				weather_report += "Precip: " + str(round(daily_precipitation_probability_max[i],2)) + "in, in " + str(round(daily_precipitation_hours[i],2)) + " hours. "
+			else:
+				weather_report += "Precip: " + str(round(daily_precipitation_probability_max[i],2)) + "mm, in " + str(round(daily_precipitation_hours[i],2)) + " hours. "
+		else:
+			weather_report += "No Precip. "
+
+		# check for wind
+		if daily_wind_speed_10m_max[i] > 0:
+			if unit == 0:
+				weather_report += "Wind: " + str(int(round(daily_wind_speed_10m_max[i]))) + "mph, gusts up to " + str(int(round(daily_wind_gusts_10m_max[i]))) + "mph from:" + wind_direction + "."
+			else:
+				weather_report += "Wind: " + str(int(round(daily_wind_speed_10m_max[i]))) + "kph, gusts up to " + str(int(round(daily_wind_gusts_10m_max[i]))) + "kph from:" + wind_direction + "."
+		else:
+			weather_report += "No Wind\n"
+
+		# add a new line for the next day
+		if i < forecastDays - 1:
+			weather_report += "\n"
+
+	return weather_report
+
+def get_flood_openmeteo(lat=0, lon=0):
+	# set forcast days 1 or 3
+	forecastDays = 3
+
+	# Flood data
+	url = "https://flood-api.open-meteo.com/v1/flood"
+	params = {
+		"latitude": {lat},
+		"longitude": {lon},
+		"timezone": "auto",
+		"daily": "river_discharge",
+		"forecast_days": forecastDays
+	}
+
+	try:
+		# Fetch the flood data
+		flood_data = get_weather_data(url, params)
+	except Exception as e:
+		logger.error(f"Error fetching meteo flood data: {e}")
+		return ERROR_FETCHING_DATA
+	
+	# Check if we got a response
+	try:
+		# Process location
+		logger.debug(f"System: Pulled River FLow Data from Open-Meteo {flood_data['timezone_abbreviation']}")
+		
+		# Ensure response is defined
+		response = flood_data
+		
+		# Process daily data. The order of variables needs to be the same as requested.
+		daily = response['daily']
+		daily_river_discharge = daily['river_discharge']
+		# check if none
+
+	except Exception as e:
+		logger.error(f"Error processing meteo flood data: {e}")
+		return ERROR_FETCHING_DATA
+	
+	# create a flood report
+	flood_report = ""
+	flood_report += "River Discharge: " + str(daily_river_discharge) + "m3/s"
+
+	return flood_report

news.txt

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

pong_bot.py

@@ -2,126 +2,301 @@
 # Meshtastic Autoresponder PONG Bot
 # K7MHI Kelly Keeton 2024
 
+try:
+    from pubsub import pub
+except ImportError:
+    print(f"Important dependencies are not met, try install.sh\n\n Did you mean to './launch.sh pong' using a virtual environment.")
+    exit(1)
+
 import asyncio
 import time # for sleep, get some when you can :)
-from pubsub import pub # pip install pubsub
+import random
 from modules.log import *
 from modules.system import *
 
-def auto_response(message, snr, rssi, hop, message_from_id, channel_number, deviceID):
-    # Auto response to messages
-    if "ping" in message.lower():
-        # Check if the user added @foo to the message
-        if "@" in message:
-            if hop == "Direct":
-                bot_response = "🏓PONG, " + f"SNR:{snr} RSSI:{rssi}" + " and copy: " + message.split("@")[1]
-            else:
-                bot_response = "🏓PONG, " + hop + " and copy: " + message.split("@")[1]
-        else:
-            if hop == "Direct":
-                bot_response = "🏓PONG, " + f"SNR:{snr} RSSI:{rssi}"
-            else:
-                bot_response = "🏓PONG, " + hop
-    elif "pong" in message.lower():
-        bot_response = "🏓Ping!!"
-    elif "motd" in message.lower():
-        # check if the user wants to set the motd by using $
-        if "$" in message:
-            motd = message.split("$")[1]
-            global MOTD
-            MOTD = motd
-            bot_response = "MOTD Set to: " + MOTD
-        else:
-            bot_response = MOTD
-    elif "cmd" in message.lower() or "cmd?" in message.lower():
-        bot_response = help_message
-    elif "lheard" in message.lower() or "sitrep" in message.lower():
-        bot_response = "Last heard:\n" + str(get_node_list(1))
-        chutil1 = interface1.nodes.get(decimal_to_hex(myNodeNum1), {}).get("deviceMetrics", {}).get("channelUtilization", 0)
-        chutil1 = "{:.2f}".format(chutil1)
-        if interface2_enabled:
-            bot_response += "Port2:\n" + str(get_node_list(2))
-            chutil2 = interface2.nodes.get(decimal_to_hex(myNodeNum2), {}).get("deviceMetrics", {}).get("channelUtilization", 0)
-            chutil2 = "{:.2f}".format(chutil2)
-    elif "ack" in message.lower():
-        if hop == "Direct":
-            bot_response = "🏓ACK-ACK! " + f"SNR:{snr} RSSI:{rssi}"
-        else:
-            bot_response = "🏓ACK-ACK! " + hop
-    elif "testing" in message.lower() or "test" in message.lower():
-        if hop == "Direct":
-            bot_response = "🏓Testing 1,2,3 " + f"SNR:{snr} RSSI:{rssi}"
-        else:
-            bot_response = "🏓Testing 1,2,3 " + hop
-    else:
-        bot_response = "I'm sorry, I'm afraid I can't do that."
+# Global Variables
+DEBUGpacket = False # Debug print the packet rx
 
-    # wait a 700ms to avoid message collision from lora-ack
-    time.sleep(0.7)
+def auto_response(message, snr, rssi, hop, pkiStatus, message_from_id, channel_number, deviceID, isDM):
+    # Auto response to messages
+    message_lower = message.lower()
+    bot_response = "I'm sorry, I'm afraid I can't do that."
+
+    command_handler = {
+        # Command List processes system.trap_list. system.messageTrap() sends any commands to here
+        "ack": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "cmd": lambda: handle_cmd(message, message_from_id, deviceID),
+        "cq": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "cqcq": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "cqcqcq": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "lheard": lambda: handle_lheard(message, message_from_id, deviceID, isDM),
+        "motd": lambda: handle_motd(message, MOTD),
+        "ping": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "pong": lambda: "🏓PING!!🛜",
+        "sitrep": lambda: lambda: handle_lheard(message, message_from_id, deviceID, isDM),
+        "sysinfo": lambda: sysinfo(message, message_from_id, deviceID),
+        "test": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+        "testing": lambda: handle_ping(message_from_id, deviceID, message, hop, snr, rssi, isDM, channel_number),
+    }
+    cmds = [] # list to hold the commands found in the message
+    for key in command_handler:
+        if key in message_lower.split(' '):
+            cmds.append({'cmd': key, 'index': message_lower.index(key)})
+
+    if len(cmds) > 0:
+        # sort the commands by index value
+        cmds = sorted(cmds, key=lambda k: k['index'])
+        logger.debug(f"System: Bot detected Commands:{cmds}")
+        # run the first command after sorting
+        bot_response = command_handler[cmds[0]['cmd']]()
+
+    # wait a responseDelay to avoid message collision from lora-ack
+    time.sleep(responseDelay)
     
     return bot_response
 
-def onReceive(packet, interface):
-    # extract interface  defailts from interface object
-    rxType = type(interface).__name__
-    rxNode = 0
-    # Debug print the interface object
-    #for item in interface.__dict__.items(): print (item)
+def handle_cmd(message, message_from_id, deviceID):
+    # why CMD? its just a command list. a terminal would normally use "Help"
+    # I didnt want to invoke the word "help" in Meshtastic due to its possible emergency use
+    if " " in message and message.split(" ")[1] in trap_list:
+        return "🤖 just use the commands directly in chat"
+    return help_message
 
+def handle_ping(message_from_id, deviceID,  message, hop, snr, rssi, isDM, channel_number):
+    global multiPing
+    if  "?" in message and isDM:
+        return message.split("?")[0].title() + " command returns SNR and RSSI, or hopcount from your message. Try adding e.g. @place or #tag"
+    
+    msg = ""
+    type = ''
+
+    if "ping" in message.lower():
+        msg = "🏓PONG\n"
+        type = "🏓PING"
+    elif "test" in message.lower() or "testing" in message.lower():
+        msg = random.choice(["🎙Testing 1,2,3\n", "🎙Testing\n",\
+                             "🎙Testing, testing\n",\
+                             "🎙Ah-wun, ah-two...\n", "🎙Is this thing on?\n",\
+                             "🎙Roger that!\n",])
+        type = "🎙TEST"
+    elif "ack" in message.lower():
+        msg = random.choice(["✋ACK-ACK!\n", "✋Ack to you!\n"])
+        type = "✋ACK"
+    elif "cqcq" in message.lower() or "cq" in message.lower() or "cqcqcq" in message.lower():
+        if deviceID == 1:
+            myname = get_name_from_number(myNodeNum1, 'short', 1)
+        elif deviceID == 2:
+            myname = get_name_from_number(myNodeNum2, 'short', 2)
+        msg = f"QSP QSL OM DE  {myname}   K\n"
+    else:
+        msg = "🔊 Can you hear me now?"
+
+    if hop == "Direct":
+        msg = msg + f"SNR:{snr} RSSI:{rssi}"
+    else:
+        msg = msg + hop
+
+    if "@" in message:
+        msg = msg + " @" + message.split("@")[1]
+        type = type + " @" + message.split("@")[1]
+    elif "#" in message:
+        msg = msg + " #" + message.split("#")[1]
+        type = type + " #" + message.split("#")[1]
+
+
+    # check for multi ping request
+    if " " in message:
+        # if stop multi ping
+        if "stop" in message.lower():
+            for i in range(0, len(multiPingList)):
+                if multiPingList[i].get('message_from_id') == message_from_id:
+                    multiPingList.pop(i)
+                    msg = "🛑 auto-ping"
+
+
+        # if 3 or more entries (2 or more active), throttle the multi-ping for congestion
+        if len(multiPingList) > 2:
+            msg = "🚫⛔️ auto-ping, service busy. ⏳Try again soon."
+            pingCount = -1
+        else:
+            # set inital pingCount
+            try:
+                pingCount = int(message.split(" ")[1])
+                if pingCount == 123 or pingCount == 1234:
+                    pingCount =  1
+                elif not autoPingInChannel and not isDM:
+                    # no autoping in channels
+                    pingCount = 1
+
+                if pingCount > 51:
+                    pingCount = 50
+            except:
+                pingCount = -1
+    
+        if pingCount > 1:
+            multiPingList.append({'message_from_id': message_from_id, 'count': pingCount + 1, 'type': type, 'deviceID': deviceID, 'channel_number': channel_number, 'startCount': pingCount})
+            if type == "🎙TEST":
+                msg = f"🛜Initalizing BufferTest, using chunks of about {int(maxBuffer // pingCount)}, max length {maxBuffer} in {pingCount} messages"
+            else:
+                msg = f"🚦Initalizing {pingCount} auto-ping"
+
+    # if not a DM add the username to the beginning of msg
+    if not useDMForResponse and not isDM:
+        msg = "@" + get_name_from_number(message_from_id, 'short', deviceID) + " " + msg
+            
+    return msg
+
+def handle_motd(message):
+    global MOTD
+    if "$" in message:
+        motd = message.split("$")[1]
+        MOTD = motd.rstrip()
+        return "MOTD Set to: " + MOTD
+    else:
+        return MOTD
+    
+def sysinfo(message, message_from_id, deviceID):
+    if "?" in message:
+        return "sysinfo command returns system information."
+    else:
+        return get_sysinfo(message_from_id, deviceID)
+
+def handle_lheard(message, nodeid, deviceID, isDM):
+    if  "?" in message and isDM:
+        return message.split("?")[0].title() + " command returns a list of the nodes that have been heard recently"
+
+    # display last heard nodes add to response
+    bot_response = "Last Heard\n"
+    bot_response += str(get_node_list(1))
+
+    # show last users of the bot with the cmdHistory list
+    history = handle_history(message, nodeid, deviceID, isDM, lheard=True)
+    if history:
+        bot_response += f'LastSeen\n{history}'
+    else:
+        # trim the last \n
+        bot_response = bot_response[:-1]
+
+    # bot_response += getNodeTelemetry(deviceID)
+    return bot_response
+
+def onReceive(packet, interface):
+    global seenNodes
+    # Priocess the incoming packet, handles the responses to the packet with auto_response()
+    # Sends the packet to the correct handler for processing
+
+    # extract interface details from inbound packet
+    rxType = type(interface).__name__
+
+    # Valies assinged to the packet
+    rxNode, message_from_id, snr, rssi, hop, hop_away, channel_number = 0, 0, 0, 0, 0, 0, 0
+    pkiStatus = (False, 'ABC')
+    replyIDset = False
+    emojiSeen = False
+    isDM = False
+
+    if DEBUGpacket:
+        # Debug print the interface object
+        for item in interface.__dict__.items(): intDebug = f"{item}\n"
+        logger.debug(f"System: Packet Received on {rxType} Interface\n {intDebug} \n END of interface \n")
+        # Debug print the packet for debugging
+        logger.debug(f"Packet Received\n {packet} \n END of packet \n")
+
+    # set the value for the incomming interface
     if rxType == 'SerialInterface':
         rxInterface = interface.__dict__.get('devPath', 'unknown')
-        if port1 in rxInterface:
-            rxNode = 1
-        elif interface2_enabled and port2 in rxInterface:
-            rxNode = 2
+        if port1 in rxInterface: rxNode = 1
+        elif multiple_interface and port2 in rxInterface: rxNode = 2
+        elif multiple_interface and port3 in rxInterface: rxNode = 3
+        elif multiple_interface and port4 in rxInterface: rxNode = 4
+        elif multiple_interface and port5 in rxInterface: rxNode = 5
+        elif multiple_interface and port6 in rxInterface: rxNode = 6
+        elif multiple_interface and port7 in rxInterface: rxNode = 7
+        elif multiple_interface and port8 in rxInterface: rxNode = 8
+        elif multiple_interface and port9 in rxInterface: rxNode = 9
     
     if rxType == 'TCPInterface':
         rxHost = interface.__dict__.get('hostname', 'unknown')
-        if hostname1 in rxHost and interface1_type == 'tcp':
-            rxNode = 1
-        elif interface2_enabled and hostname2 in rxHost and interface2_type == 'tcp':
-            rxNode = 2
+        if rxHost and hostname1 in rxHost and interface1_type == 'tcp': rxNode = 1
+        elif multiple_interface and rxHost and hostname2 in rxHost and interface2_type == 'tcp': rxNode = 2
+        elif multiple_interface and rxHost and hostname3 in rxHost and interface3_type == 'tcp': rxNode = 3
+        elif multiple_interface and rxHost and hostname4 in rxHost and interface4_type == 'tcp': rxNode = 4
+        elif multiple_interface and rxHost and hostname5 in rxHost and interface5_type == 'tcp': rxNode = 5
+        elif multiple_interface and rxHost and hostname6 in rxHost and interface6_type == 'tcp': rxNode = 6
+        elif multiple_interface and rxHost and hostname7 in rxHost and interface7_type == 'tcp': rxNode = 7
+        elif multiple_interface and rxHost and hostname8 in rxHost and interface8_type == 'tcp': rxNode = 8
+        elif multiple_interface and rxHost and hostname9 in rxHost and interface9_type == 'tcp': rxNode = 9
 
-    # Debug print the packet for debugging
-    #print(f"Packet Received\n {packet} \n END of packet \n")
-    message_from_id = 0
+    if rxType == 'BLEInterface':
+        if interface1_type == 'ble': rxNode = 1
+        elif multiple_interface and interface2_type == 'ble': rxNode = 2
+        elif multiple_interface and interface3_type == 'ble': rxNode = 3
+        elif multiple_interface and interface4_type == 'ble': rxNode = 4
+        elif multiple_interface and interface5_type == 'ble': rxNode = 5
+        elif multiple_interface and interface6_type == 'ble': rxNode = 6
+        elif multiple_interface and interface7_type == 'ble': rxNode = 7
+        elif multiple_interface and interface8_type == 'ble': rxNode = 8
+        elif multiple_interface and interface9_type == 'ble': rxNode = 9
+    
+    # check if the packet has a channel flag use it
+    if packet.get('channel'):
+        channel_number = packet.get('channel', 0)
 
-    # check for a message packet and process it
+    # set the message_from_id
+    message_from_id = packet['from']
+
+    # check if the packet has a channel flag use it
+    if packet.get('channel'):
+        channel_number = packet.get('channel', 0)
+
+    # handle TEXT_MESSAGE_APP
     try:
         if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
             message_bytes = packet['decoded']['payload']
             message_string = message_bytes.decode('utf-8')
-            message_from_id = packet['from']
-            try:
-                snr = packet['rxSnr']
-                rssi = packet['rxRssi']
-            except KeyError:
-                snr = 0
-                rssi = 0
+            via_mqtt = packet['decoded'].get('viaMqtt', False)
+
+            # check if the packet is from us
+            if message_from_id == myNodeNum1 or message_from_id == myNodeNum2:
+                logger.warning(f"System: Packet from self {message_from_id} loop or traffic replay deteted")
+
+            # get the signal strength and snr if available
+            if packet.get('rxSnr') or packet.get('rxRssi'):
+                snr = packet.get('rxSnr', 0)
+                rssi = packet.get('rxRssi', 0)
+
+            # check if the packet has a publicKey flag use it
+            if packet.get('publicKey'):
+                pkiStatus = (packet.get('pkiEncrypted', False), packet.get('publicKey', 'ABC'))
 
-            if packet.get('channel'):
-                channel_number = packet['channel']
-            else:
-                channel_number = publicChannel
-        
             # check if the packet has a hop count flag use it
             if packet.get('hopsAway'):
-                hop_away = packet['hopsAway']
+                hop_away = packet.get('hopsAway', 0)
             else:
                 # if the packet does not have a hop count try other methods
-                hop_away = 0
                 if packet.get('hopLimit'):
-                    hop_limit = packet['hopLimit']
+                    hop_limit = packet.get('hopLimit', 0)
                 else:
                     hop_limit = 0
                 
                 if packet.get('hopStart'):
-                    hop_start = packet['hopStart']
+                    hop_start = packet.get('hopStart', 0)
                 else:
                     hop_start = 0
 
+            if enableHopLogs:
+                logger.debug(f"System: Packet HopDebugger: hop_away:{hop_away} hop_limit:{hop_limit} hop_start:{hop_start}")
+            
+            if hop_away == 0 and hop_limit == 0 and hop_start == 0:
+                hop = "Last Hop"
+                hop_count = 0
+            
             if hop_start == hop_limit:
                 hop = "Direct"
+                hop_count = 0
+            elif hop_start == 0 and hop_limit > 0 or via_mqtt:
+                hop = "MQTT"
+                hop_count = 0
             else:
                 # set hop to Direct if the message was sent directly otherwise set the hop count
                 if hop_away > 0:
@@ -132,49 +307,57 @@ def onReceive(packet, interface):
 
                 hop = f"{hop_count} hops"
             
-            if message_string == help_message or message_string == welcome_message or "CMD?:" in message_string:
+            if help_message in message_string or welcome_message in message_string or "CMD?:" in message_string:
                 # ignore help and welcome messages
                 logger.warning(f"Got Own Welcome/Help header. From: {get_name_from_number(message_from_id, 'long', rxNode)}")
                 return
-
+        
             # If the packet is a DM (Direct Message) respond to it, otherwise validate its a message for us on the channel
             if packet['to'] == myNodeNum1 or packet['to'] == myNodeNum2:
                 # message is DM to us
-
+                isDM = True
                 # check if the message contains a trap word, DMs are always responded to
-                if messageTrap(message_string):
+                if (messageTrap(message_string) and not llm_enabled) or messageTrap(message_string.split()[0]):
+                    # log the message to stdout
                     logger.info(f"Device:{rxNode} Channel: {channel_number} " + CustomFormatter.green + f"Received DM: " + CustomFormatter.white + f"{message_string} " + CustomFormatter.purple +\
                                 "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
+                    send_message(auto_response(message_string, snr, rssi, hop, pkiStatus, message_from_id, channel_number, rxNode, isDM), channel_number, message_from_id, rxNode)
+                else:
                     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)
-                    msgLogger.info(f"Device:{rxNode} Channel:{channel_number} | {get_name_from_number(message_from_id, 'long', rxNode)} | {message_string}")
+                    time.sleep(responseDelay)
+                    
+                    # log the message to the message log
+                    if log_messages_to_file:
+                        msgLogger.info(f"Device:{rxNode} Channel:{channel_number} | {get_name_from_number(message_from_id, 'long', rxNode)} | DM | " + message_string.replace('\n', '-nl-'))
             else:
                 # message is on a channel
                 if messageTrap(message_string):
-                    # message is for bot to respond to
-                    logger.info(f"Device:{rxNode} Channel:{channel_number} " + CustomFormatter.green + "Received: " + CustomFormatter.white + f"{message_string} " + CustomFormatter.purple +\
-                                 "From: " + CustomFormatter.white + f"{get_name_from_number(message_from_id, 'long', rxNode)}")
-                    if useDMForResponse:
-                        # respond to channel message via direct message
-                        send_message(auto_response(message_string, snr, rssi, hop, message_from_id, channel_number, rxNode), channel_number, message_from_id, rxNode)
+                    if ignoreDefaultChannel and channel_number == publicChannel:
+                        logger.debug(f"System: ignoreDefaultChannel CMD:{message_string} From: {get_name_from_number(message_from_id, 'short', rxNode)}")
                     else:
-                        # or respond to channel message on the channel itself
-                        if channel_number == publicChannel and antiSpam:
-                            # warning user spamming default channel
-                            logger.error(f"System: AntiSpam protection, sending DM to: {get_name_from_number(message_from_id, 'long', rxNode)}")
-                        
+                        # message is for bot to respond to
+                        logger.info(f"Device:{rxNode} Channel:{channel_number} " + CustomFormatter.green + "ReceivedChannel: " + CustomFormatter.white + f"{message_string} " + CustomFormatter.purple +\
+                                    "From: " + CustomFormatter.white + f"{get_name_from_number(message_from_id, 'long', rxNode)}")
+                        if useDMForResponse:
                             # respond to channel message via direct message
-                            send_message(auto_response(message_string, snr, rssi, hop, message_from_id, channel_number, rxNode), channel_number, message_from_id, rxNode)
+                            send_message(auto_response(message_string, snr, rssi, hop, pkiStatus, message_from_id, channel_number, rxNode, isDM), channel_number, message_from_id, rxNode)
                         else:
-                            # respond to channel message on the channel itself
-                            send_message(auto_response(message_string, snr, rssi, hop, message_from_id, channel_number, rxNode), channel_number, 0, rxNode)
+                            # or respond to channel message on the channel itself
+                            if channel_number == publicChannel and antiSpam:
+                                # warning user spamming default channel
+                                logger.warning(f"System: AntiSpam protection, sending DM to: {get_name_from_number(message_from_id, 'long', rxNode)}")
+                            
+                                # respond to channel message via direct message
+                                send_message(auto_response(message_string, snr, rssi, hop, pkiStatus, message_from_id, channel_number, rxNode, isDM), channel_number, message_from_id, rxNode)
+                            else:
+                                # respond to channel message on the channel itself
+                                send_message(auto_response(message_string, snr, rssi, hop, pkiStatus, message_from_id, channel_number, rxNode, isDM), channel_number, 0, rxNode)
+
                 else:
                     # message is not for bot to respond to
-                    # ignore the message but add it to the message history and repeat it if enabled
+                    # ignore the message but add it to the message history list
                     if zuluTime:
                         timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
                     else:
@@ -185,50 +368,71 @@ def onReceive(packet, interface):
                     else:
                         msg_history.pop(0)
                         msg_history.append((get_name_from_number(message_from_id, 'long', rxNode), message_string, channel_number, timestamp, rxNode))
-                    
-                    # check if repeater is enabled and the other interface is enabled
-                    if repeater_enabled and interface2_enabled:         
-                        # repeat the message on the other device
+
+                    # print the message to the log and sdout
+                    logger.info(f"Device:{rxNode} Channel:{channel_number} " + CustomFormatter.green + "Ignoring Message:" + CustomFormatter.white +\
+                                f" {message_string} " + CustomFormatter.purple + "From:" + CustomFormatter.white + f" {get_name_from_number(message_from_id)}")
+                    if log_messages_to_file:
+                        msgLogger.info(f"Device:{rxNode} Channel:{channel_number} | {get_name_from_number(message_from_id, 'long', rxNode)} | " + message_string.replace('\n', '-nl-'))
+
+                     # repeat the message on the other device
+                    if repeater_enabled and multiple_interface:         
+                        # wait a responseDelay to avoid message collision from lora-ack.
+                        time.sleep(responseDelay)
                         rMsg = (f"{message_string} From:{get_name_from_number(message_from_id, 'short', rxNode)}")
                         # if channel found in the repeater list repeat the message
-                        # wait a 700ms to avoid message collision from lora-ack
-                        time.sleep(0.7)
                         if str(channel_number) in repeater_channels:
-                            if rxNode == 1:
-                                logger.debug(f"Repeating message on Device2 Channel:{channel_number}")
-                                send_message(rMsg, channel_number, 0, 2)
-                            elif rxNode == 2:
-                                logger.debug(f"Repeating message on Device1 Channel:{channel_number}")
-                                send_message(rMsg, channel_number, 0, 1)
-                    else: 
-                         # nothing to do for us
-                        logger.info(f"Ignoring Device:{rxNode} Channel:{channel_number} " + CustomFormatter.green + "Message:" + CustomFormatter.white +\
-                                     f" {message_string} " + CustomFormatter.purple + "From:" + CustomFormatter.white + f" {get_name_from_number(message_from_id)}")
-                        msgLogger.info(f"Device:{rxNode} Channel:{channel_number} | {get_name_from_number(message_from_id, 'long', rxNode)} | {message_string}")
+                            for i in range(1, 10):
+                                if globals().get(f'interface{i}_enabled', False) and i != rxNode:
+                                    logger.debug(f"Repeating message on Device{i} Channel:{channel_number}")
+                                    send_message(rMsg, channel_number, 0, i)
+                                    time.sleep(responseDelay)
+        else:
+            # Evaluate non TEXT_MESSAGE_APP packets
+            consumeMetadata(packet, rxNode)
     except KeyError as e:
         logger.critical(f"System: Error processing packet: {e} Device:{rxNode}")
-        print(packet) # print the packet for debugging
-        print("END of packet \n")
+        logger.debug(f"System: Error Packet = {packet}")
 
 async def start_rx():
     print (CustomFormatter.bold_white + f"\nMeshtastic Autoresponder Bot CTL+C to exit\n" + CustomFormatter.reset)
     # Start the receive subscriber using pubsub via meshtastic library
     pub.subscribe(onReceive, 'meshtastic.receive')
-    logger.info(f"System: Autoresponder Started for Device1 {get_name_from_number(myNodeNum1, 'long', 1)}," 
-                f"{get_name_from_number(myNodeNum1, 'short', 1)}. NodeID: {myNodeNum1}, {decimal_to_hex(myNodeNum1)}")
-    if interface2_enabled:
-        logger.info(f"System: Autoresponder Started for Device2 {get_name_from_number(myNodeNum2, 'long', 2)},"
-                    f"{get_name_from_number(myNodeNum2, 'short', 2)}. NodeID: {myNodeNum2}, {decimal_to_hex(myNodeNum2)}")
+    pub.subscribe(onDisconnect, 'meshtastic.connection.lost')
+    for i in range(1, 10):
+        if globals().get(f'interface{i}_enabled', False):
+            myNodeNum = globals().get(f'myNodeNum{i}', 0)
+            logger.info(f"System: Autoresponder Started for Device{i} {get_name_from_number(myNodeNum, 'long', i)},"
+                        f"{get_name_from_number(myNodeNum, 'short', i)}. NodeID: {myNodeNum}, {decimal_to_hex(myNodeNum)}")
+    
     if log_messages_to_file:
-        logger.debug(f"System: Logging Messages to disk")
+        logger.debug("System: Logging Messages to disk")
+    if syslog_to_file:
+        logger.debug("System: Logging System Logs to disk")
+    if solar_conditions_enabled:
+        logger.debug("System: Celestial Telemetry Enabled")
+    if motd_enabled:
+        logger.debug(f"System: MOTD Enabled using {MOTD}")
+    if sentry_enabled:
+        logger.debug(f"System: Sentry Mode Enabled {sentry_radius}m radius reporting to channel:{secure_channel}")
     if store_forward_enabled:
         logger.debug(f"System: Store and Forward Enabled using limit: {storeFlimit}")
     if useDMForResponse:
         logger.debug(f"System: Respond by DM only")
-    if repeater_enabled and interface2_enabled:
+    if repeater_enabled and multiple_interface:
         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 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 scheduler_enabled:
+        # Examples of using the scheduler, Times here are in 24hr format
+        # https://schedule.readthedocs.io/en/stable/
+        
+        # Reminder Scheduler is enabled every Monday at noon send a log message
+        schedule.every().monday.at("12:00").do(lambda: logger.info("System: Scheduled Broadcast Reminder"))
+        logger.debug("System: Starting the broadcast scheduler")
+        await BroadcastScheduler()
 
     # here we go loopty loo
     while True:
@@ -239,14 +443,20 @@ async def start_rx():
 async def main():
     meshRxTask = asyncio.create_task(start_rx())
     watchdogTask = asyncio.create_task(watchdog())
-    await asyncio.wait([meshRxTask, watchdogTask])
+    if file_monitor_enabled:
+        fileMonTask: asyncio.Task = asyncio.create_task(handleFileWatcher())
 
-try:
-    asyncLoop = asyncio.new_event_loop()
-    if __name__ == "__main__":
+    await asyncio.gather(meshRxTask, watchdogTask)
+    if file_monitor_enabled:
+        await asyncio.gather(fileMonTask)
+
+    await asyncio.sleep(0.01)
+
+if __name__ == "__main__":
+    try:
         asyncio.run(main())
-except KeyboardInterrupt:
-    exit_handler()
-    pass
-
+    except KeyboardInterrupt:
+        exit_handler()
+    except SystemExit:
+        pass
 # EOF

requirements.txt

@@ -3,7 +3,10 @@ pubsub
 datetime
 pyephem
 requests
-geopy
 maidenhead
 beautifulsoup4
 dadjokes
+geopy
+schedule
+wikipedia
+googlesearch-python

script/docker/README.md

@@ -0,0 +1,25 @@
+# How do I use this thing?
+This is not a full turnkey setup for Docker yet but gets you most of the way there!
+
+## Setup New Image
+`docker build -t meshing-around .`
+
+there is also [script/docker/docker-install.bat](script/docker/docker-install.bat) which will automate this.
+
+## Ollama Image with compose
+still a WIP
+`docker compose up -d`
+
+## Edit the config.ini in the docker
+To edit the config.ini in the docker you can
+`docker run -it --entrypoint /bin/bash meshing-around -c "nano /app/config.ini"`
+
+there is also [script/docker/docker-terminal.bat](script/docker/docker-terminal.bat) which will open nano to edit.
+ctl+o to write out and exit editor in shell
+
+## other info
+1. Ensure your serial port is properly shared.
+2. Run the Docker container:
+    ```sh
+    docker run --rm -it --device=/dev/ttyUSB0 meshing-around
+    ```

script/docker/compose.yaml

@@ -0,0 +1,52 @@
+services:
+  meshing-around:
+    build: 
+      context: ../..
+    depends_on:
+      ollama:
+        condition: service_healthy
+    devices:
+      - /dev/ttyAMA10 # Replace this with your actual device!
+    configs:
+      - source: me_config
+        target: /app/config.ini
+    extra_hosts:
+      - "host.docker.internal:host-gateway" # Used to access a local linux meshtasticd device via tcp
+  ollama:
+    image: ollama/ollama:0.5.1
+    volumes:
+      - ./ollama:/root/.ollama
+      - ./ollama-entrypoint.sh:./entrypoint.sh
+    container_name: ollama
+    pull_policy: always
+    tty: true
+    restart: always
+    entrypoint: 
+      - /usr/bin/bash
+      - /script/docker/entrypoint.sh
+    expose:
+      - 11434
+    healthcheck:
+      test: "apt update && apt install curl -y && curl -f http://localhost:11434/api/tags | grep -q llama3.2:3b"
+      interval: 30s
+      timeout: 10s
+      retries: 20
+  node-exporter:
+    image: quay.io/prometheus/node-exporter:latest
+    volumes:
+      - /proc:/host/proc:ro
+      - /sys:/host/sys:ro
+      - /:/rootfs:ro
+    command:
+      - --path.procfs=/host/proc
+      - --path.rootfs=/rootfs
+      - --path.sysfs=/host/sys
+      - --collector.filesystem.mount-points-exclude=^/(sys|proc|dev|host|etc)($$|/)
+    restart: unless-stopped
+    expose:
+      - 9100
+    network_mode: host
+    pid: host
+configs:
+  me_config:
+    file: ./config.ini

script/docker/docker-install.bat

@@ -0,0 +1,6 @@
+REM batch file to install docker on windows
+REM docker compose up -d
+cd ../../
+docker build -t meshing-around .
+REM docker-compose up -d
+docker run -it --entrypoint /bin/bash meshing-around -c "nano /app/config.ini"

script/docker/docker-terminal.bat

@@ -0,0 +1,2 @@
+REM launch meshing-around container with a terminal
+docker run -it --entrypoint /bin/bash meshing-around

script/docker/entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+# instruction set the meshing-around docker container entrypoint
+# Substitute environment variables in the config file (what is the purpose of this?)
+# envsubst < /app/config.ini > /app/config.tmp && mv /app/config.tmp /app/config.ini
+# Run the bot
+exec python /app/mesh_bot.py

script/docker/ollama-entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# Start Ollama in the background.
+/bin/ollama serve &
+# Record Process ID.
+pid=$!
+
+# Pause for Ollama to start.
+sleep 5
+
+echo "🔴 Retrieve llama3.2:3b model..."
+ollama pull llama3.2:3b
+echo "🟢 Done!"
+
+# Wait for Ollama process to finish.
+wait $pid

script/runShell.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+# meshing-around demo script for shell scripting
+# runShell.sh
+cd "$(dirname "$0")"
+program_path=$(pwd)
+
+printf "Running meshing-around demo script for shell scripting from $program_path\n"

script/send-environment-metrics.py

@@ -0,0 +1,53 @@
+# file name: send-environment-metrics.py
+# https://github.com/pdxlocations/Meshtastic-Python-Examples/blob/main/send-environment-metrics.py
+
+from meshtastic.protobuf import portnums_pb2, telemetry_pb2
+from meshtastic import BROADCAST_ADDR
+import time
+
+# For connection over serial
+# import meshtastic.serial_interface
+# interface = meshtastic.serial_interface.SerialInterface()
+
+# For connection over TCP
+import meshtastic.tcp_interface
+interface = meshtastic.tcp_interface.TCPInterface(hostname='127.0.0.1', noProto=False)
+
+# Create a telemetry data object
+telemetry_data = telemetry_pb2.Telemetry()
+telemetry_data.time = int(time.time())
+#telemetry_data.local_stats.upTime = 0
+telemetry_data.environment_metrics.temperature = 0
+# telemetry_data.environment_metrics.voltage = 0
+# telemetry_data.environment_metrics.current = 0
+# telemetry_data.environment_metrics.relative_humidity = 0
+# telemetry_data.environment_metrics.barometric_pressure = 0
+# telemetry_data.environment_metrics.gas_resistance = 0
+# telemetry_data.environment_metrics.iaq = 0
+# telemetry_data.environment_metrics.distance = 0
+# telemetry_data.environment_metrics.lux = 0
+# telemetry_data.environment_metrics.white_lux = 0
+# telemetry_data.environment_metrics.ir_lux = 0
+# telemetry_data.environment_metrics.uv_lux = 0
+# telemetry_data.environment_metrics.wind_direction = 0
+# telemetry_data.environment_metrics.wind_speed = 0
+# telemetry_data.environment_metrics.wind_gust = 0
+# telemetry_data.environment_metrics.wind_lull = 0
+# telemetry_data.environment_metrics.weight = 0
+
+# Read the uptime
+# with open('/proc/uptime', 'r') as uptime:
+#     telemetry_data.local_stats.upTime = int(float(uptime.readline().split()[0]))
+
+# Read the CPU temperature
+with open('/sys/class/thermal/thermal_zone0/temp', 'r') as cpu_temp:
+    telemetry_data.environment_metrics.temperature = int(cpu_temp.read()) / 1000
+
+interface.sendData(
+    telemetry_data,
+    destinationId=BROADCAST_ADDR,
+    portNum=portnums_pb2.PortNum.TELEMETRY_APP,
+    wantResponse=False,
+)
+
+interface.close()

script/sysEnv.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# meshing-around shell script for sysinfo
+# runShell.sh
+cd "$(dirname "$0")"
+program_path=$(pwd)
+
+# get basic telemetry data. Free space, CPU, RAM, and temperature for a raspberry pi
+free_space=$(df -h | grep ' /$' | awk '{print $4}')
+cpu_usage=$(top -bn1 | grep "Cpu(s)" | sed "s/.*, *\([0-9.]*\)%* id.*/\1/" | awk '{print 100 - $1}')
+ram_usage=$(free | grep Mem | awk '{print $3/$2 * 100.0}')
+ram_free=$(echo "scale=2; 100 - $ram_usage" | bc)
+
+# if command vcgencmd is found, part of raspberrypi tools, use it to get temperature
+if command -v vcgencmd &> /dev/null
+then
+    # get temperature
+    temp=$(vcgencmd measure_temp | sed "s/temp=//" | sed "s/'C//")
+    # temp in fahrenheit
+    tempf=$(echo "scale=2; $temp * 9 / 5 + 32" | bc)
+else
+    # get temperature from thermal zone
+    temp=$(paste <(cat /sys/class/thermal/thermal_zone*/type) <(cat /sys/class/thermal/thermal_zone*/temp) | grep "temp" | awk '{print $2/1000}' | awk '{s+=$1} END {print s/NR}')
+    tempf=$(echo "scale=2; $temp * 9 / 5 + 32" | bc)
+fi
+
+# print telemetry data rounded to 2 decimal places
+printf "Disk:%s RAM:%.2f%% CPU:%.2f%% CPU-T:%.2f°C (%.2f°F)\n" "$free_space" "$ram_usage" "$cpu_usage" "$temp" "$tempf"
+
+# attempt check for updates
+if command -v git &> /dev/null
+then
+    if [ -d ../.git ]; then
+        # check for updates
+        git fetch --quiet
+        local_branch=$(git rev-parse --abbrev-ref HEAD)
+        if [ "$local_branch" != "HEAD" ] && git show-ref --verify --quiet "refs/remotes/origin/$local_branch"; then
+            local_commit=$(git rev-parse "$local_branch")
+            remote_commit=$(git rev-parse "origin/$local_branch")
+            if [ "$local_commit" != "$remote_commit" ]; then
+                echo "Bot Update Available!"
+            fi
+        fi
+    fi
+fi

update.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+# MeshBot Update Script
+# Usage: bash update.sh or ./update.sh after making it executable with chmod +x update.sh
+
+# Check if the mesh_bot.service or pong_bot.service 
+if systemctl is-active --quiet mesh_bot.service; then
+    echo "Stopping mesh_bot.service..."
+    systemctl stop mesh_bot.service
+fi
+if systemctl is-active --quiet pong_bot.service; then
+    echo "Stopping pong_bot.service..."
+    systemctl stop pong_bot.service
+fi
+if systemctl is-active --quiet mesh_bot_reporting.service; then
+    echo "Stopping mesh_bot_reporting.service..."
+    systemctl stop mesh_bot_reporting.service
+fi
+if systemctl is-active --quiet mesh_bot_w3.service; then
+    echo "Stopping mesh_bot_w3.service..."
+    systemctl stop mesh_bot_w3.service
+fi
+
+# Update the local repository
+echo "Updating local repository..."
+#git fetch --all
+#git reset --hard origin/main    # Replace 'main' with your branch name if different
+git pull origin main --rebase  # Fetch and rebase to keep local changes if any
+echo "Local repository updated."
+
+# Install or update dependencies
+echo "Installing or updating dependencies..."
+pip install -r requirements.txt --upgrade
+
+echo "Dependencies installed or updated."
+
+# Restart the services
+echo "Restarting services..."
+systemctl start mesh_bot.service
+systemctl start pong_bot.service
+systemctl start mesh_bot_reporting.service
+systemctl start mesh_bot_w3.service
+echo "Services restarted."
+# Print completion message
+echo "Update completed successfully?"
+exit 0
+# End of script