aboutsummaryrefslogtreecommitdiffhomepage
path: root/schema
diff options
context:
space:
mode:
authorPeter Johanson <[email protected]>2022-12-23 05:02:18 +0000
committerPete Johanson <[email protected]>2022-12-23 02:41:35 -0600
commitc23443a086b62833ba0b88dd3a271993d3bc9cea (patch)
treeb525d3bb8707719ef33c595d581ea4e3a23f4b3e /schema
parentd993b0343304c1d7f67837e1d5a42e70bf05a8f2 (diff)
downloadzmk-c23443a086b62833ba0b88dd3a271993d3bc9cea.tar.gz
zmk-c23443a086b62833ba0b88dd3a271993d3bc9cea.zip
feat(docs): Generate new shield interconnect docs.
* Add to metadata schema for interconnects. * New conventional location for pinout diagrams/pics. * New component to generate the tabs for the new shield doc section on interconnects. * Add XIAO and arduino uno pinout diagram. Co-authored-by: Cem Aksoylar <[email protected]>
Diffstat (limited to 'schema')
-rw-r--r--schema/hardware-metadata.schema.json22
1 files changed, 22 insertions, 0 deletions
diff --git a/schema/hardware-metadata.schema.json b/schema/hardware-metadata.schema.json
index 4975574928..8ca382c552 100644
--- a/schema/hardware-metadata.schema.json
+++ b/schema/hardware-metadata.schema.json
@@ -85,6 +85,21 @@
}
}
},
+ "interconnect_node_labels": {
+ "title": "InterconnectNodeLabels",
+ "type": "object",
+ "additionalProperties": false,
+ "required": [
+ "gpio"
+ ],
+ "properties": {
+ "gpio": { "type": "string" },
+ "i2c": { "type": "string" },
+ "spi": { "type": "string" },
+ "uart": { "type": "string" },
+ "adc": { "type": "string" }
+ }
+ },
"interconnect": {
"title": "Interconnect",
"type": "object",
@@ -93,6 +108,7 @@
"file_format",
"id",
"name",
+ "description",
"url",
"type"
],
@@ -117,6 +133,12 @@
"description": {
"type": "string"
},
+ "node_labels": {
+ "$ref": "#/$defs/interconnect_node_labels"
+ },
+ "design_guideline": {
+ "type": "string"
+ },
"manufacturer": {
"type": "string"
},