aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_sequencer.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2020-11-28 12:02:18 -0800
committerGitHub <noreply@github.com>2020-11-28 12:02:18 -0800
commitc66df1664497546f32662409778731143e45a552 (patch)
treeda73a2d532a27685a31d932b3a44a707d4a3af81 /docs/feature_sequencer.md
parent15385d4113414d42bd062c60c9de5df797d3157f (diff)
downloadqmk_firmware-c66df1664497546f32662409778731143e45a552.tar.gz
qmk_firmware-c66df1664497546f32662409778731143e45a552.zip
2020 November 28 Breaking Changes Update (#11053)
* Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
Diffstat (limited to 'docs/feature_sequencer.md')
-rw-r--r--docs/feature_sequencer.md88
1 files changed, 88 insertions, 0 deletions
diff --git a/docs/feature_sequencer.md b/docs/feature_sequencer.md
new file mode 100644
index 000000000..8c8587a9b
--- /dev/null
+++ b/docs/feature_sequencer.md
@@ -0,0 +1,88 @@
1# Sequencer
2
3Since QMK has experimental support for MIDI, you can now turn your keyboard into a [step sequencer](https://en.wikipedia.org/wiki/Music_sequencer#Step_sequencers)!
4
5!> **IMPORTANT:** This feature is highly experimental, it has only been tested on a Planck EZ so far. Also, the scope will be limited to support the drum machine use-case to start with.
6
7## Enable the step sequencer
8
9Add the following line to your `rules.mk`:
10
11```make
12SEQUENCER_ENABLE = yes
13```
14
15By default the sequencer has 16 steps, but you can override this setting in your `config.h`:
16
17```c
18#define SEQUENCER_STEPS 32
19```
20
21## Tracks
22
23You can program up to 8 independent tracks with the step sequencer. Select the tracks you want to edit, enable or disable some steps, and start the sequence!
24
25## Resolutions
26
27While the tempo defines the absolute speed at which the sequencer goes through the steps, the resolution defines the granularity of these steps (from coarser to finer).
28
29|Resolution |Description |
30|---------- |----------- |
31|`SQ_RES_2` |Every other beat |
32|`SQ_RES_2T` |Every 1.5 beats |
33|`SQ_RES_4` |Every beat |
34|`SQ_RES_4T` |Three times per 2 beats|
35|`SQ_RES_8` |Twice per beat |
36|`SQ_RES_8T` |Three times per beat |
37|`SQ_RES_16` |Four times per beat |
38|`SQ_RES_16T` |Six times per beat |
39|`SQ_RES_32` |Eight times per beat |
40
41## Keycodes
42
43|Keycode |Description |
44|------- |----------- |
45|`SQ_ON` |Start the step sequencer |
46|`SQ_OFF` |Stop the step sequencer |
47|`SQ_TOG` |Toggle the step sequencer playback |
48|`SQ_SALL`|Enable all the steps |
49|`SQ_SCLR`|Disable all the steps |
50|`SQ_S(n)`|Toggle the step `n` |
51|`SQ_TMPD`|Decrease the tempo |
52|`SQ_TMPU`|Increase the tempo |
53|`SQ_R(n)`|Set the resolution to n |
54|`SQ_RESD`|Change to the slower resolution |
55|`SQ_RESU`|Change to the faster resolution |
56|`SQ_T(n)`|Set `n` as the only active track or deactivate all |
57
58## Functions
59
60|Function |Description |
61|-------- |----------- |
62|`bool is_sequencer_on(void);` |Return whether the sequencer is playing |
63|`void sequencer_toggle(void);` |Toggle the step sequencer playback |
64|`void sequencer_on(void);` |Start the step sequencer |
65|`void sequencer_off(void);` |Stop the step sequencer |
66|`bool is_sequencer_step_on(uint8_t step);` |Return whether the step is currently enabled |
67|`void sequencer_set_step(uint8_t step, bool value);` |Enable or disable the step |
68|`void sequencer_set_step_on();` |Enable the step |
69|`void sequencer_set_step_off();` |Disable the step |
70|`void sequencer_toggle_step(uint8_t step);` |Toggle the step |
71|`void sequencer_set_all_steps(bool value);` |Enable or disable all the steps |
72|`void sequencer_set_all_steps_on();` |Enable all the steps |
73|`void sequencer_set_all_steps_off();` |Disable all the steps |
74|`uint8_t sequencer_get_tempo(void);` |Return the current tempo |
75|`void sequencer_set_tempo(uint8_t tempo);` |Set the tempo to `tempo` (between 1 and 255) |
76|`void sequencer_increase_tempo(void);` |Increase the tempo |
77|`void sequencer_decrease_tempo(void);` |Decrease the tempo |
78|`sequencer_resolution_t sequencer_get_resolution(void);` |Return the current resolution |
79|`void sequencer_set_resolution(sequencer_resolution_t resolution);` |Set the resolution to `resolution` |
80|`void sequencer_increase_resolution(void);` |Change to the faster resolution |
81|`void sequencer_decrease_resolution(void);` |Change to the slower resolution |
82|`bool is_sequencer_track_active(uint8_t track);` |Return whether the track is active |
83|`void sequencer_set_track_activation(uint8_t track, bool value);` |Activate or deactivate the `track` |
84|`void sequencer_toggle_track_activation(uint8_t track);` |Toggle the `track` |
85|`void sequencer_activate_track(uint8_t track);` |Activate the `track` |
86|`void sequencer_deactivate_track(uint8_t track);` |Deactivate the `track` |
87|`void sequencer_toggle_single_active_track(uint8_t track);` |Set `track` as the only active track or deactivate all |
88
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-15 06:03:17 +0000