meshing-around/modules/space.py

# helper functions to get HF band conditions, DRAP X-ray flux, and sunrise/sunset times
# 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.log import *

trap_list_solarconditions = ("sun", "moon", "solar", "hfcond", "satpass")

def hf_band_conditions():
    # ham radio HF band conditions
    hf_cond = ""
    band_cond = requests.get("https://www.hamqsl.com/solarxml.php", timeout=urlTimeoutSeconds)
    if(band_cond.ok):
        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:
        logger.error("Solar: Error fetching HF band conditions")
        hf_cond = ERROR_FETCHING_DATA
    
    return hf_cond

def solar_conditions():
    # radio related solar conditions from hamsql.com
    solar_cond = ""
    solar_cond = requests.get("https://www.hamqsl.com/solarxml.php", timeout=urlTimeoutSeconds)
    if(solar_cond.ok):
        solar_xml = xml.dom.minidom.parseString(solar_cond.text)
        for i in solar_xml.getElementsByTagName("solardata"):
            solar_a_index = i.getElementsByTagName("aindex")[0].childNodes[0].data
            solar_k_index = i.getElementsByTagName("kindex")[0].childNodes[0].data
            solar_xray = i.getElementsByTagName("xray")[0].childNodes[0].data
            solar_flux = i.getElementsByTagName("solarflux")[0].childNodes[0].data
            sunspots = i.getElementsByTagName("sunspots")[0].childNodes[0].data
            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:
        logger.error("Solar: Error fetching solar conditions")
        solar_cond = ERROR_FETCHING_DATA
    return solar_cond

def drap_xray_conditions():
    # DRAP X-ray flux conditions, from NOAA direct
    drap_cond = ""
    drap_cond = requests.get("https://services.swpc.noaa.gov/text/drap_global_frequencies.txt", timeout=urlTimeoutSeconds)
    if(drap_cond.ok):
        drap_list = drap_cond.text.split('\n')
        x_filter = '#  X-RAY Message :'
        for line in drap_list:
            if x_filter in line:
                xray_flux = line.split(": ")[1]
    else:
        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()
    sun = ephem.Sun()
    if lat != 0 and lon != 0:
        obs.lat = str(lat)
        obs.lon = str(lon)
    else:
        obs.lat = str(latitudeValue)
        obs.lon = str(longitudeValue)

    sun.compute(obs)
    sun_table = {}
    sun_table['azimuth'] = sun.az
    sun_table['altitude'] = sun.alt

    # get the next rise and set times
    local_sunrise = ephem.localtime(obs.next_rising(sun))
    local_sunset = ephem.localtime(obs.next_setting(sun))
    if zuluTime:
        sun_table['rise_time'] = local_sunrise.strftime('%a %d %H:%M')
        sun_table['set_time'] = local_sunset.strftime('%a %d %H:%M')
    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 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']
    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:
        obs.lat = str(lat)
        obs.lon = str(lon)
    else:
        obs.lat = str(latitudeValue)
        obs.lon = str(longitudeValue)
    
    obs.date = datetime.now()
    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]
    moon_table['phase'] = moon_phase
    moon_table['illumination'] = moon.phase
    moon_table['azimuth'] = moon.az
    moon_table['altitude'] = moon.alt

    local_moonrise = ephem.localtime(obs.next_rising(moon))
    local_moonset = ephem.localtime(obs.next_setting(moon))
    if zuluTime:
        moon_table['rise_time'] = local_moonrise.strftime('%a %d %H:%M')
        moon_table['set_time'] = local_moonset.strftime('%a %d %H:%M')
    else:
        moon_table['rise_time'] = local_moonrise.strftime('%a %d %I:%M%p')
        moon_table['set_time'] = local_moonset.strftime('%a %d %I:%M%p')

    local_next_full_moon = ephem.localtime(ephem.next_full_moon((obs.date)))
    local_next_new_moon = ephem.localtime(ephem.next_new_moon((obs.date)))
    if zuluTime:
        moon_table['next_full_moon'] = local_next_full_moon.strftime('%a %b %d %H:%M')
        moon_table['next_new_moon'] = local_next_new_moon.strftime('%a %b %d %H:%M')
    else:
        moon_table['next_full_moon'] = local_next_full_moon.strftime('%a %b %d %I:%M%p')
        moon_table['next_new_moon'] = local_next_new_moon.strftime('%a %b %d %I:%M%p')

    moon_data = "MoonRise:" + moon_table['rise_time'] + "\nSet:" + moon_table['set_time'] + \
        "\nPhase:" + moon_table['phase'] + " @:" + str('{0:.2f}'.format(moon_table['illumination'])) + "%" \
        + "\nFullMoon:" + moon_table['next_full_moon'] + "\nNewMoon:" + moon_table['next_new_moon']
    
    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