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

Refactor protobuf messages out to _msgs package #6

Open
3 tasks
mabelzhang opened this issue Sep 22, 2021 · 3 comments
Open
3 tasks

Refactor protobuf messages out to _msgs package #6

mabelzhang opened this issue Sep 22, 2021 · 3 comments
Labels
good first issue Good for newcomers

Comments

@mabelzhang
Copy link
Collaborator

mabelzhang commented Sep 22, 2021

Tasks in this ticket, elaborated below.

Refactor to lrauv_msgs

As discussed here #82 (comment) , there is a circular dependency between lrauv-application (MBARI repo) and lrauv_ignition_plugins package.
MBARI repo depends on the compiled protobuf message headers in lrauv_ignition_plugins.
lrauv_ignition_plugins depends on the MBARI repo for automated mission tests.

Verbally, we agreed on refactoring the custom protobuf messages to a lrauv_msgs package.
Then lrauv-application would depend on lrauv_msgs.
lrauv_ignition_plugins would depend on lrauv_msgs and lrauv-application.
That solves the circular dependency.

Style of field names

As discussed here #90 (comment) , we want to eliminate the trailing underscores of the field names, and to change to snake_case.

This applies to LRAUVState, LRAUVCommand, and LRAUVInit.

@chapulina
Copy link
Contributor

Another question about messages, do the non-action fields of LRAUVCommand ever get used? i.e.

https://github.com/osrf/lrauv/blob/9c73845d3d71e60916816a8dedd3a3ba6e7187b4/lrauv_ignition_plugins/proto/lrauv_command.proto#L35-L41

@mabelzhang
Copy link
Collaborator Author

mabelzhang commented Oct 14, 2021

dropWeightState_ is used. That's the only field for drop weight – it doesn't have an action field. It's a state as opposed to an action because on the real vehicle, it's an indicator meaning "it's been dropped. Goner."

The 5 other fields, if I remember correctly, are what the MBARI controller thinks the positions of the actuators are. The Ignition side doesn't use those at the moment. They become useful if there is a mismatch between where the controller thinks the actuators are, and where the simulator's state thinks the actuators are, which can be due to time sync issues, physics instability at a very fast time step, etc.
@braanan can correct me.

@braanan
Copy link
Collaborator

braanan commented Oct 14, 2021

All true. Thanks, @mabelzhang

@chapulina chapulina transferred this issue from another repository Nov 2, 2021
@mabelzhang mabelzhang added the good first issue Good for newcomers label Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants