sunny - v0.4.0

sunny/api/forecast

The module for interactiong with the Forecast API.

Types

CellSelection

</> 
pub type CellSelection {
  Land
  Sea
  Nearest
}

Constructors 

  • Land
  • Sea
  • Nearest

ForecastParams

</>

The different parameters available on the Forecast API.

See https://open-meteo.com/en/docs for further reference.

pub type ForecastParams {
  ForecastParams(
    position: position.Position,
    hourly: List(instant.InstantVariable),
    daily: List(daily.DailyVariable),
    minutely: List(instant.InstantVariable),
    current: List(instant.InstantVariable),
    temperature_unit: TemperatureUnit,
    wind_speed_unit: WindSpeedUnit,
    precipitation_unit: PrecipitationUnit,
    timezone: String,
    past_days: Int,
    forecast_days: Int,
    forecast_hours: option.Option(Int),
    forecast_minutely_15: option.Option(Int),
    past_hours: option.Option(Int),
    past_minutely_15: option.Option(Int),
    start_date: option.Option(birl.Time),
    end_date: option.Option(birl.Time),
    start_hour: option.Option(birl.Time),
    end_hour: option.Option(birl.Time),
    start_minutely_15: option.Option(birl.Time),
    end_minutely_15: option.Option(birl.Time),
    cell_selection: CellSelection,
  )
}

Constructors 

  • ForecastParams(
  position: position.Position,
  hourly: List(instant.InstantVariable),
  daily: List(daily.DailyVariable),
  minutely: List(instant.InstantVariable),
  current: List(instant.InstantVariable),
  temperature_unit: TemperatureUnit,
  wind_speed_unit: WindSpeedUnit,
  precipitation_unit: PrecipitationUnit,
  timezone: String,
  past_days: Int,
  forecast_days: Int,
  forecast_hours: option.Option(Int),
  forecast_minutely_15: option.Option(Int),
  past_hours: option.Option(Int),
  past_minutely_15: option.Option(Int),
  start_date: option.Option(birl.Time),
  end_date: option.Option(birl.Time),
  start_hour: option.Option(birl.Time),
  end_hour: option.Option(birl.Time),
  start_minutely_15: option.Option(birl.Time),
  end_minutely_15: option.Option(birl.Time),
  cell_selection: CellSelection,
)

    Arguments

    • minutely

      Get data every 15 minutes. Some data can’t be optained every 15 minutes, so it will be interpolated over the hour (or more if needed)

    • timezone

      Full list here : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

      You can set timezone to auto, and the API will deduce the local timezone from the coordinates.

      For abbreviations, in my experience only three letter ones work (e.g. CEST returns an error).

    • past_days

      Will be clamped between 0 and 92.

    • forecast_days

      Will be clamped between 0 and 16.

    • forecast_hours

      If forecast_hours is negative or null, it will be set to option.None.

    • forecast_minutely_15

      If forecast_minutely_15 is negative or null, it will be set to option.None.

    • past_hours

      If past_hours is negative or null, it will be set to option.None.

    • past_minutely_15

      If past_minutely_15 is negative or null, it will be set to option.None.

ForecastResult

</>

The result of a request to the Forecast API.

pub type ForecastResult {
  ForecastResult(
    position: position.Position,
    elevation: Float,
    utc_offset_seconds: Int,
    timezone: String,
    timezone_abbreviation: String,
    hourly: data.TimeRangedData(instant.InstantVariable),
    daily: data.TimeRangedData(daily.DailyVariable),
    minutely: data.TimeRangedData(instant.InstantVariable),
    current: option.Option(
      data.CurrentData(instant.InstantVariable),
    ),
  )
}

Constructors 

  • ForecastResult(
  position: position.Position,
  elevation: Float,
  utc_offset_seconds: Int,
  timezone: String,
  timezone_abbreviation: String,
  hourly: data.TimeRangedData(instant.InstantVariable),
  daily: data.TimeRangedData(daily.DailyVariable),
  minutely: data.TimeRangedData(instant.InstantVariable),
  current: option.Option(
    data.CurrentData(instant.InstantVariable),
  ),
)

PrecipitationUnit

</> 
pub type PrecipitationUnit {
  Millimeters
  Inches
}

Constructors 

  • Millimeters
  • Inches

TemperatureUnit

</> 
pub type TemperatureUnit {
  Celsius
  Fahrenheit
}

Constructors 

  • Celsius
  • Fahrenheit

WindSpeedUnit

</> 
pub type WindSpeedUnit {
  KilometersPerHour
  MetersPerSecond
  MilesPerHour
  Knots
}

Constructors 

  • KilometersPerHour
  • MetersPerSecond
  • MilesPerHour
  • Knots

Functions

get_request

</> 
pub fn get_request(
  client: Client,
  params: ForecastParams,
) -> Request(String)

Get a request.Request(String) according to the specified ForecastParams.

Once you made a request using your favorite HTTP client, pass the String body to get_result.

get_result

</> 
pub fn get_result(
  response_body: String,
) -> Result(ForecastResult, SunnyError)

