kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added power supply optional property for the power profiler

Browse source
This commit is contained in:
Nicolas Munnich 2024-08-08 23:08:05 +02:00
parent c9c1a129a7
commit 629742460d
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx
View file

@ -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.
:::