Skip to content
Snippets Groups Projects
Commit d8668d20 authored by Zámolyi Csaba Ferenc's avatar Zámolyi Csaba Ferenc
Browse files

Added first version of README

parents
No related branches found
No related tags found
No related merge requests found
# SysCshee - batteryd
The newest, coolest, fastest and smallest useless daemon for your system!
My name is Csaba Zámolyi, and my nickname is "Cshee" (pronunciation: /'tʃeː/), hence the main project name: SysCshee (/'sɪstʃeː/). This daemon is part of the SysCshee project, but is compilable and runnable completely separately, it's not tied to other parts of SysCshee.
### Why?
Why not? It was a long and rough day and around 2AM, after 5-6 beers, it seemed to be a good idea to write a daemon for my personal amusement. This is generally intended as a joke, although for me it serves real purpose. I didn't want to use any 3rd party service for monitoring my battery level, because I know exactly what I want and how I want to do it and what configuration options I wish, and the task seemed easy enough to do for myself. This is a small and easly usable software, and it would be really fun if other people used it or did something with it :slight_smile:
### What is this?
This daemon does nothing more and nothing less than monitoring your battery level and taking action(s) at set treshold(s)
The tresholds and the actions to take are both configurable in `/etc/syscshee/batteryd.conf`
### Configuration
An example of a `batteryd.conf` file
```
# Example batteryd.conf file
# TODO: License
# There are three available battery levels: HALF, LOW, CRITICAL and their percentage value can be configured
# The actions can be as follows:
# - "notify": sends a notification to the user and informs them about the battery percentage via notify-send
# - "sleep": suspends system to RAM, waits for a configured amount of time.
# - "shutdown": gracefully shuts down the system, waits for a configured amount of time.
# HALF battery percentage treshold (usually 50%, but who knows!)
TRESHOLD_HALF=50
# Action to do at HALF battery
ACTION_HALF="notify"
# LOW battery percentage treshold (0-100)
TRESHOLD_LOW=30
# Action to do at LOW battery
ACTION_LOW="notify"
# CRITICAL battery percentage treshold (0-100)
TRESHOLD_CRITICAL=15
ACTION_CRITICAL="notify,sleep"
# Waiting times for actions (in seconds, maximum of 300)
# Waiting time for "sleep" action
WAIT_TIME_SLEEP=30
# Waiting time for "shutdown" action
WAIT_TIME_SHUTDOWN=60
# TODO: more
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment