"Micromobility" refers to single-occupancy modes of docked or dockless transportation such as e-scooters, e-bikes, and human-powered bikes.
See the modes overview for how the mode specific information below applies across MDS.
The short name identifier for Micromobility used across MDS is micromobility.
The journey_id field is not used in this mode. Trips are point-to-point.
The journey_attributes array is not used in this mode.
Required in events if event_types contains trip_start, trip_end, trip_cancel, trip_enter_jurisdiction, or trip_leave_jurisdiction.
The trip_type field may have one of the following values:
rider: a single rider is taking a triprebalance: vehicle ridden by operator to rebalancemaintenance: vehicles ridden by operator to perform maintenance or check operation
The trip_attributes array is not used in this mode.
See more available trip attributes for any mode in the trips endpoint.
The fare_attributes array is not used in this mode.
See more available fare attributes for any mode in the trips endpoint.
The vehicle_attributes array may have the following key value pairs:
year(integer, optional)make(string, optional)model(string, optional)
See more available vehicle attributes for any mode in the vehicles endpoint.
This accessibility_options enum represents the accessibility options available on a given vehicle, or the accessibility options utilized for a given trip.
accessibility_options |
Description |
|---|---|
adaptive |
This vehicle is accessible to people with various physical disabilities, and may include three wheels or be self balancing, a seat, or a basket or storage area |
Valid micromobility vehicle states are
removedavailablenon_operationalreservedon_tripelsewhereunknown
See Vehicle States for descriptions.
Valid micromobility vehicle event types are
agency_drop_offagency_pick_upbattery_chargedbattery_lowcomms_lostcomms_restoredcompliance_pick_updecommissionedlocatedmaintenancemaintenance_pick_upmissingoff_hourson_hoursprovider_drop_offrebalance_pick_upreservation_cancelreservation_startsystem_resumesystem_suspendtrip_canceltrip_endtrip_enter_jurisdictiontrip_leave_jurisdictiontrip_startunspecified
Note that providers should make best-effort to map their business logic onto these states, which are meant to provide a view of the fleet to an agency. But if an agency does not perform agency_drop_off or agency_pick_up, for example, they need not be included in the parovider's implementation.
See vehicle Event Types for descriptions.
This is the list of vehicle_state and event_type pairings that constitute the valid transitions of the vehicle state machine.
The state-transition table below describes how the vehicle_state changes in response to each event_type. Most events will have a single event_type. However, if a single event has more than one ordered event_type entry, the intermediate vehicle_state value(s) are discarded. For example, if an event contains [trip_end, battery_low] then the vehicle transitions from on_trip through available to non_operational per the state machine, but the vehicle is never "in" the available state.
Note that to handle out-of-order events, the validity of the prior-state shall not be enforced at the time of ingest via Provider or Agency. Events received out-of-order may result in transient incorrect vehicle states.
Vehicles can enter the unknown state to and from any other state with the following event types: any state can go to unknown with event type comms_lost, missing, or unspecified, and unknown can go to any state with event type comms_restored of unspecified.
Valid prior vehicle_state values |
vehicle_state |
event_type |
Description |
|---|---|---|---|
non_operational |
available |
battery_charged |
The vehicle became available because its battery is now charged. |
non_operational |
available |
on_hours |
The vehicle has entered operating hours (per the regulator or per the provider) |
removed, unknown |
available |
provider_drop_off |
The vehicle was placed in the PROW by the provider |
removed, unknown |
available |
agency_drop_off |
The vehicle was placed in the PROW by a city or county |
non_operational |
available |
maintenance |
The vehicle was previously in need of maintenance |
on_trip |
available |
trip_end |
A trip has ended, and the vehicle is again available for rent |
reserved |
available |
reservation_cancel |
A reservation was canceled and the vehicle returned to service |
on_trip |
available |
trip_cancel |
A trip was initiated, then canceled prior to moving any distance |
non_operational |
available |
system_resume |
The vehicle is available because e.g. weather suspension or temporary regulations ended |
unknown |
available |
comms_restored |
The vehicle transmitted status information after a period of being out of communication. |
unknown |
available |
located |
The vehicle has been located by the provider |
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. |
available |
reserved |
reservation_start |
The vehicle was reserved for use by a customer |
unknown |
reserved |
comms_restored |
The vehicle transmitted status information after a period of being out of communication. |
unknown |
reserved |
located |
The vehicle has been located by the provider |
unknown |
reserved |
unspecified |
The provider cannot definitively state how a vehicle became reserved. |
available, reserved |
on_trip |
trip_start |
A customer initiated a trip with this vehicle |
elsewhere |
on_trip |
trip_enter_jurisdiction |
A vehicle on a trip entered the jurisdiction |
unknown |
on_trip |
comms_restored |
The vehicle transmitted status information after a period of being out of communication. |
unknown |
on_trip |
located |
The vehicle has been located by the provider |
unknown |
on_trip |
unspecified |
The provider cannot definitively state how a vehicle started a trip. |
on_trip |
elsewhere |
trip_leave_jurisdiction |
A vehicle on a trip left the jurisdiction |
on_trip |
on_trip |
changed_geographies |
Beta feature: Yes (as of 1.1.0). The vehicle has entered or left one or more Geographies managed by a Policy. See Geography Driven Events. |
unknown |
elsewhere |
comms_restored |
The vehicle transmitted status information after a period of being out of communication. |
unknown |
elsewhere |
located |
The vehicle has been located by the provider |
unknown |
elsewhere |
unspecified |
The provider cannot definitively state how a vehicle went elsewhere. |
available |
non_operational |
battery_low |
The vehicle's battery is below some rentability threshold |
available |
non_operational |
maintenance |
The vehicle requires some non-charge-related maintenance |
available |
non_operational |
off_hours |
The vehicle has exited operating hours (per the regulator or per the Provider) |
available |
non_operational |
system_suspend |
The vehicle is not available because of e.g. weather or temporary regulations |
available, unknown |
non_operational |
unspecified |
The vehicle became unavailable, but the Provider cannot definitively (yet) specify the reason. |
unknown |
non_operational |
comms_restored |
The vehicle transmitted status information after a period of being out of communication |
unknown |
non_operational |
located |
The vehicle has been located by the provider |
available, non_operational, elsewhere |
removed |
rebalance_pick_up |
The provider picked up the vehicle for rebalancing purposes |
available, non_operational, elsewhere |
removed |
maintenance_pick_up |
The provider picked up the vehicle to service it |
available, non_operational, elsewhere, unknown |
removed |
agency_pick_up |
An agency picked up the vehicle for some reason, e.g. illegal placement |
available, non_operational, elsewhere |
removed |
compliance_pick_up |
The provider picked up the vehicle because it was placed in a non-compliant location |
available, non_operational, elsewhere, unknown |
removed |
decommissioned |
The provider has removed the vehicle from its fleet |
unknown, non_operational, available, elsewhere |
removed |
unspecified |
The vehicle was removed, but the provider cannot definitively (yet) specify the reason |
unknown |
removed |
comms_restored |
The vehicle transmitted status information after a period of being in an unknown state |
unknown |
removed |
located |
The vehicle has been located by the provider |
available, elsewhere, non_operational, on_trip, removed, reserved |
unknown |
missing |
The vehicle is not at its last reported GPS location, or that location is wildly in error |
available, elsewhere, non_operational, on_trip, removed, reserved |
unknown |
comms_lost |
The vehicle is unable to transmit its GPS location or other status information |
available, elsewhere, non_operational, on_trip, removed, reserved |
unknown |
unspecified |
The provider cannot definitively (yet) specify the reason for the unknown state |
This State Machine Diagram shows how vehicle_state and event_type relate to each other and how vehicles can transition between states. See Google Slides for the source file.
