aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_ps2_mouse.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_ps2_mouse.md')
-rw-r--r--docs/feature_ps2_mouse.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/feature_ps2_mouse.md b/docs/feature_ps2_mouse.md
index dac3a5b36..51ae5fa26 100644
--- a/docs/feature_ps2_mouse.md
+++ b/docs/feature_ps2_mouse.md
@@ -6,7 +6,7 @@ To hook up a Trackpoint, you need to obtain a Trackpoint module (i.e. harvest fr
6 6
7There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended). 7There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended).
8 8
9### Busywait version 9### Busywait Version
10 10
11Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible. 11Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
12 12
@@ -32,7 +32,7 @@ In your keyboard config.h:
32#endif 32#endif
33``` 33```
34 34
35### Interrupt version 35### Interrupt Version
36 36
37The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data. 37The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
38 38
@@ -70,7 +70,7 @@ In your keyboard config.h:
70#endif 70#endif
71``` 71```
72 72
73### USART version 73### USART Version
74 74
75To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version. 75To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
76 76
@@ -129,7 +129,7 @@ In your keyboard config.h:
129 129
130### Additional Settings 130### Additional Settings
131 131
132#### PS/2 mouse features 132#### PS/2 Mouse Features
133 133
134These enable settings supported by the PS/2 mouse protocol: http://www.computer-engineering.org/ps2mouse/ 134These enable settings supported by the PS/2 mouse protocol: http://www.computer-engineering.org/ps2mouse/
135 135
@@ -170,7 +170,7 @@ void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
170void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate); 170void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
171``` 171```
172 172
173#### Fine control 173#### Fine Control
174 174
175Use the following defines to change the sensitivity and speed of the mouse. 175Use the following defines to change the sensitivity and speed of the mouse.
176Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads). 176Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads).
@@ -181,7 +181,7 @@ Note: you can also use `ps2_mouse_set_resolution` for the same effect (not suppo
181#define PS2_MOUSE_V_MULTIPLIER 1 181#define PS2_MOUSE_V_MULTIPLIER 1
182``` 182```
183 183
184#### Scroll button 184#### Scroll Button
185 185
186If you're using a trackpoint, you will likely want to be able to use it for scrolling. 186If you're using a trackpoint, you will likely want to be able to use it for scrolling.
187Its possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving. 187Its possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving.
@@ -227,7 +227,7 @@ Fine control over the scrolling is supported with the following defines:
227#define PS2_MOUSE_SCROLL_DIVISOR_V 2 227#define PS2_MOUSE_SCROLL_DIVISOR_V 2
228``` 228```
229 229
230#### Invert mouse and scroll axes 230#### Invert Mouse and Scroll Axes
231 231
232To invert the X and Y axes you can put: 232To invert the X and Y axes you can put:
233 233
@@ -247,7 +247,7 @@ To reverse the scroll axes you can put:
247 247
248into config.h. 248into config.h.
249 249
250#### Debug settings 250#### Debug Settings
251 251
252To debug the mouse, add `debug_mouse = true` or enable via bootmagic. 252To debug the mouse, add `debug_mouse = true` or enable via bootmagic.
253 253