Add descriptions for solar conditions #92

This commit is contained in:
Ian Renton
2026-03-28 10:39:26 +00:00
parent 1173af6a9d
commit 2a5e0db5bc
14 changed files with 203 additions and 49 deletions

View File

@@ -1362,18 +1362,18 @@ components:
properties:
band:
type: string
description: Band group name as used by the data source, e.g. "80m-40m", "30m-20m", "17m-15m", "10m-6m".
description: Band group, e.g. "80m-40m", "30m-20m", "17m-15m", "10m-6m". As provided by HamQSL.
example: "80m-40m"
time:
type: string
description: Time of day these conditions apply to.
description: Time of day these conditions apply to. As provided by HamQSL.
enum:
- day
- night
example: day
condition:
type: string
description: Propagation condition assessment.
description: Propagation condition assessment. As provided by HamQSL.
enum:
- Good
- Fair
@@ -1386,12 +1386,12 @@ components:
properties:
phenomenon:
type: string
description: The name of the propagation phenomenon, e.g. "E-Skip", "Sporadic E".
description: The name of the propagation phenomenon, e.g. "E-Skip", "vhf-aurora". As provided by HamQSL.
example: "E-Skip"
location:
type: string
description: The geographic region this condition applies to, e.g. "Europe", "N America".
example: "Europe"
description: The geographic region this condition applies to, e.g. "europe", "north_america", "northern_hemi". As provided by HamQSL.
example: "europe"
condition:
type: string
description: The current condition for this phenomenon and location.
@@ -1407,66 +1407,98 @@ components:
example: 1759579508
sfi:
type: integer
description: Solar Flux Index (SFI). Higher values generally indicate better HF propagation.
description: Solar Flux Index (SFI)
example: 170
a_index:
type: integer
description: A-index — daily geomagnetic activity index. Higher values indicate more disturbed conditions.
description: Daily geomagnetic activity index
example: 7
k_index:
type: integer
description: K-index — 3-hour geomagnetic activity index, 09. Values of 5 or above indicate a geomagnetic storm.
description: 3-hour geomagnetic activity index, 09
example: 2
x_ray:
type: string
description: Current X-ray flux class, e.g. "B2.3", "C1.0", "M5.0".
description: Current X-ray flux class
example: "B2.3"
proton_flux:
type: integer
description: Proton flux level.
description: Proton flux level
example: 1
electron_flux:
type: integer
description: Electron flux level.
description: Electron flux level
example: 631
aurora:
type: integer
description: Aurora activity level.
description: Aurora activity level
example: 5
aurora_latitude:
type: number
description: Latitude in degrees of the equatorward boundary of the aurora.
description: Lowest latitude at which aurora should be visible
example: 66.3
sunspots:
type: integer
description: Current sunspot count.
description: Sunspot count
example: 87
solar_wind:
type: number
description: Solar wind speed in km/s.
description: Solar wind speed in km/s
example: 356.6
magnetic_field:
type: number
description: Interplanetary magnetic field (IMF) strength in nT.
description: Interplanetary magnetic field strength in nT
example: 2.5
geomag_field:
type: string
description: Geomagnetic field condition summary.
description: Geomagnetic field condition summary
example: "Active"
geomag_noise:
type: string
description: Geomagnetic background noise level on HF, using S-units.
description: Geomagnetic background noise level on HF, in S-units
example: "S0"
hf_conditions:
type: array
description: HF propagation condition assessments by band group and time of day.
description: HF propagation condition assessments by band group and time of day
items:
$ref: '#/components/schemas/HFBandCondition'
vhf_conditions:
type: array
description: VHF propagation condition assessments by phenomenon and location.
description: VHF propagation condition assessments by phenomenon and location
items:
$ref: '#/components/schemas/VHFCondition'
blackout_desc:
type: string
description: HF radio blackout risk description, derived from the X-ray flux class.
example: "No significant radio blackout"
proton_flux_desc:
type: string
description: Solar radiation storm level description, derived from proton flux.
example: "No solar radiation storm"
solar_storm_scale:
type: integer
description: Solar radiation storm scale number (S0-S5), derived from proton flux. S0 = none, S5 = extreme.
minimum: 0
maximum: 5
example: 0
geomag_storm_desc:
type: string
description: Geomagnetic storm level description, derived from K-index.
example: "Quiet"
geomag_storm_scale:
type: integer
description: Geomagnetic storm scale number (G0-G5), derived from K-index. G0 = none, G5 = extreme.
minimum: 0
maximum: 5
example: 0
band_conditions_desc:
type: string
description: Overall HF band conditions summary, derived from Solar Flux Index.
example: "Fair to good conditions on all bands up to 10m"
electron_flux_desc:
type: string
description: Electron flux impact description, derived from electron flux level.
example: "No impact"
SolarConditionsProviderStatus:
type: object