avoid to update SMART more than each 30s (costly operation for the udisks2 daemon)
[psensor.git] / src / lib / psensor.h
index cd44106..2e851a7 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2010-2012 jeanfi@gmail.com
+ * Copyright (C) 2010-2014 jeanfi@gmail.com
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
 #ifndef _PSENSOR_PSENSOR_H_
 #define _PSENSOR_PSENSOR_H_
 
-#include "config.h"
 #include <sensors/sensors.h>
 
+#include "config.h"
 #ifdef HAVE_ATASMART
 #include <atasmart.h>
 #endif
 
+#include "bool.h"
 #include "color.h"
-#include "log.h"
+#include <plog.h>
 #include "measure.h"
 
 enum psensor_type {
-       SENSOR_TYPE_TEMP = 0x0001,
-       SENSOR_TYPE_FAN = 0x0002,
-       SENSOR_TYPE_REMOTE = 0x0004,
-
-       SENSOR_TYPE_LMSENSOR = 0x0100,
-       SENSOR_TYPE_NVIDIA_TEMP = 0x0200 | SENSOR_TYPE_TEMP,
-       SENSOR_TYPE_HDD_TEMP = 0x0400 | SENSOR_TYPE_TEMP,
-       SENSOR_TYPE_CPU_USAGE = 0x0800,
-       SENSOR_TYPE_AMD = 0x1000,
-
-       SENSOR_TYPE_HDD_TEMP_ATASMART = 0x2000 | SENSOR_TYPE_HDD_TEMP,
-       SENSOR_TYPE_HDD_TEMP_HDDTEMP = 0x4000 | SENSOR_TYPE_HDD_TEMP,
-
-       SENSOR_TYPE_AMD_TEMP = SENSOR_TYPE_AMD | SENSOR_TYPE_TEMP,
-       SENSOR_TYPE_AMD_FAN = SENSOR_TYPE_AMD | SENSOR_TYPE_FAN,
-
-       SENSOR_TYPE_LMSENSOR_TEMP = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_TEMP,
-       SENSOR_TYPE_LMSENSOR_FAN = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_FAN
+       /* type of sensor values */
+       SENSOR_TYPE_TEMP = 0x00001,
+       SENSOR_TYPE_RPM = 0x00002,
+       SENSOR_TYPE_PERCENT = 0x00004,
+
+       /* Whether the sensor is remote */
+       SENSOR_TYPE_REMOTE = 0x00008,
+
+       /* Libraries used for retrieving sensor information */
+       SENSOR_TYPE_LMSENSOR = 0x00100,
+       SENSOR_TYPE_NVCTRL = 0x00200,
+       SENSOR_TYPE_GTOP = 0x00400,
+       SENSOR_TYPE_ATIADL = 0x00800,
+       SENSOR_TYPE_ATASMART = 0x01000,
+       SENSOR_TYPE_HDDTEMP = 0x02000,
+       SENSOR_TYPE_UDISKS2 = 0x800000,
+
+       /* Type of HW component */
+       SENSOR_TYPE_HDD = 0x04000,
+       SENSOR_TYPE_CPU = 0x08000,
+       SENSOR_TYPE_GPU = 0x10000,
+       SENSOR_TYPE_FAN = 0x20000,
+
+       SENSOR_TYPE_GRAPHICS = 0x40000,
+       SENSOR_TYPE_VIDEO = 0x80000,
+       SENSOR_TYPE_PCIE = 0x100000,
+       SENSOR_TYPE_MEMORY = 0x200000,
+       SENSOR_TYPE_AMBIENT = 0x400000,
+
+       /* Combinations */
+       SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
+       SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
 };
 
 struct psensor {
@@ -58,8 +73,12 @@ struct psensor {
        /* Uniq id of the sensor */
        char *id;
 
+       /* Name of the chip. */
+       char *chip;
+
        /* lm-sensor */
        const sensors_chip_name *iname;
+
        const sensors_feature *feature;
 
        /* Maximum length of 'values' */
@@ -72,8 +91,8 @@ struct psensor {
        /* Color of the sensor used for the graph */
        struct color *color;
 
-       /* Whether the sensor is displayed in the graph */
-       int enabled;
+       /* Whether the graph sensor is displayed. */
+       bool graph_enabled;
 
        /* see psensor_type */
        unsigned int type;
@@ -84,21 +103,16 @@ struct psensor {
        /* The minimum detected value of the sensor */
        double min;
 
-       /*
-          Whether alarm alerts is enabled for this sensor
-        */
-       int alarm_enabled;
+       /* Whether alarm alert is enabled for this sensor */
+       bool alarm_enabled;
 
-       /*
-          An alarm is raised if the current sensor value is bigger. 0
-          means no limit
-        */
-       double alarm_limit;
+       int alarm_high_threshold;
+       int alarm_low_threshold;
 
-       /* Whether the current value is bigger than 'alarm_limit'.  */
-       int alarm_raised;
+       /* Whether an alarm is raised for this sensor */
+       unsigned int alarm_raised;
 
-       void (*cb_alarm_raised) (struct psensor *, void *);
+       void (*cb_alarm_raised)(struct psensor *, void *);
        void *cb_alarm_raised_data;
 
 #ifdef HAVE_NVIDIA
@@ -113,11 +127,18 @@ struct psensor {
        SkDisk *disk;
 #endif
 
+       void *provider_data;
+       void (*provider_data_free_fct)(void *);
+
        char *url;
+
+       bool appindicator_enabled;
 };
 
 struct psensor *psensor_create(char *id,
-                              char *name, unsigned int type,
+                              char *name,
+                              char *chip,
+                              unsigned int type,
                               int values_max_length);
 
 void psensor_values_resize(struct psensor *s, int new_size);
@@ -127,6 +148,8 @@ void psensor_free(struct psensor *sensor);
 void psensor_list_free(struct psensor **sensors);
 int psensor_list_size(struct psensor **sensors);
 
+struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
+
 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
                                       const char *id);
 
@@ -136,7 +159,6 @@ struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 
 int is_temp_type(unsigned int type);
-int is_fan_type(unsigned int type);
 
 double get_min_temp(struct psensor **sensors);
 double get_max_temp(struct psensor **sensors);
@@ -156,20 +178,28 @@ psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
   or SENSOR_TYPE_LMSENSOR_FAN
 */
-char *psensor_value_to_string(unsigned int type,
-                             double value,
-                             int use_celcius);
+char *psensor_value_to_str(unsigned int type,
+                          double value,
+                          int use_celsius);
+
+char *psensor_measure_to_str(const struct measure *m,
+                            unsigned int type,
+                            unsigned int use_celsius);
 
 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 
 struct psensor **psensor_list_add(struct psensor **sensors,
                                  struct psensor *sensor);
 
+void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
+
+struct psensor **psensor_list_copy(struct psensor **);
+
 void psensor_set_current_value(struct psensor *sensor, double value);
 void psensor_set_current_measure(struct psensor *sensor, double value,
                                 struct timeval tv);
 
-double psensor_get_current_value(struct psensor *sensor);
+double psensor_get_current_value(const struct psensor *);
 
 struct measure *psensor_get_current_measure(struct psensor *sensor);
 
@@ -178,7 +208,7 @@ struct measure *psensor_get_current_measure(struct psensor *sensor);
 */
 const char *psensor_type_to_str(unsigned int type);
 
-const char *psensor_type_to_unit_str(unsigned int type, int use_celcius);
+const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
 
 void psensor_list_update_measures(struct psensor **sensors);
 
@@ -188,6 +218,8 @@ void psensor_cleanup();
 
 double get_max_value(struct psensor **sensors, int type);
 
-double celcius_to_fahrenheit(double c);
+char *psensor_current_value_to_str(const struct psensor *, unsigned int);
+
+void psensor_log_measures(struct psensor **sensors);
 
 #endif