Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CUSTOM serial and MIDI creation MACRO's #286

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

lathoub
Copy link
Collaborator

@lathoub lathoub commented Jun 4, 2022

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

@coveralls
Copy link

Coverage Status

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

@franky47 franky47 mentioned this pull request Oct 8, 2022
@franky47
Copy link
Member

franky47 commented Oct 8, 2022

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
Copy link
Collaborator Author

lathoub commented Oct 14, 2022

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
Copy link
Member

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
Copy link
Collaborator Author

lathoub commented Oct 16, 2022

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
Copy link
Collaborator Author

lathoub commented Feb 26, 2023

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

- added custom MIDI settings override example, disabling the 1byteparser
- added custom MIDI and Serial override example
- renamed CustomBaudRateSettings to CustomSerialSettings in existing CustomBaudRate example
- added DefaultSerialSettings to keywords
- added 2 examples to platformio.yml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants