Skip to content

api-doc.md

Latest commit

 

History

History
223 lines (221 loc) · 13.7 KB

api-doc.md

File metadata and controls

223 lines (221 loc) · 13.7 KB

API Documentation

This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.

path Argument Units Min Max Default required sample values proposal valid_values
/ham/HamClock/Bz/Bz.txt
/ham/HamClock/NOAASpaceWX/noaaswx.txt
/ham/HamClock/NOAASpaceWX/rank2_coeffs.txt
/ham/HamClock/ONTA/onta.txt
/ham/HamClock/RSS/web15rss.pl
/ham/HamClock/SDO/f_131_170.bmp.z
/ham/HamClock/SDO/f_131_340.bmp.z
/ham/HamClock/SDO/f_131_680.bmp.z
/ham/HamClock/SDO/f_193_170.bmp.z
/ham/HamClock/SDO/f_193_340.bmp.z
/ham/HamClock/SDO/f_193_680.bmp.z
/ham/HamClock/SDO/f_211_170.bmp.z
/ham/HamClock/SDO/f_211_193_171_170.bmp.z
/ham/HamClock/SDO/f_211_193_171_340.bmp.z
/ham/HamClock/SDO/f_211_193_171_510.bmp.z
/ham/HamClock/SDO/f_211_193_171_680.bmp.z
/ham/HamClock/SDO/f_211_340.bmp.z
/ham/HamClock/SDO/f_211_680.bmp.z
/ham/HamClock/SDO/f_304_170.bmp.z
/ham/HamClock/SDO/f_304_340.bmp.z
/ham/HamClock/SDO/f_304_680.bmp.z
/ham/HamClock/SDO/latest_170_HMIB.bmp.z
/ham/HamClock/SDO/latest_170_HMIIC.bmp.z
/ham/HamClock/SDO/latest_340_HMIB.bmp.z
/ham/HamClock/SDO/latest_340_HMIIC.bmp.z
/ham/HamClock/SDO/latest_510_HMIIC.bmp.z
/ham/HamClock/SDO/latest_680_HMIB.bmp.z
/ham/HamClock/SDO/latest_680_HMIIC.bmp.z
/ham/HamClock/aurora/aurora.txt
/ham/HamClock/cities2.txt
/ham/HamClock/contests/contests311.txt
/ham/HamClock/cty/cty_wt_mod-ll-dxcc.txt
/ham/HamClock/drap/stats.txt
/ham/HamClock/dst/dst.txt
/ham/HamClock/dxpeds/dxpeditions.txt
/ham/HamClock/esats/esats.txt
/ham/HamClock/fetchBandConditions.pl MODE 17, 13, 38, 19, 3 $ModeEnum
MONTH 0, 4
PATH 0, 1 $PathEnum
POW 10, 50, 1000, 5, 100...
RXLAT -58.909, 6.000, 33.667, 54.917, 33.711...
RXLNG 77.727, 98.182, -157.455, 12.583, -83.727...
TOA degrees 0.1 30.0 1.0, 3.0, 9.0
TXLAT 41.246, 10.333, 25.958, 37.730, 50.815...
TXLNG -84.167, -1.750, -121.833, -96.333, 12.583...
UTC 17, 11, 7, 6, 12...
YEAR 2026, 1970
ANTDEDXCONTROL no 0, 3 001 $AntControlEnum
ANTDEINDEX no 0, 1024 001 $AntIndexEnum
ANTDXINDEX no 0 001 $AntIndexEnum
ANTDEAZ degrees 0.0 359.9 no 0.0 001
ANTDXAZ degrees 0.0 359.9 no 0.0 001
/ham/HamClock/fetchPSKReporter.pl bycall W1AW
bygrid FM14, EM99, EM97, DM97, CN85...
maxage 86400, 21600, 1800, 900, 3600
ofcall W1AW
ofgrid IO90, EM84, CN85, JO55, DM14...
/ham/HamClock/fetchRBN.pl maxage secs yes 900, 1800, 3600, 86400
ofcall W1AW
bycall WZ7I
bygrid FN20, FN20kk
ofgrid DM37, DM37lr
/ham/HamClock/fetchVOACAP-MUF.pl HEIGHT yes 330, 660, 2970, 990, 1320 $MapHeightEnum
MHZ yes" 0.00
MODE yes 19, 38, 13 $ModeEnum
MONTH yes 4
PATH yes 0, 1 $PathEnum
TOA degrees 0.1 30.0 yes 1.0, 3.0, 9.0
TXLAT yes 34.622, 42.875, 18.458, 37.625, 50.815...
TXLNG yes -124.000, 12.583, -122.091, -111.083, -84.750...
UTC yes 17, 11, 7, 6, 12...
WATTS yes 10, 50, 1000, 100, 500
WIDTH yes 1980, 5940, 660, 2640, 1320 $MapWidthEnum
YEAR yes 2026
ANTDEDXCONTROL no 0, 3 001 $AntControlEnum
ANTDEINDEX no 0, 1024 001 $AntIndexEnum
ANTDXINDEX no 0 001 $AntIndexEnum
ANTDEAZ degrees 0.0 359.9 no 0.0 001
ANTDXAZ degrees 0.0 359.9 no 0.0 001
/ham/HamClock/fetchVOACAP-TOA.pl HEIGHT 990, 330, 660, 1320 $MapHeightEnum
MHZ 18.10, 21.10, 7.10, 14.10, 10.10...
MODE 13, 38, 19 $ModeEnum
MONTH 4
PATH 0 $PathEnum
TOA degrees 0.1 30.0 1.0, 3.0, 9.0
TXLAT 38.958, 34.622, 41.106, 40.000, 39.875...
TXLNG -124.000, -82.000, -84.750, -86.083, -119.167...
UTC 17, 11, 7, 6, 12...
WATTS 10, 50, 1000, 100, 500
WIDTH 660, 1980, 2640, 1320 $MapWidthEnum
YEAR 2026
ANTDEDXCONTROL no 0, 3 001 $AntControlEnum
ANTDEINDEX no 0, 1024 001 $AntIndexEnum
ANTDXINDEX no 0 001 $AntIndexEnum
ANTDEAZ degrees 0.0 359.9 no 0.0 001
ANTDXAZ degrees 0.0 359.9 no 0.0 001
/ham/HamClock/fetchVOACAPArea.pl HEIGHT 1980, 330, 660, 2640, 990... $MapHeightEnum
MHZ 18.10, 21.10, 7.10, 14.10, 10.10...
MODE 17, 13, 38, 19, 3 $ModeEnum
MONTH 4
PATH 0, 1 $PathEnum
TOA degrees 0.1 30.0 1.0, 3.0, 9.0
TXLAT 39.381, 45.818, 18.458, 42.292, 40.712...
TXLNG -124.000, -1.750, -84.098, -122.000, -123.417...
UTC 17, 11, 7, 6, 12...
WATTS 10, 50, 1000, 5, 100...
WIDTH 1980, 660, 7920, 2640, 5280... $MapWidthEnum
YEAR 2026
ANTDEDXCONTROL no 0, 3 001 $AntControlEnum
ANTDEINDEX no 0, 1024 001 $AntIndexEnum
ANTDXINDEX no 0 001 $AntIndexEnum
ANTDEAZ degrees 0.0 359.9 no 0.0 001
ANTDXAZ degrees 0.0 359.9 no 0.0 001
/ham/HamClock/fetchWSPR.pl bycall W1AW
bygrid EN82, EN62
maxage 86400, 21600, 1800, 900, 3600
ofcall W1AW
ofgrid EN50, DM03, EM59, IO90, PF94
/ham/HamClock/geomag/kindex.txt
/ham/HamClock/maps/map-D-1320x660-Aurora.bmp.z
/ham/HamClock/maps/map-D-1320x660-Clouds.bmp.z
/ham/HamClock/maps/map-D-1320x660-Countries.bmp.z
/ham/HamClock/maps/map-D-1320x660-DRAP-S.bmp.z
/ham/HamClock/maps/map-D-1320x660-MUF-RT.bmp.z
/ham/HamClock/maps/map-D-1320x660-Terrain.bmp.z
/ham/HamClock/maps/map-D-1320x660-Wx-in.bmp.z
/ham/HamClock/maps/map-D-1320x660-Wx-mB.bmp.z
/ham/HamClock/maps/map-D-1980x990-Aurora.bmp.z
/ham/HamClock/maps/map-D-1980x990-Clouds.bmp.z
/ham/HamClock/maps/map-D-1980x990-Countries.bmp.z
/ham/HamClock/maps/map-D-1980x990-DRAP-S.bmp.z
/ham/HamClock/maps/map-D-1980x990-MUF-RT.bmp.z
/ham/HamClock/maps/map-D-1980x990-Terrain.bmp.z
/ham/HamClock/maps/map-D-1980x990-Wx-in.bmp.z
/ham/HamClock/maps/map-D-1980x990-Wx-mB.bmp.z
/ham/HamClock/maps/map-D-2640x1320-Aurora.bmp.z
/ham/HamClock/maps/map-D-2640x1320-Clouds.bmp.z
/ham/HamClock/maps/map-D-2640x1320-Countries.bmp.z
/ham/HamClock/maps/map-D-2640x1320-DRAP-S.bmp.z
/ham/HamClock/maps/map-D-2640x1320-MUF-RT.bmp.z
/ham/HamClock/maps/map-D-2640x1320-Terrain.bmp.z
/ham/HamClock/maps/map-D-3960x1980-Clouds.bmp.z
/ham/HamClock/maps/map-D-3960x1980-Terrain.bmp.z
/ham/HamClock/maps/map-D-3960x1980-Wx-in.bmp.z
/ham/HamClock/maps/map-D-5940x2970-Aurora.bmp.z
/ham/HamClock/maps/map-D-5940x2970-Countries.bmp.z
/ham/HamClock/maps/map-D-5940x2970-MUF-RT.bmp.z
/ham/HamClock/maps/map-D-5940x2970-Wx-mB.bmp.z
/ham/HamClock/maps/map-D-660x330-Aurora.bmp.z
/ham/HamClock/maps/map-D-660x330-Clouds.bmp.z
/ham/HamClock/maps/map-D-660x330-Countries.bmp.z
/ham/HamClock/maps/map-D-660x330-DRAP-S.bmp.z
/ham/HamClock/maps/map-D-660x330-MUF-RT.bmp.z
/ham/HamClock/maps/map-D-660x330-Wx-in.bmp.z
/ham/HamClock/maps/map-D-660x330-Wx-mB.bmp.z
/ham/HamClock/maps/map-N-1320x660-Aurora.bmp.z
/ham/HamClock/maps/map-N-1320x660-Clouds.bmp.z
/ham/HamClock/maps/map-N-1320x660-Countries.bmp.z
/ham/HamClock/maps/map-N-1320x660-DRAP-S.bmp.z
/ham/HamClock/maps/map-N-1320x660-MUF-RT.bmp.z
/ham/HamClock/maps/map-N-1320x660-Terrain.bmp.z
/ham/HamClock/maps/map-N-1320x660-Wx-in.bmp.z
/ham/HamClock/maps/map-N-1320x660-Wx-mB.bmp.z
/ham/HamClock/maps/map-N-1980x990-Aurora.bmp.z
/ham/HamClock/maps/map-N-1980x990-Clouds.bmp.z
/ham/HamClock/maps/map-N-1980x990-Countries.bmp.z
/ham/HamClock/maps/map-N-1980x990-DRAP-S.bmp.z
/ham/HamClock/maps/map-N-1980x990-MUF-RT.bmp.z
/ham/HamClock/maps/map-N-1980x990-Terrain.bmp.z
/ham/HamClock/maps/map-N-1980x990-Wx-in.bmp.z
/ham/HamClock/maps/map-N-1980x990-Wx-mB.bmp.z
/ham/HamClock/maps/map-N-2640x1320-Aurora.bmp.z
/ham/HamClock/maps/map-N-2640x1320-Clouds.bmp.z
/ham/HamClock/maps/map-N-2640x1320-Countries.bmp.z
/ham/HamClock/maps/map-N-2640x1320-DRAP-S.bmp.z
/ham/HamClock/maps/map-N-2640x1320-MUF-RT.bmp.z
/ham/HamClock/maps/map-N-2640x1320-Terrain.bmp.z
/ham/HamClock/maps/map-N-3960x1980-Clouds.bmp.z
/ham/HamClock/maps/map-N-3960x1980-Terrain.bmp.z
/ham/HamClock/maps/map-N-3960x1980-Wx-in.bmp.z
/ham/HamClock/maps/map-N-5940x2970-Aurora.bmp.z
/ham/HamClock/maps/map-N-5940x2970-Countries.bmp.z
/ham/HamClock/maps/map-N-5940x2970-MUF-RT.bmp.z
/ham/HamClock/maps/map-N-5940x2970-Wx-mB.bmp.z
/ham/HamClock/maps/map-N-660x330-Aurora.bmp.z
/ham/HamClock/maps/map-N-660x330-Clouds.bmp.z
/ham/HamClock/maps/map-N-660x330-Countries.bmp.z
/ham/HamClock/maps/map-N-660x330-DRAP-S.bmp.z
/ham/HamClock/maps/map-N-660x330-MUF-RT.bmp.z
/ham/HamClock/maps/map-N-660x330-Wx-in.bmp.z
/ham/HamClock/maps/map-N-660x330-Wx-mB.bmp.z
/ham/HamClock/solar-flux/solarflux-99.txt
/ham/HamClock/solar-flux/solarflux-history.txt
/ham/HamClock/solar-wind/swind-24hr.txt
/ham/HamClock/ssn/ssn-31.txt
/ham/HamClock/ssn/ssn-history.txt
/ham/HamClock/version.pl
/ham/HamClock/worldwx/wx.txt
/ham/HamClock/wx.pl is_de 0, 1
lat 41.246, 36.292, 37.6364, 29, 21.5468...
lng -96.9167, -84.167, -80.729, -106.5, -84.5455...
/ham/HamClock/xray/xray.txt
/ham/HamClock/lightning/strikes.pl 003
lat DD.ddddd -90 90 undef
lon DD.dddd -180 180 undef
radius km 0 41000 undef
maxage s 0 server maximum 600