Skip to content

Commit 01fbf50

Browse files
authored
Merge pull request #20 from wanyann/main
update velvet-ui docs
2 parents eccd87a + 4a85d56 commit 01fbf50

7 files changed

Lines changed: 65 additions & 73 deletions

File tree

content/en/pages/docs/velvet-ui.md

Lines changed: 31 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ title = "Velvet v3 – UI Edition"
33
tags = ["docs", "velvet-ui"]
44
+++
55

6-
![image](/images/layouts/velvet-ui.png)
6+
![Velvet v3 UI](/images/layouts/velvet_ui.png)
77

88
**Velvet v3 - Ultimate Interface Edition** is a keyboard that reduces the need to move your hand to a minimum with a keywell layout and a trackball under your thumb. The curved key placement makes moving your fingers between rows of keys noticeably easier, and the functional trackball, easily accessible under your thumb, nearly eliminates the need to move your hand to the mouse.
99

10-
## Trackball
10+
## Cursor Control
1111

1212
![image](/images/velvet-ui/trackball.jpg)
1313

14-
The Velvet UI trackball has one interesting feature - it can detect user touches. In the default layout, briefly touching the trackball will trigger a left mouse button click, and holding your finger on the trackball will activate a special layer with mouse keys.
14+
The main feature of Velvet UI is a built-in trackball located under the thumb. Rotating the trackball moves the mouse cursor and temporarily activates a special layer with mouse keys.
1515

1616
![image](/images/velvet-ui/layer.png)
1717

18-
On the mouse layer there are other keys for working with the mouse cursor: right mouse button (**MB2**), mouse wheel click (**MB3**), left mouse button click (**MB1**) is duplicated on the layer for convenience, there are also keys for switching to scroll (**&mo 5**) and sniper (**&mo 6**) modes.
19-
In scroll mode, when you rotate the trackball, instead of moving the cursor, the page scrolls both vertically and horizontally.
18+
The mouse layer contains keys for cursor control: left mouse button (**MB1**), right mouse button (**MB2**), middle mouse click (**MB3**), as well as switching to Scroll mode (**&mo 5**) and Sniper mode (**&mo 6**).
19+
The mouse layer is activated when moving the cursor with the trackball, and if the trackball remains stationary for 500 milliseconds, the layer will automatically turn off.
2020

2121
{{< video
2222
autoplay="true"
@@ -37,36 +37,6 @@ Sniper mode reduces the speed of the cursor movement, allowing you to aim it mor
3737
>}}
3838
<br />
3939
40-
## Trackball touch actions
41-
42-
The action when you touch the trackball is quite flexible, as you can assign any **behavior** to it.
43-
44-
![image](/images/velvet-ui/keymap.png)
45-
46-
By default, the <a href="https://journey.ergohaven.xyz/en-gb/pages/docs/keymap-editor/#custom-behaviors" target="_blank">custom behavior</a> `&cap_sen` is assigned to the trackball touch, briefly touching the trackball produces a left mouse button click, and holding your finger down activates the mouse layer. You can view details of the behavior or change it in the *Behaviors* tab.
47-
48-
![image](/images/velvet-ui/capsen.png)
49-
50-
51-
### Disabling mouse click
52-
53-
To disable the left mouse button click during short-term touch, it is enough to assign `&mo 4` behavior instead of `&cap_sen`. In this way the mouse layer will be activated when touching the trackball, regardless of the duration of the touch.
54-
55-
![image](/images/velvet-ui/keymap-mo.png)
56-
57-
Reassigning trackball touch behavior is also available in **ZMK Studio**.
58-
59-
60-
### Delay turning off the mouse layer
61-
62-
With the assigned behavior `&mo 4` every time you move your finger from one edge of the trackball to the other, the mouse layer is deactivated, and if you move your finger often, for example, with intensive cursor control, there is a chance to press a key, exactly in the interval when the mouse layer is deactivated. Sometimes i wanted to press the left mouse button, but got the *F* key... You can reduce the chance of such a situation by using macros, because in them you can assign a temporary pause between actions.
63-
64-
![image](/images/velvet-ui/senmo.png)
65-
66-
The macro from the screenshot, when the user removes their finger from the trackball, will wait a small delay before disabling the mouse layer, this can help reduce mis-presses.
67-
> With the introduction of a delay before turning off a layer, accidental mouse button clicks may also occur, because there is now a short pause before the layer is turned off. The delay time can be reduced in the macro settings by changing the `Wait (ms)` (default 15 ms) and `Tap (ms)` (default 30 ms) parameters.
68-
69-
7040

