particle-{argon,boron}: note that board_bat_voltage is untested

qmk · Nov 29, 2024 · eddd93e · eddd93e
1 parent c39b697
commit eddd93e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/boards/particle-argon/doc.txt b/boards/particle-argon/doc.txt
@@ -18,6 +18,12 @@ that provides access to multiple communication protocols: BLE, 802.15.4 and WiFi
 
 The board datasheet is available [here](https://docs.particle.io/assets/pdfs/datasheets/argon-datasheet.pdf)
 
+@experimental Support to measure the voltage via ADC using the
+`board_bat_voltage` feature (see [Feature List](@ref feature-list)) is provided
+for this board. However, it was only ever tested for the very similar
+@ref boards_particle-xenon. If you encounter any errors when measuring the
+voltage for the Particle Argon, please report this!
+
 ### Flash the board
 
 See the `Flashing` section in @ref boards_common_particle-mesh.

diff --git a/boards/particle-boron/doc.txt b/boards/particle-boron/doc.txt
@@ -18,6 +18,12 @@ that provides access to multiple communication protocols: BLE, 802.15.4 and LTE.
 
 The board datasheet is available [here](https://docs.particle.io/assets/pdfs/datasheets/boron-datasheet.pdf)
 
+@experimental Support to measure the voltage via ADC using the
+`board_bat_voltage` feature (see [Feature List](@ref feature-list)) is provided
+for this board. However, it was only ever tested for the very similar
+@ref boards_particle-xenon. If you encounter any errors when measuring the
+voltage for the Particle Boron, please report this!
+
 ### Flash the board
 
 See the `Flashing` section in @ref boards_common_particle-mesh.