mcci-catena / Catena-Arduino-Platform

Arduino platform library for MCCI Catena IoT Systems
MIT License
12 stars 11 forks source link

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

Open terrillmoore opened 1 year ago

terrillmoore commented 1 year ago

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: