Skip to content

Commit 375c17d

Browse files
authored
Merge pull request #558 from janedotx/1.0.0-state-transitions
Updated state transitions to account for all required unspecified and unknown situations.
2 parents db7cc30 + a5b7ab7 commit 375c17d

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

general-information.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -266,22 +266,25 @@ Vehicles can enter the `unknown` state to and from any other state with the foll
266266
| --- | --- | --- | --- |
267267
| `non_operational` | `available` | `battery_charged` | The vehicle became available because its battery is now charged. |
268268
| `non_operational` | `available` | `on_hours` | The vehicle has entered operating hours (per the regulator or per the provider) |
269-
| `removed`, `elsewhere`, `unknown` | `available` | `provider_drop_off` | The vehicle was placed in the PROW by the provider |
270-
| `removed`, `elsewhere`, `unknown` | `available` | `agency_drop_off` | The vehicle was placed in the PROW by a city or county |
269+
| `removed`, `unknown` | `available` | `provider_drop_off` | The vehicle was placed in the PROW by the provider |
270+
| `removed`, `unknown` | `available` | `agency_drop_off` | The vehicle was placed in the PROW by a city or county |
271271
| `non_operational` | `available` | `maintenance` | The vehicle was previously in need of maintenance |
272272
| `on_trip` | `available` | `trip_end` | A trip has ended, and the vehicle is again available for rent |
273273
| `reserved` | `available` | `reservation_cancel` | A reservation was canceled and the vehicle returned to service |
274274
| `on_trip` | `available` | `trip_cancel` | A trip was initiated, then canceled prior to moving any distance |
275275
| `non_operational` | `available` | `system_resume` | The vehicle is available because e.g. weather suspension or temporary regulations ended |
276276
| `unknown` | `available` | `comms_restored` | The vehicle transmitted status information after a period of being out of communication. |
277-
| `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`. |
277+
| `non_operational`, `unknown`| `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`. |
278278
| `available` | `reserved` | `reservation_start` | The vehicle was reserved for use by a customer |
279279
| `unknown` | `reserved` | `comms_restored` | The vehicle transmitted status information after a period of being out of communication. |
280+
| `unknown` | `reserved` | `unspecified` | The provider cannot definitively state how a vehicle became reserved. |
280281
| `available`, `reserved` | `on_trip` | `trip_start` | A customer initiated a trip with this vehicle |
281282
| `elsewhere` | `on_trip` | `trip_enter_jurisdiction` | A vehicle on a trip entered the jurisdiction |
282283
| `unknown` | `on_trip` | `comms_restored` | The vehicle transmitted status information after a period of being out of communication. |
284+
| `unknown` | `on_trip` | `unspecified` | The provider cannot definitively state how a vehicle started a trip. |
283285
| `on_trip` | `elsewhere` | `trip_leave_jurisdiction` | A vehicle on a trip left the jurisdiction |
284286
| `unknown` | `elsewhere` | `comms_restored` | The vehicle transmitted status information after a period of being out of communication. |
287+
| `unknown` | `elsewhere` | `unspecified` | The provider cannot definitively state how a vehicle went `elsewhere`. |
285288
| `available` | `non_operational` | `battery_low` | The vehicle's battery is below some rentability threshold |
286289
| `available` | `non_operational` | `maintenance` | The vehicle requires some non-charge-related maintenance |
287290
| `available` | `non_operational` | `off_hours` | The vehicle has exited operating hours (per the regulator or per the Provider) |
@@ -296,9 +299,11 @@ Vehicles can enter the `unknown` state to and from any other state with the foll
296299
| `available`, `non_operational`, `elsewhere`, `unknown` | `removed` | `decommissioned` | The provider has removed the vehicle from its fleet |
297300
| `unknown`, `non_operational`, `available`, `elsewhere` | `removed` | `unspecified` | The vehicle was removed, but the provider cannot definitively (yet) specify the reason |
298301
| `unknown` | `removed` | `comms_restored` | The vehicle transmitted status information after a period of being in an unknown state |
302+
| `unknown` | `removed` | `unspecified` | The provider cannot definitively state why a vehicle was removed |
303+
| `non_operational` | `removed` | `unspecified` | The provider cannot definitively state why a non-opertional vehicle was removed |
299304
| `available`, `reserved`, `on_trip`, `non_operational`, `elsewhere`, `removed` | `unknown` | `missing` | The vehicle is not at its last reported GPS location, or that location is wildly in error |
300-
| `available`, `reserved`, `on_trip`, `non_operational`, `elsewhere`, `removed` | `unknown` | `comms_lost` | The vehicle is unable to transmit its GPS location or other status information |
301-
| `available`, `non_operational` | `unknown` | `unspecified` | The provider cannot definitively (yet) specify the reason for the unknown state |
305+
| `available`, `elsewhere`, `non_operational`, `on_trip`, `removed`, `reserved` | `unknown` | `comms_lost` | The vehicle is unable to transmit its GPS location or other status information |
306+
| `available`, `elsewhere`, `non_operational`, `on_trip`, `removed`, `reserved` | `unknown` | `unspecified` | The provider cannot definitively (yet) specify the reason for the unknown state |
302307

303308
### State Machine Diagram
304309

0 commit comments

Comments
 (0)