Native Instruments Traktor Kontrol Z1: Add new HID mapping

[djantti]

Hi Mixxx developers!

I created a new Native Instruments Traktor Kontrol Z1 HID mapping based on the official Traktor Kontrol S2 MK3 code. I've been testing it with Mixxx 2.4 branch and everything seems to work properly. It has extended features using the Mode button as a modifier (same as in Kontrol Z1 wiki page) and better support for the device LEDs. I also have a finished Mixxx manual page ready for the controller.

Features:

• All knobs, faders and VU meters functional
• Mode + FX -> Playback start / stop
• Mode + Headphone -> Go to cue and stop
• Dim standby lights for all buttons
• FX button red LEDs as momentary playback start / stop indicators

Let me know if there's something missing or if changes are needed. Thanks!

[JoergAtGithub]

Welcome at Mixxx!
As a first-time contributor we need you to sign the Mixxx Contributor Agreement and comment here when you have done so. It gives us permission to distribute your contribution under the GPL v2 or later license and the Apple Mac App Store. It is also helpful for us to have contact information for contributors in case we may need it in the future.

[djantti]

Signed!

[JoergAtGithub]

The pre-commit check is failing. The best way to fix pre-commit issues is to install pre-commit locally on your system, as described here: https://github.com/mixxxdj/mixxx/wiki/Using-Git#set-up-automatic-code-checking
Than it will fix these issues automatically before every commit.
Alternatively, you can download the pre-commit.patch file from the artifacts of this PR

unzip it, and apply it using:
git apply pre-commit.patch

[JoergAtGithub]

Please use pre-commit, it will apply all the necessary changes automatically.

[djantti]

Thanks! I got pre-commit installed locally, but I'm still figuring out how to make proper use of it. I did run my code manually through it and fixed all the errors it mentioned.

[JoergAtGithub]

@djantti Did you notice my PR djantti#1 ?

[djantti]

Oh no, I'm sorry, I'm still very new to GitHub and totally missed it. Testing your PR right now.

[JoergAtGithub]

This looks already really good - just some minor naming remarks.

[djantti]

Thank you for the remarks! I think I managed to change everything needed. The naming scheme is way better now.

[JoergAtGithub]

LGTM! As soon as the manual PR is ready, we can merge this!

[djantti]

That is awesome! I will finish the manual page next.

[JoergAtGithub]

Thank you, for taking the time to bring this to a mergeable state!

[JoergAtGithub]

If you are interested in further improvement of this mapping, you could have a look at the S2 Mk1 mapping that:

• Reads the initial state of the knobs and faders at startup:

  mixxx/res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

  Lines 1286 to 1289 in bdfb495

  	const report0x02 = new Uint8Array(controller.getInputReport(0x02));
  	// The first packet is ignored by HIDConstroller
  	this.controller.parsePacket([0x02, ...Array.from(report0x02.map(x => x ^ 0xFF))]);
  	this.controller.parsePacket([0x02, ...Array.from(report0x02)]);

• Reads the knob and fader calibration values from device memory:

  mixxx/res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

  Line 1565 in bdfb495

  // # Feature Report Description

[djantti]

Oh cool, those would be really nice additions for this mapping too! I will take a look.

Working on this is a lot of fun and I'm happy I can make a contribution to one of my favorite open source applications. Also thank you for your excellent guidance and suggestions!