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_
30 /* type of sensor values */
31 SENSOR_TYPE_TEMP = 0x00001,
32 SENSOR_TYPE_RPM = 0x00002,
33 SENSOR_TYPE_PERCENT = 0x00004,
35 /* Whether the sensor is remote */
36 SENSOR_TYPE_REMOTE = 0x00008,
38 /* Libraries used for retrieving sensor information */
39 SENSOR_TYPE_LMSENSOR = 0x00100,
40 SENSOR_TYPE_NVCTRL = 0x00200,
41 SENSOR_TYPE_GTOP = 0x00400,
42 SENSOR_TYPE_ATIADL = 0x00800,
43 SENSOR_TYPE_ATASMART = 0x01000,
44 SENSOR_TYPE_HDDTEMP = 0x02000,
45 SENSOR_TYPE_UDISKS2 = 0x800000,
47 /* Type of HW component */
48 SENSOR_TYPE_HDD = 0x04000,
49 SENSOR_TYPE_CPU = 0x08000,
50 SENSOR_TYPE_GPU = 0x10000,
51 SENSOR_TYPE_FAN = 0x20000,
53 SENSOR_TYPE_GRAPHICS = 0x40000,
54 SENSOR_TYPE_VIDEO = 0x80000,
55 SENSOR_TYPE_PCIE = 0x100000,
56 SENSOR_TYPE_MEMORY = 0x200000,
57 SENSOR_TYPE_AMBIENT = 0x400000,
60 SENSOR_TYPE_HDD_TEMP = (SENSOR_TYPE_HDD | SENSOR_TYPE_TEMP),
61 SENSOR_TYPE_CPU_USAGE = (SENSOR_TYPE_CPU | SENSOR_TYPE_PERCENT)
65 /* Human readable name of the sensor. It may not be uniq. */
68 /* Uniq id of the sensor */
71 /* Name of the chip. */
74 /* Maximum length of 'values' */
75 int values_max_length;
77 /* Last registered measures of the sensor. Index 0 for the
79 struct measure *measures;
81 /* Color of the sensor used for the graph */
84 /* Whether the graph sensor is displayed. */
87 /* see psensor_type */
90 /* The maximum detected value of the sensor */
93 /* The minimum detected value of the sensor */
96 /* Whether alarm alert is enabled for this sensor */
99 int alarm_high_threshold;
100 int alarm_low_threshold;
102 /* Whether an alarm is raised for this sensor */
103 unsigned int alarm_raised;
105 void (*cb_alarm_raised)(struct psensor *, void *);
106 void *cb_alarm_raised_data;
108 #ifdef HAVE_LIBATIADL
109 /* AMD id for the aticonfig */
114 void (*provider_data_free_fct)(void *);
118 bool appindicator_enabled;
121 struct psensor *psensor_create(char *id,
125 int values_max_length);
127 void psensor_values_resize(struct psensor *s, int new_size);
129 void psensor_free(struct psensor *sensor);
131 void psensor_list_free(struct psensor **sensors);
132 int psensor_list_size(struct psensor **sensors);
134 struct psensor **psensor_list_filter_graph_enabled(struct psensor **);
136 struct psensor *psensor_list_get_by_id(struct psensor **sensors,
139 int is_temp_type(unsigned int type);
141 double get_min_temp(struct psensor **sensors);
142 double get_max_temp(struct psensor **sensors);
144 double get_min_rpm(struct psensor **sensors);
145 double get_max_rpm(struct psensor **sensors);
147 /* Get the maximal current value of all sensors of a given type. */
149 psensor_get_max_current_value(struct psensor **sensors, unsigned int type);
152 * Converts the value of a sensor to a string.
154 * parameter 'type' is SENSOR_TYPE_LMSENSOR_TEMP, SENSOR_TYPE_NVIDIA,
155 * or SENSOR_TYPE_LMSENSOR_FAN
157 char *psensor_value_to_str(unsigned int type,
161 char *psensor_measure_to_str(const struct measure *m,
163 unsigned int use_celsius);
165 struct psensor **get_all_sensors(int use_libatasmart, int values_max_length);
167 struct psensor **psensor_list_add(struct psensor **sensors,
168 struct psensor *sensor);
170 void psensor_list_append(struct psensor ***sensors, struct psensor *sensor);
172 struct psensor **psensor_list_copy(struct psensor **);
174 void psensor_set_current_value(struct psensor *sensor, double value);
175 void psensor_set_current_measure(struct psensor *sensor, double value,
178 double psensor_get_current_value(const struct psensor *);
180 struct measure *psensor_get_current_measure(struct psensor *sensor);
182 /* Returns a string representation of a psensor type. */
183 const char *psensor_type_to_str(unsigned int type);
185 const char *psensor_type_to_unit_str(unsigned int type, int use_celsius);
187 double get_max_value(struct psensor **sensors, int type);
189 char *psensor_current_value_to_str(const struct psensor *, unsigned int);
191 void psensor_log_measures(struct psensor **sensors);