Skip to content

Commit c5a3434

Browse files
committed
Update key commands' explanation
1 parent 1f1b715 commit c5a3434

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

docs/COMMANDS.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -274,14 +274,14 @@ A set of key commands is a sequence of commands to be executed when a specified
274274
- __Description:__ Description of hot key
275275
- __Commands:__ Commands to be executed when the hot key is pressed
276276

277-
A command can set brightness or contrast of a monitor or all monitors, or input source of a monitor.
277+
A command can set brightness or contrast of a monitor or all monitors, or input source of a monitor, or increment or decrement brightness of a monitor or all monitors.
278278

279279
As for the available modifier keys (Alt, Ctrl, Shift, Windows) and keys, please refer the following pages.
280280

281281
- [ModifierKeys Enum](https://learn.microsoft.com/en-us/dotnet/api/system.windows.input.modifierkeys)
282282
- [Key Enum](https://learn.microsoft.com/en-us/dotnet/api/system.windows.input.key)
283283

284-
If the specified hot key has been already used by the OS or other apps, such hot key cannot be set. In addition, some combinations are not supported as hot keys.
284+
If the specified hot key has been already used by the OS or other apps, the same hot key cannot be set. In addition, some combinations are not supported as hot keys.
285285

286286
The sets of key commands must be specified in an array of JSON format. Then, the prepared JSON file must be loaded using `/load` option. Please refer to [Load/Unload Commands](#loadunload-commands).
287287

@@ -303,6 +303,7 @@ The valid values will be shown in parentheses. The following are typical values
303303
Here are a few remarks:
304304

305305
- A set of key commands will be overwritten by another set of the same hot key. To execute multiple commands by the same hot key, they must be included in one set of key commands.
306+
- A key command to increment or decrement brightness will be repeatable only if all commands are those to increment or decrement brightness.
306307
- While conditional/time/key commands are being executed, other conditional/time/key commands will not be executed. Therefore, the brightness set by key commands will not trigger conditional commands.
307308
- Hot keys must be enabled in Key Settings.
308309

@@ -334,7 +335,7 @@ Here are a few remarks:
334335
}
335336
]
336337
},
337-
{
338+
{
338339
"KeyGesture": "Ctrl+Alt+Y",
339340
"Description": "Monitor 1 to HDMI 1",
340341
"Commands": [
@@ -345,6 +346,30 @@ Here are a few remarks:
345346
"Value": 17
346347
}
347348
]
349+
},
350+
{
351+
"KeyGesture": "Ctrl+Alt+I",
352+
"Description": "All increment",
353+
"Commands": [
354+
{
355+
"Option": "IncrementBrightness",
356+
"DeviceInstanceId": null,
357+
"IsAll": true,
358+
"Value": 25
359+
}
360+
]
361+
},
362+
{
363+
"KeyGesture": "Ctrl+Alt+D",
364+
"Description": "All decrement",
365+
"Commands": [
366+
{
367+
"Option": "DecrementBrightness",
368+
"DeviceInstanceId": null,
369+
"IsAll": true,
370+
"Value": 25
371+
}
372+
]
348373
}
349374
]
350375
```
@@ -363,7 +388,9 @@ Here are a few remarks:
363388
"enum": [
364389
"SetBrightness",
365390
"SetContrast",
366-
"SetInput"
391+
"SetInput",
392+
"IncrementBrightness",
393+
"DecrementBrightness"
367394
]
368395
},
369396
"DeviceInstanceId": {

0 commit comments

Comments
 (0)