# helper functions for system related tasks # K7MHI Kelly Keeton 2024 import meshtastic.serial_interface #pip install meshtastic import meshtastic.tcp_interface import meshtastic.ble_interface from datetime import datetime import configparser # Global Variables trap_list = ("ping", "pinging", "ack", "testing", "test", "pong", "motd", "cmd", "lheard", "sitrep") help_message = "CMD?: ping, motd, sitrep" # Read the config file config = configparser.ConfigParser() config_file = "config.ini" try: config.read(config_file) 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': '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', 'DadJokes': 'True', 'StoreForward': 'True', 'StoreLimit': '3'} config['bbs'] = {'enabled': 'True', 'bbsdb': 'bbsdb.pkl'} config['location'] = {'enabled': 'True','lat': '48.50', 'lon': '-123.0'} config['solar'] = {'enabled': 'True'} config.write(open(config_file, 'w')) print (f"System: Config file created, check {config_file} or review the config.template") # config.ini variables interface_type = config['interface'].get('type', 'serial') port = config['interface'].get('port', '') hostname = config['interface'].get('hostname', '') mac = config['interface'].get('mac', '') msg_history = [] # message history for the store and forward feature storeFlimit = config['general'].getint('StoreLimit', 3) # limit of messages to store for Store and Forward RESPOND_BY_DM_ONLY = config['general'].getboolean('respond_by_dm_only', True) DEFAULT_CHANNEL = config['general'].getint('defaultChannel', 0) LATITUDE = config['location'].getfloat('lat', 48.50) LONGITUDE = config['location'].getfloat('lon', -123.0) MOTD = config['general'].get('motd', 'Thanks for using MeshBOT! Have a good day!') welcome_message = config['general'].get('welcome_message', 'MeshBot, here for you like a friend who is not. Try sending: ping @foo or, cmd') # Interface Configuration if interface_type == 'serial': interface = meshtastic.serial_interface.SerialInterface(port) elif interface_type == 'tcp': interface = meshtastic.tcp_interface.TCPInterface(hostname) elif interface_type == 'ble': interface = meshtastic.ble_interface.BLEInterface(hostname) else: print(f"System: Interface Type: {interface_type} not supported. Validate your config against config.template Exiting") exit() # Solar Conditions Configuration solar_conditions_enabled = config['solar'].getboolean('enabled', False) if solar_conditions_enabled: from modules.solarconditions import * # from the spudgunman/meshing-around repo trap_list = trap_list + trap_list_solarconditions # items hfcond, solar, sun, moon help_message = help_message + ", sun, hfcond, solar, moon, tide" # Location Configuration location_enabled = config['location'].getboolean('enabled', False) if location_enabled: from modules.locationdata import * # from the spudgunman/meshing-around repo trap_list = trap_list + trap_list_location # items tide, whereami, wxc, wx help_message = help_message + ", whereami, wx, wxc, wxa" # BBS Configuration bbs_enabled = config['bbs'].getboolean('enabled', False) bbsdb = config['bbs'].get('bbsdb', 'bbsdb.pkl') if bbs_enabled: from modules.bbstools import * # from the spudgunman/meshing-around repo trap_list = trap_list + trap_list_bbs # items bbslist, bbspost, bbsread, bbsdelete, bbshelp help_message = help_message + ", bbslist, bbshelp" # Dad Jokes Configuration dad_jokes_enabled = config['general'].getboolean('DadJokes', False) if dad_jokes_enabled: from dadjokes import Dadjoke # pip install dadjokes trap_list = trap_list + ("joke",) help_message = help_message + ", joke" # Store and Forward Configuration store_forward_enabled = config['general'].getboolean('StoreForward', False) if store_forward_enabled: trap_list = trap_list + ("messages",) help_message = help_message + ", messages" #Get the node number of the device, check if the device is connected try: myinfo = interface.getMyNodeInfo() myNodeNum = myinfo['num'] except Exception as e: print(f"System: Critical Error script abort. {e}") exit() def log_timestamp(): return datetime.now().strftime("%Y-%m-%d %H:%M:%S") def decimal_to_hex(decimal_number): return f"!{decimal_number:08x}" def get_name_from_number(number, type='long'): name = "" for node in interface.nodes.values(): if number == node['num']: if type == 'long': name = node['user']['longName'] return name elif type == 'short': name = node['user']['shortName'] return name else: pass else: name = str(decimal_to_hex(number)) # If long name not found, use the ID as string return name def get_node_list(): node_list = [] short_node_list = [] if interface.nodes: for node in interface.nodes.values(): # ignore own if node['num'] != myNodeNum: node_name = get_name_from_number(node['num']) snr = node.get('snr', 0) # issue where lastHeard is not always present last_heard = node.get('lastHeard', 0) # make a list of nodes with last heard time and SNR item = (node_name, last_heard, snr) node_list.append(item) node_list.sort(key=lambda x: x[1], reverse=True) #print (f"Node List: {node_list[:5]}\n") # make a nice list for the user for x in node_list[:5]: short_node_list.append(f"{x[0]} SNR:{x[2]}") return "\n".join(short_node_list) else: return "Error Processing Node List" def get_node_location(number): # Get the location of a node by its number from nodeDB on device latitude = 0 longitude = 0 position = [0,0] if interface.nodes: for node in interface.nodes.values(): if number == node['num']: if 'position' in node: latitude = node['position']['latitude'] longitude = node['position']['longitude'] print (f"System: location data for {number} is {latitude},{longitude}") position = [latitude,longitude] return position else: print (f"{log_timestamp()} System: No location data for {number}") return position else: print (f"{log_timestamp()} System: No nodes found") return position def send_message(message, ch, nodeid=0): # if message over 160 characters, split it into multiple messages if len(message) > 160: print (f"{log_timestamp()} System: Splitting Message, Message Length: {len(message)}") # split the message into 160 character chunks #message = message.replace('\n', ' NEWLINE ') # replace newlines with NEWLINE to keep them in split chunks split_message = message.split() line = '' split_len = 160 message_list = [] for word in split_message: if len(line+word)