"""Built-in antenna sources and their deterministic, explicitly versioned routing.
``auto`` selects the regional register that covers the scene centre (ANFR in France, the
Antennebureau list in the Netherlands, the UKE permits in Poland), otherwise OpenCelliD when
it is configured, otherwise no antennas. The ACMA register is selected by its identifier.
Explicit identifiers override the routing and never fall back to another source.
"""
from __future__ import annotations
from openworld_radio_twin.config import Settings
from openworld_radio_twin.providers import (
acma,
anfr,
antennebureau,
local_antennas,
opencellid,
uke,
)
from openworld_radio_twin.providers.registry import (
AntennaSourceRegistry,
DataSource,
region,
resolve_source,
)
[docs]
def default_antenna_sources() -> AntennaSourceRegistry:
registry = AntennaSourceRegistry(
(
DataSource(
"anfr",
anfr.TITLE,
"1",
anfr.AnfrProvider,
covers=region("france"),
auto_priority=100,
attribution=anfr.ATTRIBUTION,
license=anfr.LICENSE,
license_url=anfr.LICENSE_URL,
),
DataSource(
"acma",
acma.TITLE,
"1",
acma.AcmaProvider,
covers=region("australia"),
auto_priority=100,
attribution=acma.ATTRIBUTION,
license=acma.LICENSE,
license_url=acma.LICENSE_URL,
),
DataSource(
"antennebureau",
antennebureau.TITLE,
"1",
antennebureau.AntennebureauProvider,
covers=region("netherlands"),
auto_priority=100,
attribution=antennebureau.ATTRIBUTION,
license=antennebureau.LICENSE,
license_url=antennebureau.LICENSE_URL,
),
DataSource(
"uke",
uke.TITLE,
"1",
uke.UkeProvider,
covers=region("poland"),
auto_priority=100,
attribution=uke.ATTRIBUTION,
license=uke.LICENSE,
license_url=uke.LICENSE_URL,
),
DataSource(
"opencellid",
opencellid.TITLE,
"1",
opencellid.OpenCellIdProvider,
auto_priority=10,
configured=opencellid.configured,
configuration_hint=opencellid.CONFIGURATION_HINT,
attribution=opencellid.ATTRIBUTION,
license=opencellid.LICENSE,
license_url=opencellid.LICENSE_URL,
),
DataSource(
"local",
local_antennas.TITLE,
"1",
local_antennas.LocalAntennaProvider,
configured=local_antennas.configured,
configuration_hint=local_antennas.CONFIGURATION_HINT,
configuration_identity=local_antennas.configuration_identity,
),
)
)
registry.load_installed()
return registry
[docs]
def resolve_antenna_source(
requested: str,
latitude: float,
longitude: float,
settings: Settings,
registry: AntennaSourceRegistry,
) -> dict[str, object]:
"""Resolve before acquisition; ``auto`` without an applicable source means no antennas."""
return resolve_source(
registry,
requested,
latitude,
longitude,
settings,
allowed=settings.automatic_antenna_sources,
fallback="none",
reserved={"none": "1"},
)