--- description: Capacitor plugin to access battery information on Android, iOS, and the Web. Read the battery level, state, and low power mode, and listen for changes. title: Capacitor Battery Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/battery.png --- [Skip to content ](#capacitor-battery-plugin) [πŸ–₯️ Introducing the **Capacitor Electron Platform** β€” build desktop apps for macOS, Windows, and Linux. Free & open source. ](/blog/announcing-the-capacitor-electron-platform/) * [ SDKs ](/docs/sdks/) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Battery Information ](#battery-information) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Biometrics ](/docs/sdks/capacitor/biometrics/) * [ Bluetooth Low Energy ](/docs/sdks/capacitor/bluetooth-low-energy/) * [ Clipboard ](/docs/sdks/capacitor/clipboard/) * [ Cloudinary ](/docs/sdks/capacitor/cloudinary/) * [ Compass ](/docs/sdks/capacitor/compass/) * [ Contacts ](/docs/sdks/capacitor/contacts/) * [ Crisp ](/docs/sdks/capacitor/crisp/) * [ Datetime Picker ](/docs/sdks/capacitor/datetime-picker/) * [ Device Info ](/docs/sdks/capacitor/device-info/) * [ Dialog ](/docs/sdks/capacitor/dialog/) * [ Electron ](/docs/sdks/capacitor/electron/) * [ Exif ](/docs/sdks/capacitor/exif/) * [ Facebook Sign-In ](/docs/sdks/capacitor/facebook-sign-in/) * [ File Compressor ](/docs/sdks/capacitor/file-compressor/) * [ File Opener ](/docs/sdks/capacitor/file-opener/) * [ File Picker ](/docs/sdks/capacitor/file-picker/) * [ Firebase ](/docs/sdks/capacitor/firebase/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Intercom ](/docs/sdks/capacitor/intercom/) * [ Intune ](/docs/sdks/capacitor/intune/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Tauri ](/docs/sdks/capacitor/tauri/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ YouTube Player ](/docs/sdks/capacitor/youtube-player/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Battery Information ](#battery-information) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Battery Plugin[ΒΆ](#capacitor-battery-plugin "Permanent link") Capacitor plugin to access battery information. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") The Capacitor Battery plugin is one of the most complete battery monitoring solutions for Capacitor apps. Here are some of the key features: * πŸ”‹ **Battery level**: Read the current battery level of the device. * ⚑ **Battery state**: Read whether the device is charging, full or unplugged. * πŸͺ« **Low power mode**: Read whether the low power mode is enabled. * πŸ‘‚ **Change events**: Listen for changes to the battery level, state and low power mode. * 🌐 **Web support**: Read the battery level and state on supported browsers. * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * 🀝 **Compatibility**: Works alongside the [Android Battery Optimization](https://capawesome.io/docs/sdks/capacitor/android-battery-optimization/) plugin. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Battery plugin is typically used whenever an app should adapt its behavior to the device's power situation, for example: * **Energy-aware features**: Reduce background work, animations, or sync frequency when the battery level is low. * **Low power mode handling**: Disable power-hungry features when the user has enabled low power mode. * **Charging-dependent tasks**: Only start heavy tasks such as large downloads while the device is charging. * **Status display**: Show the current battery level and charging state inside your app, for example in a kiosk or fleet app. * **Reacting to changes**: Warn the user when the battery level drops by listening for change events. ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-battery` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-battery [](#%5F%5Fcodelineno-2-2)npx cap sync ` This plugin does not require any additional configuration or permissions on Android or iOS. On the **Web**, the battery level and state are only available in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI) (Chromium-based browsers). The low power mode is not available on the Web. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to get the current battery level and state, check if low power mode is enabled, listen for battery changes, and remove all listeners. ### Get the current battery level[ΒΆ](#get-the-current-battery-level "Permanent link") Read the current battery level of the device as a value between `0.0` and `1.0`: `[](#%5F%5Fcodelineno-3-1)import { Battery } from '@capawesome/capacitor-battery'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const getBatteryLevel = async () => { [](#%5F%5Fcodelineno-3-4) const { level } = await Battery.getBatteryLevel(); [](#%5F%5Fcodelineno-3-5) return level; [](#%5F%5Fcodelineno-3-6)}; ` ### Get the current battery state[ΒΆ](#get-the-current-battery-state "Permanent link") Check whether the device is charging, full or unplugged: `[](#%5F%5Fcodelineno-4-1)import { Battery } from '@capawesome/capacitor-battery'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const getBatteryState = async () => { [](#%5F%5Fcodelineno-4-4) const { state } = await Battery.getBatteryState(); [](#%5F%5Fcodelineno-4-5) return state; [](#%5F%5Fcodelineno-4-6)}; ` ### Check if low power mode is enabled[ΒΆ](#check-if-low-power-mode-is-enabled "Permanent link") Read whether the low power mode (power saver mode on Android, Low Power Mode on iOS) is currently enabled. Only available on Android and iOS: `[](#%5F%5Fcodelineno-5-1)import { Battery } from '@capawesome/capacitor-battery'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const isLowPowerModeEnabled = async () => { [](#%5F%5Fcodelineno-5-4) const { enabled } = await Battery.isLowPowerModeEnabled(); [](#%5F%5Fcodelineno-5-5) return enabled; [](#%5F%5Fcodelineno-5-6)}; ` ### Listen for battery changes[ΒΆ](#listen-for-battery-changes "Permanent link") Get notified when the battery level, battery state or low power mode changes. The device is only observed while at least one listener is attached. The `lowPowerModeChange` event is only available on Android and iOS: `[](#%5F%5Fcodelineno-6-1)import { Battery } from '@capawesome/capacitor-battery'; [](#%5F%5Fcodelineno-6-2) [](#%5F%5Fcodelineno-6-3)const addBatteryLevelChangeListener = async () => { [](#%5F%5Fcodelineno-6-4) await Battery.addListener('batteryLevelChange', event => { [](#%5F%5Fcodelineno-6-5) console.log('Battery level changed:', event.level); [](#%5F%5Fcodelineno-6-6) }); [](#%5F%5Fcodelineno-6-7)}; [](#%5F%5Fcodelineno-6-8) [](#%5F%5Fcodelineno-6-9)const addBatteryStateChangeListener = async () => { [](#%5F%5Fcodelineno-6-10) await Battery.addListener('batteryStateChange', event => { [](#%5F%5Fcodelineno-6-11) console.log('Battery state changed:', event.state); [](#%5F%5Fcodelineno-6-12) }); [](#%5F%5Fcodelineno-6-13)}; [](#%5F%5Fcodelineno-6-14) [](#%5F%5Fcodelineno-6-15)const addLowPowerModeChangeListener = async () => { [](#%5F%5Fcodelineno-6-16) await Battery.addListener('lowPowerModeChange', event => { [](#%5F%5Fcodelineno-6-17) console.log('Low power mode changed:', event.enabled); [](#%5F%5Fcodelineno-6-18) }); [](#%5F%5Fcodelineno-6-19)}; ` ### Remove all listeners[ΒΆ](#remove-all-listeners "Permanent link") Remove all listeners that were registered for this plugin: `[](#%5F%5Fcodelineno-7-1)import { Battery } from '@capawesome/capacitor-battery'; [](#%5F%5Fcodelineno-7-2) [](#%5F%5Fcodelineno-7-3)const removeAllListeners = async () => { [](#%5F%5Fcodelineno-7-4) await Battery.removeAllListeners(); [](#%5F%5Fcodelineno-7-5)}; ` ## API[ΒΆ](#api "Permanent link") * [getBatteryLevel()](#getbatterylevel) * [getBatteryState()](#getbatterystate) * [isLowPowerModeEnabled()](#islowpowermodeenabled) * [addListener('batteryLevelChange', ...)](#addlistenerbatterylevelchange-) * [addListener('batteryStateChange', ...)](#addlistenerbatterystatechange-) * [addListener('lowPowerModeChange', ...)](#addlistenerlowpowermodechange-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### getBatteryLevel()[ΒΆ](#getbatterylevel "Permanent link") `[](#%5F%5Fcodelineno-8-1)getBatteryLevel() => Promise ` Get the current battery level of the device. On the web, this is only supported in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI)(Chromium-based browsers). Only available on Android, iOS and Web. **Returns:** `Promise<[GetBatteryLevelResult](#getbatterylevelresult)>` **Since:** 0.1.0 --- ### getBatteryState()[ΒΆ](#getbatterystate "Permanent link") `[](#%5F%5Fcodelineno-9-1)getBatteryState() => Promise ` Get the current battery state of the device. On the web, this is only supported in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI)(Chromium-based browsers). Only available on Android, iOS and Web. **Returns:** `Promise<[GetBatteryStateResult](#getbatterystateresult)>` **Since:** 0.1.0 --- ### isLowPowerModeEnabled()[ΒΆ](#islowpowermodeenabled "Permanent link") `[](#%5F%5Fcodelineno-10-1)isLowPowerModeEnabled() => Promise ` Get whether the low power mode is currently enabled. On Android, this refers to the power saver mode. On iOS, this refers to the Low Power Mode. Only available on Android and iOS. **Returns:** `Promise<[IsLowPowerModeEnabledResult](#islowpowermodeenabledresult)>` **Since:** 0.1.0 --- ### addListener('batteryLevelChange', ...)[ΒΆ](#addlistenerbatterylevelchange "Permanent link") `[](#%5F%5Fcodelineno-11-1)addListener(eventName: 'batteryLevelChange', listenerFunc: (event: BatteryLevelChangeEvent) => void) => Promise ` Listen for changes to the battery level of the device. The device is only observed while at least one listener is attached. On the web, this is only supported in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI)(Chromium-based browsers). Only available on Android, iOS and Web. | Param | Type | | ---------------- | -------------------------------------------------------------------- | | **eventName** | 'batteryLevelChange' | | **listenerFunc** | (event: [BatteryLevelChangeEvent](#batterylevelchangeevent)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### addListener('batteryStateChange', ...)[ΒΆ](#addlistenerbatterystatechange "Permanent link") `[](#%5F%5Fcodelineno-12-1)addListener(eventName: 'batteryStateChange', listenerFunc: (event: BatteryStateChangeEvent) => void) => Promise ` Listen for changes to the battery state of the device. The device is only observed while at least one listener is attached. On the web, this is only supported in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI)(Chromium-based browsers). Only available on Android, iOS and Web. | Param | Type | | ---------------- | -------------------------------------------------------------------- | | **eventName** | 'batteryStateChange' | | **listenerFunc** | (event: [BatteryStateChangeEvent](#batterystatechangeevent)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### addListener('lowPowerModeChange', ...)[ΒΆ](#addlistenerlowpowermodechange "Permanent link") `[](#%5F%5Fcodelineno-13-1)addListener(eventName: 'lowPowerModeChange', listenerFunc: (event: LowPowerModeChangeEvent) => void) => Promise ` Listen for changes to the low power mode of the device. The device is only observed while at least one listener is attached. Only available on Android and iOS. | Param | Type | | ---------------- | -------------------------------------------------------------------- | | **eventName** | 'lowPowerModeChange' | | **listenerFunc** | (event: [LowPowerModeChangeEvent](#lowpowermodechangeevent)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-14-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### GetBatteryLevelResult[ΒΆ](#getbatterylevelresult "Permanent link") | Prop | Type | Description | Since | | --------- | ------ | ----------------------------------------------------------------------- | ----- | | **level** | number | The current battery level of the device as a value between 0.0 and 1.0. | 0.1.0 | #### GetBatteryStateResult[ΒΆ](#getbatterystateresult "Permanent link") | Prop | Type | Description | Since | | --------- | ----------------------------- | ---------------------------------------- | ----- | | **state** | [BatteryState](#batterystate) | The current battery state of the device. | 0.1.0 | #### IsLowPowerModeEnabledResult[ΒΆ](#islowpowermodeenabledresult "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | ------------------------------------------------ | ----- | | **enabled** | boolean | Whether the low power mode is currently enabled. | 0.1.0 | #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | #### BatteryLevelChangeEvent[ΒΆ](#batterylevelchangeevent "Permanent link") | Prop | Type | Description | Since | | --------- | ------ | ----------------------------------------------------------------------- | ----- | | **level** | number | The current battery level of the device as a value between 0.0 and 1.0. | 0.1.0 | #### BatteryStateChangeEvent[ΒΆ](#batterystatechangeevent "Permanent link") | Prop | Type | Description | Since | | --------- | ----------------------------- | ---------------------------------------- | ----- | | **state** | [BatteryState](#batterystate) | The current battery state of the device. | 0.1.0 | #### LowPowerModeChangeEvent[ΒΆ](#lowpowermodechangeevent "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | ------------------------------------------------ | ----- | | **enabled** | boolean | Whether the low power mode is currently enabled. | 0.1.0 | ### Type Aliases[ΒΆ](#type-aliases "Permanent link") #### BatteryState[ΒΆ](#batterystate "Permanent link") The battery state of the device. * `charging`: The device is plugged into power and the battery is charging. * `full`: The device is plugged into power and the battery is fully charged. * `unplugged`: The device is not plugged into power and the battery is discharging. * `unknown`: The battery state could not be determined. `'charging' | 'full' | 'unplugged' | 'unknown'` ## Battery Information[ΒΆ](#battery-information "Permanent link") Keep the following platform differences in mind when accessing battery information: * **Android**: The battery level and state are read from the sticky [ACTION\_BATTERY\_CHANGED](https://developer.android.com/reference/android/content/Intent#ACTION%5FBATTERY%5FCHANGED) broadcast. The low power mode reflects the [power saver mode](https://developer.android.com/reference/android/os/PowerManager#isPowerSaveMode%28%29) of the device. * **iOS**: The battery level is not available on the iOS Simulator, so `getBatteryLevel()` rejects with an error there. Use a real device to test this method. The low power mode reflects the [Low Power Mode](https://support.apple.com/en-us/101604) of the device. * **Web**: The battery level and state are only available in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI) (Chromium-based browsers). The low power mode is not available on the Web. ## FAQ[ΒΆ](#faq "Permanent link") ### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link") It reports the full battery picture β€” level, charging state, and low power mode β€” plus change events that observe the device only while a listener is attached, all through a fully typed API that works across Android, iOS, and supported browsers on the Web. If you just need a one-off battery reading, that's a quick call; if you want to react to charging and low-power changes over time without wasting energy, this plugin is built for exactly that. ### Why does `getBatteryLevel` fail on the iOS Simulator?[ΒΆ](#why-does-getbatterylevel-fail-on-the-ios-simulator "Permanent link") The battery level is not available on the iOS Simulator, so `getBatteryLevel()` rejects with an error there. Use a real device to test this method. ### Does this plugin work in all browsers?[ΒΆ](#does-this-plugin-work-in-all-browsers "Permanent link") No, on the Web the battery level and state are only available in browsers that implement the [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery%5FStatus%5FAPI), which are Chromium-based browsers. The low power mode is not available on the Web at all. ### What is the range of the battery level value?[ΒΆ](#what-is-the-range-of-the-battery-level-value "Permanent link") The battery level is returned as a value between `0.0` and `1.0`, where `0.0` means the battery is empty and `1.0` means it is fully charged. Multiply the value by 100 if you want to display it as a percentage. ### What does low power mode mean on Android and iOS?[ΒΆ](#what-does-low-power-mode-mean-on-android-and-ios "Permanent link") On Android, it refers to the [power saver mode](https://developer.android.com/reference/android/os/PowerManager#isPowerSaveMode%28%29) of the device. On iOS, it refers to the [Low Power Mode](https://support.apple.com/en-us/101604). The `isLowPowerModeEnabled()` method and the `lowPowerModeChange` event are only available on Android and iOS. ### Does listening for battery changes drain the battery?[ΒΆ](#does-listening-for-battery-changes-drain-the-battery "Permanent link") The device is only observed while at least one listener is attached. As soon as you remove all listeners, for example with `removeAllListeners()`, the plugin stops observing the device. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Android Battery Optimization](https://capawesome.io/docs/sdks/capacitor/android-battery-optimization/): Manage battery optimization settings and request exemptions on Android. * [Device Info](https://capawesome.io/docs/sdks/capacitor/device-info/): Read device information, such as the model, manufacturer, operating system, and memory. * [Thermal State](https://capawesome.io/docs/sdks/capacitor/thermal-state/): Read the device thermal state and react before the operating system throttles your app. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/battery/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/battery/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/battery/#article", "headline": "Capacitor Battery Plugin for Android, iOS & Web", "name": "Capacitor Battery Plugin for Android, iOS & Web", "description": "Capacitor plugin to access battery information on Android, iOS, and the Web. Read the battery level, state, and low power mode, and listen for changes.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/battery/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/battery/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/battery/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/battery/#software", "name": "Capacitor Battery Plugin for Android, iOS & Web", "description": "Capacitor plugin to access battery information on Android, iOS, and the Web. Read the battery level, state, and low power mode, and listen for changes.", "url": "https://capawesome.io/docs/sdks/capacitor/battery/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It reports the full battery picture β€” level, charging state, and low power mode β€” plus change events that observe the device only while a listener is attached, all through a fully typed API that works across Android, iOS, and supported browsers on the Web. If you just need a one-off battery reading, that's a quick call; if you want to react to charging and low-power changes over time without wasting energy, this plugin is built for exactly that."}}, {"@type": "Question", "name": "Why does getBatteryLevel fail on the iOS Simulator?", "acceptedAnswer": {"@type": "Answer", "text": "The battery level is not available on the iOS Simulator, so getBatteryLevel() rejects with an error there. Use a real device to test this method."}}, {"@type": "Question", "name": "Does this plugin work in all browsers?", "acceptedAnswer": {"@type": "Answer", "text": "No, on the Web the battery level and state are only available in browsers that implement the Battery Status API, which are Chromium-based browsers. The low power mode is not available on the Web at all."}}, {"@type": "Question", "name": "What is the range of the battery level value?", "acceptedAnswer": {"@type": "Answer", "text": "The battery level is returned as a value between 0.0 and 1.0, where 0.0 means the battery is empty and 1.0 means it is fully charged. Multiply the value by 100 if you want to display it as a percentage."}}, {"@type": "Question", "name": "What does low power mode mean on Android and iOS?", "acceptedAnswer": {"@type": "Answer", "text": "On Android, it refers to the power saver mode of the device. On iOS, it refers to the Low Power Mode. The isLowPowerModeEnabled() method and the lowPowerModeChange event are only available on Android and iOS."}}, {"@type": "Question", "name": "Does listening for battery changes drain the battery?", "acceptedAnswer": {"@type": "Answer", "text": "The device is only observed while at least one listener is attached. As soon as you remove all listeners, for example with removeAllListeners(), the plugin stops observing the device."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/battery/"} ```