From e34bc30c010ecfa6e768c7b04138a4ed97f53b83 Mon Sep 17 00:00:00 2001 From: Nicolas Munnich Date: Thu, 8 Aug 2024 23:08:05 +0200 Subject: [PATCH] Added power supply optional property for the power profiler --- .../hardware-metadata-files.mdx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx index 5854d459..68630c00 100644 --- a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx +++ b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx @@ -142,6 +142,22 @@ The `outputs` array tracks the type of outputs that a keyboard can have. It incl The optional `arch` property describes the architecture that the MCU of a board uses. +### Power + +The optional `power_supply` property is used to describe the power consumption characteristics of the board, for use with [ZMK's power profiler]. It has the following children: +- `psu_type` is set to either `LDO` or `SWITCHING` +- `psu_output_voltage` is set to the output voltage of the power supply (in mV) +- `psu_quiescent` is set to the quiescent of the power supply (in uA) +- `misc_quiescent` is any other quiescent present on the board (in uA) + +```yaml +power_supply: + psu_type: LDO + psu_output_voltage: 3.3 + psu_quiescent: 55 + misc_quiescent: 4 +``` + :::note The following metadata properties are generally used for boards which are also keyboards. MCU-only boards usually do not make use of the below properties. :::