Merge pull request #13 from gistart/gsettings

Gsettings

Author: gistart

README.md

@@ -9,3 +9,5 @@ Simple extension to show current power consumption in Gnome battery widget.
 Differs from original wattmeter -- it reads directly from `/sys/class/power_supply/BAT0/power_now`.
 
 Tested with ThinkPad Carbon X1 Gen4
+
+Download from: https://extensions.gnome.org/extension/2308/tp_wattmeter/

extension.js

@@ -12,10 +12,6 @@ const Config = imports.misc.config;
 /** Settings
  */
 
-const HISTORY_DEPTH = 5;
-const MEASURE_PERIOD = 1000;
-const FORCE_SYNC_PERIOD = 5000;
-
 const BAT_STATUS = "/sys/class/power_supply/BAT0/status";
 const POWER_NOW = "/sys/class/power_supply/BAT0/power_now";
 
@@ -31,14 +27,18 @@ var TPIndicator = GObject.registerClass(
         _init() {
             super._init();
 
+            this.settings = ExtensionUtils.getSettings('org.gnome.shell.extensions.tp_wattmeter');
+
+            // to detect changes FIXME: a better way?
+            this.last_period_val = this.settings.get_double('period-sec');
+
             this.readings = [];
             this.last_value = 0.0;
             this.tm_measure = null;
-            this.tm_force_sync = null;
         }
 
         _getBatteryStatus() {
-            const pct = this._proxy.Percentage;
+            const pct = this._proxy.Percentage.toFixed(0);
             const power = this.last_value.toFixed(1);
             const status = this._read_file(BAT_STATUS, '???');
 
@@ -71,39 +71,40 @@ var TPIndicator = GObject.registerClass(
             const power = parseFloat(this._read_file(POWER_NOW), 0) / 1000000;
             this.readings.push(power)
 
-            if (this.readings.length >= HISTORY_DEPTH) {
-                let avg = this.readings.reduce((acc, elem) => acc + elem, 0.0) / this.readings.length;
-                this.last_value = avg;
-
-                while (this.readings.length) { this.readings.pop(); };
-                this.readings.push(avg);
-            }
-            return true;
-        }
-
-        _force_sync() {
-            this._sync();
+            const period_now = this.settings.get_double('period-sec');
+            if (period_now.toFixed(1) != this.last_period_val.toFixed(1)) {
+                // period changed, re-spawn
+                this._spawn();
+                this.last_period_val = period_now;
+            };
+
+            const avg_of = this.settings.get_int('avg-of');
+            if (this.readings.length >= avg_of) {
+                this.last_value = this.readings.reduce((acc, elem) => acc + elem, 0.0) / this.readings.length; // simple mean
+                this._sync(); // update battery widget now!
+                this.readings.length = 0;  // fastest way to clear array?
+            } 
             return true;
         }
 
         _spawn() {
+            if (this.tm_measure !== null) {
+                GLib.source_remove(this.tm_measure);
+            }
             this.tm_measure = GLib.timeout_add(
                 GLib.PRIORITY_DEFAULT,
-                MEASURE_PERIOD,
-                Lang.bind(this, this._measure));
-            this.tm_force_sync = GLib.timeout_add(
-                GLib.PRIORITY_DEFAULT,
-                FORCE_SYNC_PERIOD,
-                Lang.bind(this, this._force_sync));
+                this.settings.get_double('period-sec') * 1000,
+                Lang.bind(this, this._measure)
+            );
         }
 
         _stop() {
             GLib.source_remove(this.tm_measure);
-            GLib.source_remove(this.tm_force_sync);
         }
     }
 );
 
+
 /** Extension
  */
 
@@ -114,12 +115,12 @@ class TPWattMeter {
 
         this.aggregateMenu = Panel.statusArea['aggregateMenu'];
         this.originalIndicator = this.aggregateMenu._power;
-        this.aggregateMenu._indicators.replace_child(this.originalIndicator.indicators, this.customIndicator.indicators);
+        this.aggregateMenu._indicators.replace_child(this.originalIndicator, this.customIndicator);
     }
 
     destroy(arg) {
         this.customIndicator._stop();
-        this.aggregateMenu._indicators.replace_child(this.customIndicator.indicators, this.originalIndicator.indicators);
+        this.aggregateMenu._indicators.replace_child(this.customIndicator, this.originalIndicator);
         this.customIndicator = null;
     }
 }
