Skip to content

Latest commit

 

History

History
160 lines (116 loc) · 18.3 KB

README.md

File metadata and controls

160 lines (116 loc) · 18.3 KB
Raw

Work Zone Data Exchange (WZDx) Specification

The Work Zone Data Exchange (WZDx) Specification aims to make harmonized work zone data provided by infrastructure owners and operators (IOOs) available for third party use, making travel on public roads safer and more efficient through ubiquitous access to data on work zone activity.

The goal of WZDx is to enable widespread access to up-to-date information about dynamic conditions occurring on roads such as construction events. Currently, many IOOs maintain data on work zone activity. However, a lack of common data standards and convening mechanisms makes it difficult and costly for third parties such as original equipment manufacturers (OEMs) and navigation applications to access and use these data across various jurisdictions. WZDx defines a common language for describing work zone information. This simplifies the design process for producers and the processing logic for consumers and makes work zone data more accessible.

Specifically, WZDx defines the structure and content of several GeoJSON documents that are each intended to be distributed as a data feed. The feeds describe a variety of high-level road work-related information such as the location and status of work zones, detours, and field devices.

README Outline

Data Feeds

WZDx defines the structure and content of multiple distinct data feeds. Each feed is distributed as a single GeoJSON file and is represented by both human-friendly documentation in the spec-content directory and a JSON Schema in /schemas. Each feed is designed for a specific use case is are flexible and its use in practice can vary by application.

List of Data Feeds

Feed Name Description Producer Consumer Uses Content
WZDxFeed Provides high-level information about events occurring on roadways (called "road events"), primarily work zones, that impact the characteristics of the roadway and involve a change from the default state (such as a lane closure). The WZDxFeed is the original work zone data exchange feed. Agencies responsible for managing roadways and road work, typically state and local DOTs. Traveling public via third parties such as mapping companies and CAVs. Route planning; increased awareness; "put work zones on the map". Work zone and detour road events (see WorkZoneRoadEvent and DetourRoadEvent).
RoadRestrictionFeed Provides information about sections of roadways that have restrictions. Restriction types described by this specification are listed in the RestrictionType enumerated type. Transportation Authorities like Tribal, Local, State, or Federal Agencies. Traveling public via third parties such as mapping companies and CAVs. Increased awareness; Route planning; Driver, Passenger, and Road-User Safety; Increased Efficiency; Reduced Damage to Infrastructure. Restriction road events (see RestrictionRoadEvent).
SwzDeviceFeed Provides information (location, status, live data) about field devices deployed on the roadway in work zones. Smart work zone equipment manufacturers or vendors. Agencies responsible for managing roadways and permitting work, typically state and local DOTs. Third-parties such as mapping companies and CAVs may also be interested in field device information. Simplifies design process for agencies wanting to interface with equipment manufacturers; aids in dynamically generating a WZDxFeed with accurate information; reduces effort for manufacturers to conform to different agencies requirements. Field devices (see FieldDeviceFeature).

Repostitory Organization

The WZDx Specification repository contains several files and subdirectories.

Directories

  1. documents: supplementary PDF and Word documents such as the WZDx Early Adopter's Guide and WZDx Data Feed Self Validation Checklist.
  2. examples: example GeoJSON documents from WZDx data feeds. examples/README.md describes the content of this directory in detail.
  3. images: the images that are referenced by other Markdown files in the repository.
  4. schemas: contains JSON Schemas for each of the feeds defined by WZDx for feed validation.
  5. spec-content: details the data content of the WZDx specification, including objects, property names and types, and enumerated types. spec-content/README.md describes the content of this directory in detail.

Files

  1. Creating_a_WZDx_Feed.md: information to assist in creating a WZDx data feed, such as the feed format, business rules, and validation tools.
  2. LICENSE: the Creative Commons Zero v1.0 Universal license that the repository is licensed under.
  3. README.md (this document): information about the WZDx effort and navigating the repository.
  4. RELEASES.md: detailed information about every release of the WZDx specification.

Project Description

What is the WZDx Specification? The Work Zone Data Exchange (WZDx) Specification enables infrastructure owners and operators (IOOs) to make harmonized work zone data available for third-party use. The intent is to make travel on public roads safer and more efficient through ubiquitous access to data on work zone activity. Specifically, the project aims to get data on work zones to vehicles to help automated driving systems (ADS) and human drivers navigate more safely.

Why is WZDx being developed? Improving access to work zone data is one of the top needs identified through the US Department of Transportation (USDOT) Data for Automated Vehicle Integration (DAVI) effort.

Up-to-date information about dynamic conditions occurring on roads – such as construction events – can help ADS and humans navigate safely and efficiently. Many IOOs maintain data on work zone activity. However, a lack of common data standards and convening mechanisms makes it difficult and costly for third parties – including original equipment manufacturers (OEMs) and navigation applications – to access and use these data across various jurisdictions.

Inspired by GTFS, USDOT launched WZDx to jumpstart the voluntary adoption of a basic work zone data specification through collaboration with data producers and data users. Longer-term, the goal is to enable collaborative maintenance and expansion of the specification to meet the emerging needs of ADS.

Who is involved in developing WZDx? The Federal Highway Administration (FHWA) and Intelligent Transportation Systems Joint Program Office (ITS JPO) co-led the early stages of the WZDx project and remain actively involved along with the Bureau of Transportation Statistics (BTS), Federal Motor Carrier Safety Administration (FMCSA), and others in the USDOT.

Several data producers and data users voluntarily developed v1.1 of the specification in collaboration with USDOT, and have set up data feeds based on the specification. These WZDx-compliant feeds and their links can be found in the Work Zone Data Exchange Feed Registry. Data producers with feeds in the registry currently include: Texas Department of Transportation (TxDOT), Massachusetts Department of Transportation (MassDOT), Maricopa County Department of Transportation (MCDOT), and Iowa Department of Transportation (IDOT).

