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

Standardise all sensors to report distances in meters (encoder is currently in cm) #2

Open
BjAlvestad opened this issue Jun 5, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@BjAlvestad
Copy link
Owner

In the main program, the public properties in Encoder classes exposes distance values as centimeters, while the other sensors utilizes meters.
This may cause confustion for the people writing control logics for the vehicle.

Two alternative options that would fix the issue:

Option 1:

  • Add aditional metod reporting distance in meters (in addition to cm).
    This would mean an increment of the minor version (new functionality but no breaking change).

Option 2

  • Change methods in main program to utilize values as meters instead of centimeters.
  • Modify the Encoder page and overview page to also reflect these changes (the displayed units).
    This would mean an increment of the major version (breaking change for code allready using data from the encoders).

PS:
The microcontroller should still transfere the distance as centimeters and a whole number.
The change should only be carried out in the main program (dividing the received distance by 100).

PPS:
The versioning refered to above in the two options is based on Semantic Versioning 2.0.0

@BjAlvestad BjAlvestad added the enhancement New feature or request label Jun 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant