Document SPC outlook support
This commit is contained in:
@@ -69,10 +69,10 @@ sinks:
|
||||
|
||||
routes:
|
||||
- sink: nats_weather
|
||||
kinds: ["observation", "forecast", "forecast_discussion", "weather_story", "alert"]
|
||||
kinds: ["observation", "forecast", "forecast_discussion", "weather_story", "alert", "outlook"]
|
||||
|
||||
- sink: pg_weather
|
||||
kinds: ["observation", "forecast", "forecast_discussion", "weather_story", "alert"]
|
||||
kinds: ["observation", "forecast", "forecast_discussion", "weather_story", "alert", "outlook"]
|
||||
```
|
||||
|
||||
Do not commit real API keys, database passwords, or personal contact addresses in
|
||||
@@ -95,10 +95,10 @@ copyable configs.
|
||||
| `mode` | no | `poll`, `stream`, or omitted for auto. Current weatherfeeder drivers are polling drivers. |
|
||||
| `every` | yes | Poll interval for current weatherfeeder source drivers. |
|
||||
| `kinds` | no | Expected event kinds. If present, startup verifies they match the source driver. |
|
||||
| `params` | driver-specific | Driver parameters. Current source drivers require HTTP params. |
|
||||
| `params` | driver-specific | Driver parameters. See the source-specific sections below. |
|
||||
|
||||
Current event kinds are `observation`, `forecast`, `forecast_discussion`,
|
||||
`weather_story`, and `alert`.
|
||||
`weather_story`, `alert`, and `outlook`.
|
||||
|
||||
## Source Drivers
|
||||
|
||||
@@ -113,10 +113,11 @@ Current event kinds are `observation`, `forecast`, `forecast_discussion`,
|
||||
| `openmeteo_observation` | `observation` | Open-Meteo current conditions. |
|
||||
| `openmeteo_forecast` | `forecast` | Open-Meteo hourly forecast. |
|
||||
| `openweather_observation` | `observation` | OpenWeather current weather. |
|
||||
| `spc_convective_outlook` | `outlook` | SPC Day 1-3 convective outlooks. |
|
||||
|
||||
## HTTP Source Params
|
||||
|
||||
All current source drivers use the shared HTTP polling helper.
|
||||
Most source drivers use the shared HTTP polling helper.
|
||||
|
||||
| Param | Required | Description |
|
||||
|---|:---:|---|
|
||||
@@ -132,6 +133,44 @@ source emits no events for that poll.
|
||||
OpenWeather observation URLs must include `units=metric`. Startup fails if the
|
||||
URL omits it or sets another unit system.
|
||||
|
||||
## SPC Convective Outlook Params
|
||||
|
||||
`spc_convective_outlook` fetches the twelve required Day 1-3 GeoJSON outlook
|
||||
products and the three required Day 1-3 print pages as one atomic bundle.
|
||||
|
||||
| Param | Required | Description |
|
||||
|---|:---:|---|
|
||||
| `latitude` | yes | Location latitude in decimal degrees. |
|
||||
| `longitude` | yes | Location longitude in decimal degrees. |
|
||||
| `user_agent` | yes | User-Agent sent to SPC. `userAgent` is also accepted. |
|
||||
| `location_id` | no | Operator-defined location identifier copied into canonical outlook runs. |
|
||||
| `location_name` | no | Human location label copied into canonical outlook runs. |
|
||||
| `geojson_urls` | no | Map of product key to override URL. Used for tests and upstream URL changes. |
|
||||
| `discussion_urls` | no | Map of day key to override print-page URL. Used for tests and upstream URL changes. |
|
||||
| `rss_url` | no | Optional RSS URL. RSS is not fetched unless this is configured. |
|
||||
| `http_timeout` | no | Positive duration for the HTTP client timeout. |
|
||||
| `http_response_body_limit_bytes` | no | Positive integer response body limit in bytes. |
|
||||
|
||||
GeoJSON product keys are `day1_categorical`, `day1_tornado`, `day1_hail`,
|
||||
`day1_wind`, `day2_categorical`, `day2_tornado`, `day2_hail`, `day2_wind`,
|
||||
`day3_categorical`, `day3_tornado`, `day3_hail`, and `day3_wind`.
|
||||
Discussion keys are `day1`, `day2`, and `day3`.
|
||||
|
||||
```yaml
|
||||
sources:
|
||||
- name: SPCConvectiveOutlookSTL
|
||||
mode: poll
|
||||
kinds: ["outlook"]
|
||||
driver: spc_convective_outlook
|
||||
every: 30m
|
||||
params:
|
||||
latitude: 38.6239
|
||||
longitude: -90.3571
|
||||
location_id: "stl"
|
||||
location_name: "St. Louis, MO"
|
||||
user_agent: "Example weatherfeeder operator (ops@example.com)"
|
||||
```
|
||||
|
||||
## Sink Fields
|
||||
|
||||
| Field | Required | Description |
|
||||
|
||||
Reference in New Issue
Block a user