Skip to content

Commit 5b41e20

Browse files
committed
change trip to on_trip
change unavailable to non_operational add system_suspend and system_resume
1 parent 6089d3d commit 5b41e20

1 file changed

Lines changed: 28 additions & 30 deletions

File tree

general-information.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -137,17 +137,17 @@ A vehicle may have one or more values from the `propulsion`, depending on the nu
137137

138138
This table describes the list of vehicle conditions that may be used by regulators to assess the disposition of individual vehicles and fleets of vehicles. Some of these states describe vehicles in the Public Right-of-Way (PROW), and others represent vehicles that are not. One state (`unknown`) implies that PROW status is unknown.
139139

140-
In a multi-jurisdiction environment, the status of a vehicle is per-jurisdiction. For example, a vehicle may be in the `trip` status for a county that contains five cities, and also in the `trip` status for one of those cities, but `elsewhere` for the other four cities. In such a condition, generally a Provider would send the device data to the over-arching jurisdiction (the county) and the vehicle state with respect to each city would be determined by the Agency managing the jurisdictions.
140+
In a multi-jurisdiction environment, the status of a vehicle is per-jurisdiction. For example, a vehicle may be in the `on_trip` status for a county that contains five cities, and also in the `on_trip` status for one of those cities, but `elsewhere` for the other four cities. In such a condition, generally a Provider would send the device data to the over-arching jurisdiction (the county) and the vehicle state with respect to each city would be determined by the Agency managing the jurisdictions.
141141

142142
| `vehicle_state` | In PROW? | Description |
143143
| --- | --- | --- |
144-
| `removed` | no | Examples include: at the Provider's warehouse, in a Provider's truck, or destroyed and in a landfill. |
145-
| `available` | yes | Available for rental via the Provider's app. In PROW. |
146-
| `unavailable` | yes | Not available for rent. Examples include: vehicle has low battery, or currently outside legal operating hours. |
147-
| `reserved` | yes | Reserved via Provider's app, waiting to be picked up by a rider. |
148-
| `trip` | yes | In possession of renter. May or may not be in motion. |
149-
| `elsewhere` | no | Outside of regulator's jurisdiction, and thus not subject to cap-counts or other regulations. Example: a vehicle that started a trip in L.A. has transitioned to Santa Monica. |
150-
| `unknown` | unknown | Provider has lost contact with the vehicle and its disposition is unknown. Examples include: taken into a private residence, thrown in river. |
144+
| `removed` | no | Examples include: at the Provider's warehouse, in a Provider's truck, or destroyed and in a landfill. |
145+
| `available` | yes | Available for rental via the Provider's app. In PROW. |
146+
| `non_operational` | yes | Not available for rent. Examples include: vehicle has low battery, or currently outside legal operating hours. |
147+
| `reserved` | yes | Reserved via Provider's app, waiting to be picked up by a rider. |
148+
| `on_trip` | yes | In possession of renter. May or may not be in motion. |
149+
| `elsewhere` | no | Outside of regulator's jurisdiction, and thus not subject to cap-counts or other regulations. Example: a vehicle that started a trip in L.A. has transitioned to Santa Monica. |
150+
| `unknown` | unknown | Provider has lost contact with the vehicle and its disposition is unknown. Examples include: taken into a private residence, thrown in river. |
151151

152152
## Vehicle Events
153153

@@ -157,38 +157,36 @@ Note that to handle out-of-order events, the validity of the prior-state shall n
157157

