status light

LimelightVision · Apr 26, 2023 · ea97328 · ea97328
1 parent 23be890
commit ea97328
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,7 @@ Limelight is an easy-to-use smart camera for FRC.
 
    getting_started
    crosshair_calibration
+   status_lights
    using_multiple_pipelines
    best_practices
 

diff --git a/docs/status_lights.rst b/docs/status_lights.rst
@@ -0,0 +1,21 @@
+Status Lights and Blink Patterns
+===============================
+
+Green Status Light
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The green status light will blink slowly if no targets are detected by the current pipeline. It will blink quickly if any targets are detected by the current pipeline.
+
+Yellow Status Light
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The yellow status light will blink when a static IP address has not been assigned. If a static IP address is assigned, the light will remain either consistently on or off, without any blinking.
+
+Green Illumination LEDs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The green illumination LEDs are controllable via the web interface and various APIs, but there are a few special blink patterns that are designed to help troubleshoot hardware and software issues:
+
+* Left/Right or Top/Bottom alternating blink: The internal camera cable has become unseated, or the image sensor has suffered damage.
+* Fast Blink (all leds): The networking reset button has been held for at least 10 seconds.
+* Repeated Startup Sequence (three blinks, or multiple fade-in fade-out blinks): The software is crashing, possibly due to hardware damage. 
+