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

Add 'located' event_type from 'Unknown' for symmetry with 'missing' #566

Closed
schnuerle opened this issue Aug 25, 2020 · 5 comments · Fixed by #570
Closed

Add 'located' event_type from 'Unknown' for symmetry with 'missing' #566

schnuerle opened this issue Aug 25, 2020 · 5 comments · Fixed by #570
Assignees
Labels
Schema Implications for JSON Schema or OpenAPI State Machine Changes in the vehicle state events and state machine diagram
Milestone

Comments

@schnuerle
Copy link
Member

schnuerle commented Aug 25, 2020

Is your feature request related to a problem? Please describe.

With the 1.0.0rc, devices can go into Unknown from any state with 'missing'. And they can leave Unknown with 'comms_restored' and 'unspecified' to any state, and to some states with a few other event_types. But there is not a clear way to designate a device was located after having gone missing.

Describe the solution you'd like

Would like to add 'located' event_type just out of Unknown. I can update the docs and the state machine diagram.

Is this a breaking change

  • No, not breaking

Impacted Spec

  • agency
  • policy
  • provider

Describe alternatives you've considered

Leave out 'located'. Could be called 'found' but 'located' seems more precise/consistent with other language. Eg lost and found, vs missing and located.

Additional context

Note this could be left for the 1.1.0 release if there is not consensus now.

@schnuerle schnuerle added this to the 1.0.0 milestone Aug 25, 2020
@schnuerle schnuerle added the State Machine Changes in the vehicle state events and state machine diagram label Aug 25, 2020
@schnuerle schnuerle self-assigned this Aug 25, 2020
@marie-x
Copy link
Collaborator

marie-x commented Aug 25, 2020

Yes please

@schnuerle
Copy link
Member Author

I'd like some feedback on this from providers and other experts, like @dirkdk @joshuaandrewjohnson1 @Karcass @bhandzo. This seems like a good thing to add, but want to make sure that it makes sense to you.

@schnuerle schnuerle added the Schema Implications for JSON Schema or OpenAPI label Aug 26, 2020
@schnuerle
Copy link
Member Author

schnuerle commented Aug 26, 2020

For the state machine diagram, the language at the bottom would be updated from this:

Unknown Events (not shown in diagram):

  • Any state can go to Unknown with event_type comms_lost, missing, unspecified
  • Unknown can go to any state with event_type comms_restored, unspecified

To this (see emphasis for the addition in the new text):

Unknown Events (not shown in diagram):

  • Any state can go to Unknown with event_type comms_lost, missing, unspecified
  • Unknown can go to any state with event_type comms_restored, located, unspecified

@dirkdk
Copy link
Contributor

dirkdk commented Aug 27, 2020

yes sounds good. Sometimes location might be transmitted but off so untraceable , or vehicle is unreachable (in house of private person). It makes sense to distinguish between comms_restored and located.

@schnuerle schnuerle linked a pull request Aug 28, 2020 that will close this issue
@schnuerle
Copy link
Member Author

Thanks for the feedback here and via the working group mailing list and elsewhere. PR #570 is complete and merged for the 1.0.0 release.

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

Successfully merging a pull request may close this issue.

3 participants