https://github.com/deficient/brightness

Brightness widget for awesome WM
https://github.com/deficient/brightness

awesome-wm brightness-level widget

Last synced: 4 months ago
JSON representation

Brightness widget for awesome WM

• Host: GitHub
• URL: https://github.com/deficient/brightness
• Owner: deficient
• License: unlicense
• Archived: true
• Created: 2015-12-19T00:03:10.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-18T20:10:35.000Z (6 months ago)
• Last Synced: 2024-08-18T21:26:38.879Z (6 months ago)
• Topics: awesome-wm, brightness-level, widget
• Language: Lua
• Size: 43 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-awesomewm-modules-widgets-and-libraries - brightness
• awesome-awesomewm-modules-widgets-and-libraries - brightness

README

        
**This repository has been assimilated into** https://github.com/deficient/deficient

## awesome-brightness

### Description

Brightness indicator/control widget for [awesome wm](https://awesomewm.org/)

based on ``xbacklight`` or ``brightnessctl``.

### Dependencies:

The module requires either `xbacklight` or `brightnessctl` to work.

Thus, on archlinux, you'll need to install at least one of the following

system packages:

- [acpilight](https://archlinux.org/packages/extra/any/acpilight/) or

  [xorg-xbacklight](https://archlinux.org/packages/extra/x86_64/xorg-xbacklight/) for `xbacklight`

- [brightnessctl](https://archlinux.org/packages/extra/x86_64/brightnessctl/) for `brightnessctl`

I've experienced `xorg-xbacklight` not work on certain laptops. So, if you

find that the widget is not working, try a different backend.

### Installation

Drop the script into your awesome config folder. Suggestion:

```bash

cd ~/.config/awesome

git clone https://github.com/deficient/brightness.git

```

### Usage

In your `~/.config/awesome/rc.lua`:

```lua

-- Import and instanciate:

local brightness_ctrl = require("brightness") {

    -- pass options here

}

-- Add widget to the wibox:

s.mywibox:setup {

    ...,

    { -- Right widgets

        ...,

        brightness_ctrl.widget,

    },

}

```

Note that you need to pass `.widget` to the wibox, not the instance itself!

The flag `brightness_ctrl.is_valid` indicates successful initialization.

### Usage options

Full example:

```lua

local brightness_ctrl = require("brightness") {

  backend = nil,

  step = 5,

  timeout = 3,

  levels = {1, 25, 50, 75, 100},

}

```

`backend`

Picks command with which to perform brightness queries and updates.

Allowed values are `nil` (meaning *autodetect*), `"xbacklight"` or

`"brightnessctl"`. Default: `nil`.

`step`

How many percentage points to increase or decrease the brightness level when

clicking the widget. Default: 3.

`timeout`

Interval in seconds at which to check the current brightness level and update

the widget text. Default: 5.

`levels`

Cycle through these brightness percentages on middle-click.

Default: ``{1, 25, 50, 75, 100}`.

### Troubleshooting

If you get errors on startup, try executing `xbacklight -get` or

`brightnessctl -c backlight get` in a terminal.

If you get the error "No outputs have backlight property", make sure you have

installed an appropriate display driver, e.g. for intel cards:

```bash

sudo pacman -S xf86-video-intel

```

You may need to restart afterwards.

### Requirements

* [awesome 4.0](http://awesome.naquadah.org/)