~mmach/netext73/lm-sensors

« back to all changes in this revision

Viewing changes to doc/libsensors-API.txt

  • Committer: mmach
  • Date: 2020-02-05 20:28:34 UTC
  • Revision ID: netbit73@gmail.com-20200205202834-zc3sla47j9e700w5
3.6

Show diffs side-by-side

added added

removed removed

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