Merge pull request #11 from TomasTomecek/sensor-stats

sensor stats

Author: TomasTomecek

Makefile

@@ -1,4 +1,4 @@
-TEST_MODULE = conf net humanize load io display
+TEST_MODULE = conf net humanize load io display sens
 PREFIX ?= ${DESTDIR}/usr
 INSTALLDIR=${PREFIX}/bin
 DESTDIR =

README.md

@@ -3,12 +3,13 @@ tmux-top
 
 Monitoring information for your [tmux](https://tmux.github.io) status line.
 
-`tmux-top` allows you to see your:
+`tmux-top` allows you to see:
 
  * load
  * memory usage
- * network information
- * I/O
+ * network statistics
+ * I/O statistics
+ * temperature
 
 ![tmux-top sample](https://raw.githubusercontent.com/TomasTomecek/tmux-top/master/docs/tmux_top_example.png)
 ![tmux-top sample](https://raw.githubusercontent.com/TomasTomecek/tmux-top/master/docs/tmux_top_example2.png)
@@ -17,7 +18,9 @@ Monitoring information for your [tmux](https://tmux.github.io) status line.
 Installation
 ------------
 
-This tool is written in [Go](http://golang.org/). If you want to compile it, you have to [setup your Go environment](http://golang.org/doc/install) first.
+This tool is written in [Go](http://golang.org/). You have to compile it yourself -- there are no binaries being provided.
+
+[This is how you can setup your Go environment](http://golang.org/doc/install).
 
 #### Supported platforms
 
@@ -54,12 +57,71 @@ $ sudo make install
 Usage
 -----
 
-There are four subcommands at the moment:
-
  1. `tmux-top load` — load of your workstation
  2. `tmux-top mem` — actual memry usage and total memory
  3. `tmux-top net` — network statistics: IP address, network interface and current bandwidth
  4. `tmux-top io` — I/O statistics: current reads and writes
+ 4. `tmux-top sensors` — show sensor stats (temperature)
+
+
+Sensors
+-------
+
+With `sensors` command, I am trying to pursue a new design of `tmux-top`,
+utilizing [Go templates](https://golang.org/pkg/text/template/). The idea is
+that `tmux-top` will just gather the data and offer it to you as Go structs
+which you can easily utilize and display by writing a Go template. There will
+be a sensible default.
+
+You can easily print what data is available to you:
+```
+$ tmux-top sensors --format '{{.|printf "%#v"}}'
+sens.SensorsStats{Devices:[]sens.DeviceStat{sens.DeviceStat{Name:"acpitz", LowValue:48, HighValue:48, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:48}}}, sens.DeviceStat{Name:"", LowValue:1e+06, HighValue:-100, Stats:[]sens.TemperatureStat{}}, sens.DeviceStat{Name:"pch_wildcat_point", LowValue:48.5, HighValue:48.5, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:48.5}}}, sens.DeviceStat{Name:"iwlwifi", LowValue:41, HighValue:41, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:41}}}, sens.DeviceStat{Name:"coretemp", LowValue:52, HighValue:55, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"Package id 0", CurrentTemp:55}, sens.TemperatureStat{Label:"Core 0", CurrentTemp:52}, sens.TemperatureStat{Label:"Core 1", CurrentTemp:55}}}}}
+```
+
+We can see, there is a struct `SensorsStats` and it contains array of structs
+`DeviceStat`. Let's see what sensors are available:
+```
+$ tmux-top sensors --format '{{range $i, $device := .Devices}}{{.Name}}: {{.|printf "%#v\n"}}{{end}}'
+acpitz: sens.DeviceStat{Name:"acpitz", LowValue:45, HighValue:45, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:45}}}
+: sens.DeviceStat{Name:"", LowValue:1e+06, HighValue:-100, Stats:[]sens.TemperatureStat{}}
+pch_wildcat_point: sens.DeviceStat{Name:"pch_wildcat_point", LowValue:48, HighValue:48, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:48}}}
+iwlwifi: sens.DeviceStat{Name:"iwlwifi", LowValue:42, HighValue:42, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"", CurrentTemp:42}}}
+coretemp: sens.DeviceStat{Name:"coretemp", LowValue:46, HighValue:46, Stats:[]sens.TemperatureStat{sens.TemperatureStat{Label:"Package id 0", CurrentTemp:46}, sens.TemperatureStat{Label:"Core 0", CurrentTemp:46}, sens.TemperatureStat{Label:"Core 1", CurrentTemp:46}}}
+```
+
+Each `DeviceStat` has fields `Name` (might not be populated though`, `LowValue`,
+`HighValue` (so you do conditions) and array of actual values, available as
+`Stats`. Let's see a full example:
+```
+$ tmux-top sensors --format '{{range $i, $device := .Devices}}{{.Name}}: {{range $j, $stat := .Stats}}{{.CurrentTemp}} {{end}}{{printf "\n"}}{{end}}'
+acpitz: 44
+:
+pch_wildcat_point: 46.5
+iwlwifi: 42
+coretemp: 45 45 44
+```
+
+The default is:
+```
+$ tmux-top sensors --format '{{range $i, $device := .Devices}}{{if eq .Name "coretemp"}}{{if gt $device.HighValue 50.0}}Temp: {{range $j, $e := $device.Stats}}{{$e.CurrentTemp}} {{end}}{{end}}{{end}}{{end}}'
+Temp: 67 67 67
+```
+
+It prints temperature if it's higher than 50 °C and it select only sensor on CPU.
+
+There is also one helper function available to print values in tmux syntax:
+```
+{{tmux_display "default" "colour14" .CurrentTemp}}
+```
+
+which would yield
+```
+#[bg=default,fg=colour14]65#[bg=default,fg=default]
+```
+
+all of the data is coming from `/sys/class/hwmon/*`.
+
 
 Configuration
 -------------

cmd/tmux-top/cli.go

@@ -8,6 +8,7 @@ import (
 	"github.com/TomasTomecek/tmux-top/load"
 	"github.com/TomasTomecek/tmux-top/mem"
 	"github.com/TomasTomecek/tmux-top/net"
+	"github.com/TomasTomecek/tmux-top/sens"
 	"github.com/urfave/cli"
 	"os"
 )
@@ -98,6 +99,11 @@ func print_io(*cli.Context) {
 	}
 }
 
+func print_sens(ctx *cli.Context) {
+	template := c.GetSensorsTemplate(ctx.String("format"))
+	sens.PrintSensorStats(template)
+}
+
 func main() {
 	app := cli.NewApp()
 	app.Version = "0.0.4"
@@ -128,6 +134,18 @@ func main() {
 			Usage:     "show I/O stats ",
 			Action:    print_io,
 		},
+		{
+			Name:      "sensors",
+			ShortName: "s",
+			Usage:     "show sensor stats (temperature)",
+			Action:    print_sens,
+			Flags: []cli.Flag{
+				cli.StringFlag{
+					Name:  "format, f",
+					Usage: "Format the output using the given Go template",
+				},
+			},
+		},
 	}
 
 	app.Run(os.Args)

conf/conf.go

@@ -88,15 +88,21 @@ type MemConfiguration struct {
 	TotalFg     *string            `json:"total_fg"`
 }
 
+// configuration in a config file
+type SensorsConfiguration struct {
+	Template *string `json:"template"`
+}
+
 type LoadConfiguration struct {
 	Intervals *[]IntervalDisplay `json:"intervals"`
 }
 
 type Configuration struct {
-	Load *LoadConfiguration `json:"load"`
-	Net  *NetConfiguration  `json:"net"`
-	Mem  *MemConfiguration  `json:"mem"`
-	IO   *IOConfiguration   `json:"io"`
+	Load    *LoadConfiguration    `json:"load"`
+	Net     *NetConfiguration     `json:"net"`
+	Mem     *MemConfiguration     `json:"mem"`
+	IO      *IOConfiguration      `json:"io"`
+	Sensors *SensorsConfiguration `json:"sensors"`
 }
 
 func loadConfFromFile(path string) []byte {
@@ -107,7 +113,7 @@ func loadConfFromFile(path string) []byte {
 	return response
 }
 
-func loadConfFromBytes(json_input []byte) *Configuration {
+func LoadConfFromBytes(json_input []byte) *Configuration {
 	var conf *Configuration = new(Configuration)
 	err := json.Unmarshal(json_input, &conf)
 
@@ -123,8 +129,8 @@ func LoadConf() *ConfigurationManager {
 	home_dir := os.Getenv("HOME")
 	bytes := loadConfFromFile(path.Join(home_dir, ".tmux-top"))
 	if len(bytes) > 0 {
-		c.User = loadConfFromBytes(bytes)
+		c.User = LoadConfFromBytes(bytes)
 	}
-	c.Default = loadConfFromBytes([]byte(default_conf))
+	c.Default = LoadConfFromBytes([]byte(default_conf))
 	return c
 }

conf/default_json.go

@@ -164,5 +164,12 @@ var default_conf string = `
 			"bg_color": "colour1",
 			"fg_color": "white"
 		}]
+	},
+	"sensors": {
+		"template": "{{range $i, $device := .Devices}}{{if eq .Name \"coretemp\"}}{{if gt $device.HighValue 50.0}}Temp: {{range $j, $e := $device.Stats}}{{$e.CurrentTemp}} {{end}}{{end}}{{end}}{{end}}"
 	}
 }`
+
+func GetDefaultConf() string {
+	return default_conf
+}

conf/manager.go

@@ -1,5 +1,11 @@
 package conf
 
+import (
+	"fmt"
+	"strings"
+	"text/template"
+)
+
 /*
 This ugly boilerplate code enables user to override default settings
 
@@ -266,3 +272,43 @@ func (c *ConfigurationManager) GetIOWriteLabelFg() string {
 	}
 	return *c.Default.IO.WriteLabelFg
 }
+
+func replace(input, from, to string) string {
+	return strings.Replace(input, from, to, -1)
+}
+
+func tmux_display(bg, fg string, value interface{}) (response string) {
+	response = fmt.Sprintf("#[bg=%s,fg=%s]%v#[bg=default,fg=default]", bg, fg, value)
+	return
+}
+
+func Init_template() template.Template {
+	tmpl := template.New("")
+	funcMap := template.FuncMap{
+		"replace":      replace,
+		"tmux_display": tmux_display,
+	}
+	tmpl.Funcs(funcMap)
+	return *tmpl
+}
+
+// format -- CLI option
+func (c *ConfigurationManager) GetSensorsTemplate(format string) template.Template {
+	template_s := format
+	if format == "" {
+		template_s = *c.Default.Sensors.Template
+		if c.User != nil {
+			if c.User.Sensors != nil {
+				if c.User.Sensors.Template != nil {
+					template_s = *c.User.Sensors.Template
+				}
+			}
+		}
+	}
+	template := Init_template()
+	t, err := template.Parse(template_s)
+	if err != nil {
+		panic(err)
+	}
+	return *t
+}

sens/sens.go

@@ -0,0 +1,135 @@
+/*
+docs: `strace sensors`
+*/
+
+package sens
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+	"path/filepath"
+	"strconv"
+	"strings"
+	"text/template"
+)
+
+var BASE_PATH string = "/sys/class/hwmon/"
+
+type TemperatureStat struct {
+	Label       string
+	CurrentTemp float64
+	// MaxTemp       float64
+	// CritTemp      float64
+	// CritAlarmTemp float64
+}
+
+// a list of stats for this device
+type DeviceStat struct {
+	Name      string            `json:"Name"`
+	LowValue  float64           `json:"LowValue"`
+	HighValue float64           `json:"HighValue"`
+	Stats     []TemperatureStat `json:"Stats"`
+}
+
+type SensorsStats struct {
+	Devices []DeviceStat
+}
+
+func getFileContentToInt(p string) (float64, error) {
+	fd, err := ioutil.ReadFile(p)
+	if err != nil {
+		return 0.0, err
+	}
+	i, err := strconv.ParseInt(strings.TrimSpace(string(fd)), 10, 64)
+	if err != nil {
+		return 0.0, err
+	}
+	return float64(i) / 1000, nil
+}
+
+func getDeviceStats(f os.FileInfo) DeviceStat {
+	sens_stats := make([]TemperatureStat, 0)
+	d := DeviceStat{
+		Stats:     sens_stats,
+		Name:      "",
+		LowValue:  1000000.0,
+		HighValue: -100.0,
+	}
+	device_path, err := filepath.EvalSymlinks(path.Join(BASE_PATH, f.Name()))
+	if err != nil {
+		return d
+	}
+
+	name_f, err := ioutil.ReadFile(path.Join(device_path, "name"))
+	name := ""
+	if err == nil {
+		name = strings.TrimSpace(string(name_f))
+	}
+	d.Name = name
+
+	count := 1
+	for {
+		cur_p := path.Join(
+			device_path,
+			fmt.Sprintf("temp%s_input", strconv.Itoa(count)),
+		)
+		cur_f, err := getFileContentToInt(cur_p)
+		if err != nil {
+			break
+		}
+
+		label_f, err := ioutil.ReadFile(path.Join(
+			device_path,
+			fmt.Sprintf("temp%s_label", strconv.Itoa(count)),
+		))
+		label := ""
+		if err == nil {
+			label = strings.TrimSpace(string(label_f))
+		}
+
+		if d.LowValue > cur_f {
+			d.LowValue = cur_f
+		}
+		if d.HighValue < cur_f {
+			d.HighValue = cur_f
+		}
+
+		s := TemperatureStat{
+			CurrentTemp: cur_f,
+			Label:       label,
+		}
+		sens_stats = append(sens_stats, s)
+
+		count++
+	}
+	d.Stats = sens_stats
+	return d
+}
+
+func getSensorsStats() SensorsStats {
+	device_stats := make([]DeviceStat, 0)
+	s := SensorsStats{
+		Devices: device_stats,
+	}
+	entries, err := ioutil.ReadDir(BASE_PATH)
+	if err != nil {
+		panic(err)
+	}
+	// fd, os.FileInfo
+	for _, e := range entries {
+		d := getDeviceStats(e)
+		device_stats = append(device_stats, d)
+	}
+	s.Devices = device_stats
+	return s
+}
+
+func PrintSensorStats(t template.Template) {
+	d := getSensorsStats()
+	err := t.Execute(os.Stdout, d)
+	if err != nil {
+		panic(err)
+	}
+}