summaryrefslogtreecommitdiff
path: root/docs/reference_info_json.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2022-07-13 00:06:19 +0100
committerGitHub <noreply@github.com>2022-07-13 00:06:19 +0100
commit2a3dd95229b68492e8740e1906957dad8ea38ea3 (patch)
tree793f6e7a11d38a9f73e524b0c2d2e2c08e13e3ab /docs/reference_info_json.md
parent2714c70bd774489f039b7c60a2f8634a64ff40c3 (diff)
downloadqmk_firmware-2a3dd95229b68492e8740e1906957dad8ea38ea3.tar.gz
qmk_firmware-2a3dd95229b68492e8740e1906957dad8ea38ea3.zip
Add basic secure docs (#17577)
Diffstat (limited to 'docs/reference_info_json.md')
-rw-r--r--docs/reference_info_json.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 97817164dd..aa59711592 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -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
+ }
+}
+```