diff options
Diffstat (limited to 'docs/feature_haptic_feedback.md')
-rw-r--r-- | docs/feature_haptic_feedback.md | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/feature_haptic_feedback.md b/docs/feature_haptic_feedback.md index 1f36f5b05..c8c74cb8f 100644 --- a/docs/feature_haptic_feedback.md +++ b/docs/feature_haptic_feedback.md | |||
@@ -4,9 +4,22 @@ | |||
4 | 4 | ||
5 | The following options are currently available for haptic feedback in `rules.mk`: | 5 | The following options are currently available for haptic feedback in `rules.mk`: |
6 | 6 | ||
7 | `HAPTIC_ENABLE += DRV2605L` | 7 | ``` |
8 | HAPTIC_ENABLE = yes | ||
9 | |||
10 | HAPTIC_DRIVER += DRV2605L | ||
11 | HAPTIC_DRIVER += SOLENOID | ||
12 | ``` | ||
13 | |||
14 | The following `config.h` settings are available for all types of haptic feedback: | ||
8 | 15 | ||
9 | `HAPTIC_ENABLE += SOLENOID` | 16 | | Settings | Default | Description | |
17 | |--------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------| | ||
18 | |`HAPTIC_ENABLE_PIN` | *Not defined* |Configures a pin to enable a boost converter for some haptic solution, often used with solenoid drivers. | | ||
19 | |`HAPTIC_ENABLE_PIN_ACTIVE_LOW` | *Not defined* |If defined then the haptic enable pin is active-low. | | ||
20 | |`HAPTIC_ENABLE_STATUS_LED` | *Not defined* |Configures a pin to reflect the current enabled/disabled status of haptic feedback. | | ||
21 | |`HAPTIC_ENABLE_STATUS_LED_ACTIVE_LOW` | *Not defined* |If defined then the haptic status led will be active-low. | | ||
22 | |`HAPTIC_OFF_IN_LOW_POWER` | `0` |If set to `1`, haptic feedback is disabled before the device is configured, and while the device is suspended. | | ||
10 | 23 | ||
11 | ## Known Supported Hardware | 24 | ## Known Supported Hardware |
12 | 25 | ||
@@ -45,6 +58,7 @@ First you will need a build a circuit to drive the solenoid through a mosfet as | |||
45 | | Settings | Default | Description | | 58 | | Settings | Default | Description | |
46 | |----------------------------|----------------------|-------------------------------------------------------| | 59 | |----------------------------|----------------------|-------------------------------------------------------| |
47 | |`SOLENOID_PIN` | *Not defined* |Configures the pin that the Solenoid is connected to. | | 60 | |`SOLENOID_PIN` | *Not defined* |Configures the pin that the Solenoid is connected to. | |
61 | |`SOLENOID_PIN_ACTIVE_LOW` | *Not defined* |If defined then the solenoid trigger pin is active low.| | ||
48 | |`SOLENOID_DEFAULT_DWELL` | `12` ms |Configures the default dwell time for the solenoid. | | 62 | |`SOLENOID_DEFAULT_DWELL` | `12` ms |Configures the default dwell time for the solenoid. | |
49 | |`SOLENOID_MIN_DWELL` | `4` ms |Sets the lower limit for the dwell. | | 63 | |`SOLENOID_MIN_DWELL` | `4` ms |Sets the lower limit for the dwell. | |
50 | |`SOLENOID_MAX_DWELL` | `100` ms |Sets the upper limit for the dwell. | | 64 | |`SOLENOID_MAX_DWELL` | `100` ms |Sets the upper limit for the dwell. | |
@@ -170,8 +184,9 @@ The Haptic Exclusion is implemented as `__attribute__((weak)) bool get_haptic_en | |||
170 | ### NO_HAPTIC_MOD | 184 | ### NO_HAPTIC_MOD |
171 | With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will not trigger feedback: | 185 | With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will not trigger feedback: |
172 | 186 | ||
173 | * Usual modifier keys such as Control/Shift/Alt/Gui (For example `KC_LCTRL`) | 187 | * Usual modifier keys such as Control/Shift/Alt/Gui (For example `KC_LCTL`) |
174 | * `MO()` momentary keys. See also [Layers](feature_layers.md). | 188 | * `MO()` momentary keys. See also [Layers](feature_layers.md). |
189 | * `LM()` momentary keys with mod active. | ||
175 | * `LT()` layer tap keys, when held to activate a layer. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. | 190 | * `LT()` layer tap keys, when held to activate a layer. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. |
176 | * `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered. | 191 | * `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered. |
177 | * `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md). | 192 | * `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md). |