EdgeTX / edgetx

EdgeTX is the cutting edge open source firmware for your R/C radio
https://edgetx.org
GNU General Public License v2.0
1.63k stars 343 forks source link

make functionSwitchConfig less cryptic in yaml file #4913

Open arkarkark opened 7 months ago

arkarkark commented 7 months ago

Is there an existing issue for this feature request?

Is your feature request related to a problem?

currently parts of the yaml file are easy to understand and even update outside of the radio or companion. One area where they are decidedly complex and cryptic are the switches (like the six above the screen on a t-pro). There is a section titled switchNames which works well, but if you are trying to work out if the switches are 2POS or Toggle then you need to decrpt the functionSwitchConfig integer which is not very intuitive.

Describe the solution you'd like

perhaps ditch switchNames and replace it with a switches: array and each element in the array can have a name and also a type (and add start, group and alwaysOn

I'm not sure how much version downgrading/backward compatibility you are aiming for in the yml files.

Describe alternatives you've considered

you could keep switchNames and functionSwitchConfig and add in the switches section and update BOTH for a while so people can move back a version and then finally remove functionSwitchConfig in a later version.

Additional context

No response

raphaelcoeffic commented 7 months ago

I'm not sure how much version downgrading/backward compatibility you are aiming for in the yml files.

The common rule in this project is:

So, if this is changed, it will be a one-way street only. Otherwise the data model is too hard to maintain.