Skip to content

Commit e7815f9

Browse files
committed
chore: migrate hardware manual to Markdown
1 parent 5ff5793 commit e7815f9

203 files changed

Lines changed: 8770 additions & 9258 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Akai LPD8
2+
3+
- [Manufacturer’s product page](https://www.akaipro.com/lpd8)
4+
- [Forum thread](https://mixxx.discourse.group/t/akai-lpd8-mapping-4-decks-30-hotcues-loops-etc-v2/13064)
5+
6+
:::{versionadded} 1.10.1
7+
:::
8+
9+
:::{note}
10+
Unfortunately a detailed description of this controller mapping is still missing.
11+
If you own this controller, please consider
12+
[contributing one](https://github.com/mixxxdj/mixxx/wiki/Contributing-Mappings#user-content-documenting-the-mapping).
13+
:::

source/hardware/controllers/akai_lpd8.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Akai MPD24
2+
3+
- [Manufacturer’s product page](https://www.akaipro.com/mpd24)
4+
- [Forum thread](https://mixxx.discourse.group/t/akai-mpd24-midi-setup/9020)
5+
6+
:::{versionadded} 1.8
7+
:::
8+
:::{note}
9+
Unfortunately a detailed description of this controller mapping is still missing.
10+
If you own this controller, please consider
11+
[contributing one](https://github.com/mixxxdj/mixxx/wiki/Contributing-Mappings#user-content-documenting-the-mapping).
12+
:::

source/hardware/controllers/akai_mpd24.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

source/hardware/controllers/allen_heath_xone_k2_k1.rst renamed to source/hardware/controllers/allen_heath_xone_k2_k1.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _allen-heath-xone-k2:
1+
(allen-heath-xone-k2)=
2+
3+
# Allen & Heath Xone:K2
24

3-
Allen & Heath Xone:K2
4-
=====================
55

66
The Allen & Heath Xone:K2 is a flexible controller that is mapped to
77
control Mixxx’s decks, effects, or both. It has an integrated 4 channel
@@ -10,24 +10,23 @@ Xone K1 is the same as the Xone K2 but without the built in audio
1010
interface and does not come with the EVA travel case that the K2 comes
1111
with.
1212

13-
- `Manufacturer’s product page <https://www.allen-heath.com/ahproducts/xonek2/>`__
14-
- `Forum thread <https://mixxx.discourse.group/t/allen-heath-xone-k2/12506>`__
15-
- `Manufacturer’s User Guide <https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf>`__
16-
- `Blank template diagrams <https://www.allen-heath.com/content/uploads/2023/06/XoneK2BlankOverlays.zip>`__
13+
- [Manufacturer’s product page](https://www.allen-heath.com/ahproducts/xonek2/)
14+
- [Forum thread](https://mixxx.discourse.group/t/allen-heath-xone-k2/12506)
15+
- [Manufacturer’s User Guide](https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf)
16+
- [Blank template diagrams](https://www.allen-heath.com/content/uploads/2023/06/XoneK2BlankOverlays.zip)
1717

18-
.. versionadded:: 1.11
18+
:::{versionadded} 1.11
19+
:::
20+
## Audio Setup
1921

20-
Audio Setup
21-
-----------
2222

2323
The Xone:K2 is setup in Mixxx > Preferences > Sound Hardware > Output
2424

25-
========== ======= =============
26-
Output Device Channel
27-
========== ======= =============
28-
Main XONE:K2 Channel 3 - 4
29-
Headphones XONE:K2 Channel 1 - 2
30-
========== ======= =============
25+
| Output | Device | Channel |
26+
| --- | --- | --- |
27+
| Main | XONE:K2 | Channel 3 - 4 |
28+
| Headphones | XONE:K2 | Channel 1 - 2 |
29+
3130

3231
Note: This Channel setup is the opposite of what most DJ controllers
3332
with an integrated audio interface use. The design choice to not use
@@ -41,12 +40,12 @@ volume. Adjusting the volume of main and headphone outputs is done by
4140
adjusting the gain for those outputs in Mixxx using the controller
4241
mapping.
4342

44-
Setup
45-
-----
43+
## Setup
44+
4645

4746
**Requirement**: The Xone K2 must have Latching Layers turned off, which
48-
is the default. Refer to the `Xone K2
49-
manual <https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf>`__ page
47+
is the default. Refer to the [Xone K2
48+
manual](https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf) page
5049
12 for details. The K1 does not have Latching Layers.
5150

5251
This mapping can used with one or multiple Xone K2s/K1s. Multiple Xone
@@ -73,8 +72,8 @@ when selecting the channel:
7372
- Channel 9 (I): four effect units ordered 3 1 2 4
7473
- Channel 8 (H): four effect units ordered 1 2 3 4
7574

76-
Global Controls
77-
---------------
75+
## Global Controls
76+
7877

7978
These are available on any configuration with decks, but not the 4
8079
effect unit layout.
@@ -93,8 +92,8 @@ effect unit layout.
9392
- press and hold: load selected track into a deck by pressing the play button of the deck
9493
- shift: main gain
9594

96-
Decks
97-
-----
95+
## Decks
96+
9897

9998
The bottom right button is the shift button. The bottom left button
10099
toggles the bottom button grid between a loop layer (amber) and a hotcue
@@ -171,10 +170,10 @@ the same time activates supershift mode.
171170
If loop is enabled, move the loop backward by the beatjump size.
172171
- supershift: halve beatjump size
173172

174-
Effects
175-
-------
173+
## Effects
176174

177-
The top part of the column uses the :ref:`Standard Effects
175+
176+
The top part of the column uses the {ref}`Standard Effects
178177
Mapping <controller-effects-mapping>`.
179178
Pressing the top encoder acts
180179
as the effect focus button. When no effect is focused, the buttons are
@@ -195,11 +194,11 @@ headphones channels and light up amber.
195194

196195
The bottom encoders are not mapped in the 4 effect unit layout.
197196

198-
Effect unit focusing
199-
~~~~~~~~~~~~~~~~~~~~
197+
### Effect unit focusing
198+
200199

201200
In addition to focusing one effect in a unit at a time with the
202-
:ref:`Standard Effects Mapping <controller-effects-mapping>`, the Xone
201+
{ref}`Standard Effects Mapping <controller-effects-mapping>`, the Xone
203202
K2/K1 has another mode for focusing a whole effect unit. This allows for
204203
controlling the parameters of all 3 effects in the unit at a time. This
205204
mode is only available on the 4 effect unit layouts. To access it, press
@@ -220,17 +219,17 @@ again. The next time Layer is pressed, the effect unit that was focused
220219
before will be remembered (but it will not be remembered after
221220
restarting Mixxx).
222221

223-
Troubleshooting
224-
---------------
222+
## Troubleshooting
223+
225224

226225
If general functionality or supershift are not working, double check
227226
that Latch Layers is turned off and MIDI CH is selected. Refer to the
228-
`Xone K2
229-
manual <https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf>`__ page
227+
[Xone K2
228+
manual](https://www.allen-heath.com/content/uploads/2023/06/XoneK2_UG_AP8509_3.pdf) page
230229
12 for details.
231230

232-
Known Issues
233-
------------
231+
## Known Issues
232+
234233

235234
There are a few known issues with the Xone K2/K1 firmware:
236235

@@ -242,5 +241,5 @@ There are a few known issues with the Xone K2/K1 firmware:
242241
disconnecting the hub from the computer, the controller will not send MIDI
243242
input until it is powered down (unplugged) and plugged back in.
244243

245-
If you would like these issues to be fixed, please let `Allen & Heath
246-
Support <https://www.allen-heath.com/support/>`__ know.
244+
If you would like these issues to be fixed, please let [Allen & Heath
245+
Support](https://www.allen-heath.com/support/) know.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# American Audio Radius 2000
2+
3+
A CD and USB media player that can control Mixxx over USB with MIDI. It
4+
can also play timecode from CDs or USB drives which can control Mixxx
5+
when they are connected by a sound card.
6+
7+
- [Manufacturer’s product page](https://www.americandj.eu/en/radius-2000.html)
8+
9+
:::{versionadded} 1.10
10+
:::
11+
:::{note}
12+
Unfortunately a detailed description of this controller mapping is still missing.
13+
If you own this controller, please consider
14+
[contributing one](https://github.com/mixxxdj/mixxx/wiki/Contributing-Mappings#user-content-documenting-the-mapping).
15+
:::

source/hardware/controllers/american_audio_radius_2000.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

source/hardware/controllers/american_audio_vms4.rst renamed to source/hardware/controllers/american_audio_vms4.md

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
American Audio VMS4/4.1
2-
=======================
1+
# American Audio VMS4/4.1
2+
33

44
The original VMS4 has problems with sound quality. The microphone input
55
impedance is off and the output volume is low. The VMS4.1 is the same
66
controller, except that those hardware issues have been fixed. The
77
Traktor edition has different labels on some buttons & knobs, but it’s
88
otherwise the same hardware as the VMS4.1.
99

10-
- `VMS4 <http://www.adj.com/vms4>`__
11-
- `VMS4.1 <http://www.adj.com/vms4-1>`__
12-
- `VMS4.1 Traktor edition <http://www.adj.com/vms4-1-traktor>`__
13-
14-
.. versionadded:: 1.9
10+
- [VMS4](http://www.adj.com/vms4)
11+
- [VMS4.1](http://www.adj.com/vms4-1)
12+
- [VMS4.1 Traktor edition](http://www.adj.com/vms4-1-traktor)
1513

16-
Setup
17-
-----
14+
:::{versionadded} 1.9
15+
:::
16+
## Setup
1817

19-
.. note::
20-
Mixxx expects the VMS4 to be set to “Post EQ” mode for best
21-
sound quality. Do this by holding down the Headphone Cue button on
22-
Midilog 4 while powering on the unit. You only need to do this once.
23-
(Each time you do, it changes the mode back and forth.) Consult the
24-
`user manual <https://web.archive.org/web/20220727170646/intranet.americandj.com/ItemRelatedFiles/8347/vms4.pdf>`__
25-
for more information.
2618

27-
To check the status of this in Linux, at a
28-
console, issue the command ``lsusb -v|grep 'iSerial\|iProduct'`` and
29-
look at the serial number under the VMS4 device per the instructions in
30-
the user manual. As of this writing, the leading digit should be **1**.
19+
:::{note}
20+
Mixxx expects the VMS4 to be set to “Post EQ” mode for best
21+
sound quality. Do this by holding down the Headphone Cue button on
22+
Midilog 4 while powering on the unit. You only need to do this once.
23+
(Each time you do, it changes the mode back and forth.) Consult the
24+
[user manual](https://web.archive.org/web/20220727170646/intranet.americandj.com/ItemRelatedFiles/8347/vms4.pdf)
25+
for more information.
3126

27+
To check the status of this in Linux, at a
28+
console, issue the command ``lsusb -v|grep 'iSerial\|iProduct'`` and
29+
look at the serial number under the VMS4 device per the instructions in
30+
the user manual. As of this writing, the leading digit should be **1**.
31+
:::
3232
1. Make sure the VMS4 is off
3333
2. Slide the switch on the front of the VMS4 to “8 OUT”
3434

@@ -74,13 +74,13 @@ Setup
7474
and button area.
7575

7676
10. Click the Enable checkbox in the right pane
77-
11. Click the drop-down and choose the :guilabel:`American Audio VMS4` preset
77+
11. Click the drop-down and choose the {guilabel}`American Audio VMS4` preset
7878
12. Click OK and the controller should light up. (In 1.9.x, the
7979
controller will light up when you load a track to a deck.)
8080
13. Continue reading below to know how everything is mapped
8181

82-
Direct deck output implications
83-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82+
### Direct deck output implications
83+
8484

8585
This setup uses direct deck outputs because mixing takes place in the
8686
VMS4 hardware. The down side to this is that you won’t be able to use
@@ -89,8 +89,8 @@ Samplers. Using these features with a hardware + MIDI mixer like the
8989
VMS4 is not really feasible unless you used a separate sound interface
9090
or controlled Mixxx’s internal mixer another way.
9191

92-
Control
93-
-------
92+
## Control
93+
9494

9595
This guide explains how the VMS4 is mapped by default in Mixxx.
9696

@@ -104,14 +104,14 @@ Just open the ``midi/American-Audio-VMS4-scripts.js`` file in your
104104
favorite text editor (Wordpad works too) and you’ll see these variables
105105
right near the top. Edit & save, then restart Mixxx and enjoy.
106106

107-
Deck controls
108-
-------------
107+
## Deck controls
109108

110-
.. note::
111-
There are a number of different face plates in the wild so
112-
these images and control descriptions may not exactly match yours. The
113-
locations of the controls are the key things to pay attention to.
114109

110+
:::{note}
111+
There are a number of different face plates in the wild so
112+
these images and control descriptions may not exactly match yours. The
113+
locations of the controls are the key things to pay attention to.
114+
:::
115115
*The controls are the same on both sides of the controller. The left
116116
side controls Deck 1 and the right side controls Deck 2.*
117117

@@ -157,29 +157,27 @@ side controls Deck 1 and the right side controls Deck 2.*
157157
Hold Shift and press to set this deck as the leader for syncing with another
158158
- **Pause** - Stops the deck playback
159159

160-
Effects section
161-
~~~~~~~~~~~~~~~
160+
### Effects section
161+
162162

163163
The left side controls effect unit 1 and the right side controls effect
164164
unit 2.
165165

166166
- **Select knob**
167-
168-
- Rotate to choose the effect chain preset
169-
- Press to toggle whether the effect unit is on or not
167+
- Rotate to choose the effect chain preset
168+
- Press to toggle whether the effect unit is on or not
170169

171170
- **Control knob**
172-
173-
- Adjusts the wet/dry ratio
174-
- When Parameter is on, this becomes the Wonder Knob, adjusting all
171+
- Adjusts the wet/dry ratio
172+
- When Parameter is on, this becomes the Wonder Knob, adjusting all
175173
effect parameters at once
176174

177175
- **On/Off** - Toggles the effect for the deck matching the effect unit
178176
number
179177
- **Parameter** - Toggles what the above Control knob adjusts
180178

181-
Sample section
182-
~~~~~~~~~~~~~~
179+
### Sample section
180+
183181

184182
The left side of the controller controls Sampler 1, and the right,
185183
Sampler 2.
@@ -196,8 +194,8 @@ Sampler 2.
196194
Hold Shift and press to stop playing.
197195
- **Rec** - *Currently does nothing*
198196

199-
Mixer controls
200-
--------------
197+
## Mixer controls
198+
201199

202200
The volume sliders don’t control the ones in Mixxx because direct Deck
203201
outputs are affected by Mixxx’s internal ones.

0 commit comments

Comments
 (0)