Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'maintenance' event has two different definitions #595

Closed
vilesa1 opened this issue Nov 3, 2020 · 9 comments
Closed

'maintenance' event has two different definitions #595

vilesa1 opened this issue Nov 3, 2020 · 9 comments
Labels
State Machine Changes in the vehicle state events and state machine diagram
Milestone

Comments

@vilesa1
Copy link
Contributor

vilesa1 commented Nov 3, 2020

Hello

As per: https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/general-information.md#vehicle-states

'maintenance' is defined as a transition (1) from 'available' state to 'non_operational' state ("The vehicle requires some non-charge-related maintenance")

however it seems to be also: a transition (2) from 'non_operational' state to 'available' ("The vehicle was previously in need of maintenance")

issues:

  • two events have the same name but mean different things. Shouldn't the (2) be called "maintenance_end" for example, to distinguish with the other?
  • in any case "maintenance" is vague, and is not consistent with the other events being verbs (e.g. trip_end)

thanks!
vic

@marie-x
Copy link
Collaborator

marie-x commented Nov 6, 2020

Yep, it's a little ambiguous. I'm not sure why nobody flagged it during the 1.0 release process. We could fix it, but it would be a breaking change. Since you get to specify the reason (maintenance) as well as the state (available, non_operational), you can still disambiguate them.

@schnuerle schnuerle added this to the 2.0.0 milestone Nov 9, 2020
@schnuerle schnuerle added the State Machine Changes in the vehicle state events and state machine diagram label Nov 18, 2020
@pierre-bouffort
Copy link
Collaborator

Very old topic here, reviving it right now. We had discussions regarding this topic in NYC with the operators there. Eventually, what the outcome of the discussion was is the following:

  • maintenance events are dedicated to "street maintenance", meaning quick actions performed by operators on their scooters as they go to them on the street. This is why they would point to the non operational status
  • maintenance pick up events are dedicated to "workshop maintenance", meaning That the scooter is removed from the street to undergo specific work from the operations teams. This is why they would point to the removed status

It is kind of written in the spec, but not that clearly... Maybe a simple clarification in the definition of those events could be enough ?

@schnuerle
Copy link
Member

If anyone could create the recommended wording clarification change here or in a PR, that would help move this forward.

@pierre-bouffort
Copy link
Collaborator

pierre-bouffort commented Dec 19, 2022

Here is a proposal Michael:

maintenance - General maintenance that doesn't need to be performed in operator's facilities.
maintenance_pick_up - Pick for maintenance that has to be performed in operator's facilities.

@schnuerle
Copy link
Member

This seems a bit related to the removal of the unknown state drafted by @jean-populus which means to clarify if a vehicle is in the PROW or not: #814

I think that's what @pierre-bouffort is getting at with his suggestion, that some maintenance stays in the PROW, and some goes back to a warehouse out of PROW, and that's an important distinction.

I feel that @vilesa1 is saying more that maintenance could be used to mean going into maintenance or returning from maintenance, which is why @marie-x said the resulting state already can clarify this.

So the initial issue seems to be resolved, but Pierre is suggesting a fix to a related issue, right?

@schnuerle
Copy link
Member

Can @marie-x confirm that this issue will be resolved?

@marie-x
Copy link
Collaborator

marie-x commented Jan 9, 2023

This is in the modes work rather than the agency/provider work - someone (could be me) should audit the modes docs.

@schnuerle
Copy link
Member

I'll add this as an update to the spec when working on the 2.0 release candidate. Approved by the WGSC.

@schnuerle
Copy link
Member

This has been added to the dev branch. See it listed in the event types file, and for each mode, eg, micromobility.

Descriptions are generic but adequate.

maintenance General maintenance
maintenance_pick_up Pick up for maintenance

But should they be updated to

maintenance - General maintenance that doesn't need to be performed in operator's facilities.
maintenance_pick_up - Pick for maintenance that has to be performed in operator's facilities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
State Machine Changes in the vehicle state events and state machine diagram
Projects
None yet
Development

No branches or pull requests

4 participants