Native Instruments Traktor Kontrol Z1: Add new manual page #594
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JoergAtGithub
requested changes
Dec 7, 2023
| Compatibility | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| The Kontrol Z1 is a HID and USB audio class compliant device, which makes it fully compatible with Mixxx. It requires no proprietary drivers when used on Linux or macOS. For Windows, download and install the latest driver from the `manufacturer's website <https://www.native-instruments.com/en/support/downloads/drivers-other-files/>`__. |
There was a problem hiding this comment.
Suggested change
| The Kontrol Z1 is a HID and USB audio class compliant device, which makes it fully compatible with Mixxx. It requires no proprietary drivers when used on Linux or macOS. For Windows, download and install the latest driver from the `manufacturer's website <https://www.native-instruments.com/en/support/downloads/drivers-other-files/>`__. | |
| The Kontrol Z1 is a HID and USB audio class compliant device, which makes it fully compatible with Mixxx. It requires no proprietary drivers when used on Linux or macOS. | |
| For Windows, download and install the latest Traktor Kontrol Z1 audio driver from the `manufacturer's website <https://www.native-instruments.com/en/support/downloads/drivers-other-files/>`__. |
Only the Audio driver is needed for Mixxx.
| ~~~~~~~~~~~~~ | ||
|
|
||
| The Kontrol Z1 is a HID and USB audio class compliant device, which makes it fully compatible with Mixxx. It requires no proprietary drivers when used on Linux or macOS. For Windows, download and install the latest driver from the `manufacturer's website <https://www.native-instruments.com/en/support/downloads/drivers-other-files/>`__. | ||
|
|
There was a problem hiding this comment.
Suggested change
| .. warning:: | |
| **Parallel installation of Traktor Pro software on Windows** | |
| If you have a parallel installation of Traktor Pro on Windows, a service called :file:`NIHardwareService.exe` is running in the background, which has control over the LEDs of the Z1. | |
| To make the Z1 work properly with Mixxx, you must either uninstall the Traktor Pro software, or temporarily stop this Windows service. One way to do this is to open a Windows Powershell terminal as Administrator, and run the following command: | |
| Stop-Service -Name "NIHardwareService" |
Comment on lines
33
to
34
| :width: 50% | ||
| :figwidth: 50% |
There was a problem hiding this comment.
This drawing appears rather tiny, could you increase the size.
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | No | Element | Primary function | Secondary function (+ Mode) | | ||
| +====+=======================+===================================================================================================================+=====================================================+ | ||
| | 1 | Main knob | Hardware main output volume (not mapped in Mixxx) | | |
There was a problem hiding this comment.
Suggested change
| | 1 | Main knob | Hardware main output volume (not mapped in Mixxx) | | | |
| | 1 | Main knob | Hardware main output volume (hardware function - not mapped in Mixxx) | | |
same below
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 4 | Gain knob | Adjusts pre-fader gain of the deck | | | ||
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 5 | Hi knob | High frequency filter | | |
There was a problem hiding this comment.
Suggested change
| | 5 | Hi knob | High frequency filter | | | |
| | 5 | Hi knob | High frequency-band equalizer knob | | |
Technically the term filter is correct, but EQ is more common for this function
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 10 | Mode button | Activates secondary functions when pressed | | | ||
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 11 | Filter / FX On button | Toggles selected deck quick effect on / off | Start / stop track playback | |
There was a problem hiding this comment.
If you could chage the numbering that Filter / FX On button appears in the row directly below Filter / FX knob would be great.
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 9 | Headphone button | Toggles deck headphone cueing on / off | Seek track to cue and stop | | ||
| +----+-----------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ | ||
| | 10 | Mode button | Activates secondary functions when pressed | | |
There was a problem hiding this comment.
Suggested change
| | 10 | Mode button | Activates secondary functions when pressed | | | |
| | 10 | :hwlabel:`Mode` button | Activates secondary functions when pressed | | |
Use the :hwlabel:` keyword, for every text that is printed as label on the controller itself.
A good example for this is: https://manual.mixxx.org/2.4/en/hardware/controllers/roland_dj_505#browser-section-p-4
|
Thank you for the excellent suggestions! I think I managed to include all the requested changes. Those labels especially are a really nice touch and hopefully I made good use of them. |
JoergAtGithub
approved these changes
Dec 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Greetings!
I wrote a Native Instruments Traktor Kontrol Z1 manual page related to Mixxx HID mapping PR #12366. It's a small and simple DJ controller so the manual is kept pretty simple as well. The included controller picture was drawn by me, so there are no copyright issues with using it.
Let me know if something needs to be changed or added. Thanks!