sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Implement suggestions and improve documentation clarity

Browse Source
This commit is contained in:
James Fitzgerald 2022-06-29 09:49:19 -04:00 committed by xs5871
parent c77bfc432a
commit 7886b374b6
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/rapidfire.md
View File

@ -23,12 +23,12 @@ Each repeat counts as one full cycle of pressing and releasing. RapidFire works
The RapidFire keycode has a few different options:
| Option | Default Value | Description |
| :-------------------: | :-----------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `repeat` | `100` | The delay between repeats in milliseconds. Note: `10` appears to be the minimum effective value. If you run into issues, try increasing this value. |
| `wait` | `200` | The delay before starting to repeat in milliseconds. Useful if you want to be able to type with keys that have a low `repeat` value. A value of `0` will result in no waiting period. |
| `randomize_repeat` | `False` | Randomize the value of `repeat`. Useful for making the repetitive input look human in instances where you may be flagged as a bot otherwise. |
| `randomize_magnitude` | `15` | The magnitude of the randomization. If randomization is enabled, the repeat delay will be `repeat` plus or minus a random value up to this amount. |
| `toggle` | `False` | If set to `True`, activating RapidFire will toggle it on or off. Useful if you don't want to have to keep the button held. Set `wait` to `0` if you would like to toggle on tap. |
| :-----------------------: | :-----------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `interval` | `100` | The time between key taps sent in milliseconds. Note: `10` appears to be the minimum effective value. |
| `timeout` | `200` | The amount of time in milliseconds the key must be held down before RapidFire activates. Useful if you want to be able to type with keys that have a low `interval` value. A value of `0` will result in no waiting period. |
| `randomize` | `False` | Add randomization to the value of `interval`. Useful for making the repetitive input look human in instances where you may be flagged as a bot otherwise. |
| `randomization_magnitude` | `15` | If `randomize` is `True`, the time between key taps sent will be `interval` plus or minus a random value up to this amount. |
| `toggle` | `False` | If set to `True`, activating RapidFire will toggle it on or off. Useful if you don't want to have to keep the button held. Set `timeout` to `0` if you would like to toggle on tap. |
### Example Code
@ -38,9 +38,9 @@ from kmk.modules.rapidfire import RapidFire
keyboard.modules.append(RapidFire())
# After 200 milliseconds, repeatedly send Shift+A every 75-125 milliseconds while the button is held
SPAM_A = KC.RF(KC.LSFT(KC.A), wait=200, repeat=100, randomize_repeat=True, randomize_magnitude=25)
SPAM_A = KC.RF(KC.LSFT(KC.A), timeout=200, interval=100, randomize=True, randomization_magnitude=25)
# Immediately toggle repeatedly sending Enter every 50 milliseconds on tap
SPAM_ENTER = KC.RF(KC.ENT, toggle=True, wait=0, repeat=50)
SPAM_ENTER = KC.RF(KC.ENT, toggle=True, timeout=0, interval=50)
keyboard.keymap = [[

28
kmk/modules/rapidfire.py
View File

@ -8,17 +8,17 @@ class RapidFireMeta:
def __init__(
self,
kc,
repeat=100,
wait=200,
randomize_repeat=False,
randomize_magnitude=15,
interval=100,
timeout=200,
randomize=False,
randomization_magnitude=15,
toggle=False,
):
self.kc = kc
self.repeat = repeat
self.wait = wait
self.randomize_repeat = randomize_repeat
self.randomize_magnitude = randomize_magnitude
self.interval = interval
self.timeout = timeout
self.randomize = randomize
self.randomization_magnitude = randomization_magnitude
self.toggle = toggle
@ -36,11 +36,11 @@ class RapidFire(Module):
)
def _get_repeat(self, key):
if key.meta.randomize_repeat:
return key.meta.repeat + randint(
-key.meta.randomize_magnitude, key.meta.randomize_magnitude
if key.meta.randomize:
return key.meta.interval + randint(
-key.meta.randomization_magnitude, key.meta.randomization_magnitude
)
return key.meta.repeat
return key.meta.interval
def _on_timer_timeout(self, key, keyboard):
keyboard.tap_key(key.meta.kc)
@ -57,11 +57,11 @@ class RapidFire(Module):
self._toggled_keys.remove(key)
self._deactivate_key(key, keyboard)
return
if key.meta.wait > 0:
if key.meta.timeout > 0:
keyboard.tap_key(key.meta.kc)
self._waiting_keys.append(key)
self._active_keys[key] = keyboard.set_timeout(
key.meta.wait, lambda: self._on_timer_timeout(key, keyboard)
key.meta.timeout, lambda: self._on_timer_timeout(key, keyboard)
)
else:
self._on_timer_timeout(key, keyboard)