A new way to configure the MC6Pro

Hi y’all,

The Morningstar Editor (and related tools) is great, but didn’t fit the way I like to work. So I wrote a tool that let me keep the config in a file (still JSON, but human readable) and use that instead. This is the first version. I’ve pasted the README.md below. If you are interested in trying it, drop me a message and I will send you a link to the repo.

It is written in Python, so you should be comfortable with running python scripts, and looking at JSON files.

John

MC6ProIntuitive

Configuring the Morningstar MC6Pro via an intuitive config file

  • Human editable configuration file
  • Named messages allow easy reuse
  • Named banks
  • Navigator mode: Bank 1 is a roadmap/index bank, and navigating is easy
  • Navigator mode allows more than 32 presets per bank

Overview

The Morningstar Editor is great software, but presents a brittle experience. Instead, this package defines a JSON based configuation file. The configuration file is converted to a MC6Pro backup format, and can be restored to the device.

Instead of editing directly through the editor, you edit the configuration file via any editor capable of handling JSON.

You start by backing up your config and converting that into into an Intuitive config.

Human editable Configuration file

The MC6Pro backup files are JSON, but are not human editable. They are large (over 11MB) and all fields and elements are present, even if empty or not used.

The Intuitive format only requires values for non-empty fields and elements. Banks, for example, would only have banks actually in use instead of all banks.

In addition, the format is more intuitive: the top level includes device configuration, messages (which appear deeply nested in the backup format), MIDI channels, and banks.

Messages, MIDI channels, and banks are referred to by name, instead of relying on position or a number.

Named messages allow easy reuse

Named messages deserve special mention: messages are named and defined at top level.

