__ | | | /_) | | | |
| __ \ _ \ ’ / | | / | _ \ __ \ | ` | __ \ __|
| | | | _/ . \ | < | | / | | | ( | | |_
_| | ||_| |__||_\|_|| | _____|_,|_.__/ ____/
USBMidiKliK4x4
A multi-port USB MIDI interface for the STM32DUINO platform.
Download the last firmware here : https://github.com/TheKikGen/USBMidiKliK4x4/releases
User manual is here : https://github.com/TheKikGen/USBMidiKliK4x4/wiki/UMK4x4-V2.5-User-Manual
Check also the wiki here : https://github.com/TheKikGen/USBMidiKliK4x4/wiki
The story of this project starts with a hack of the MIDIPLUS/MIDITECH 4x4 USB to MIDI interface.
Needing more midi jacks, I bought a second Miditech interface, but I discovered it was not possible to use 2 Miditech / Midiplus MIDI USB 4X4 on the same computer to get 8x8, and according to the Miditech support, as that usb midi interface was not updateable at all !
I was stucked…That was motivating me enough to write a totally new and better firmware : the UsbMidiKlik4x4 project was born.
The current version V2.5 supports full USB midi until 16xIN , 16XOUT plus routing features, enabling configurables standalone mode, merge mode, thru mode, split mode, midi transformation, midi clock, etc., huge sysex flow, configuration menu from serial USB, and is very fast and stable thanks to the STM32F103. More of that, you can aggregate until 5 3x3 boards seen as one by activating the “Bus mode”.
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.
If you are a regular user of USBMidiKlik, please consider making a donation to encourage our team, and to pay for the coffees swallowed during the long nights of coding !
NEWS
If you are using the recommended TKG-HID-BOOTLOADER
you can now update your firmware easyly with that web utility :
You can use it locally or on-line here : https://thekikgen.github.io/tkg-hid-webcli.html
This release introduces new utilities to configure your UMK4x4. These utilities work locally or online.
Check the directory here : https://github.com/TheKikGen/USBMidiKliK4x4/tree/master/htmltools to download locally.
New release V2.5.3 : Correction of the blocking issue in standalone mode
The previous release introduced an issue blocking UMK firmware when it was used in standalone mode (with a power supply only).
it is now corrected. You can adjust the USB detection time with the option #7 in the configuration menu (USB idle time), or by sending the appropriate sysex (Intelligent thru mode settings). Default USB idle is 30 seconds: that means the standalone mode will be activated after 30 seconds.
Limited number of the new UMK4x4 PCB v2.3 available at Tindie right now !
The inclination towards smaller hardware devices has made it increasingly difficult to make use of DIN connectors for MIDI In/Out in the past few years. Many manufacturers have chosen to use 3.5mm “TRS” connectors instead. It is why The KikGen Labs team released a new UM4x4 V2.3 board based on the STM32F103 Bluepill. This new board uses 3,5MM TRS jacks instead of midi DIN, with full MMA RP-054 type A compliance. Midi DIN is still possible obviously, under the form of a 4 mini 3.5mm jacks to DINs rail board, so you can “patch” midi in and out as you want.
3 news pipes have been added in that release :
- VLCURV1 : allows you to define a default 5 segments velocity curve by adjusting 4 in ranges to out values.
- VLCURV2 : allows you to define a single segment of the velocity curve with a (midi in, midi out) pairs. You can use that to define a fully customized curve, by adding, for example, eight pipes that will form 9 segments. It can be combined with VLCURV1 to adjust only some specify segments of a the 4 values curve.
- VLCURV3 : allows you to choose a predefined velocity curve between 6 presets : compressed for hard player, medium velocity, compresser/expander, low velocity 1 & 2, top and bottom ends cut
https://github.com/TheKikGen/USBMidiKliK4x4/releases/tag/v2.5.2
New release : V2.5.1 correcting the MSGFLTR pipe bug
This v2.5.1 release includes a bug correction in parameters validation of the MSGFLTR pipe that was blocking the function #2.
https://github.com/TheKikGen/USBMidiKliK4x4/releases/tag/v2.5.1
USBMidiKliK4x4 detailed features
- STM32F103C8 / STM32F103CB / STM32F103RB / STM32F103RC uC support
- Bluepill and Miditech 4x4 board support
- 16 MIDI USB IN/OUT
- 15-16 MIDI JACK IN / JACKS OUT *1
- 8 Virtual internal IN/OUT
- 4 midi clock and Midi Time Code generators
- Full remote configuration by SYSEX
- Configuration user interface from a serial USB terminal
- Support of large sysex flow
- Complex routing engine allowing to route any IN to any OUT
- Transformation pipes allowing dynamic modification of midi messages
- Customisable USB device ProductStringName, Vendor and Product Ids
- STANDALONE mode (no USB host needed)
- INTELLITHRU mode allowing specific routing rules when USB is idle
- Stackable interfaces in bus mode to get 6x6 to 15x15 physical midi ports
The “pipeline” feature allows you to modify an incoming midi message through a chain of transformation functions (a “pipe”), e.g., transpose notes, split, map channel to another, map CC to another, etc…New pipes can be easily added in order to obtain complex midi transformations without degrading performances.
4 Midi clock generator / 8 virtual ports are available within the routing engine. Below is an overview of the possible paths for a midi message packet, coming from a physical in port to a physical out port :
The bus mode allows the aggregation of up to five interfaces using the I2C protocol, which will be seen as a single interface by the usb host and/or the midi routing engine (including standalone mode).
Last release of the firmware can be found here : https://github.com/TheKikGen/USBMidiKliK4x4/releases/
Update tool is included. Unzip and launch the UMK_BluePillUpdate.bat file (Windows only currently).
USBMidiKlik 4x4 PCB ready to be used
A new version of the USBMidiKlik 4x4 PCB ready-to-use (based on a STM32F103) is available now at Tindie
The board is USB Powered, so no additional power supply necessary.
It works driverless as a class compliant device, with all Windows and Linux versions, Mac OS X, Akai MPC Live/X/Force, IOS, Android…
To simplify connectivity, this board uses now only 3.5mm jacks for MIDI and I2C :
- 6 TRS jacks : 3 MIDI in, 3 out, compliants with the MMA RP-054 type A specifications.
- You can use TRS to Midi DIN conversion cables, or connect your MIDI device directly with a simple stereo cable.
- 4 TRS jacks are now used instead connectors for stacking multiple boards on the I2C bus with 1 pair of stereo cables (power and data).
You will find also at Tindie, a 4 ports “midi rail” PCB allowing MIDI DIN from/to TRS. This can help if your need MIDI DIN ports and/or to arange the order of the DIN ports.
With a single board, you can set e.g. 2 MIDI DIN IN and 2 OUT or 3 IN, 1 OUT, or you can set a 16 DIN ports (8 IN, 8 OUT) with 4 PCB, etc…
With 8 midi rail boards and 5 UMK4x4 stacked boards, it is possbile to get 30 midi DIN ports (15 x IN + 16 x OUT).
NB: The UMK4x4 supports only 3 physical IN and 3 physical OUT.
The first protoype of the bus mode I use every day !
USBMidiKliK4x4 - Configuration overview
Prebuilt binaries are compiled for the tkg-hid-bootloader since the 2.5 version, so you need the tkg-hid-bootloader firmware here :
https://github.com/TheKikGen/stm32-tkg-hid-bootloader/blob/master/F1/bootloader_only_binaries/tkg_hid_generic_pc13.bin
You can then use TKG-FLASH.EXE provided in the release to flash the 128K or the 64k bluepill version.
The 128K firmware should work on a 64K Bluepill most of the time. If it is not the case, try the 64K firmware version.
2 modes can be used to configure the USBMidiKlik midi : system exclusive messages or a configuration menu.
Sysex messages have the following format, and ARE ONLY INTERPRETED ON CABLE 0 OR MIDI IN JACK 1 :
F0 77 77 78 <sysex function id > <data> F7
The “F0 77 77 78” is the specific sysex header for USBMidiKlik4x4. Know that it is a totally unofficial header.
You will find the sysex V2.5 documentation in the repository :
https://raw.githubusercontent.com/TheKikGen/USBMidiKliK4x4/master/UMK-4X4-SYSEX-IPL.TXT
The second way is to activate the configuration menu on the serial port with the following sysex :
F0 77 77 78 06 08 F7
To send that Sysex, you can use for example, MIDIOX, or the “sendmidi” command line utility by gbevin :
sendmidi dev "USB MIDIKliK 4x4" syx hex 77 77 78 06 08
You will find the last binary release of sendmidi here : https://github.com/gbevin/SendMIDI/releases
Immediatly after sending this sequence with your prefered midi software, the interface will reboot in CDC serial COM mode, allowing you to open a terminal to configure easily USBMIDIKLIK.
You can use any software like TERATERM, on Windows, or “screen” on MacOs. The bauds rate must be set to 115200.
The following menu should appear after connecting to the right serial USB port , and pressing ENTER :
USBMIDIKLIK 4x4 - BLUEPILL STMF103C8x - V2.0
(c) TheKikGen Labs
https://github.com/TheKikGen/USBMidiKliK4x4
[0] View global settings [a] Show active devices
[1] View midi routing [d] SYSEX settings dump
[2] Usb VID PID
[3] Usb product string
[4] Cable OUT routing [e] Reload settings
[5] Jack IN routing [f] Factory settings
[6] IntelliThru routing [r] Factory routing
[7] IntelliThru timeout [s] Save settings
[8] Toggle bus mode [z] Debug on Serial3
[9] Set device Id [x] Exit
=>
Don’t forget to save your settings with the “s” option before leaving the configuration menu with “x”.
WIKI
评论