Skip to content

Commit 30aba0a

Browse files
authored
Add per widget update intervals with possible configuration in deck files (#31)
1 parent 77d9326 commit 30aba0a

6 files changed

Lines changed: 95 additions & 62 deletions

File tree

‎config.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ type ActionConfig struct {
2626

2727
// WidgetConfig describes configuration data for widgets.
2828
type WidgetConfig struct {
29-
ID string `toml:"id,omitempty"`
30-
Config map[string]string `toml:"config,omitempty"`
29+
ID string `toml:"id,omitempty"`
30+
Interval uint `toml:"interval,omitempty"`
31+
Config map[string]string `toml:"config,omitempty"`
3132
}
3233

3334
// KeyConfig holds the entire configuration for a single key.

‎deck.go‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func LoadDeck(dev *streamdeck.Device, base string, deck string) (*Deck, error) {
6060

6161
var w Widget
6262
if k, found := keyMap[i]; found {
63-
w = NewWidget(k.Index, k.Widget.ID, k.Action, k.ActionHold, bg, k.Widget.Config)
63+
w = NewWidget(k, bg)
6464
} else {
6565
w = NewBaseWidget(i, nil, nil, bg)
6666
}
@@ -241,6 +241,11 @@ func (d *Deck) triggerAction(dev *streamdeck.Device, index uint8, hold bool) {
241241
// updateWidgets updates/repaints all the widgets.
242242
func (d *Deck) updateWidgets(dev *streamdeck.Device) {
243243
for _, w := range d.Widgets {
244+
if !w.RequiresUpdate() {
245+
continue
246+
}
247+
248+
// log.Printf("Repaint %d", w.Key())
244249
if err := w.Update(dev); err != nil {
245250
log.Fatalf("error: %v", err)
246251
}

‎main.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ func main() {
138138
}
139139
for {
140140
select {
141-
case <-time.After(900 * time.Millisecond):
141+
case <-time.After(100 * time.Millisecond):
142142
deck.updateWidgets(&dev)
143143

144144
case k, ok := <-kch:
@@ -149,13 +149,11 @@ func main() {
149149
}
150150
continue
151151
}
152-
// spew.Dump(k)
153152

154153
var state bool
155154
if ks, ok := keyStates.Load(k.Index); ok {
156155
state = ks.(bool)
157156
}
158-
// log.Println("Storing state", k.Pressed)
159157
keyStates.Store(k.Index, k.Pressed)
160158

161159
if state && !k.Pressed {

‎widget.go‎

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"log"
88
"os"
99
"strconv"
10-
"sync"
10+
"time"
1111

1212
"github.com/golang/freetype"
1313
"github.com/golang/freetype/truetype"
@@ -18,6 +18,7 @@ import (
1818
// Widget is an interface implemented by all available widgets.
1919
type Widget interface {
2020
Key() uint8
21+
RequiresUpdate() bool
2122
Update(dev *streamdeck.Device) error
2223
Action() *ActionConfig
2324
ActionHold() *ActionConfig
@@ -30,7 +31,8 @@ type BaseWidget struct {
3031
action *ActionConfig
3132
actionHold *ActionConfig
3233
background image.Image
33-
init *sync.Once
34+
lastUpdate time.Time
35+
interval uint
3436
}
3537

3638
// Key returns the key a widget is mapped to.
@@ -53,14 +55,20 @@ func (w *BaseWidget) TriggerAction() {
5355
// just a stub
5456
}
5557

58+
// RequiresUpdate returns true when the widget wants to be repainted.
59+
func (w *BaseWidget) RequiresUpdate() bool {
60+
if !w.lastUpdate.IsZero() && // initial paint done
61+
(w.interval == 0 || // never to be repainted
62+
time.Since(w.lastUpdate) < time.Duration(w.interval)*time.Millisecond) {
63+
return false
64+
}
65+
66+
return true
67+
}
68+
5669
// Update renders the widget.
5770
func (w *BaseWidget) Update(dev *streamdeck.Device) error {
58-
var err error
59-
w.init.Do(func() {
60-
err = w.render(dev, nil)
61-
})
62-
63-
return err
71+
return w.render(dev, nil)
6472
}
6573

6674
// NewBaseWidget returns a new BaseWidget.
@@ -70,45 +78,49 @@ func NewBaseWidget(index uint8, action, actionHold *ActionConfig, bg image.Image
7078
action: action,
7179
actionHold: actionHold,
7280
background: bg,
73-
init: &sync.Once{},
7481
}
7582
}
7683

7784
// NewWidget initializes a widget.
78-
func NewWidget(index uint8, id string, action, actionHold *ActionConfig, bg image.Image, config map[string]string) Widget {
79-
bw := NewBaseWidget(index, action, actionHold, bg)
85+
func NewWidget(kc KeyConfig, bg image.Image) Widget {
86+
bw := NewBaseWidget(kc.Index, kc.Action, kc.ActionHold, bg)
87+
wc := kc.Widget
8088

81-
switch id {
89+
switch wc.ID {
8290
case "button":
91+
bw.setInterval(wc.Interval, 0)
8392
return &ButtonWidget{
8493
BaseWidget: *bw,
85-
icon: config["icon"],
86-
label: config["label"],
94+
icon: wc.Config["icon"],
95+
label: wc.Config["label"],
8796
}
8897

8998
case "clock":
99+
bw.setInterval(wc.Interval, 1000)
90100
return &TimeWidget{
91101
BaseWidget: *bw,
92102
format: "%H;%i;%s",
93103
font: "bold;regular;thin",
94104
}
95105

96106
case "date":
107+
bw.setInterval(wc.Interval, 1000)
97108
return &TimeWidget{
98109
BaseWidget: *bw,
99110
format: "%l;%d;%M",
100111
font: "regular;bold;regular",
101112
}
102113

103114
case "time":
115+
bw.setInterval(wc.Interval, 1000)
104116
return &TimeWidget{
105117
BaseWidget: *bw,
106-
format: config["format"],
107-
font: config["font"],
118+
format: wc.Config["format"],
119+
font: wc.Config["font"],
108120
}
109121

110122
case "recentWindow":
111-
i, err := strconv.ParseUint(config["window"], 10, 64)
123+
i, err := strconv.ParseUint(wc.Config["window"], 10, 64)
112124
if err != nil {
113125
log.Fatal(err)
114126
}
@@ -118,24 +130,26 @@ func NewWidget(index uint8, id string, action, actionHold *ActionConfig, bg imag
118130
}
119131

120132
case "top":
133+
bw.setInterval(wc.Interval, 500)
121134
return &TopWidget{
122135
BaseWidget: *bw,
123-
mode: config["mode"],
124-
fillColor: config["fillColor"],
136+
mode: wc.Config["mode"],
137+
fillColor: wc.Config["fillColor"],
125138
}
126139

127140
default:
128141
// unknown widget ID
129-
log.Println("Unknown widget with ID:", id)
142+
log.Println("Unknown widget with ID:", wc.ID)
130143
}
131144

132145
return nil
133146
}
134147

135148
// renders the widget including its background image.
136149
func (w *BaseWidget) render(dev *streamdeck.Device, fg image.Image) error {
137-
pixels := int(dev.Pixels)
150+
w.lastUpdate = time.Now()
138151

152+
pixels := int(dev.Pixels)
139153
img := image.NewRGBA(image.Rect(0, 0, pixels, pixels))
140154
if w.background != nil {
141155
draw.Draw(img, img.Bounds(), w.background, image.Point{}, draw.Over)
@@ -147,6 +161,15 @@ func (w *BaseWidget) render(dev *streamdeck.Device, fg image.Image) error {
147161
return dev.SetImage(w.key, img)
148162
}
149163

164+
// change the interval a widget gets rendered in.
165+
func (w *BaseWidget) setInterval(interval uint, defaultInterval uint) {
166+
if interval == 0 {
167+
interval = defaultInterval
168+
}
169+
170+
w.interval = interval
171+
}
172+
150173
func drawImage(img *image.RGBA, path string, size int, pt image.Point) error {
151174
f, err := os.Open(path)
152175
if err != nil {

‎widget_button.go‎

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package main
33
import (
44
"image"
55
"path/filepath"
6-
"sync"
76

87
"github.com/muesli/streamdeck"
98
)
@@ -14,52 +13,50 @@ type ButtonWidget struct {
1413
icon string
1514
label string
1615
fontsize float64
17-
18-
init sync.Once
1916
}
2017

2118
// Update renders the widget.
2219
func (w *ButtonWidget) Update(dev *streamdeck.Device) error {
23-
var err error
24-
w.init.Do(func() {
25-
size := int(dev.Pixels)
26-
margin := size / 18
27-
height := size - (margin * 2)
28-
img := image.NewRGBA(image.Rect(0, 0, size, size))
20+
size := int(dev.Pixels)
21+
margin := size / 18
22+
height := size - (margin * 2)
23+
img := image.NewRGBA(image.Rect(0, 0, size, size))
2924

30-
if w.label != "" {
31-
iconsize := int((float64(height) / 3.0) * 2.0)
32-
bounds := img.Bounds()
25+
if w.label != "" {
26+
iconsize := int((float64(height) / 3.0) * 2.0)
27+
bounds := img.Bounds()
3328

34-
if w.icon != "" {
35-
err = drawImage(img,
36-
findImage(filepath.Dir(deck.File), w.icon),
37-
iconsize,
38-
image.Pt(-1, margin))
29+
if w.icon != "" {
30+
err := drawImage(img,
31+
findImage(filepath.Dir(deck.File), w.icon),
32+
iconsize,
33+
image.Pt(-1, margin))
3934

40-
bounds.Min.Y += iconsize + margin
41-
bounds.Max.Y -= margin
35+
if err != nil {
36+
return err
4237
}
4338

44-
drawString(img,
45-
bounds,
46-
ttfFont,
47-
w.label,
48-
dev.DPI,
49-
w.fontsize,
50-
image.Pt(-1, -1))
51-
} else if w.icon != "" {
52-
err = drawImage(img,
53-
findImage(filepath.Dir(deck.File), w.icon),
54-
height,
55-
image.Pt(-1, -1))
39+
bounds.Min.Y += iconsize + margin
40+
bounds.Max.Y -= margin
5641
}
5742

43+
drawString(img,
44+
bounds,
45+
ttfFont,
46+
w.label,
47+
dev.DPI,
48+
w.fontsize,
49+
image.Pt(-1, -1))
50+
} else if w.icon != "" {
51+
err := drawImage(img,
52+
findImage(filepath.Dir(deck.File), w.icon),
53+
height,
54+
image.Pt(-1, -1))
55+
5856
if err != nil {
59-
return
57+
return err
6058
}
61-
err = w.render(dev, img)
62-
})
59+
}
6360

64-
return err
61+
return w.render(dev, img)
6562
}

‎widget_recent_window.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ type RecentWindowWidget struct {
1717
lastClass string
1818
}
1919

20+
// RequiresUpdate returns true when the widget wants to be repainted.
21+
func (w *RecentWindowWidget) RequiresUpdate() bool {
22+
if int(w.window) < len(recentWindows) {
23+
return w.lastClass != recentWindows[w.window].Class
24+
}
25+
26+
return false
27+
}
28+
2029
// Update renders the widget.
2130
func (w *RecentWindowWidget) Update(dev *streamdeck.Device) error {
2231
img := image.NewRGBA(image.Rect(0, 0, int(dev.Pixels), int(dev.Pixels)))

0 commit comments

Comments
 (0)
⌂ 换网址