v1.5.0
February 2026
v1.4.3 → v1.5.0
Summary
This release introduces new route customization options for path plan generation, adds support for cross-hatch patterns, and includes minor parameter naming improvements for consistency.
New Features
1. Advanced Path Plan Options
The `POST /api/path-plans/direct` and `POST /api/path-plans/direct/geojson` endpoints now support an `options` parameter for enabling advanced features.
Supported Options
| Option | Description |
|---|---|
useCrossHatches |
Enable cross-hatch patterns for better coverage visualization |
excludePassable |
Exclude passable areas from the path plan |
extendTracks |
Enable track extension to cover more area |
Example
{
"boundary": { ... },
"equipment": { ... },
"exteriorHeadlandPasses": 2,
"options": "useCrossHatches,extendTracks"
}
2. Route Customization Options
A new `routeOptions` object provides fine-grained control over route generation behavior.
Properties
| Property | Type | Description |
|---|---|---|
startPointNodeIndex |
integer | Start node index for the route |
endPointNodeIndex |
integer | End node index for the route |
algorithm |
string | Optimization algorithm to use |
skipCount |
integer | Tracks to skip (for clusteredSpiral algorithm) |
enableHeadlandDrivethrough |
boolean | Force straight connectors through headlands |
headlandsFirst |
boolean | Process exterior headlands before inner tracks |
calculateRefillPoints |
boolean | Calculate refill points along the route |
stagingArea |
[lon, lat] | WGS84 coordinates for staging area |
refillStrategyType |
string | Refill placement: Exact, StartOfTrack, ClosestExternalHeadland |
maxOptimizerTime |
integer | Maximum optimizer time in seconds (default: 10) |
forcedDirection |
enum | Force winding direction (CW, CCW) |
Example
{
"boundary": { ... },
"equipment": { ... },
"exteriorHeadlandPasses": 2,
"routeOptions": {
"algorithm": "clusteredSpiral",
"skipCount": 2,
"headlandsFirst": true,
"calculateRefillPoints": true,
"refillStrategyType": "StartOfTrack",
"maxOptimizerTime": 15
}
}
3. New Response Fields
The path plan response now includes additional data when specific options are enabled.
| Property | Condition | Description |
|---|---|---|
crosshatches |
When `useCrossHatches` option is used | Cross-hatch extension points for coverage visualization |
New Schemas
| Schema | Description |
|---|---|
RouteApiOptions |
Route customization options for path plan requests |
Crosshatch |
Cross-hatch extension data for coverage visualization |
GuidanceGeometryType |
Enum for guidance geometry types (Track, ExteriorHeadland, InteriorHeadland) |
SmoothingStrategyType |
Enum for line smoothing strategies |
Migration Guide
Using new features
- 1 **Cross-hatches:** Add `"options": "useCrossHatches"` to your path plan request and read `crosshatches` from the response.
- 2 **Route Customization:** Add a `routeOptions` object to your request with the desired settings.
Questions?
For questions about these API changes, please contact [email protected] or refer to the API documentation.