Add meshtasticd config metadata (#10001)

To be consumed by config-picker utils, and hopefully meshtasticd itself in the future.
2026-03-27 11:38:49 -05:00
parent 993c242202
commit 068f5af4d8
33 changed files with 281 additions and 68 deletions
@@ -0,0 +1,28 @@
+# meshtasticd configuration files
+
+This directory contains YAML configuration files for meshtasticd. Each file describes a specific hardware configuration, including the LoRa module and pin assignments. These configurations are used by meshtasticd to correctly interface with the hardware.
+
+## Metadata structure
+
+Each configuration file includes a `Meta` section that provides information about the configuration.
+This configuration is consumed by configuration-selection tools.
+
+```yaml
+Meta:
+  name: MeshAdv-Pi E22-900M30S # A unique identifier for this configuration.
+  support: community # community, official, or deprecated; determined by Meshtastic Leads.
+  compatible: # A list of compatible products or platforms.
+    - raspberry-pi
+```
+`name`: A unique identifier for the configuration, typically reflecting the hardware it supports.
+
+`support`: Indicates the level of support for this configuration. It can be one of the following:
+
+- `community`: Supported by the Meshtastic community. Meshtastic Members may not possess, or have not tested this configuration.
+- `official`: Fully supported by Meshtastic. Meshtastic Members have tested and verified this configuration.
+- `deprecated`: No longer recommended for deployment by Meshtastic.
+
+`compatible`: A list of compatible products or platforms that can use this configuration.
+This will vary depending on the intended use case / platform.
+Multiple compatible entries can be included. E.g. Armbian `BOARD` value or OpenWrt `TARGET` value.
+These tags can be consumed by different configuration-selection tools, filtering based upon their platform/etc.