root/lm-sensors/trunk/doc/libsensors-API.txt

Revision 6035, 4.8 KB (checked in by khali, 2 months ago)

Prepare for release.
Line 
1libsensors API history
2======================
3
4SENSORS_API_VERSION tracks the evolutions made to the libsensors API
5over time. This document summarizes these evolutions so that application
6authors can quickly figure out how to test for the availability of a
7given new feature.
8
90x432
10* Added support for new sysfs attributes
11  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_AVERAGE
12  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_LOWEST
13  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_HIGHEST
14  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_LOWEST
15  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_HIGHEST
16  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_AVERAGE
17  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_LOWEST
18  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_HIGHEST
19  enum sensors_subfeature_type SENSORS_SUBFEATURE_FAN_MAX
20  enum sensors_subfeature_type SENSORS_SUBFEATURE_FAN_MIN_ALARM
21  enum sensors_subfeature_type SENSORS_SUBFEATURE_FAN_MAX_ALARM
220x431   lm-sensors 3.3.0 to 3.3.1
23* Added support for intrusion detection
24  enum sensors_feature_type SENSORS_FEATURE_INTRUSION
25  enum sensors_subfeature_type SENSORS_SUBFEATURE_INTRUSION_ALARM
26  enum sensors_subfeature_type SENSORS_SUBFEATURE_INTRUSION_BEEP
27* Added support for various new sysfs attributes
28  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_LCRIT
29  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_CRIT
30  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_LCRIT_ALARM
31  enum sensors_subfeature_type SENSORS_SUBFEATURE_IN_CRIT_ALARM
32  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_LCRIT
33  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_EMERGENCY
34  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_EMERGENCY_HYST
35  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_LCRIT_ALARM
36  enum sensors_subfeature_type SENSORS_SUBFEATURE_TEMP_EMERGENCY_ALARM
37  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_CAP
38  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_CAP_HYST
39  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_MAX
40  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_CRIT
41  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_ALARM
42  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_CAP_ALARM
43  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_MAX_ALARM
44  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_CRIT_ALARM
45  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_LCRIT
46  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_CRIT
47  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_LCRIT_ALARM
48  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_CRIT_ALARM
49  enum sensors_subfeature_type SENSORS_SUBFEATURE_FAN_PULSES
50* Added support for humidity sensors
51  enum sensors_feature_type SENSORS_FEATURE_HUMIDITY
52  enum sensors_subfeature_type SENSORS_SUBFEATURE_HUMIDITY_INPUT
53
540x430   lm-sensors 3.2.0
55* License changed from GPL to LGPL
56
570x421   lm-sensors 3.1.2
58* Added bus type "hid":
59  #define SENSORS_BUS_TYPE_HID
60
610x420   lm-sensors 3.1.1
62* Added a method to free the memory allocated by sensors_parse_chip_name()
63  void sensors_free_chip_name(sensors_chip_name *chip);
64
650x410   lm-sensors 3.1.0
66* Added bus type "acpi":
67  #define SENSORS_BUS_TYPE_ACPI
68* Added support for instantaneous power sensors
69  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_INPUT
70  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_INPUT_HIGHEST
71  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_INPUT_LOWEST
72* Added support for current sensors
73  enum sensors_feature_type SENSORS_FEATURE_CURR
74  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_INPUT
75  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_MIN
76  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_MAX
77  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_ALARM
78  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_MIN_ALARM
79  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_MAX_ALARM
80  enum sensors_subfeature_type SENSORS_SUBFEATURE_CURR_BEEP
81* Added error value for excessive recursion depth
82  #define SENSORS_ERR_RECURSION 11
83* Added parse error reporting function including the configuration file
84  name
85  extern void (*sensors_parse_error_wfn) (const char *err,
86                                          const char *filename, int lineno);
87
880x401   lm-sensors 3.0.2 to 3.0.3
89* Added bus type "virtual":
90  #define SENSORS_BUS_TYPE_VIRTUAL
91* Added support for power and energy sensors
92  enum sensors_feature_type SENSORS_FEATURE_POWER
93  enum sensors_feature_type SENSORS_FEATURE_ENERGY
94  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_AVERAGE
95  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_AVERAGE_HIGHEST
96  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_AVERAGE_LOWEST
97  enum sensors_subfeature_type SENSORS_SUBFEATURE_POWER_AVERAGE_INTERVAL
98  enum sensors_subfeature_type SENSORS_SUBFEATURE_ENERGY_INPUT
99
1000x400   lm-sensors 3.0.0 to 3.0.1
101* Initial API.
Note: See TracBrowser for help on using the browser.