Skip to content

frequenz.api.weather.weather_pb2 ¤

Generated protocol buffer code.

Attributes¤

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_SURFACE_NET_SOLAR_RADIATION module-attribute ¤

FORECAST_FEATURE_SURFACE_NET_SOLAR_RADIATION: ValueType

Amount of solar radiation (shortwave radiation, direct and diffused) that reaches a horizontal plane at the surface of the Earth minus the amount reflected by the Earth's surface (which is governed by the albedo). The value is the forecast of the average solar irradiance from the validity time until the next validity timestamp. Measured in W/m².

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_SURFACE_SOLAR_RADIATION_DOWNWARDS module-attribute ¤

FORECAST_FEATURE_SURFACE_SOLAR_RADIATION_DOWNWARDS: (
    ValueType
)

Amount of solar radiation (shortwave radiation, direct and diffused) that reaches a horizontal plane at the surface of the Earth. The value is the forecast of the average solar irradiance from the validity time until the next validity timestamp. Measured in W/m².

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_TEMPERATURE_2_METRE module-attribute ¤

FORECAST_FEATURE_TEMPERATURE_2_METRE: ValueType

Temperature at 2 m above the earth's surface. It is the temperature of the air at a height of 2 metres above the surface of land, sea or in-land waters. Measured in Kelvin. To convert to Celsius, subtract 273.15.

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_UNSPECIFIED module-attribute ¤

FORECAST_FEATURE_UNSPECIFIED: ValueType

Default value. When used, the API responds with all features listed below.

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_U_WIND_COMPONENT_100_METRE module-attribute ¤

FORECAST_FEATURE_U_WIND_COMPONENT_100_METRE: ValueType

Eastward component of the wind at 100 m altitude. It is the horizontal speed of air moving towards the east, at a height of 100 metres above the surface of the Earth. A positive value indicates eastward wind, and a negative value indicates westward wind. Typical range is -20 to 20 m/s. Measured in m/s.

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_U_WIND_COMPONENT_10_METRE module-attribute ¤

FORECAST_FEATURE_U_WIND_COMPONENT_10_METRE: ValueType

Eastward component wind at 10 m altitude. It is the horizontal speed of air moving towards the east, at a height of 10 metres above the surface of the Earth. A positive value indicates eastward wind, and a negative value indicates westward wind. Typical values are smaller than their 100 m counterparts since it is stronger influenced by local terrain, vegetation and buildings. Measured in m/s.

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_V_WIND_COMPONENT_100_METRE module-attribute ¤

FORECAST_FEATURE_V_WIND_COMPONENT_100_METRE: ValueType

Northward component wind at 100 m altitude. It is the horizontal speed of air moving towards the north, at a height of 100 metres above the surface of the Earth. A positive value indicates northward wind, and a negative value indicates southward wind. Typical range is -20 to 20 m/s. Measured in m/s.

frequenz.api.weather.weather_pb2.FORECAST_FEATURE_V_WIND_COMPONENT_10_METRE module-attribute ¤

FORECAST_FEATURE_V_WIND_COMPONENT_10_METRE: ValueType

Northward component wind at 10 m altitude. It is the horizontal speed of air moving towards the north, at a height of 100 metres above the surface of the Earth. A positive value indicates northward wind, and a negative value indicates southward wind. Typical values are smaller than their 100 m counterparts since it is stronger influenced by local terrain, vegetation and buildings. Measured in m/s.

Classes¤

frequenz.api.weather.weather_pb2.ForecastFeature ¤

Bases: _ForecastFeature

Weather features (e.g. wind speeds or solar radiation) available for query through the API.

frequenz.api.weather.weather_pb2.GetHistoricalWeatherForecastRequest ¤

Bases: Message

The GetHistoricalWeatherForecastRequest message defines parameters for retrieving historical weather forecasts, targeting a specific location and time period, with designated features.

Attributes¤
end_ts property ¤
end_ts: Timestamp

The UTC timestamp indicating the end of the requested historical forecast period.

features property ¤
features: RepeatedScalarFieldContainer[ValueType]

List of required features. If none are specified, all available features will be returned.

locations property ¤
locations: RepeatedCompositeFieldContainer[Location]

The locations for which the forecast is being requested. The maximum number of locations that can be requested is 50. If the request exceeds this limit, the API will respond with an error.

pagination_params property ¤
pagination_params: PaginationParams

The parameters define the 'page_size' and the 'page_token'. An inital query of a request will omit the 'page_token'. Subsequent queries of the same request must include the 'page_token' from the previous response.

start_ts property ¤
start_ts: Timestamp

The UTC timestamp indicating the start of the requested historical forecast period.

frequenz.api.weather.weather_pb2.GetHistoricalWeatherForecastResponse ¤

Bases: Message

The message encapsulates a collection of historical weather forecasts, each corresponding to a requested location.

Attributes¤
pagination_info property ¤
pagination_info: PaginationInfo

The pagination_info contains the number of 'total_items' in the response and the 'next_page_token' for the subsequent query of the request. It is omitted in the last response.

frequenz.api.weather.weather_pb2.LocationForecast ¤

Bases: Message

The ForecastResponse message provides a structured format for representing forecast data for a specific location, including UTC timestamps for validity and creation.

Attributes¤
creation_ts property ¤
creation_ts: Timestamp

The UTC timestamp indicating when the forecast was originally created.

forecasts property ¤
forecasts: RepeatedCompositeFieldContainer[Forecasts]

Weather forecasts.

location property ¤
location: Location

The location for which the weather data is returned.

Classes¤
Forecasts ¤

Bases: Message

Holds all weather features forecast for a certain point in time.

Attributes¤
features property ¤ 
features: RepeatedCompositeFieldContainer[FeatureForecast]

All requested weather features.

valid_at_ts property ¤ 
valid_at_ts: Timestamp

The UTC timestamp for which the features in this entry are valid for.

Classes¤
FeatureForecast ¤

Bases: Message

Holds the forecast for a single weather feature.

Attributes¤
value instance-attribute ¤ 
value: float

Value of the feature. Unit depends on the feature (e.g., m/s for wind speed, W/m² for radiation). Details can be found in the ForecastFeature enum under each feature.

frequenz.api.weather.weather_pb2.ReceiveLiveWeatherForecastRequest ¤

Bases: Message

The ReceiveLiveWeatherForecastRequest message defines parameters for requesting live weather forecasts for a specified location, with designated features.

Attributes¤
features property ¤
features: RepeatedScalarFieldContainer[ValueType]

List of required features. If none are specified, all available features will be streamed.

forecast_horizon_max instance-attribute ¤
forecast_horizon_max: int

Maximum forecast horizon (in hours) to include in the returned forecasts. If not specified, forecasts up to their maximum available horizon will be returned. If the requested horizon exceeds the available forecast data, the maximum available horizon will be used.

forecast_horizon_min instance-attribute ¤
forecast_horizon_min: int

Minimum forecast horizon (in hours) to include in the returned forecasts. Each forecast predicts weather conditions for a certain time span into the future (the forecast horizon). If not specified, forecasts starting from the earliest available horizon will be returned.

locations property ¤
locations: RepeatedCompositeFieldContainer[Location]

The locations for which the forecast is being requested. The maximum number of locations that can be requested is 50. If the request exceeds this limit, the API will respond with an error.

frequenz.api.weather.weather_pb2.ReceiveLiveWeatherForecastResponse ¤

Bases: Message

The message encapsulates a collection of live weather forecasts, each corresponding to a requested location.