# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1604604614 0
# Node ID 5dd748850f2b9567422b594c83c72186211b9c0f
# Parent  db7b2724203b2bc14348a0c8bb1b11ffe825cbe7
fc-shell help: batt command: better documentation

The semantic meaning of the two bytes carried in the MMI_BATTERY_IND
primitive depends on the firmware version.  Update the documentation
to describe what these two bytes mean in current FC Tourmaline firmware.

diff -r db7b2724203b -r 5dd748850f2b rvinterf/asyncshell/helpfile
--- a/rvinterf/asyncshell/helpfile	Thu Oct 22 06:22:58 2020 +0000
+++ b/rvinterf/asyncshell/helpfile	Thu Nov 05 19:30:14 2020 +0000
@@ -35,7 +35,7 @@
 asynchronous output from ATI is also enabled as a side effect.
 
 === batt
-batt <byte1> <byte2>
+batt <state> <level>
 
 TI's MFW (UI firmware component) uses MMI_BATTERY_IND primitive (in the GPF and
 protocol stack sense) to communicate battery events from driver callback
@@ -46,7 +46,16 @@
 
 fc-shell batt command sends an MMI_BATTERY_IND protocol stack primitive with
 user-specified parameter bytes; the meaning of these parameter bytes depends on
-the firmware version.
+the firmware version.  In current FC Tourmaline fw the state byte communicates
+both durable states and transient events as listed below, whereas the level byte
+sets the battery icon level in the [0,4] range or is set to 255 to mean no
+battery level information in this event.  Valid states and events for current
+FC Tourmaline are as follows:
+
+batt 0 lev	-- no charging activity, lev is in [0,4] range
+batt 1 255	-- charging in progress, battery icon becomes animated
+batt 2 4	-- charging complete, battery icon full
+batt 3 255	-- charger plug transient event
 
 === disable
 === enable