From c560f0f02ddf51a3ce38a945b48ecf49a138e38d Mon Sep 17 00:00:00 2001 From: Tomasz Kramkowski Date: Wed, 30 Dec 2020 22:27:33 +0000 Subject: Simpler and more flexible interval handling --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d6a49e1..6acba52 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ A simple battery daemon written for use with a daemontools-style supervisor. -`run` polls the status of a `check` function with a regular interval. On the -transition from a successful `check` exit status to an unsuccessful `check` exit -status the `failed` function is called. +`run` polls the status of a `check` function with an interleaved call to +`interval`. On the transition from a successful `check` exit status to an +unsuccessful `check` exit status the `failed` function is called. ## Installation @@ -20,7 +20,7 @@ Adjust the above as needed. Configure `conf` appropriately. This should contain three functions: `interval` -: Called to determine the polling interval (see below). +: Called between consecutive calls to `check`. `check` : Called to determine the battery status. @@ -29,10 +29,3 @@ Configure `conf` appropriately. This should contain three functions: : Called when the battery status has transitioned from a successful to a failing return. -Optionally two variables can be set: - -`long_interval` -: The polling interval when `interval` returns success (default: 300). - -`short_interval` -: The polling interval when `interval` returns failure (default: 30). -- cgit v1.2.3-54-g00ecf