Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

Add basic secure docs (#17577)

Browse source
This commit is contained in:
Joel Challis 2022-07-13 00:06:19 +01:00 • committed by GitHub
parent 2714c70bd7
commit 2a3dd95229
Failed to generate hash of commit
3 changed files with 77 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/reference_info_json.md
View file

@ -238,3 +238,25 @@ Example:
```
The device version is a BCD (binary coded decimal) value, in the format `MMmr`, so the below value would look like `0x0100` in the generated code. This also means the maximum valid values for each part are `99.9.9`, despite it being a hexadecimal value under the hood.
### Secure
The following options can be configured:
|Key |Description |
|------------------|---------------------------------------------------------------------------------|
|`unlock_sequence` | Timeout for the user to perform the configured unlock sequence - `0` to disable |
|`unlock_timeout` | Timeout while unlocked before returning to locked - `0` to disable |
|`idle_timeout` | Array of matrix locations describing a sequential sequence of keypresses |
Example:
```json
{
"secure": {
"unlock_sequence": [ [0,0], [0,1] ],
"unlock_timeout": 5000,
"idle_timeout": 60000
}
}
```