Skip to content

Commit

Permalink
Fix spellchecking of analogin.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xs5871 committed Jan 8, 2025
1 parent 6779aa6 commit 3a76f2b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
18 changes: 9 additions & 9 deletions docs/en/analogin.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ analog = AnalogInputs(
)
```

#### inputs
#### `inputs`

A list of `AnalogInput` objects, see below.

#### evtmap
#### `evtmap`

The event map is `AnalogIn`s version of `keyboard.keymap`, but for analog events
instead of keys.
Expand All @@ -46,21 +46,21 @@ a.delta

```

#### input
#### `input`

An `AnalogIn` like object.

#### filter
#### `filter`

A customizable function that reads and transforms `input.value`.
The default transformation maps uint16 ([0-65535]) to uint8 ([0-255]) resolution.

#### value
#### `value`

Holds the transformed value of the `AnalogIn` input.
To be used in handler functions.

#### delta
#### `delta`

Holds the amount of change of transformed value of the `AnalogIn` input.
To be used in handler functions.
Expand Down Expand Up @@ -118,9 +118,9 @@ keyboard.modules.append(analog)

### External DAC with AnalogEvent

Use an external ADC to adjust holdtap taptime at runtime between 20 and 2000 ms.
If no new readings occur: change rgb hue.
But carefull: if changed by more than 100 units at a time, the board will reboot.
Use an external ADC to adjust `HoldTap.tap_time` at runtime between 20 and 2000 ms.
If no new readings occur: change RGB hue.
But careful: if changed by more than 100 units at a time, the board will reboot.

```python
# setup of holdtap and rgb omitted for brevity
Expand Down
12 changes: 11 additions & 1 deletion util/aspell.en.pws
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
personal_ws-1.1 en 363
personal_ws-1.1 en 368
ADNS
AMS
ANAVI
Expand All @@ -7,6 +7,13 @@ AVR
Adafruit
Adafruit's
Affero
AnalogEvent
AnalogIn
AnalogInput
AnalogInputs
AnalogKey
AnalogKeys
Analogio
BT
BYO
Batreus
Expand All @@ -33,6 +40,7 @@ Crkbd
Crowboard
Ctrl
Cygwin
DAC
DFU
DISCOVERABLE
DIY
Expand Down Expand Up @@ -218,6 +226,7 @@ adafruit
addon
adns
amongst
analogio
argumented
assignees
automounter
Expand Down Expand Up @@ -350,6 +359,7 @@ synched
th
tl
txt
uint
uncomment
underglow
underlighting
Expand Down

0 comments on commit 3a76f2b

Please sign in to comment.