Get a ForecastResult from the body of a HTTP request response.

You can get a request to the Forecast API by using get_request.

params

</> 
pub fn params(position: Position) -> ForecastParams

Creates a new ForecastParams with the default values. Takes the Position of the place you to get the forecast (see the sunny/position module).

Defaults :

  • temperature_unit : Celsius
  • wind_speed_unit : Kilometers per hour
  • precipitation_unit : Millimeters
  • timezone : GMT
  • past_days : 0
  • forecast_days : 7
  • cell_selection : Land These are the same defaults as the Open-Meteo API’s ones. Other parameters are set to option.None or to an empty List.

set_all_current

</> 
pub fn set_all_current(
  params: ForecastParams,
  except: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with all the current variables except the ones in the except argument.

set_all_daily

</> 
pub fn set_all_daily(
  params: ForecastParams,
  except: List(DailyVariable),
) -> ForecastParams

Returns a new ForecastParams with all the daily variables except the ones in the except argument

set_all_hourly

</> 
pub fn set_all_hourly(
  params: ForecastParams,
  except: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with all the hourly variables except the ones in the except argument.

set_all_minutely

</> 
pub fn set_all_minutely(
  params: ForecastParams,
  except: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with all the minutely variables except the ones in the except argument.

set_cell_selection

</> 
pub fn set_cell_selection(
  params: ForecastParams,
  cell_selection: CellSelection,
) -> ForecastParams

Returns a new ForecastParams with the specified cell selection.

set_current

</> 
pub fn set_current(
  params: ForecastParams,
  current_list: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with the specified hourly list

set_daily

</> 
pub fn set_daily(
  params: ForecastParams,
  daily_list: List(DailyVariable),
) -> ForecastParams

Returns a new ForecastParams with the specified daily list

set_end_date

</> 
pub fn set_end_date(
  params: ForecastParams,
  end_date: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified end date.

set_end_hour

</> 
pub fn set_end_hour(
  params: ForecastParams,
  end_hour: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified end hour.

set_end_minutely_15

</> 
pub fn set_end_minutely_15(
  params: ForecastParams,
  end_minutely_15: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified end minutely 15.

set_forecast_days

</> 
pub fn set_forecast_days(
  params: ForecastParams,
  forecast_days: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified forecast days.

forecast_days will be clamped between 0 and 16.

set_forecast_hours

</> 
pub fn set_forecast_hours(
  params: ForecastParams,
  forecast_hours: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified forecast hours.

If forecast_hours is negative or null, it will be set to option.None.

set_forecast_minutely_15

</> 
pub fn set_forecast_minutely_15(
  params: ForecastParams,
  forecast_minutely_15: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified forecast minutely 15.

If forecast_minutely_15 is negative or null, it will be set to option.None.

set_hourly

</> 
pub fn set_hourly(
  params: ForecastParams,
  hourly_list: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with the specified hourly list.

set_minutely

</> 
pub fn set_minutely(
  params: ForecastParams,
  minutely_list: List(InstantVariable),
) -> ForecastParams

Returns a new ForecastParams with the specified 15-minutely list

set_past_days

</> 
pub fn set_past_days(
  params: ForecastParams,
  past_days: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified past days.

past_days will be clamped between 0 and 92.

set_past_hours

</> 
pub fn set_past_hours(
  params: ForecastParams,
  past_hours: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified past hours.

If past_hours is negative or null, it will be set to option.None.

set_past_minutely_15

</> 
pub fn set_past_minutely_15(
  params: ForecastParams,
  past_minutely_15: Int,
) -> ForecastParams

Returns a new ForecastParams with the specified past minutely 15.

If past_minutely_15 is negative or null, it will be set to option.None.

set_precipitation_unit

</> 
pub fn set_precipitation_unit(
  params: ForecastParams,
  unit: PrecipitationUnit,
) -> ForecastParams

Returns a new ForecastParams with the specified temperature unit.

set_start_date

</> 
pub fn set_start_date(
  params: ForecastParams,
  start_date: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified start date.

set_start_hour

</> 
pub fn set_start_hour(
  params: ForecastParams,
  start_hour: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified start hour.

set_start_minutely_15

</> 
pub fn set_start_minutely_15(
  params: ForecastParams,
  start_minutely_15: Time,
) -> ForecastParams

Returns a new ForecastParams with the specified start minutely 15.

set_temperature_unit

</> 
pub fn set_temperature_unit(
  params: ForecastParams,
  unit: TemperatureUnit,
) -> ForecastParams

Returns a new ForecastParams with the specified temperature unit.

set_timezone

</> 
pub fn set_timezone(
  params: ForecastParams,
  timezone: String,
) -> ForecastParams

Returns a new ForecastParams with the specified timezone.

set_wind_speed_unit

</> 
pub fn set_wind_speed_unit(
  params: ForecastParams,
  unit: WindSpeedUnit,
) -> ForecastParams

Returns a new ForecastParams with the specified temperature unit.

✨ Search Document