CUSTOM serial and MIDI creation MACRO's

FortySevenEffects / arduino_midi_library

MIDI for Arduino

MIT License

1.56k stars 252 forks source link

CUSTOM serial and MIDI creation MACRO's #286

Open lathoub opened 2 years ago

lathoub commented 2 years ago

MIDI_CREATE_CUSTOMSERIAL_INSTANCE: both overwritten serial and MIDI settings
MIDI_CREATE_SPECIAL_INSTANCE: overwritten serial settings (overwritten MIDI settings MACRO already exists)

coveralls commented 2 years ago

Coverage remained the same at 99.625% when pulling 28b98cc0044d3bb82bf87853f48b347d617969a3 on create_CUSTOM_INSTANCE into 2d64cc3c2ff85bbee654a7054e36c59694d8d8e4 on master.

franky47 commented 1 year ago

The number of different names for those macros is becoming quite high, it would be good to have some documentation about all the variants.

lathoub commented 1 year ago

MACRO's are indeed dubieus (and not intuitive). I suggest to rethink the MIDI_CREATE_* macro naming and provide additional (wiki) documentation. Let me think about it over the weekend

franky47 commented 1 year ago

Sounds good. We should keep the existing ones for compatibility in this version, since almost every single sketch out there uses those macros as the entrypoint.

lathoub commented 1 year ago

Ideally MIDI_CREATE_CUSTOM_INSTANCE would be renamed to MIDI_CREATE_CUSTOMMIDI_INSTANCE , in line with MIDI_CREATE_CUSTOMSERIAL_INSTANCE. MIDI_CREATE_SPECIAL_INSTANCE could then become MIDI_CREATE_CUSTOMSERIALANDMIDI_INSTANCE

Alternatively, only renamed MIDI_CREATE_SPECIAL_INSTANCE to MIDI_CREATE_CUSTOMSERIALANDMIDI_INSTANCE

Either way: update the wiki as part of the PR/Release

lathoub commented 1 year ago

Attached the updated wiki for the creation MACROs (not sure how to add this to this PR).

Should we go ahead with the renaming of the MACROs?

Using-custom-Settings.md