@@ -132,7 +133,7 @@ let tp_wattmeter;
 
 
 function enable() {
-    tp_wattmeter = new TPWattMeter(); //tp_reader, tp_indicator);
+    tp_wattmeter = new TPWattMeter();
 }
 
 function disable() {

metadata.json

@@ -2,9 +2,8 @@
     "name": "tp_wattmeter",
     "uuid": "tp_wattmeter@gistart",
     "url": "https://github.com/gistart/tp_wattmeter",
-    "description": "Shows battery power consumption of ThinkPad laptops",
+    "description": "Shows battery power consumption of ThinkPad laptops. Now configurable!",
     "shell-version": [
-        "3.36.0",
         "40",
         "41",
         "42"

pack-extension.sh

@@ -1,3 +1,18 @@
 #!/bin/bash
 
-zip -j tp_wattmeter.zip extension.js metadata.json
+# compile schema
+glib-compile-schemas schemas/
+
+# pack extension
+zip -r tp_wattmeter.zip \
+            extension.js \
+            prefs.js \
+            metadata.json \
+            schemas/gschemas.compiled \
+            schemas/org.gnome.shell.extensions.tp_wattmeter.gschema.xml
+
+# install extension
+gnome-extensions install ./tp_wattmeter.zip --force
+
+# test settings
+# gnome-extensions prefs tp_wattmeter@gistart

prefs.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const { Adw, Gio, Gtk } = imports.gi;
+
+const ExtensionUtils = imports.misc.extensionUtils;
+const Me = ExtensionUtils.getCurrentExtension();
+
+
+function init() {
+}
+
+function fillPreferencesWindow(window) {
+    const settings = ExtensionUtils.getSettings('org.gnome.shell.extensions.tp_wattmeter');
+
+    const page = new Adw.PreferencesPage();
+    const group = new Adw.PreferencesGroup();
+    page.add(group);
+
+    // history depth
+    const avg_row = new Adw.ActionRow({ title: 'Show average of this many measurements' });
+    group.add(avg_row);
+
+    const avg_spin = new Gtk.SpinButton({
+        climb_rate: 1,
+        digits: 0,
+        adjustment: new Gtk.Adjustment({
+            value: settings.get_uint('avg-of'),
+            lower: 1,
+            upper: 25,
+            step_increment: 1,
+        }),
+    });
+    settings.bind(
+        'avg-of',
+        avg_spin,
+        'value',
+        Gio.SettingsBindFlags.DEFAULT
+    );
+    avg_row.add_suffix(avg_spin);
+    avg_row.activatable_widget = avg_spin;
+
+    // measure period
+    const period_row = new Adw.ActionRow({ title: 'Period between measurements in seconds' });
+    group.add(period_row);
+
+    const period_spin = new Gtk.SpinButton({
+        climb_rate: 1,
+        digits: 1,
+        adjustment: new Gtk.Adjustment({
+            value: settings.get_double('period-sec'),
+            lower: 0.1,
+            upper: 10.0,
+            step_increment: 0.5,
+        }),
+    });
+    settings.bind(
+        'period-sec',
+        period_spin,
+        'value',
+        Gio.SettingsBindFlags.DEFAULT
+    );
+    period_row.add_suffix(period_spin);
+    period_row.activatable_widget = period_spin;
+
+    // done
+    window.add(page);
+}

schemas/gschemas.compiled

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schemalist>
+    <schema id="org.gnome.shell.extensions.tp_wattmeter" path="/org/gnome/shell/extensions/tp_wattmeter/">
+        <key name="avg-of" type="i">
+            <default>5</default>
+        </key>
+        <key name="period-sec" type="d">
+            <default>1.0</default>
+        </key>    
+    </schema>
+</schemalist>