arduino_midi_library icon indicating copy to clipboard operation
arduino_midi_library copied to clipboard

Published 20 hours ago • verified publisher icon FortySevenEffects

CUSTOM serial and MIDI creation MACRO's

Open lathoub opened this issue 3 years ago • 6 comments

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

lathoub avatar Jun 04 '22 14:06 lathoub

Coverage Status

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

coveralls avatar Jun 04 '22 14:06 coveralls

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

franky47 avatar Oct 08 '22 13:10 franky47

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

lathoub avatar Oct 14 '22 07:10 lathoub

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.

franky47 avatar Oct 14 '22 07:10 franky47

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 avatar Oct 16 '22 08:10 lathoub

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

lathoub avatar Feb 26 '23 10:02 lathoub