usdot-jpo-ode / wzdx

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.
Creative Commons Zero v1.0 Universal
89 stars 62 forks source link

Consider conformance of HybridSign static text #275

Open j-d-b opened 2 years ago

j-d-b commented 2 years ago

Background

Currently, the static_sign_text property on the HybridSign object is optional. The property is described as:

The static text on the non-electronic component of the hybrid sign.

Issue

Members have asked several times why the static_sign_text is optional, and I couldn't find an answer in the specification documentation or my meeting notes. This issue seeks to start discussion that could lead to requiring this property in a future release.

Discussion

j-d-b commented 2 years ago

For some initial thoughts:

Generally, WZDx tries to only make properties required that are critical to processing the data. For a hybrid sign, the only required property is dynamic_message_function, which is defined as:

The function the dynamic message displayed (e.g. a speed limit).

This can have a value of speed-limit, travel-time, or other. With speed-limit, the static_sign_text is not needed to know if what dynamic_message_text is used for. Perhaps this is why it is optional.

sergebeaudry commented 2 years ago

I agree that this could be required. I only see cases where some text exist on those. Speed Limit, Travel Time, height limit, width limit, etc....... Even the dynamic_message_text might be required with potential to call it blanked

j-d-b commented 2 years ago

Based on SWZ subgroup co-chairs discussion, static_sign_text should be required. Thus the proposed change in the meantime is to indicate in the documentation that the property will be required in a future release.

This issue will remain open until v5.0, when the property can be required.

tfoster-vm commented 2 years ago

Could it stay open for being required in v5.0 and also be added still be added as optional until v5.0?