BrightSky

Type-safe query builders and response types for the Bright Sky API, providing access to German weather data from the Deutscher Wetterdienst (DWD).

Quick Start

With reqwest Extension Trait (Recommended)

The easiest way to use brightsky with reqwest:

[dependencies]
brightsky = { version = "0.2", features = ["reqwest"] }
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }

use brightsky::{CurrentWeatherQueryBuilder, ext::BrightSkyReqwestExt, types::CurrentWeatherResponse};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::new();

    let query = CurrentWeatherQueryBuilder::new()
        .with_lat_lon((52.52, 13.4))  // Berlin
        .build()?;

    let response: CurrentWeatherResponse = client.get_brightsky(query).await?;
    println!("Temperature: {:?}C", response.weather.temperature);
    Ok(())
}

Manual HTTP Client Usage

If you prefer to handle HTTP yourself:

[dependencies]
brightsky = "0.2"
reqwest = { version = "0.13", features = ["json"] }
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }

use brightsky::{CurrentWeatherQueryBuilder, ToBrightSkyUrl, BRIGHT_SKY_API, types::CurrentWeatherResponse};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let query = CurrentWeatherQueryBuilder::new()
        .with_lat_lon((52.52, 13.4))
        .build()?;

    let url = query.to_url(BRIGHT_SKY_API)?;
    let response: CurrentWeatherResponse = reqwest::get(url).await?.json().await?;

    println!("Temperature: {:?}C", response.weather.temperature);
    Ok(())
}

Examples

Weather Forecast/History

use brightsky::{WeatherQueryBuilder, ext::BrightSkyReqwestExt, types::{WeatherResponse, UnitType}};
use chrono::NaiveDate;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::new();

    let query = WeatherQueryBuilder::new()
        .with_lat_lon((52.52, 13.4))
        .with_date(NaiveDate::from_ymd_opt(2025, 1, 15).unwrap())
        .with_units(UnitType::Si)
        .build()?;

    let response: WeatherResponse = client.get_brightsky(query).await?;
    println!("Found {} hourly records", response.weather.len());
    Ok(())
}

Embedded Usage (no_std)

For embedded systems, use to_url_string() with your HTTP client:

use brightsky::{CurrentWeatherQueryBuilder, ToBrightSkyUrl, BRIGHT_SKY_API, types::CurrentWeatherResponse};

let query = CurrentWeatherQueryBuilder::new()
    .with_lat_lon((52.52, 13.4))
    .build()?;

// Get URL as String (works in no_std)
let url = query.to_url_string(BRIGHT_SKY_API)?;

// Use your HTTP client (reqwless, etc.) to fetch, then deserialize
let response: CurrentWeatherResponse = serde_json::from_slice(&body)?;

Query Builders

Common Options

• Location: .with_lat_lon((lat, lon)) or .with_dwd_station_id(vec!["01766"])
• Date: .with_date(date) and .with_last_date(end_date)
• Timezone: .with_tz("Europe/Berlin")
• Units: .with_units(UnitType::Si) or .with_units(UnitType::Dwd)

Feature Flags

Without std: Only to_url_string() available (no_std compatible for embedded systems).

Data Sources

All data is sourced from the DWD open data server:

• SYNOP observations: Real-time weather station data
• MOSMIX forecasts: Numerical weather prediction
• Radar composites: RV product precipitation data
• CAP alerts: Official weather warnings

Please refer to the DWD Terms of Use for data usage guidelines.

Acknowledgements

BrightSky API is provided by Jakob de Maeyer. Consider sponsoring his work!

License

MIT License - see LICENSE for details.