Going forward, the Work Zone Data Working Group (WZDWG), established under the Federal Geographic Data Committee (FGDC) Transportation Subcommittee (TSC) will maintain the WZDx Specification with the goal of publishing incremental updates to refine the features, attributes, and vocabulary needed to model work zone activity data.

How can I get help with implementation? Review Creating_a_WZDx_Feed.md which contains information to assist in creating a WZDx data feed, such as the feed format, business rules, and validation tools.

This project repository will be continually updated with resources to help with implementation - in the meantime, please make a new GitHub discussion if you need help implementing the WZDx Specification or have questions.

The Federal Highway Administration is leading efforts, via the Work Zone Data Initiative (WZDI), to develop a standard approach for collecting, organizing, and sharing data on the “when”, “where,” and “how” of work zone deployment. As part of this effort, key documents have been developed and made publicly available:

  • WZDI Framework provides a conceptual architecture for work zone data systems for collecting, storing, disseminating, managing, maintaining and archiving work zone activity data.
  • WZDI Data Dictionary provides digital descriptions of work zone activities that enable and support transportation agencies and third party providers to describe and communicate work zone-related information to agency, private sector, and public users timely and seamlessly across multiple jurisdictions and regions.

Contact Information

Contact Name: ITS JPO

Contact Information: [email protected]

Release Notes

WZDx v4.0 (December 2021)

WZDx version 4.0 implements clean up and small additions in functionality to the WZDx feed and adds definitions for two new feeds, the SwzDeviceFeed and RoadRestrictionFeed. Until version 4.0, the WZDx specification defined only one feed, the WZDxFeed.

For detailed release information, see RELEASES.md

Features

  • Add values to the VehicleImpact enumerated type.
  • Allow restrictions with a value and unit to be provided at the road event level.
  • Add values to the LaneType enumerated type.
  • Define a new data feed, the RoadRestrictionFeed, to enable providing a feed of restrictions on roadways, such as bridge clearances.
  • Define a new data feed, the SwzDeviceFeed, to enable equipment vendors and manufacturers to provide high-level information about deployed field devices in work zones.
  • Rename the workers_present property on the WorkZoneRoadEvent object to worker_presence; change the type from "boolean" to a new WorkerPresence object which enables providing more nuanced information about worker presence in work zones.

Refactoring

  • Separate the v3.1 RoadEvent object into RoadEventCoreDetails (details that are shared by all specific types of road events) and specific types of road events (WorkZoneRoadEvent, DetourRoadEvent, and RestrictionRoadEvent) which each contain the RoadEventCoreDetails via a core_details property; update the RoadEventFeature properties property to be one of the specific road events types.
  • Move the location_method property from the FeedDataSource object to the WorkZoneRoadEvent object.
  • Change the reduced_speed_limit property on the WorkZoneRoadEvent to reduced_speed_limit_kph; change its type from "integer" to "number" and clarify that the value should be in kilometers per hour.
  • Deprecate the lane_number property on the Lane object.
  • Deprecate the lrs_type and lrs_url properties on the FeedDataSource object.
  • Remove the deprecated value alternating-one-way from the LaneStatus enumerated type.
  • Remove all deprecated properties from the road event (RoadEvent in previous versions; WorkZoneRoadEvent and RoadEventCoreDetails in 4.0).
  • Require the road_names property on the RoadEventCoreDetails.
  • Require the id property on the RoadEventFeature.
  • Refine the LaneType enumerated type.
  • Deprecate the location_verify_method property on the FeedDataSource.
  • Update the SpatialVerification enumerated type value descriptions to clarify that verified work zone locations should use a GPS enabled device.

Getting Started

The WZDWG welcomes feedback and comments on the WZDx v4.0 Specification. Comments can be made by posting a GitHub Issue or Discussion, while suggested changes can be made using a Pull Request.

  1. Read about WZDWG activities Wiki and the WZDx Early Adopter's Guide.
  2. Learn about using GitHub as a tool for collaboration and support.
  3. Read Creating a WZDx feed which contains information about creating a WZDx data feed, such as the feed format, business rules, and validation tools.
  4. Use the Specification Content page to understand the data components of the specification.
  5. Validate your feed output using the respective JSON Schema.
  6. Publish your feed and tell us about it via [email protected].

JSON Schemas

The WZDx Specification defines a JSON schema for each feed within the schemas directory. Schemas can be used to validate a WZDx feed document for compliance to the specification. The repository contains schemas for the following feeds:

Current Version (4.0)

Previous Version

Contributions

How do I contribute to the WZDx Specification?

  • Report bugs and request features via GitHub Issues.
  • Ask the WZDx community for input on a question or propose an idea you have via GithHub Discussions.
  • Create a GitHub Pull Request that implements new functionality or fixes a bug.
  • Review and provide feedback on update issues/discussions/pull requests created by other users.
  • Alternatively, email us with any questions.
  • Help us improve our best practices and formatting on GitHub.

Versioning

The WZDx specification uses a major.minor versioning scheme, similar to SemVer. The rules are as follows:

  1. The minor version number must be incremented if new, backwards compatible fields/entities/enumerations are introduced or if any existing fields/entities/enumerations are marked as deprecated.
  2. The major version number must be incremented if any backwards incompatible changes are introduced.
  3. Neither version number shall be incremented for documentation changes/clarifications that have no effect on either the specification schema or the content or structure of a GeoJSON feed file which conforms to the specification.

To view available versions, refer to the tags section of this repository.

License

The WZDx project is in the worldwide public domain (i.e., in the public domain within the United States - copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication). All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with the waiver of copyright interest. see License for more details.