When a preset refers to a message, it only refers to the name. This allows easy reuse of a message.

  "presets": [
    {
      "short_name": "Enabled",
      ...
      "messages": [
        {
          "trigger": "Press",
          "toggle": "one",
          "midi_message": "Iridium Disable"
        },
        {
          "trigger": "Press",
          "toggle": "two",
          "midi_message": "Iridium Enable"
        }
      ]
    }, ...

Named banks

With named banks, the bank’s position in the bank list doesn’t matter. It is referred to by name.

This is primarily for Bank Jump messages, and is used in Navigator mode.

Navigator mode

Navigator mode has two aspects:

  • it is easy to navigate between banks
  • it is easy to navigate between pages in a bank

In navigator mode, bank 1 is a roadmap. The presets for bank 1 are named after banks, and pressing the preset takes you to that bank. Preset C on each bank is set to return you to the roadmap.

In addition, all banks (including the roadmap) bank use the two rightmost presets (e.g. C and F on page 1) for page navigation - page up and page down.

If you define a bank (in an Intuitive conf file) that has more than 24 presets, that bank is broken into two MC6Pro banks, and the page up/page down presets navigate between the two banks and pages seamlessly. This may happen even with less than 24 presets, as the page navigation presets inserted by Navigator Mode count against the total.

Use

Everything is done via the python app mc6pro.py and the Controller Backup tab on the Morningstar Editor. You also have the following resources:

Features.json

This contains all implemented features as a backup file. Convert it to an intuitive config to see the syntax:

python3 -b Features.json Features-Intuitive.json

Demo.json

This is a sample Intuitive config file

Initial Use

  1. Create a backup of your current configuration in the Controller Backup tab, using All banks (including Controller Settings), say it is named backup.json
  2. python3 mc6pro.py -b backup.json intuitive.json

The names chosen for the messages are not intuitive, so you should rename them. Also, add the Navigator Mode element if you want:

"navigator": true,

Later use

Now, edit your Intuitive.json file, and make any changes or additions. Then convert it to a backup file:

python3 intuitive.json intuitive-base.json

And load that file via the Controller Backup tab in the editor using Restore your controller presets Note that the MC6Pro will state the file has been modified.

Theory and Development

The heart of the app is a grammar tool. The grammar tool handles JSON grammars. It can parse a grammar into a model (python object representing the meaning), or generate a JSON string from a model.

The backup files (aka base files) have a grammar that is complete. This means all elements must appear, even if they are default values.

The intuitive files have a grammar that is minimal: only non-default values appear.

The backup grammar is defensive: elements that are not yet implemented are coded in the grammar as constants. Getting a value that doesn’t match the constant will cause an error. This happens when someone is using a feature that is not yet supported.

Grammars consist of atoms (int, str, boolean), enums, lists, dictionaries, and switch dictionaries (which allow a little variation in the structure).

There is a pretty comprehensive set of tests. They can be run via:

python3 tests.py

In addition, the tests produce a few base config files, named:

  • tmp\Empty.json
  • tmp\Features.json
  • tmp\Demo.json
  • tmp\NavigatorTest_Base_Script.json
  • These should be loaded and spot-checked after changes.
4 Likes

Very nice.

Have you considered supporting yaml. It’s a superset of json and more human friendly.

Nice idea! I did JSON because that was the backup file format, but I bet it is easy to choose a different loader. Thanks for the suggestion.

I just pushed a new version that supports YAML, and also has better color support (color schemas, instead of ad hoc attaching of colors to banks or presets)

The YAML is very cool, my config file in YAML:

# The MIDI channel assigned to the MC6Pro
midi_channel: 3
# The list of MIDI channels, the position in the list determines the channel number (1 based)
midi_channels:
- name: Iridium
- name: Scarlett
- name: MC6Pro
- name: H9
- name: Timeline
- name: Looper
# Use navigator mode
navigator: true
# Color schemas
colors:
- name: default
  bank_color: black
  bank_background_color: lightyellow
  preset_color: black
  preset_background_color: lightyellow
- name: navigator
  bank_color: red
  bank_background_color: yellow
  preset_color: red
  preset_background_color: yellow
- name: bypass
  preset_color: black
  preset_toggle_color: white
  preset_background_color: darkgreen
  preset_toggle_background_color: red
# The list of MIDI messages, order is not important
messages:
- {channel: Iridium, name: Iridium Disable, type: CC, number: 102, value: 0}
- {channel: Iridium, name: Iridium Enable, type: CC, number: 102, value: 127}
- {channel: Iridium, name: Iridium Bank 0, type: CC, number: 0, value: 0}
- {channel: Iridium, name: Iridium Clean, type: PC, number: 0}
- {channel: Iridium, name: Iridium Burry, type: PC, number: 1}
- {channel: Iridium, name: Iridium Distortion, type: PC, number: 2}
- {channel: Iridium, name: Iridium Max Distortion, type: PC, number: 3}
- {channel: H9, name: H9 Disable, type: CC, number: 1, value: 0}
- {channel: H9, name: H9 Enable, type: CC, number: 0, value: 0}
- {channel: Timeline, name: Timeline Disable, type: CC, number: 102, value: 0}
- {channel: Timeline, name: Timeline Enable, type: CC, number: 102, value: 127}
- {channel: Looper, name: Looper Test, type: CC, number: 34, value: 0}
# Banks - as a list
banks:
- name: Noodling
  description: A selection of cool guitar sounds
  to_display: true
- name: Iridium
  description: Iridium choices
  to_display: true
  presets:
  - short_name: Enabled
    toggle_name: Disabled
    colors: bypass
    to_toggle: true
    messages:
    - {midi_message: Iridium Disable, toggle: one}
    - {midi_message: Iridium Enable, toggle: two}
  - short_name: Clean
    messages:
    - {midi_message: Iridium Bank 0}
    - {midi_message: Iridium Clean}
  - short_name: Burry
    messages:
    - {midi_message: Iridium Bank 0}
    - {midi_message: Iridium Burry}
  - short_name: Distortion
    messages:
    - {midi_message: Iridium Bank 0}
    - {midi_message: Iridium Distortion}
  - short_name: Max Distortion
    messages:
    - {midi_message: Iridium Bank 0}
    - {midi_message: Iridium Max Distortion}
- name: H9
  description: Best of H9 sounds
  to_display: true
  presets:
  - short_name: Enabled
    toggle_name: Disabled
    colors: bypass
    to_toggle: true
    messages:
    - {midi_message: H9 Disable, toggle: one}
    - {midi_message: H9 Enable, toggle: two}
- name: Timeline
  description: Various delay sounds
  to_display: true
  presets:
  - short_name: Enabled
    toggle_name: Disabled
    colors: bypass
    to_toggle: true
    messages:
    - {midi_message: Timeline Disable, toggle: one}
    - {midi_message: Timeline Enable, toggle: two}
- name: For What It's Worth
  description: Crosby, Stills, Nash and Young
  to_display: true
- name: Prelude in C# Minor
  description: Rachmaninoff
  to_display: true

1 Like

I pushed a new version. The repo is here:

The changelog for the latest:

Change Log

[0.1.0] - 2024-03-17

  • Initial version with a change log
  • Bank Messages
  • Implementation.md a matrix describing which features are implemented
  • renamed Bank to_description to display_description
  • renamed Preset to_toggle to toggle_mode
  • major refactor of grammar code: cleaned up tests, grammar nodes are python objects instead of dictionaries
  • Added versioning

New version:

[0.1.1] - 2024-03-29

Added Toggle Group
Improved error messages
Added versions to sample files
Better versioning
Fixed bug: bank messages not being converted to Base

I’m trying to run the python script (python3 -b Features.json Features-Intuitive.json) but keep having the same problem. The terminal fills with text and ends with the following message:

NameError: name ‘false’ is not defined. Did you mean: ‘False’?

What am I doing wrong or configured correctly?

Thanks!

New version with a 1 button variant of the Navigator Mode

[0.1.2] - 2024-04-17

  • Added names to all grammar nodes
  • Added print_grammar program
  • Refactored navigator mode, no functional change
  • Improved error handling
  • Made Jump Bank message have page default to 0
  • Added “One Button” mode to Navigator Mode
  • Added Navigator Mode override to mc6pro.py for testing

It’s been a while! I added support for all MIDI/controller message types (with a couple of small incompletes). It took a lot longer than I thought:

[0.2.0] - 2024-06-16

Added get/set var methods to JsonGrammarModel
Changed dict keys so that on complete models, a key can be marked as not required
    This allows the setlist program output to be parsed
    It doesn't include the controller settings
Added per-key models to switch dicts
add To Message Scroll to the Preset Array schema (MC6Pro Config)
Added shifted name color and to msg scroll to preset
Added Exp Preset Array
Better handling of Intuitive messages, using first class functions
All message types are now handled, more or less
Added better 'required' parameter to dict keys
Added 'per switch' models to switch dicts