Skip to content

Latest commit

 

History

History
36 lines (34 loc) · 4.01 KB

FieldDeviceCoreDetails.md

File metadata and controls

36 lines (34 loc) · 4.01 KB
Raw

FieldDeviceCoreDetails Object

The FieldDeviceCoreDetails object represents the core details—both configuration and current state—of a field device that are shared by all types of field devices. The FieldDeviceCoreDetails object cannot occur directly in a data feed and does not represent a field device on its own. It is used as the value of the core_details property on every specific type of field device, each represented by its own object.

Properties

Name Type Description Conformance Notes
device_type FieldDeviceType The type of field device. Required
data_source_id String Identifies the data source from which the field device data originates. Required Please see Business Rule #4.
device_status FieldDeviceStatus The operational status of the field device. The value of this property indicates if the device is ok or in an error or warning state. Required
update_date String; date-time The UTC time and date when the field device information was updated. Required Please see Business Rule #5.
has_automatic_location Boolean A yes/no value indicating if the field device location (parent FieldDeviceFeature's geometry) is determined automatically from an onboard GPS (true) or manually set/overridden (false). Required
road_direction Direction The direction of the road that the field device is on. This value indicates the direction of the traffic flow of the road, not a real heading angle. Optional
road_names Array; [String] A list of publicly known names of the road on which the device is located. This may include the road number designated by a jurisdiction such as a county, state or interstate (e.g. I-5, VT 133). Optional
name String A human-readable name for the field device. Optional
description String A description of the field device. Optional
status_messages Array; [String] A list of messages associated with the device's status, if applicable. Used to provide additional information about the status such as specific warning or error messages. Optional The content of this property is up to the producer.
is_moving Boolean A yes/no value indicating if the device is actively moving (not statically placed) as part of a mobile work zone operation. Optional The is_moving property is optional and should not be provided if it is not known if the device is moving.
road_event_ids Array; [String] A list of one or more IDs of a RoadEventFeature that the device is associated with. Optional
milepost Number The linear distance measured against a milepost marker along a roadway where the device is located. Optional
make String The make or manufacturer of the device. Optional
model String The model of the device. Optional
serial_number String The serial number of the device. Optional
firmware_version String The version of firmware the device is using to operate. Optional
velocity_kph Number The velocity of the device in kilometers per hour. Optional

Used By

Property Object
core_details ArrowBoard
core_details Camera
core_details DynamicMessageSign
core_details FlashingBeacon
core_details HybridSign
core_details LocationMarker
core_details TrafficSensor
core_details TrafficSignal