158158
| Valid prior `vehicle_state` values | `vehicle_state` | `event_type` | Description |
159159
| --- | --- | --- | --- |
160-
| `unavailable` | `available` | `battery_charged` | The vehicle became available because its battery is now charged. |
161-
| `unavailable` | `available` | `on_hours` | The vehicle has entered operating hours (per the regulator or per the provider) |
160+
| `non_operational` | `available` | `battery_charged` | The vehicle became available because its battery is now charged. |
161+
| `non_operational` | `available` | `on_hours` | The vehicle has entered operating hours (per the regulator or per the provider) |
162162
| `removed`, `elsewhere`, `unknown` | `available` | `provider_drop_off` | The vehicle was placed in the PROW by the provider |
163163
| `removed`, `elsewhere`, `unknown` | `available` | `agency_drop_off` | The vehicle was placed in the PROW by a city or county |
164-
| `unavailable` | `available` | `maintenance` | The vehicle was previously in need of maintenance |
165-
| `trip` | `available` | `trip_end` | A trip has ended, and the vehicle is again available for rent |
164+
| `non_operational` | `available` | `maintenance` | The vehicle was previously in need of maintenance |
165+
| `on_trip` | `available` | `trip_end` | A trip has ended, and the vehicle is again available for rent |
166166
| `reserved` | `available` | `reservation_cancel` | A reservation was canceled and the vehicle returned to service |
167-
| `trip` | `available` | `trip_cancel` | A trip was initiated, then canceled prior to moving any distance |
168-
| `unavailable`, `unknown`, `removed`, `reserved`, `elsewhere` | `available` | `unspecified` | The vehicle became available, but the provider cannot definitively (yet) specify the reason. Generally, regulator Service-Level Agreements will limit the amount of time a vehicle's last event type may be `unspecified`. |
167+
| `on_trip` | `available` | `trip_cancel` | A trip was initiated, then canceled prior to moving any distance |
168+
| `non_operational` | `available` | `system_resume` | The vehicle is available because e.g. weather suspension or temporary regulations ended |
169+
| `non_operational`, `unknown`, `removed`, `reserved`, `elsewhere` | `available` | `unspecified` | The vehicle became available, but the provider cannot definitively (yet) specify the reason. Generally, regulator Service-Level Agreements will limit the amount of time a vehicle's last event type may be `unspecified`. |
169170
| `available` | `reserved` | `reservation_start` | The vehicle was reserved for use by a customer |
170-
| `available`, `reserved` | `trip` | `trip_start` | A customer initiated a trip with this vehicle |
171-
| `elsewhere` | `trip` | `trip_enter_jurisdiction` | A vehicle on a trip entered the jurisdiction |
172-
| `trip` | `elsewhere` | `trip_leave_jurisdiction` | A vehicle on a trip left the jurisdiction |
173-
| `available` | `unavailable` | `low_battery` | The vehicle's battery is below some rentability threshold |
174-
| `available` | `unavailable` | `maintenance` | The vehicle requires some non-charge-related maintenance |
175-
| `available` | `unavailable` | `off_hours` | The vehicle has exited operating hours (per the regulator or per the Provider) |
176-
| `available` | `unavailable` | `unspecified` | The vehicle became unavailable, but he Provider cannot definitively (yet) specify the reason. |
177-
| `available`, `unavailable`, `elsewhere` | `removed` | `rebalance_pick_up` | The provider picked up the vehicle for rebalancing purposes |
178-
| `available`, `unavailable`, `elsewhere` | `removed` | `maintenance_pick_up` | The provider picked up the vehicle to service it |
171+
| `available`, `reserved` | `on_trip` | `trip_start` | A customer initiated a trip with this vehicle |
172+
| `elsewhere` | `on_trip` | `trip_enter_jurisdiction` | A vehicle on a trip entered the jurisdiction |
173+
| `on_trip` | `elsewhere` | `trip_leave_jurisdiction` | A vehicle on a trip left the jurisdiction |
174+
| `available` | `non_operational` | `low_battery` | The vehicle's battery is below some rentability threshold |
175+
| `available` | `non_operational` | `maintenance` | The vehicle requires some non-charge-related maintenance |
176+
| `available` | `non_operational` | `off_hours` | The vehicle has exited operating hours (per the regulator or per the Provider) |
177+
| `available` | `non_operational` | `system_suspend` | The vehicle is not available because of e.g. weather or temporary regulations |
178+
| `available` | `non_operational` | `unspecified` | The vehicle became unavailable, but he Provider cannot definitively (yet) specify the reason. |
179+
| `available`, `non_operational`, `elsewhere` | `removed` | `rebalance_pick_up` | The provider picked up the vehicle for rebalancing purposes |
180+
| `available`, `non_operational`, `elsewhere` | `removed` | `maintenance_pick_up` | The provider picked up the vehicle to service it |
179181
| any | `removed` | `agency_pick_up` | An agency picked up the vehicle for some reason, e.g. illegal placement |
180-
| `available`, `unavailable`, `elsewhere` | `removed` | `compliance_pick_up` | The provider picked up the vehicle because it was placed in a non-compliant location |
181-
| `available`, `unavailable`, `removed`, `elsewhere`, `unknown` | `removed` | `decommissioned` | The provider has removed the vehicle from its fleet |
182-
| `unknown`, `unavailable`, `available`, `elsewhere` | `removed` | `unspecified` | The vehicle was removed, but the provider cannot definitively (yet) specify the reason |
182+
| `available`, `non_operational`, `elsewhere` | `removed` | `compliance_pick_up` | The provider picked up the vehicle because it was placed in a non-compliant location |
183+
| `available`, `non_operational`, `removed`, `elsewhere`, `unknown` | `removed` | `decommissioned` | The provider has removed the vehicle from its fleet |
184+
| `unknown`, `non_operational`, `available`, `elsewhere` | `removed` | `unspecified` | The vehicle was removed, but the provider cannot definitively (yet) specify the reason |
183185
| any | `unknown` | `missing` | The vehicle is not at its last reported GPS location, or that location is wildly in error |
184186
| any | `unknown` | `out_of_comms` | The vehicle is unable to transmit its GPS location |
185187

186188
NOTES:
187189

188-
`trip` vs. `in_trip` vs. `on_trip`?
189-
190-
`unavailable` vs `non_operational`?
191-
192190
Should we try to handle "unlicensed movements"?
193191

194192
What's the best way to return from `unknown`?

0 commit comments

Comments
 (0)