2 * Copyright (C) 2010-2014 jeanfi@gmail.com
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.
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.
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
19 #ifndef _PSENSOR_PSENSOR_H_
20 #define _PSENSOR_PSENSOR_H_
22 #include <sensors/sensors.h>
37 /* type of sensor values */
38 SENSOR_TYPE_TEMP = 0x00001,
39 SENSOR_TYPE_RPM = 0x00002,
40 SENSOR_TYPE_PERCENT = 0x00004,
42 /* Whether the sensor is remote */
43 SENSOR_TYPE_REMOTE = 0x00008,
45 /* Libraries used for retrieving sensor information */
46 SENSOR_TYPE_LMSENSOR = 0x00100,
47 SENSOR_TYPE_NVCTRL = 0x00200,
48 SENSOR_TYPE_GTOP = 0x00400,
49 SENSOR_TYPE_ATIADL = 0x00800,
50 SENSOR_TYPE_ATASMART = 0x01000,
51 SENSOR_TYPE_HDDTEMP = 0x02000,
52 SENSOR_TYPE_UDISKS2 = 0x800000,
54 /* Type of HW component */
55 SENSOR_TYPE_HDD = 0x04000,
56 SENSOR_TYPE_CPU = 0x08000,
57 SENSOR_TYPE_GPU = 0x10000,
58 SENSOR_TYPE_FAN = 0x20000,
60 SENSOR_TYPE_GRAPHICS = 0x40000,
61 SENSOR_TYPE_VIDEO = 0x80000,
62 SENSOR_TYPE_PCIE = 0x100000,
63 SENSOR_TYPE_MEMORY = 0x200000,
64 SENSOR_TYPE_AMBIENT = 0x400000,
67 SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
68 SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
72 /* Human readable name of the sensor. It may not be uniq. */
75 /* Uniq id of the sensor */
78 /* Name of the chip. */
82 const sensors_chip_name *iname;
84 const sensors_feature *feature;
86 /* Maximum length of 'values' */
87 int values_max_length;
89 /* Last registered measures of the sensor. Index 0 for the
91 struct measure *measures;
93 /* Color of the sensor used for the graph */
96 /* Whether the graph sensor is displayed. */
99 /* see psensor_type */
102 /* The maximum detected value of the sensor */
105 /* The minimum detected value of the sensor */
108 /* Whether alarm alert is enabled for this sensor */
111 int alarm_high_threshold;
112 int alarm_low_threshold;
114 /* Whether an alarm is raised for this sensor */
115 unsigned int alarm_raised;
117 void (*cb_alarm_raised)(struct psensor *, void *);
118 void *cb_alarm_raised_data;
120 #ifdef HAVE_LIBATIADL
121 /* AMD id for the aticonfig */
129 void (*provider_data_free_fct)(void *);
133 bool appindicator_enabled;
136 struct psensor *psensor_create(char *id,
140 int values_max_length);
142 void psensor_values_resize(struct psensor *s, int new_size);
144 void psensor_free(struct psensor *sensor);
146 void psensor_list_free(struct psensor **sensors);
147 int psensor_list_size(struct psensor **sensors);
149 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
151 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
154 int is_temp_type(unsigned int type);
156 double get_min_temp(struct psensor **sensors);
157 double get_max_temp(struct psensor **sensors);
159 double get_min_rpm(struct psensor **sensors);
160 double get_max_rpm(struct psensor **sensors);
162 /* Get the maximal current value of all sensors of a given type. */
164 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
167 * Converts the value of a sensor to a string.
169 * parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
170 * or SENSOR_TYPE_LMSENSOR_FAN
172 char *psensor_value_to_str(unsigned int type,
176 char *psensor_measure_to_str(const struct measure *m,
178 unsigned int use_celsius);
180 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
182 struct psensor **psensor_list_add(struct psensor **sensors,
183 struct psensor *sensor);
185 void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
187 struct psensor **psensor_list_copy(struct psensor **);
189 void psensor_set_current_value(struct psensor *sensor, double value);
190 void psensor_set_current_measure(struct psensor *sensor, double value,
193 double psensor_get_current_value(const struct psensor *);
195 struct measure *psensor_get_current_measure(struct psensor *sensor);
197 /* Returns a string representation of a psensor type. */
198 const char *psensor_type_to_str(unsigned int type);
200 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
202 double get_max_value(struct psensor **sensors, int type);
204 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
206 void psensor_log_measures(struct psensor **sensors);