Skip to content

Commit

Permalink
docs: Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mayanez committed Mar 26, 2024
1 parent 09f3962 commit 0a963dc
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,35 @@ or

The first thing you'll want to do is `dump` your current configuration:

$ dumang-config dump > config.yml

The configuration is a YAML file describing each _Board_ half, the attached _Key Modules_, and the keycodes associated with each _Layer_ or _Macro_. Each _Board_ and _Key Module_ will have an associated `serial` that is embedded in the hardware. Each _Key Module_ can be assigned up to four layers (eg. `layer_0` - `layer_3`) and one macro.
$ dumang-config dump --format=yaml > config.yml
$ dumang-config dump --format=json > config.json

The configuration is a file describing each _Board_ half, the attached _Key Modules_, and the keycodes associated with each _Layer_ or _Macro_. Each _Board_ and _Key Module_ will have an associated `serial` that is embedded in the hardware. Each _Key Module_ can be assigned up to four layers (eg. `layer_0` - `layer_3`), one macro, and one color.

The following is an example of a YAML configuration file:

```yml
- board:
serial: "DEADBEEF" # as hex string
nkro: true # or false. When false at most 6 keys can be pressed at a given time.
report_rate: 1000 # Allowed values [100, 125, 200, 250, 333, 500, 1000]
keys:
- key:
serial: "28287602" # as hex string
layer_0: BACKSLASH # Refer to HID Keycodes in dumang_ctrl/dumang/common.py
layer_1: MACRO
layer_2: TRANSPARENT
layer_3: TRANSPARENT
color: "FF0000" # as hex string. Note that the LED can only represet 4-bits for each color channel [0x00 - 0x0F].
macro:
# A maximum of 69 entries are allowed.
- type: KEYDOWN # Valid types: [KEYDOWN, KEYUP, WAIT_KEYUP]
key: A
delay_ms: 10 # Delay Range: [10 - 65280]
- type: KEYUP
key: A
delay_ms: 10
```
#### inspect
Expand All @@ -61,6 +87,7 @@ The GUI will allow you to inspect your current configuration, but most important

The `load` command does the opposite of the `dump` command and allows one to program _Key Modules_.

$ dumang-config load <file>
$ dumang-config load --format=yaml <file>
$ dumang-config load --format=json <file>

This will only load the configuration onto _Key Modules_ that are specified in the file, all other keys will be unaffected.

0 comments on commit 0a963dc

Please sign in to comment.