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>
35 /* type of sensor values */
36 SENSOR_TYPE_TEMP = 0x00001,
37 SENSOR_TYPE_RPM = 0x00002,
38 SENSOR_TYPE_PERCENT = 0x00004,
40 /* Whether the sensor is remote */
41 SENSOR_TYPE_REMOTE = 0x00008,
43 /* Libraries used for retrieving sensor information */
44 SENSOR_TYPE_LMSENSOR = 0x00100,
45 SENSOR_TYPE_NVCTRL = 0x00200,
46 SENSOR_TYPE_GTOP = 0x00400,
47 SENSOR_TYPE_ATIADL = 0x00800,
48 SENSOR_TYPE_ATASMART = 0x01000,
49 SENSOR_TYPE_HDDTEMP = 0x02000,
51 /* Type of HW component */
52 SENSOR_TYPE_HDD = 0x04000,
53 SENSOR_TYPE_CPU = 0x08000,
54 SENSOR_TYPE_GPU = 0x10000,
55 SENSOR_TYPE_FAN = 0x20000,
57 SENSOR_TYPE_GRAPHICS = 0x40000,
58 SENSOR_TYPE_VIDEO = 0x80000,
59 SENSOR_TYPE_PCIE = 0x100000,
60 SENSOR_TYPE_MEMORY = 0x200000,
61 SENSOR_TYPE_AMBIENT = 0x400000,
64 SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
65 SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
69 /* Human readable name of the sensor. It may not be uniq. */
72 /* Uniq id of the sensor */
75 /* Name of the chip. */
79 const sensors_chip_name *iname;
81 const sensors_feature *feature;
83 /* Maximum length of 'values' */
84 int values_max_length;
86 /* Last registered measures of the sensor. Index 0 for the
88 struct measure *measures;
90 /* Color of the sensor used for the graph */
93 /* Whether the graph sensor is displayed. */
96 /* see psensor_type */
99 /* The maximum detected value of the sensor */
102 /* The minimum detected value of the sensor */
105 /* Whether alarm alert is enabled for this sensor */
108 int alarm_high_threshold;
109 int alarm_low_threshold;
111 /* Whether an alarm is raised for this sensor */
112 unsigned int alarm_raised;
114 void (*cb_alarm_raised)(struct psensor *, void *);
115 void *cb_alarm_raised_data;
118 /* Nvidia id for the nvctrl */
121 #ifdef HAVE_LIBATIADL
122 /* AMD id for the aticonfig */
130 bool appindicator_enabled;
133 struct psensor *psensor_create(char *id,
137 int values_max_length);
139 void psensor_values_resize(struct psensor *s, int new_size);
141 void psensor_free(struct psensor *sensor);
143 void psensor_list_free(struct psensor **sensors);
144 int psensor_list_size(struct psensor **sensors);
146 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
148 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
152 Return 1 if there is at least one sensor of a given type, else
154 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
156 int is_temp_type(unsigned int type);
158 double get_min_temp(struct psensor **sensors);
159 double get_max_temp(struct psensor **sensors);
161 double get_min_rpm(struct psensor **sensors);
162 double get_max_rpm(struct psensor **sensors);
165 Get the maximal current value of all sensors of a given type.
168 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
171 Converts the value of a sensor to a string.
173 parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
174 or SENSOR_TYPE_LMSENSOR_FAN
176 char *psensor_value_to_str(unsigned int type,
180 char *psensor_measure_to_str(const struct measure *m,
182 unsigned int use_celsius);
184 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
186 struct psensor **psensor_list_add(struct psensor **sensors,
187 struct psensor *sensor);
189 void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
191 struct psensor **psensor_list_copy(struct psensor **);
193 void psensor_set_current_value(struct psensor *sensor, double value);
194 void psensor_set_current_measure(struct psensor *sensor, double value,
197 double psensor_get_current_value(const struct psensor *);
199 struct measure *psensor_get_current_measure(struct psensor *sensor);
202 Returns a string representation of a psensor type.
204 const char *psensor_type_to_str(unsigned int type);
206 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
208 void psensor_list_update_measures(struct psensor **sensors);
212 void psensor_cleanup();
214 double get_max_value(struct psensor **sensors, int type);
216 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
218 void psensor_log_measures(struct psensor **sensors);