OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
weather.route_weather Namespace Reference

Arrival-time forecasts sampled along an active route. More...

Classes

class  RouteWeatherProvider
 Fetch a single batch of hourly forecasts in UTC for route checkpoints. More...
 

Functions

tuple[RouteCheckpoint,...] sample_route (RouteResult route, datetime departure, float progress=0)
 Sample up to six remaining checkpoints using maneuver travel times.
 

Detailed Description

Arrival-time forecasts sampled along an active route.

Function Documentation

◆ sample_route()

tuple[RouteCheckpoint, ...] weather.route_weather.sample_route ( RouteResult  route,
datetime  departure,
float   progress = 0 
)

Sample up to six remaining checkpoints using maneuver travel times.

Progress is a fraction of total route distance. Arrival times are estimates from the calculated route, without live traffic or planned stops.