No description
  • C 73.8%
  • C++ 19%
  • Makefile 3.8%
  • QML 1.5%
  • Python 0.8%
  • Other 1.1%
Find a file
Pekka Vuorela c38d05b5eb
Merge pull request #9 from sailfishos/mer-core-reference
[nemo-keepalive] Fix mer-core reference in docs. JB#55154
2025-03-21 14:40:41 +02:00
dbus-gmain@d42176ae47 [keepalive] Drop unused dbus-glib headers and dependency. J#51115 2020-12-07 03:46:01 +02:00
doc [nemo-keepalive] Fix mer-core reference in docs. JB#55154 2025-03-21 14:32:53 +02:00
examples [displayblanking] Allow multiple DisplayBlanking items. Fixes JB#28902 2019-05-27 09:13:16 +03:00
examples-glib [keepalive] Document dbus-gmain is needed for examples. JB#51115 2020-12-07 03:52:42 +02:00
lib Fix use with Qt6 2023-07-09 09:42:15 +00:00
lib-glib [nemo-keepalive] Add executable bit for libkeepalive-glib.so. JB#51013 2025-03-19 15:29:12 +02:00
plugin [nemo-keepalive] Update plugins.qmltypes. JB#59899 2023-01-18 14:34:51 +01:00
rpm Clean up spec to use common order, remove unnecessary %defattrs etc 2025-03-19 15:29:12 +02:00
tests [nemo-keepalive] Remove 1.0 api and legacy name. Fixes JB#41415 2019-06-13 17:15:50 +03:00
tools [keepalive] Drop unused dbus-glib headers and dependency. J#51115 2020-12-07 03:46:01 +02:00
.gitmodules [keepalive] Drop unused dbus-glib headers and dependency. J#51115 2020-12-07 03:46:01 +02:00
dbus-gmain.mk [keepalive] Drop unused dbus-glib headers and dependency. J#51115 2020-12-07 03:46:01 +02:00
keepalive.pro [nemo-keepalive] Migrate to sailfish-qdoc-template. JB#54004 2021-11-05 10:52:25 +02:00
license.lgpl [nemo-keepalive] Initial commit. 2014-01-22 01:48:44 +00:00
NOTES [nemo-keepalive] Initial commit. 2014-01-22 01:48:44 +00:00
README [displayblanking] Allow multiple DisplayBlanking items. Fixes JB#28902 2019-05-27 09:13:16 +03:00

DisplayBlanking
===============

While <preventBlanking> == true in any DisplayBlanking object, keeps the
system from automatically blanking the display.

The application must set <preventBlanking> = false when blanking
is again to be allowed.

Example use case: Video player

* the display is on due to user activity
* video playback is started
* video player sets <preventBlanking> = true
* video playback is paused/stopped
* video player sets <preventBlanking> = false

The current visibility of the display is given by DisplayBlanking.status
and can be one of:
 - DisplayBlanking.On
 - DisplayBlanking.Dimmed
 - DisplayBlanking.Off
 - DisplayBlanking.Unknown

This can be used to disable updates while the display is off, for example.


PeriodicBackgroundProcessing
============================

When <enabled> == true, wakes the process every <interval> seconds - even if
the system has entered late suspend.

The application can specify the wakeup <interval>, but do note that it is
subject to rounding done at the IPHB daemon (currently part of DSME).

Application is notified of the wakeup via <activeChanged> signal.

NOTE: The <activeChanged> signal handler must not block.

The application must check that <active> == true before starting processing,
and must set it back to false after finishing to allow normal suspend policy
to take effect.

Example use case: RSS reader

* sets the <interval> = 600 [10 minutes]
* sets <enabled> = true
* at the next 10 global wakeup slot time the <activeChanged> is signaled
  and the system is blocked from going in to late suspend
* after finishing the RSS feed updating the app sets <active> = false
* the system can suspend (unless some other policy is blocking it)
* at the next 10 global wakeup slot time the cycle repeats