TrafficSensor.md

TrafficSensor Object

The TrafficSensor object describes a traffic sensor deployed on a roadway which captures traffic metrics (e.g. speed, volume, occupancy) over a collection interval. The TrafficSensor can describe lane-level traffic data if available and if associated with a road event (e.g. WorkZoneRoadEvent).

The TrafficSensor is a type of field device; it has a core_details property which contains the FieldDeviceCoreDetails and exists within a FieldDeviceFeature.

Properties

Name	Type	Description	Conformance	Notes
core_details	FieldDeviceCoreDetails	The core details of the field device shared by all field devices types, not specific to traffic sensors.	Required	This property appears on all field devices.
collection_interval_start_date	String; date-time	The UTC date and time where the TrafficSensor data began being collected at. The averages and totals contained in the TrafficSensor data apply to the inclusive interval of collection_interval_start_date to collection_interval_end_date.	Required
collection_interval_end_date	String; date-time	The UTC date and time where the TrafficSensor collection interval ended. The averages and totals contained in the TrafficSensor data apply to the inclusive interval of collection_interval_start_date to collection_interval_end_date.	Required
average_speed_kph	Integer (>= 0)	The average speed of vehicles across all lanes over the collection interval in kilometers per hour.	Optional
volume_vph	Integer (>= 0)	The rate of vehicles passing by the sensor during the collection interval in vehicles per hour.	Optional
occupancy_percent	Integer (>= 0)	The percent of time the roadway section monitored by the sensor was occupied by a vehicle over the collection interval.	Optional
lane_data	Array; [TrafficSensorLaneData]	A list of objects each describing traffic data for a specific lane—each pointing to a road event lane and indiciating the metrics of that lane.	Optional	Lane-level data can only be provided if the data producer has knowledge of the road event to assign the traffic sensor lane data to.

Used By

Property	Object
properties	FieldDeviceFeature