summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2022-01-17 08:44:34 +1100
committerGitHub <noreply@github.com>2022-01-17 08:44:34 +1100
commitc72ed7c02473dec4da6cb263c1e0fb2ca4856b94 (patch)
tree4c218562b5ed5bbd34da67f37093ba6f47012d57 /docs
parent557fbbd6afbff3bdd571e580ea79ba3905a28ce4 (diff)
CLI: Parse USB device version BCD (#14580)
* CLI: Parse USB device version BCD * Apply suggestions
Diffstat (limited to 'docs')
-rw-r--r--docs/reference_info_json.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index b2e6cae28e..3cc807c179 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -172,7 +172,7 @@ The following animations can be enabled:
### USB
-Every USB keyboard needs to have its USB parmaters defined. At a minimum you need to set vid, pid, and device version.
+Every USB keyboard needs to have its USB parameters defined. At a minimum you need to set the Vendor ID, Product ID, and device version.
Example:
@@ -181,7 +181,9 @@ Example:
"usb": {
"vid": "0xC1ED",
"pid": "0x23B0",
- "device_ver": "0x0001"
+ "device_version": "1.0.0"
}
}
```
+
+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.