diff options
author | Purdea Andrei <andrei@purdea.ro> | 2021-11-02 07:54:29 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-02 16:54:29 +1100 |
commit | 76fb54403ccd3ebaf1ca49c5172335e3593c5c5c (patch) | |
tree | 30b41c0b027baa5b9494f80ec0fd83c50a53fd5b /docs | |
parent | 85d94d0c4d97de3d1b7ce0476499f44e79c25944 (diff) | |
download | qmk_firmware-76fb54403ccd3ebaf1ca49c5172335e3593c5c5c.tar.gz qmk_firmware-76fb54403ccd3ebaf1ca49c5172335e3593c5c5c.zip |
haptic: Feature to disable it when usb port is not configured or suspended. (#12692)
This also add support for specifying a LED pin to indicate haptic status,
and also adds support for a haptic-enable pin, which is useful to turn off
the boost converter on the solenoid driver.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_haptic_feedback.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/feature_haptic_feedback.md b/docs/feature_haptic_feedback.md index 4054c5d9b..159296a29 100644 --- a/docs/feature_haptic_feedback.md +++ b/docs/feature_haptic_feedback.md | |||
@@ -11,6 +11,16 @@ HAPTIC_DRIVER += DRV2605L | |||
11 | HAPTIC_DRIVER += SOLENOID | 11 | HAPTIC_DRIVER += SOLENOID |
12 | ``` | 12 | ``` |
13 | 13 | ||
14 | The following `config.h` settings are available for all types of haptic feedback: | ||
15 | |||
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. | | ||
23 | |||
14 | ## Known Supported Hardware | 24 | ## Known Supported Hardware |
15 | 25 | ||
16 | | Name | Description | | 26 | | Name | Description | |
@@ -48,6 +58,7 @@ First you will need a build a circuit to drive the solenoid through a mosfet as | |||
48 | | Settings | Default | Description | | 58 | | Settings | Default | Description | |
49 | |----------------------------|----------------------|-------------------------------------------------------| | 59 | |----------------------------|----------------------|-------------------------------------------------------| |
50 | |`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.| | ||
51 | |`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. | |
52 | |`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. | |
53 | |`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. | |