This Flutter plugin allows you to enable and toggle the screen wakelock on Android and iOS, which prevents the screen from turning off automatically.
Essentially, this allows you to keep the device awake, i.e. prevent the device from sleeping.
To use this plugin, follow the installing guide.
Everything in this plugin is controlled via the
If you want to enable the wakelock, i.e. keep the device awake, you can simply call
and to disable it again, you can use
import 'package:wakelock/wakelock.dart'; // ... // The following line will enable the Android and iOS wakelock. Wakelock.enable(); // The next line disables the wakelock again. Wakelock.disable();
import 'package:wakelock/wakelock.dart'; // ... // The following lines of code toggle the wakelock based on a bool value. bool on = true; // The following statement enables the wakelock. Wakelock.toggle(on: on); on = false; // The following statement disables the wakelock. Wakelock.toggle(on: on); // If you want to retrieve the current wakelock status, // you will have to be in an async scope // to await the Future returned by isEnabled. bool isEnabled = await Wakelock.isEnabled;
If you want to wait for the wakelock toggle on Android or iOS to complete (which takes an insignificant amount of time),
you can also
await any of
This plugin is originally based on
Specifically, the wakelock functionality was extracted into this plugin due to lack of maintenance by the author of the
If you want to contribute to this plugin, follow the contributing guide.