src/lib/psensor.h

   1 /*
   2  * Copyright (C) 2010-2012 jeanfi@gmail.com
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301 USA
  18  */
  19 #ifndef _PSENSOR_PSENSOR_H_
  20 #define _PSENSOR_PSENSOR_H_
  21
  22 #include <sensors/sensors.h>
  23
  24 #include "config.h"
  25 #ifdef HAVE_ATASMART
  26 #include <atasmart.h>
  27 #endif
  28
  29 #include "bool.h"
  30 #include "color.h"
  31 #include "log.h"
  32 #include "measure.h"
  33
  34 enum psensor_type {
  35         SENSOR_TYPE_TEMP = 0x0001,
  36         SENSOR_TYPE_FAN = 0x0002,
  37         SENSOR_TYPE_REMOTE = 0x0004,
  38
  39         SENSOR_TYPE_LMSENSOR = 0x0100,
  40         SENSOR_TYPE_NVIDIA_TEMP = 0x0200 | SENSOR_TYPE_TEMP,
  41         SENSOR_TYPE_HDD_TEMP = 0x0400 | SENSOR_TYPE_TEMP,
  42         SENSOR_TYPE_CPU_USAGE = 0x0800,
  43         SENSOR_TYPE_AMD = 0x1000,
  44
  45         SENSOR_TYPE_HDD_TEMP_ATASMART = 0x2000 | SENSOR_TYPE_HDD_TEMP,
  46         SENSOR_TYPE_HDD_TEMP_HDDTEMP = 0x4000 | SENSOR_TYPE_HDD_TEMP,
  47
  48         SENSOR_TYPE_AMD_TEMP = SENSOR_TYPE_AMD | SENSOR_TYPE_TEMP,
  49         SENSOR_TYPE_AMD_FAN = SENSOR_TYPE_AMD | SENSOR_TYPE_FAN,
  50
  51         SENSOR_TYPE_LMSENSOR_TEMP = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_TEMP,
  52         SENSOR_TYPE_LMSENSOR_FAN = SENSOR_TYPE_LMSENSOR | SENSOR_TYPE_FAN
  53 };
  54
  55 struct psensor {
  56         /* Human readable name of the sensor.  It may not be uniq. */
  57         char *name;
  58
  59         /* Uniq id of the sensor */
  60         char *id;
  61
  62         /* lm-sensor */
  63         const sensors_chip_name *iname;
  64         const sensors_feature *feature;
  65
  66         /* Maximum length of 'values' */
  67         int values_max_length;
  68
  69         /* Last registered measures of the sensor.  Index 0 for the
  70            oldest measure.  */
  71         struct measure *measures;
  72
  73         /* Color of the sensor used for the graph */
  74         struct color *color;
  75
  76         /* Whether the graph sensor is displayed. */
  77         bool enabled;
  78
  79         /* see psensor_type */
  80         unsigned int type;
  81
  82         /* The maximum detected value of the sensor */
  83         double max;
  84
  85         /* The minimum detected value of the sensor */
  86         double min;
  87
  88         /* Whether alarm alert is enabled for this sensor */
  89         bool alarm_enabled;
  90
  91         int alarm_high_threshold;
  92         int alarm_low_threshold;
  93
  94         /* Whether an alarm is raised for this sensor */
  95         unsigned int alarm_raised;
  96
  97         void (*cb_alarm_raised) (struct psensor *, void *);
  98         void *cb_alarm_raised_data;
  99
 100 #ifdef HAVE_NVIDIA
 101         /* Nvidia id for the nvctrl */
 102         int nvidia_id;
 103 #endif
 104 #ifdef HAVE_LIBATIADL
 105         /* AMD id for the aticonfig */
 106         int amd_id;
 107 #endif
 108 #ifdef HAVE_ATASMART
 109         SkDisk *disk;
 110 #endif
 111
 112         char *url;
 113
 114         bool appindicator_enabled;
 115 };
 116
 117 struct psensor *psensor_create(char *id,
 118                                char *name, unsigned int type,
 119                                int values_max_length);
 120
 121 void psensor_values_resize(struct psensor *s, int new_size);
 122
 123 void psensor_free(struct psensor *sensor);
 124
 125 void psensor_list_free(struct psensor **sensors);
 126 int psensor_list_size(struct psensor **sensors);
 127
 128 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
 129                                        const char *id);
 130
 131 /*
 132   Return 1 if there is at least one sensor of a given type, else
 133   returns 0 */
 134 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
 135
 136 int is_temp_type(unsigned int type);
 137 int is_fan_type(unsigned int type);
 138
 139 double get_min_temp(struct psensor **sensors);
 140 double get_max_temp(struct psensor **sensors);
 141
 142 double get_min_rpm(struct psensor **sensors);
 143 double get_max_rpm(struct psensor **sensors);
 144
 145 /*
 146   Get the maximal current value of all sensors of a given type.
 147 */
 148 double
 149 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
 150
 151 /*
 152   Converts the value of a sensor to a string.
 153
 154   parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
 155   or SENSOR_TYPE_LMSENSOR_FAN
 156 */
 157 char *psensor_value_to_str(unsigned int type,
 158                            double value,
 159                            int use_celcius);
 160
 161 char *psensor_measure_to_str(const struct measure *m,
 162                              unsigned int type,
 163                              unsigned int use_celcius);
 164
 165 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
 166
 167 struct psensor **psensor_list_add(struct psensor **sensors,
 168                                   struct psensor *sensor);
 169
 170 void psensor_set_current_value(struct psensor *sensor, double value);
 171 void psensor_set_current_measure(struct psensor *sensor, double value,
 172                                  struct timeval tv);
 173
 174 double psensor_get_current_value(struct psensor *sensor);
 175
 176 struct measure *psensor_get_current_measure(struct psensor *sensor);
 177
 178 /*
 179   Returns a string representation of a psensor type.
 180 */
 181 const char *psensor_type_to_str(unsigned int type);
 182
 183 const char *psensor_type_to_unit_str(unsigned int type, int use_celcius);
 184
 185 void psensor_list_update_measures(struct psensor **sensors);
 186
 187 void psensor_init();
 188
 189 void psensor_cleanup();
 190
 191 double get_max_value(struct psensor **sensors, int type);
 192
 193 double celcius_to_fahrenheit(double c);
 194 double fahrenheit_to_celcius(double c);
 195
 196
 197 void psensor_log_measures(struct psensor **sensors);
 198
 199 #endif