velvettear/ninwa
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated docs

Browse source
This commit is contained in:
Daniel Sommer 2022-03-11 15:59:03 +01:00
parent 5dd86716e9
commit 50929c4efc
1 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -57,16 +57,24 @@ configuration is done entirely within the file `config.json`.
- level: [*string*] verbosity of the log; either `debug`, `info`, `warning` or `error` - level: [*string*] verbosity of the log; either `debug`, `info`, `warning` or `error`
- timestamp: [*string*] format string for the timestamp; review [moment.js](https://momentjs.com/docs/#/displaying/format/) for further information - timestamp: [*string*] format string for the timestamp; review [moment.js](https://momentjs.com/docs/#/displaying/format/) for further information
### socket: [*object*] ### combos: [*object*]
- location: [*string*] path to the socket file; defaults to `/tmp/ninwa.sock` - delay: [*number*] time in milliseconds until a combo will be reset
### watchers: [*object-array*] ### watchers: [*object-array*]
- device: [*string*] name of or path to an input device; ninwa automatically tries to locate the device in `/dev/input` and `/dev/input/by-id/` if only a name is given - device: [*string*] name of or path to an input device; ninwa automatically tries to locate the device in `/dev/input` and `/dev/input/by-id/` if only a name is given
- restart: [*boolean*] restart watcher on close - restart: [*boolean*] restart watcher on close
- grep: [*string*] pre-filter evtest's output with grep - sudo: [*boolean*] use sudo to start the evtest process
- keys: [*object-array*] - keys: [*object-array*]
- key: [*string*] name of the key - key: [*string*] name of the key
- combo: [*string-array*] name of one or more keys (in order)
- event: [*string*] [event type](https://www.kernel.org/doc/html/latest/input/event-codes.html) to filter evtest's output for
- type: [*string*] type of the key event; either `keyup`, `keydown` or `keyhold` - type: [*string*] type of the key event; either `keyup`, `keydown` or `keyhold`
- delay: [*number*] time in milliseconds until the key will be registered again (mostly useful for keyhold-events) - delay: [*number*] time in milliseconds until the key will be registered again (mostly useful for keyhold-events; **unavailable for combos**)
- command: [*string*] command to execute on key press - command: [*string*] name of the command to execute on key press / combo end
### commands: [*object*]
- *name*: [*object*]
- cmd: [*string*] command / path to script to execute
- args: [*string-array*] arguments to pass to the executed command; variables `{{ key }}` and `{{ type }}` used in args will be replaced - args: [*string-array*] arguments to pass to the executed command; variables `{{ key }}` and `{{ type }}` used in args will be replaced
- sudo: [*boolean*] use sudo to execute the command