GetBatteryInfo() battery automation hook.

chrome/test/pyautolib/pyauto.py

 #!/usr/bin/python
 
 # Copyright (c) 2011 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """PyAuto: Python Interface to Chromium's Automation Proxy.
 
 PyAuto uses swig to expose Automation Proxy interfaces to Python.
 For complete documentation on the functionality available,
@@ skipping 2353 matching lines @@
 
     Effectively the same as clicking the "Sign out" link on the screen locker.
     Screen should be locked for this to work.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = { 'command': 'SignoutInScreenLocker' }
     self._GetResultFromJSONRequest(cmd_dict, windex=-1)
 
+  def GetBatteryInfo(self):
+    """Get details about battery state.
+
+    Returns:
+      A dictionary.
+      Sample:
+        { u'battery': True,
+          u'line_power': False,
+          u'time_left': 29617,   # 0 if the time left is still being calculated.

[Nirnimesh, 2011/03/29 01:29:39]

Using 0 for 'still being calculated' case is incorrect.

[dtu, 2011/03/29 02:21:22]

Done. Key will be absent in the 'still being calculated' case.

+          u'percentage': 100.0,
+          u'charged': False }
+
+      Use 'charged' instead of 'percentage' to determine whether the
+      battery is fully charged, since the percentage is only approximate.
+

[krisr, 2011/03/29 01:02:01]

I actually had to look at the device to see how this works, so we may want to
add some comments:

If battery is true and line_power is false then time_left is time until empty.
If battery is true and line_power is true then time_left is time until charged.
If battery is false and line_power it true then I don't know what time_left is
going to be, can we find out?  Looking at a device in this state it says
"Calculating time until full"

[dtu, 2011/03/29 02:21:22]

Comment expanded. I also changed it so fields only exist if they're relevant, so
those fields will be absent if the battery is missing or the time is still being
calculated.

+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = { 'command': 'GetBatteryInfo' }
+    return self._GetResultFromJSONRequest(cmd_dict, windex=-1)
+
   def GetNetworkInfo(self):
     """Get details about ethernet, wifi, and cellular networks on chromeos.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = { 'command': 'GetNetworkInfo' }
     return self._GetResultFromJSONRequest(cmd_dict, windex=-1)
 
   def NetworkScan(self):
@@ skipping 440 matching lines @@
     if self._options.verbose:
       verbosity = 2
     result = PyAutoTextTestRuner(verbosity=verbosity).run(pyauto_suite)
     del loaded_tests  # Need to destroy test cases before the suite
     del pyauto_suite
     sys.exit(not result.wasSuccessful())
 
 
 if __name__ == '__main__':
   Main()