meshing-around/pong-bot.py

#!/usr/bin/env python3
# Meshtastic Autoresponder PONG Bot
# forked from https://github.com/pdxlocations/Meshtastic-Python-Examples/autoresponder.py project
# K7MHI Kelly Keeton 2024

import signal # for catching CTL+C
from pubsub import pub # pip install pubsub
import meshtastic.serial_interface #pip install meshtastic
import meshtastic.tcp_interface
import meshtastic.ble_interface

from solarconditions import * # from the spudgunman/meshing-around repo

# Uncomment the interface you want to use depending on your device connection
interface = meshtastic.serial_interface.SerialInterface() #serial interface
#interface=meshtastic.tcp_interface.TCPInterface(hostname="192.168.0.1") # IP of your device
#interface=meshtastic.ble_interface.BLEInterface("AA:BB:CC:DD:EE:FF") # BLE interface

trap_list = ("ping","ack","testing","pong","motd","help","sun","solar","hfcond") #A list of strings to trap and respond to
welcome_message = "PongBot, here for you like a friend who is not. Try sending: ping @foo  or, help"
help_message = "Commands are: ping, ack, motd, sun, solar, hfcond"
RESPOND_BY_DM_ONLY = True # Set to True to respond messages via DM only (keeps the channel clean)
MOTD = "Thanks for using PongBOT! Have a good day!" # Message of the Day

try:
    myinfo = interface.getMyNodeInfo()
    myNodeNum = myinfo['num']
except Exception as e:
    print(f"System: Critical Error script abort. {e}")
    exit()

def auto_response(message,snr,rssi,hop):
    #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 "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():
        bot_response = "Testing 1,2,3"
    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 "help" in message.lower():
        bot_response = help_message
    elif "sun" in message.lower():
        suntime = get_sunrise_sunset()
        bot_response = "Sunrise: " + suntime[0] + "\nSunset: " + suntime[1]
    elif "hfcond" in message.lower():
        bot_response = hf_band_conditions()
    elif "solar" in message.lower():
        bot_response = drap_xray_conditions()
    else:
        bot_response = "I'm sorry, I'm afraid I can't do that."
    
    return bot_response

def log_timestamp():
    return datetime.now().strftime("%Y-%m-%d %H:%M:%S")
    
def onReceive(packet, interface):
    channel_number = 0
    message_from_id = 0
    snr = 0
    rssi = 0
    try:
        if 'decoded' in packet and packet['decoded']['portnum'] == 'TEXT_MESSAGE_APP':
            message_bytes = packet['decoded']['payload']
            message_string = message_bytes.decode('utf-8')
            if packet.get('channel'):
                channel_number = packet['channel']
            
            message_from_id = packet['from']
            snr = packet['rxSnr']
            rssi = packet['rxRssi']
            hop_limit = packet['hopLimit']
            hop_start = packet['hopStart']
            
            if hop_start == hop_limit:
                hop = "Direct"
            else:
                hop = "Relayed"
            
            # If the packet is a DM (Direct Message) respond to it, otherwise validate its a message for us
            if packet['to'] == myNodeNum:
                if messageTrap(message_string):
                    print(f"{log_timestamp()} Received DM: {message_string} on Channel: {channel_number} From: {message_from_id}")
                    # respond with a direct message
                    send_message(auto_response(message_string,snr,rssi,hop),channel_number,message_from_id)
                else: 
                    #respond with welcome message
                    print(f"{log_timestamp()} Ignoring DM: {message_string} From: {message_from_id}")
                    send_message(welcome_message,channel_number,message_from_id)
            else:
                if messageTrap(message_string):
                    print(f"{log_timestamp()} Received On Channel {channel_number}: {message_string} From: {message_from_id}")
                    if RESPOND_BY_DM_ONLY:
                        # respond to channel message via direct message to keep the channel clean
                        send_message(auto_response(message_string,snr,rssi,hop),channel_number,message_from_id)
                    else:
                        # or respond to channel message on the channel itself
                        send_message(auto_response(message_string,snr,rssi),channel_number,0)
                else:
                    print(f"{log_timestamp()} System: Ignoring incoming channel {channel_number}: {message_string} From: {message_from_id}")
                
    except KeyError as e:
        print(f"System: Error processing packet: {e}")
        
def messageTrap(msg):
    message_list=msg.split(" ")
    for m in message_list:
        for t in trap_list:
            if t.lower() == m.lower():
                return True
    return False
        
def send_message(message,ch,nodeid):
    if nodeid == 0:
        #Send to channel
        interface.sendText(text=message,channelIndex=ch)
        print (f"{log_timestamp()} System: Sending: {message} on Channel: {ch}")
    else:
        #Send to DM
        print (f"{log_timestamp()} System: Sending: {message} To: {nodeid}")
        interface.sendText(text=message,channelIndex=ch,destinationId=nodeid)

def exit_handler(signum, frame):
    print("\nSystem: Closing Autoresponder")
    interface.close()
    exit (0)

print ("\nMeshtastic Autoresponder PONG Bot CTL+C to exit\n")
pub.subscribe(onReceive, 'meshtastic.receive')
print (f"System: Autoresponder Started for device {myNodeNum}")

while True:
    signal.signal(signal.SIGINT, exit_handler)
    pass