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

Rename Catena4802::ReadVin (or remove it) #341

Open
terrillmoore opened this issue Jul 12, 2022 · 0 comments
Open

Rename Catena4802::ReadVin (or remove it) #341

terrillmoore opened this issue Jul 12, 2022 · 0 comments
Assignees
Labels

Comments

@terrillmoore
Copy link
Member

A spurious API was added for the Catena4802, "read vin". This is reading vbat. We never know whether a battery voltage is a actually a battery, renaming was a bad idea because it breaks compatibilty. Futhermore, ReadVin implies that it's an arbitrary analog voltage. It's a bad name if we're actually reading a supply voltage. Since it's reading Catena480x::ANALOG_CHANNEL_VBAT, it is clear that either the name of the channel is wrong or the name of the API.

Solution:

  • Deprecate ReadVin immediately
  • Replace with "ReadVbat" (and implement by calling) the ReadVbat used by other other Catenas;
  • Remove ReadVin remove in next major version.
@terrillmoore terrillmoore self-assigned this Jul 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant