document device configuration
authorHelmut Grohne <helmut@subdivi.de>
Sat, 22 Jun 2013 17:01:39 +0000 (19:01 +0200)
committerHelmut Grohne <helmut@subdivi.de>
Sat, 22 Jun 2013 17:01:39 +0000 (19:01 +0200)
README.md

index dfdf9eb..86d9356 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,6 +26,20 @@ Consider the following use cases:
    services. This is another inhibiting strategy. It is already being solved by
    [systemd-inhibit][] though.
 
+Configuration
+=============
+Activation with sispmctl using the first socket of the first usb device
+delaying of deactivation by 3 seconds:
+
+    dev = onoff.command.OnoffCommand(["sispmctl", "-o", "1"],
+                                     ["sispmctl", "-f", "1"])
+    dev = onoff.common.ThrottledDevice(dev, 3)
+
+When inhibiting redshift, run redshift from the dbus service:
+
+    dev = onoff.processs.OnoffProcess(["redshift"], 3)
+    dev = onoff.common.InvertedDevice(dev)
+
 [sispmctl]: http://sispmctl.sf.net
 [slugpower]: http://chezphil.org/slugpower/
 [redshift]: http://jonls.dk/redshift/