wxPython – GetBatteryState() function in wxPython

In this article we are going to learn about wx.GetBatteryState() which is a inbuilt parent function present in wxPython. GetBatteryState() returns battery state as one of BATTERY_NORMAL_STATE, BATTERY_LOW_STATE, BATTERY_CRITICAL_STATE, BATTERY_SHUTDOWN_STATE or BATTERY_UNKNOWN_STATE .

BATTERY_UNKNOWN_STATE is also the default on platforms where this feature is not implemented (currently everywhere but MS Windows).

Syntax: wx.GetBatteryState()

Parameters: No parameters

Return Type: wx.BatteryState

Code Example:

import wx


class Example(wx.Frame):

    def __init__(self, *args, **kwargs):
        super(Example, self).__init__(*args, **kwargs)

        self.InitUI()

    def InitUI(self):

        self.locale = wx.Locale(wx.LANGUAGE_ENGLISH)
        # print battery state
        # 0 for wx.BATTERY_NORMAL_STATE
        # 1 for wx.BATTERY_LOW_STATE
        # 2 for wx.BATTERY_CRITICAL_STATE
        # 3 for wx.BATTERY_SHUTDOWN_STATE
        # 4 for wx.BATTERY_UNKNOWN_STATE
        print(wx.GetBatteryState())

def main():
    app = wx.App()
    ex = Example(None)
    ex.Show()
    app.MainLoop()


if __name__ == '__main__':
    main()

Output:

1

which is wx.BATTERY_LOW_STATE.