From 8d31397110a758ddac803b33b6b403ccf23b18ee Mon Sep 17 00:00:00 2001
From: Filip Ayazi <filipayazi@gmail.com>
Date: Fri, 6 Oct 2023 04:28:59 +0100
Subject: [PATCH] Illumination: explain cc_test function

---
 src/modules/illumination/illumination.cpp | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/modules/illumination/illumination.cpp b/src/modules/illumination/illumination.cpp
index d7861e0..b98ce95 100644
--- a/src/modules/illumination/illumination.cpp
+++ b/src/modules/illumination/illumination.cpp
@@ -179,6 +179,14 @@ float multi_read(uint8_t pin, uint16_t reads)
     return total/reads;
 }
 
+/*This is a test function used for debugging the CC driver.
+* A wire has to be soldered to one side of the feedback resistor R16
+* and connected to A0 on the header. This will then go through CC settings
+* and measure voltage on the feedback resistor (i.e. current).
+*
+* This is really only useful for anyone modifying the hardware
+* or CC driver communication.
+*/
 void cc_test()
 {
     analogReadResolution(12);