|
8 | 8 |
|
9 | 9 |
|
10 | 10 | class FieldDeviceCoreDetails(BaseModel): |
11 | | - device_type: FieldDeviceType = Field(alias="device_type") |
12 | | - data_source_id: str = Field(alias="data_source_id") |
13 | | - device_status: FieldDeviceStatus = Field(alias="device_status") |
14 | | - update_date: datetime = Field(alias="update_date") |
15 | | - has_automatic_location: bool = Field(alias="has_automatic_location") |
16 | | - road_direction: Optional[Direction] = Field(None, alias="road_direction") |
17 | | - road_names: Optional[list[str]] = Field(None, alias="road_names") |
18 | | - name: Optional[str] = Field(None, alias="name") |
19 | | - description: Optional[str] = Field(None, alias="description") |
20 | | - status_messages: Optional[list[str]] = Field(None, alias="status_messages") |
21 | | - is_moving: Optional[bool] = Field(None, alias="is_moving") |
22 | | - road_event_ids: Optional[list[str]] = Field(None, alias="road_event_ids") |
23 | | - milepost: Optional[float] = Field(None, alias="milepost") |
24 | | - make: Optional[str] = Field(None, alias="make") |
25 | | - model: Optional[str] = Field(None, alias="model") |
26 | | - serial_number: Optional[str] = Field(None, alias="serial_number") |
27 | | - firmware_version: Optional[str] = Field(None, alias="firmware_version") |
28 | | - velocity_kph: Optional[float] = Field(None, alias="velocity_kph") |
| 11 | + """ |
| 12 | + 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. |
| 13 | + 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 |
| 14 | + property on every specific type of field device, each represented by its own object. |
| 15 | +
|
| 16 | + Documentation: https://github.com/usdot-jpo-ode/wzdx/blob/develop/spec-content/objects/FieldDeviceCoreDetails.md |
| 17 | + """ |
| 18 | + |
| 19 | + device_type: FieldDeviceType = Field( |
| 20 | + alias="device_type", description="The type of field device." |
| 21 | + ) |
| 22 | + data_source_id: str = Field( |
| 23 | + alias="data_source_id", |
| 24 | + description="Identifies the data source from which the field device data originates.", |
| 25 | + ) |
| 26 | + device_status: FieldDeviceStatus = Field( |
| 27 | + alias="device_status", |
| 28 | + description="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.", |
| 29 | + ) |
| 30 | + update_date: datetime = Field( |
| 31 | + alias="update_date", |
| 32 | + description="The UTC time and date when the field device information was updated.", |
| 33 | + ) |
| 34 | + has_automatic_location: bool = Field( |
| 35 | + alias="has_automatic_location", |
| 36 | + description="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).", |
| 37 | + ) |
| 38 | + road_direction: Optional[Direction] = Field( |
| 39 | + None, |
| 40 | + alias="road_direction", |
| 41 | + description="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.", |
| 42 | + ) |
| 43 | + road_names: Optional[list[str]] = Field( |
| 44 | + None, |
| 45 | + alias="road_names", |
| 46 | + description="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).", |
| 47 | + ) |
| 48 | + name: Optional[str] = Field( |
| 49 | + None, alias="name", description="A human-readable name for the field device." |
| 50 | + ) |
| 51 | + description: Optional[str] = Field( |
| 52 | + None, alias="description", description="A description of the field device." |
| 53 | + ) |
| 54 | + status_messages: Optional[list[str]] = Field( |
| 55 | + None, |
| 56 | + alias="status_messages", |
| 57 | + description="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.", |
| 58 | + ) |
| 59 | + is_moving: Optional[bool] = Field( |
| 60 | + None, |
| 61 | + alias="is_moving", |
| 62 | + description="A yes/no value indicating if the device is actively moving (not statically placed) as part of a mobile work zone operation.", |
| 63 | + ) |
| 64 | + road_event_ids: Optional[list[str]] = Field( |
| 65 | + None, |
| 66 | + alias="road_event_ids", |
| 67 | + description="A list of one or more IDs of a RoadEventFeature that the device is associated with.", |
| 68 | + ) |
| 69 | + milepost: Optional[float] = Field( |
| 70 | + None, |
| 71 | + alias="milepost", |
| 72 | + description="The linear distance measured against a milepost marker along a roadway where the device is located.", |
| 73 | + ) |
| 74 | + make: Optional[str] = Field( |
| 75 | + None, alias="make", description="The make or manufacturer of the device." |
| 76 | + ) |
| 77 | + model: Optional[str] = Field( |
| 78 | + None, alias="model", description="The model of the device." |
| 79 | + ) |
| 80 | + serial_number: Optional[str] = Field( |
| 81 | + None, alias="serial_number", description="The serial number of the device." |
| 82 | + ) |
| 83 | + firmware_version: Optional[str] = Field( |
| 84 | + None, |
| 85 | + alias="firmware_version", |
| 86 | + description="The version of firmware the device is using to operate.", |
| 87 | + ) |
| 88 | + velocity_kph: Optional[float] = Field( |
| 89 | + None, |
| 90 | + alias="velocity_kph", |
| 91 | + description="The velocity of the device in kilometers per hour.", |
| 92 | + ) |
0 commit comments