https://github.com/deficient/leds-widget

https://github.com/deficient/leds-widget

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/deficient/leds-widget
• Owner: deficient
• License: unlicense
• Archived: true
• Created: 2017-05-03T16:39:23.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-18T20:12:59.000Z (6 months ago)
• Last Synced: 2024-08-18T21:27:53.770Z (6 months ago)
• Language: Lua
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-awesomewm-modules-widgets-and-libraries - leds-widget
• awesome-awesomewm-modules-widgets-and-libraries - leds-widget

README

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

## awesome.leds-widget

### Description

Single generic "led" indicator widget for awesome window manager.

Uses `leds_widget.is_enabled()` for status information, this must be provided

for each specific usecase.

### Installation

Drop the script into your awesome config folder. Suggestion:

```bash

cd ~/.config/awesome

git clone https://github.com/deficient/leds-widget.git

```

### Usage

In your `rc.lua`:

```lua

-- load the widget code

local leds_widget = require("leds-widget")

-- define your led widget

capslock = leds_widget({ led_name = "Capslock",

                         is_enabled = function() ... end })

-- add the widget to your wibox

...

right_layout:add(capslock.widget)

...

```

### Usage Options

```lua

leds_widget({

    led_name = "Led",

    text_on = "on",

    text_off = "off",

    tooltip_on = "on",

    tooltip_off = "off",

    color_on = "green",

    color_off = "red",

    is_enabled = function() ... end,

    timeout = 10,

    widget_text = "${color_start}${state_text}${color_end}",

    tooltip_text = "${led_name} is ${state_tooltip}",

})

```

`led_name`  

The value to populate `${led_name}`.

`text_on`, `text_off`  

The value to populate `${state_text}` when led state is on, respectively off.

`tooltip_on`, `tooltip_off`  

The value to populate `${state_tooltip}` when led state is on, respectively off.

`color_on`, `color_off`  

The colors that the text between `${color_start}` and `${color_end}` changes to.

`timeout`  

The time interval that the widget waits before it updates itself, in seconds.

`widget_text`, `tooltip_text`  

The text which shows up on the toolbar and when you highlight the widget, respectively.

The function `leds_widget:update()` will use the function `leds_widget.is_enabled()`

to get led state.

### Requirements

* [awesome 4.0](http://awesome.naquadah.org/) and possibly also 3.5