Files
weatherfeeder/README.md
Eric Rakestraw 356c3be648
All checks were successful
ci/woodpecker/push/build-image Pipeline was successful
Feature addition to support narrative forecast updates from the NWS
2026-03-27 16:07:12 -05:00

1.2 KiB

weatherfeeder

weatherfeeder is a small daemon that polls weather observations, forecasts, and alerts from multiple upstream providers, normalizes them into a provider-independent format, and emits them to a sink.

Today, the only implemented sink is stdout, which prints JSON-encoded events.

What weatherfeeder emits

weatherfeeder emits feed events encoded as JSON. Each event includes a schema identifier and a payload. Downstream consumers should key off the schema value and decode the payload accordingly.

Canonical domain schemas emitted after normalization:

  • weather.observation.v1WeatherObservation
  • weather.forecast.v1WeatherForecastRun
  • weather.alert.v1WeatherAlertRun

For the complete wire contract (event envelope + payload schemas, fields, units, and compatibility rules), see:

  • API.md

Upstream providers (current MVP)

  • NWS: observations, hourly forecasts, narrative forecasts, alerts
  • Open-Meteo: observations, hourly forecasts
  • OpenWeather: observations

Versioning & compatibility

The JSON field names on canonical payload types are treated as part of the wire contract. Additive changes are preferred. Renames/removals require a schema version bump.

See API.md for details.