aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 6acba522d27bd702657e3582a5ad72af8b7be0eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# battd

A simple battery daemon written for use with a daemontools-style supervisor.

`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

``` text
# ./install /etc/sv/battd
# ln -s /etc/sv/battd /var/service
```

Adjust the above as needed.

## Usage

Configure `conf` appropriately. This should contain three functions:

`interval`
:   Called between consecutive calls to `check`.

`check`
:   Called to determine the battery status.

`failed`
:   Called when the battery status has transitioned from a successful to a
    failing return.