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_USAGE = 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,
58 SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
59 SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_USAGE)
63 /* Human readable name of the sensor. It may not be uniq. */
66 /* Uniq id of the sensor */
69 /* Name of the chip. */
73 const sensors_chip_name *iname;
74 const sensors_feature *feature;
76 /* Maximum length of 'values' */
77 int values_max_length;
79 /* Last registered measures of the sensor. Index 0 for the
81 struct measure *measures;
83 /* Color of the sensor used for the graph */
86 /* Whether the graph sensor is displayed. */
89 /* see psensor_type */
92 /* The maximum detected value of the sensor */
95 /* The minimum detected value of the sensor */
98 /* Whether alarm alert is enabled for this sensor */
101 int alarm_high_threshold;
102 int alarm_low_threshold;
104 /* Whether an alarm is raised for this sensor */
105 unsigned int alarm_raised;
107 void (*cb_alarm_raised) (struct psensor *, void *);
108 void *cb_alarm_raised_data;
111 /* Nvidia id for the nvctrl */
114 #ifdef HAVE_LIBATIADL
115 /* AMD id for the aticonfig */
123 bool appindicator_enabled;
126 struct psensor *psensor_create(char *id,
130 int values_max_length);
132 void psensor_values_resize(struct psensor *s, int new_size);
134 void psensor_free(struct psensor *sensor);
136 void psensor_list_free(struct psensor **sensors);
137 int psensor_list_size(struct psensor **sensors);
139 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
141 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
145 Return 1 if there is at least one sensor of a given type, else
147 int psensor_list_contains_type(struct psensor **sensors, unsigned int type);
149 int is_temp_type(unsigned int type);
150 int is_fan_type(unsigned int type);
152 double get_min_temp(struct psensor **sensors);
153 double get_max_temp(struct psensor **sensors);
155 double get_min_rpm(struct psensor **sensors);
156 double get_max_rpm(struct psensor **sensors);
159 Get the maximal current value of all sensors of a given type.
162 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
165 Converts the value of a sensor to a string.
167 parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
168 or SENSOR_TYPE_LMSENSOR_FAN
170 char *psensor_value_to_str(unsigned int type,
174 char *psensor_measure_to_str(const struct measure *m,
176 unsigned int use_celcius);
178 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
180 struct psensor **psensor_list_add(struct psensor **sensors,
181 struct psensor *sensor);
183 struct psensor **psensor_list_copy(struct psensor **);
185 void psensor_set_current_value(struct psensor *sensor, double value);
186 void psensor_set_current_measure(struct psensor *sensor, double value,
189 double psensor_get_current_value(const struct psensor *);
191 struct measure *psensor_get_current_measure(struct psensor *sensor);
194 Returns a string representation of a psensor type.
196 const char *psensor_type_to_str(unsigned int type);
198 const char *psensor_type_to_unit_str(unsigned int type, int use_celcius);
200 void psensor_list_update_measures(struct psensor **sensors);
204 void psensor_cleanup();
206 double get_max_value(struct psensor **sensors, int type);
208 double celcius_to_fahrenheit(double c);
209 double fahrenheit_to_celcius(double c);
211 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
213 void psensor_log_measures(struct psensor **sensors);