summaryrefslogtreecommitdiff
path: root/zephyr/projects/intelrvp/led.md
diff options
context:
space:
mode:
Diffstat (limited to 'zephyr/projects/intelrvp/led.md')
-rw-r--r--zephyr/projects/intelrvp/led.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/zephyr/projects/intelrvp/led.md b/zephyr/projects/intelrvp/led.md
new file mode 100644
index 0000000000..c36bc6b36c
--- /dev/null
+++ b/zephyr/projects/intelrvp/led.md
@@ -0,0 +1,44 @@
+## LED behavior on Intel RVP
+
+There are two LEDs on RVP, they represent battery and charger status
+respectively.
+
+LED | Description
+------------|------------------------
+CHARGER_LED | Represent charger state
+BATTERY_LED | Represent battery state
+
+LEDs on RVP emit a single color (green). Rather than just using the on and off
+state of the LED, PWM is used to blink the LED to represent multiple states and
+the below table represents the multiple LED states.
+
+LED State | Description
+---------------|------------------------------
+LED_ON | Switch On using gpio/pwmduty
+LED_OFF | Switch Off using gpio/pwmduty
+LED_FLASH_SLOW | Flashing with 2 sec period
+LED_FLASH_FAST | Flashing with 250ms period
+
+### LED Behavior : Charger
+
+CHARGER_LED is dedicated to represent Charger status and the below table
+represents the LED states for the Charger.
+
+Charger Status | LED States
+---------------------|---------------
+Charging | LED_ON
+Discharging | LED_FLASH_SLOW
+Charging error | LED_FLASH_FAST
+No Charger Connected | LED_OFF
+
+### LED Behavior : Battery
+
+BATTERY_LED is dedicated to represent Battery status and the below table
+represents the LED states for the Battery.
+
+Battery Status | LED States
+----------------------------|---------------
+Battery Low (<10%) | LED_FLASH_FAST
+Battery Normal (10% to 90%) | LED_FLASH_SLOW
+Battery Full (>90%) | LED_ON
+Battery Not Present | LED_OFF