search

goecharger / go-eCharger-API-v1

API specification for V2 go-eCharger (compatible with V3 too)
100 stars 26 forks source link

Naming convention is inefficient #107

Closed aop closed 2 years ago

aop commented 2 years ago

I know this is not a real issue as such but I found this so horrific I had to comment.

Why on earth would anyone name their parameters as shortened versions? Why is the "reboot_counter" parameter rbc? It's not like we live in the age of dial-up modems where we need to save some bandwidth. I at least have my device over a 700MBps Wifi connection.

What takes time though is to either learn, or constantly check, what the parameters mean. From a developer point of view it is a lot easier to work with

{
   'allow_charging': true
}

than this

{
   'alw': 1
}

So I don't know who does the API designing but (s)he clearly is not very into proper naming conventions.

Adminius commented 1 year ago

I know, it's closed... but: heard of the goE charger is a ESP8266 (at least HW V2) It doen't have to much RAM to hold all the long strings in a JSON... so the easiest way is to short all the names.