User Tools

Site Tools


Chapter 15: Troubleshooting

Log Pane

The Log Pane can be very useful to determine what is happening in terms of MIDI messages.

The Log is opened from the More menu.

Log as of version 2.313 (with annotations - in color): Log as of version 2.313 (with annotations)

  • When the Log Pane is open, all outgoing and incoming MIDI messages are logged. Otherwise they are discarded.
  • If the Log Pane is paused – Pause Button (Toggle) is ON – messages are discarded.
  • You may clear all data in the log by using the Clear button.

The log was enhanced in version 2.313. Data shown:

  • Arrows for outbound (right) or inbound (left) data
  • Time in minutes, seconds, and fractions
  • Data - three byte messages show the command, channel, and two data bytes
  • Outbound messages - the originating control label

On initial load, it will show the MDP2 version and build numbers.

The log will also show when StreamByter input and output rules load successfully.

You can select and copy data in the log to paste in to other apps, including Mail.


External Logging

On occasion, an external log may help in troubleshooting. Two useful free (currently) MIDI log tools are:

  • Protokol (iPadOS) - hexler.net
  • MIDI Monitor (MacOS) - snoise.com

Metadata

In the More → Config → Actions menu, there is an option to mail Meta data.

This option creates a draft e-mail with three spreadsheet files (.csv format)

  • Layout info (shows the data for layouts controls, such as Label, Type, Subtype, Supercontrols, Subcontrols, etc.)
  • Unused Control Changes
  • Unused Notes

These files can help troubleshooting large layouts.

The files can be accessed by e-mailing them to yourself, or by saving the draft e-mail, then accessing them from the drafts folder of you e-mail client.

As of 2.320, the layout info file does not include SysEx control data.

Scrambled Controls

In the early days, things were easy with a single display aspect ratio iPad. As larger aspect ratios appeared, we have allowed “native” aspect ratio layouts. The downside of this is when a layout created in a larger aspect ratio is loaded on a smaller display, controls that do not have room in the different aspect will stack up to the top right.

All the controls are still present, they need to be manually rearranged to conform to the actual display aspect. Go to design mode and rearrange the stacked controls.

This stacking will also happen when an iPad layout is loaded on an iPhone, or the developer iPhone aspect is different from the current iPhone.

For maximum compatibility, use the default layout size, not the “native” option!

Automatically reconfiguring the control layout on resize is non-trivial problem, and not on our to-do list.

When Things Are Not Working

Close and Reboot

May seem a cliché, but when strange things are happening, closing all apps and rebooting is a good first step and clears many issues. Please try this before reporting a problem.

iPad

iPhone

Mac

⌘ + Q on each app, select Restart… from  menu

Single Control

Very occasionally, we have seen meta data for a control might get scrambled. If a single control is misbehaving, and no other troubleshooting seems to correct it, try deleting the control and rebuilding it.


Options for Getting Help

Options for getting help include:

The FB group and forums are best for getting more eyes on your question quickly and leveraging the community knowledge. We watch the group and forum. When these do not provide and answer, contact us directly from the app Config → Actions → Email Us or the Contact Form on the MD Website.

Short, Self-Contained, Correct Example

If you are asking a question to other users or to Tech Support, please try to create a short, self-contained, and correct example (if possible). This means:

  • Short—Please try to “slim” your question. For example, if there are 40 buttons not related to your example, please remove them. If you can produce the problem with one slider, present that. The better you can locate the problem, the easier it is for people to help you.
  • Self-Contained—Provide everything so that somebody else can also see the problem occur. You might need to include files, and even MIDI specs, but hopefully you can simplify the problem so that this isn't necessary. (Sometimes, other people might just need to have the same expensive synth you do to solve the problem. In that case, you cannot make the example self-contained)
  • Correct—The example should be readable and everything that is not part of the problem should work. Other problems in your layout should be corrected or, better yet, removed.
  • Example—Make sure you can see the problem clearly in the question and the resources provided. If you are asking others to download an MD layout which shows the problem, download it yourself to make sure the problem can be seen.

The easier it is to see your issue the faster you can get a solution. Please submit the minimum sample necessary to view the issue, with any extraneous controls removed.

manual/chapter-troubleshooting.txt · Last modified: 2022/12/21 18:15 by jkhiser