7141
## Mode switching
7242

@@ -80,7 +50,7 @@ You can also make a hybrid <a href="https://journey.ergohaven.xyz/en-gb/pages/do
8050

8151
## Trackball configuration
8252

83-
All trackball modes can be customized in the `config/velvet_v3_ui.keymap` file, this can be done quickly and conveniently in the GitHub web-interface by clicking **Edit this file**.
53+
All trackball modes, including the automatic switching to the mouse layer, can be configured in the `config/velvet_v3_ui.keymap` file, this can be done quickly and conveniently in the GitHub web-interface by clicking **Edit this file**.
8454

8555
![image](/images/velvet-ui/github-edit.png)
8656

@@ -119,7 +89,31 @@ In addition to the `cpi` parameter, a multiplier `<&zip_xy_scaler 9 20>` is also
11989
&trackball_listener {
12090
input-processors = <&zip_xy_scaler 9 20>;
12191
```
122-
You can read more about the available `input-processors` in the ZMK documentation: https://zamk.dev/docs/keymaps/input-processors
92+
You can read more about the available `input-processors` in the ZMK documentation: https://zmk.dev/docs/keymaps/input-processors
93+
94+
95+
### Configuring Mouse Layer Activation
96+
97+
The `<&zip_auto_mouse 4 500>` fragment handles the automatic activation of the mouse layer. Let's review the available settings:
98+
99+
- 4 - the number of the layer to be automatically activated. If you change the keymap and the mouse layer gets a different number, simply update this value;
100+
- 500 - the duration for which the mouse layer remains active.
101+
102+
> If you want to disable the automatic mouse layer activation, simply remove the <&zip_auto_mouse 4 500> fragment.
103+
104+
To prevent accidental mouse layer activations during typing, the layer will not activate for 800 milliseconds after any key press. This delay can also be configured in the fragment located higher in the `config/velvet_v3_ui.keymap` file:
105+
106+
```
107+
zip_auto_mouse: zip_auto_mouse {
108+
compatible = "zmk,input-processor-temp-layer";
109+
#input-processor-cells = <2>;
110+
require-prior-idle-ms = <800>;
111+
excluded-positions = <>;
112+
};
113+
```
114+
115+
If you want to increase or decrease this threshold, edit the `require-prior-idle-ms` value.
116+
> For more information about automatic mouse layer settings, please refer to the [ZMK documentation](https://zmk.dev/docs/keymaps/input-processors/temp-layer).
123117
124118

125119
### Scroll mode settings

content/ru/.DS_Store

6 KB
Binary file not shown.

content/ru/pages/.DS_Store

6 KB
Binary file not shown.

content/ru/pages/docs/velvet-ui.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,18 @@ tags = ["docs", "velvet-ui"]
88
**Velvet v3 – Ultimate Interface Edition** - клавиатура, уменьшающая необходимость перемещения кисти до минимума за счет изогнутого расположения клавиш и наличия трекбола под большим пальцем. Благодаря изогнутости клавиатуры перемещение пальцев между рядами клавиш происходит заметно проще, а функциональный трекбол, всегда доступный под большим пальцем, практически полностью убирает необходимость перемещения руки к мышке.
99

1010

11-
## Трекбол
11+
## Управление курсором
1212

1313
![image](/images/velvet-ui/trackball.jpg)
1414

15-
У трекбола Velvet UI есть одна интересная особенность - он умеет определять, когда пользователь дотрагивается до шара. В раскладке по умолчанию при кратковременном нажатии на трекбол сработает клик левой кнопки мыши, а при удержании пальца на трекболе активируется специальный слой с клавишами мыши.
15+
Главная особенность Velvet UI - встроенный трекбол, находящийся под большим пальцем, при поворотах трекбола перемещается курсор мыши и временно активируется специальный слой с клавишами мыши.
1616

1717
![image](/images/velvet-ui/layer.png)
1818

19-
На слое мыши находятся остальные клавиши для работы с курсором: правая кнопка мыши (**MB2**), клик колесом мыши (**MB3**), для удобства на слое продублирован клик левой кнопки мыши (**MB1**), а также переключение на режимы скролла (**&mo 5**) и снайпера (**&mo 6**).
20-
В режиме скролла при кручении трекбола вместо перемещения курсора происходит скроллинг страницы, как по вертикали, так и по горизонтали.
19+
На слое мыши находятся клавиши для работы с курсором: левая кнопка мыши (**MB1**), правая кнопка мыши (**MB2**), клик колесом мыши (**MB3**), а также переключение на режимы скролла (**&mo 5**) и снайпера (**&mo 6**).
20+
Слой мыши активируется при перемещении курсора трекболом, и если в течение 500 милисекунд трекбол находится в неподвижном состоянии, то слой автоматически выключится.
21+
22+
В режиме скролла при кручении трекбола вместо перемещения курсора происходит скроллинг страницы, как по вертикали, так и по горизонтали.
2123

2224
{{< video
2325
autoplay="true"
@@ -38,35 +40,6 @@ tags = ["docs", "velvet-ui"]
3840
>}}
3941
<br />
4042
41-
## Действие при прикосновении к трекболу
42-
43-
Действие при прикосновении к трекболу можно довольно гибко настраивать, ведь на него можно назначить любое **поведение**.
44-
45-
![image](/images/velvet-ui/keymap.png)
46-
47-
По умолчанию на него назначено <a href="https://journey.ergohaven.xyz/pages/docs/keymap-editor/#custom-behaviors" target="_blank">кастомное поведение</a> `&cap_sen`, при кратковременном прикосновении к трекболу производящее клик левой кнопкой мыши, и при удержании пальца активируется слой мыши. Посмотреть подробности поведения или изменить его можно на вкладке *Behaviors*.
48-
49-
![image](/images/velvet-ui/capsen.png)
50-
51-
52-
### Отключение клика мыши
53-
54-
Чтобы отключить клик левой кнопкой мыши при кратковременном тапе достаточно назначить вместо `&cap_sen` поведение `&mo 4`. Таким образом слой мыши будет активироваться при прикосновении к трекболу, независимо от длительности прикосновения.
55-
56-
![image](/images/velvet-ui/keymap-mo.png)
57-
58-
Переназначение поведения при прикосновении к трекболу также доступно и в **ZMK Studio**.
59-
60-
61-
### Добавление задержки перед выключением слоя мыши
62-
63-
С назначенным поведением `&mo 4` при каждом переставлении пальца с одного края трекбола на другой происходит деактивация слоя мыши, и если переставлять палец часто, например при интенсивном управлении курсором, то есть ненулевой шанс нажать клавишу, именно в промежуток, когда слой мыши деактивировался. Хотел нажать левую кнопку мыши, а получилась клавиша *F*... Уменьшить шанс возникновения такой ситуации можно с помощью макросов, ведь в них можно назначить временную паузу между действиями.
64-
65-
![image](/images/velvet-ui/senmo.png)
66-
67-
Макрос со скриншота, когда пользователь уберет палец с трекбола, подождет небольшую задержку перед отключением слоя мыши, это может помочь уменьшить количество ошибочных нажатий.
68-
> С появлением задержки перед выключением слоя могут также появится и случайные нажатия кнопок мыши, ведь перед отключением слоя теперь есть небольшая пауза. Время задержки можно уменьшить в настройках макроса, изменив значение параметров `&macro_wait_time`, *Wait (ms)* (по умолчанию 15 мс) и *Tap (ms)* (по умолчанию 30 мс).
69-
7043

7144
## Переключение режимов
7245

@@ -80,7 +53,7 @@ tags = ["docs", "velvet-ui"]
8053

8154
## Конфигурирование трекбола
8255

83-
Все режимы трекбола можно настроить в файле `config/velvet_v3_ui.keymap`, это быстро и удобно можно сделать в веб-интерфейсе GitHub, нажав кнопку **Edit this file**.
56+
Все режимы трекбола, включая автоматическое переключение на слой мыши, можно настроить в файле `config/velvet_v3_ui.keymap`, это быстро и удобно можно сделать в веб-интерфейсе GitHub, нажав кнопку **Edit this file**.
8457

8558
![image](/images/velvet-ui/github-edit.png)
8659

@@ -90,7 +63,7 @@ tags = ["docs", "velvet-ui"]
9063
&trackball { cpi = <1000>; };
9164
9265
&trackball_listener {
93-
input-processors = <&zip_xy_scaler 9 20>;
66+
input-processors = <&zip_auto_mouse 4 500>, <&zip_xy_scaler 9 20>;
9467
9568
scroller {
9669
layers = <5>;
@@ -117,11 +90,36 @@ tags = ["docs", "velvet-ui"]
11790
Дополнительно к параметру `cpi` также применяется множитель `<&zip_xy_scaler 9 20>`, означающий что итоговая чувствительность будет равна девяти двадцатых от изначального значения `cpi`. Это значение также можно изменять.
11891
```
11992
&trackball_listener {
120-
input-processors = <&zip_xy_scaler 9 20>;
93+
input-processors = <&zip_auto_mouse 4 500>, <&zip_xy_scaler 9 20>;
12194
```
12295
Подробнее о доступных `input-processors` можно почитать в документации ZMK: https://zmk.dev/docs/keymaps/input-processors
12396

12497

98+
### Настройка переключения на слой мыши
99+
100+
Фрагмент `<&zip_auto_mouse 4 500>` отвечает за автоматическую активацию слоя мыши, рассмотрим доступные настройки:
101+
102+
- 4 - номер автоматически активируемого слоя, если вы измените раскладку слой мыши окажется с другим порядковым номером, то просто измените это значение;
103+
- 500 - время, на которое активируется слой мыши.
104+
105+
> Если вы хотите выключить автоматическую активацию слоя мыши, то просто удалите фрагмент `<&zip_auto_mouse 4 500>,`
106+
107+
Чтобы избежать случайных активаций слоя мыши при печати, в течение 800 милисекунд после нажатия клавиш слой мыши активироваться не будет, это время также можно настроить в фрагменте, находящемся выше в файле `config/velvet_v3_ui.keymap`.
108+
109+
```
110+
zip_auto_mouse: zip_auto_mouse {
111+
compatible = "zmk,input-processor-temp-layer";
112+
#input-processor-cells = <2>;
113+
require-prior-idle-ms = <800>;
114+
excluded-positions = <>;
115+
};
116+
```
117+
118+
Если хотите увеличить или уменьшить этот порог, отредактируйте значение `require-prior-idle-ms`.
119+
120+
> Подробнее о настройках автоматической активации слоя мыши можно почитать в [документации ZMK](https://zmk.dev/docs/keymaps/input-processors/temp-layer)
121+
122+
125123
### Настройки режима скролла
126124

127125
Для режима скролла доступны следующие настройки:
-475 Bytes
Loading
-665 Bytes
Loading

static/images/velvet-ui/senmo.png

-69.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)