Merge remote-tracking branch 'origin/pr/693'

Conflicts:
	src/collectd.conf.pod

diff --cc README
index 9fb900435eeb938180ac7ac90ea71db1d3da2d35,de8a09a6e8c94e28d650273b73e114523881ace5..04ea788d45b955af1779d42624b81bfd0cd93a95
--- 1/README
--- 2/README
+++ b/README
@@@ -33,9 -33,8 +33,9 @@@ Feature
        Statistics about Ascent, a free server for the game `World of Warcraft'.
  
      - barometer
-       Using digital barometer sensor MPL115A2 or MPL3115 from Freescale
-       provides absolute barometric pressure, air pressure reduced to sea level
-       and temperature.
 -      Reads absolute barometric pressure, air pressure reduced to sea level and temperature.
 -      Supported sensors are MPL115A2 and MPL3115 from Freescale and BMP085 from Bosch.
++      Reads absolute barometric pressure, air pressure reduced to sea level and
++      temperature.  Supported sensors are MPL115A2 and MPL3115 from Freescale
++      and BMP085 from Bosch.
  
      - battery
        Batterycharge, -current and voltage of ACPI and PMU based laptop

diff --cc src/collectd.conf.pod
index bd7810748e1111b6a13456c0eb5e3ee0fb19b347,08dfb6d72ebce4facc3792c17cbc6a6814f97fad..b0ed0ed5b2f052f7e22b371e76bcaff056c591ac
--- 1/src/collectd.conf.pod
--- 2/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@@ -885,11 -846,11 +899,11 @@@ It was developed and tested under Linu
  the standard Linux i2c-dev interface (the particular bus driver has to
  support the SM Bus command subset).
  
- The reduction or normalization to mean sea level pressure requires (depedning on
 -The reduction or normalization to mean sea level pressure requires (depending on
--selected method/approximation) also altitude and reference to temperature sensor(s).
--When multiple temperature sensors are configured the minumum of their values is
--always used (expecting that the warmer ones are affected by e.g. direct sun light
--at that moment).
++The reduction or normalization to mean sea level pressure requires (depending
++on selected method/approximation) also altitude and reference to temperature
++sensor(s).  When multiple temperature sensors are configured the minumum of
++their values is always used (expecting that the warmer ones are affected by
++e.g. direct sun light at that moment).
  
  Synopsis:
  
@@@ -907,8 -868,10 +921,10 @@@
  
  =item B<Device> I<device>
  
- Device name of the I2C bus to which the sensor is connected. Note that typically
- you need to have loaded the i2c-dev module.
+ The only mandatory configuration parameter.
+ 
 -Device name of the I2C bus to which the sensor is connected. Note that typically
 -you need to have loaded the i2c-dev module.
++Device name of the I2C bus to which the sensor is connected. Note that
++typically you need to have loaded the i2c-dev module.
  Using i2c-tools you can check/list i2c buses available on your system by:
  
    i2cdetect -l
@@@ -922,29 -885,41 +938,42 @@@ connected and detected on address 0x60
  
  =item B<Oversampling> I<value>
  
- For MPL115 this is the size of the averaging window. To filter out sensor noise
- a simple averaging using floating window of configurable size is used. The plugin
- will use average of the last C<value> measurements (value of 1 means no averaging).
- Minimal size is 1, maximal 1024.
+ Optional parameter controlling the oversampling/accuracy. Default value
+ is 1 providing fastest and least accurate reading.
+ 
 -For I<MPL115> this is the size of the averaging window. To filter out sensor noise
 -a simple averaging using floating window of this configurable size is used. The plugin
 -will use average of the last C<value> measurements (value of 1 means no averaging).
 -Minimal size is 1, maximal 1024.
 -
 -For I<MPL3115> this is the oversampling value. The actual oversampling is performed
 -by the sensor and the higher value the higher accuracy and longer conversion time
 -(although nothing to worry about in the collectd context). Supported values are:
 -1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
++For I<MPL115> this is the size of the averaging window. To filter out sensor
++noise a simple averaging using floating window of this configurable size is
++used. The plugin will use average of the last C<value> measurements (value of 1
++means no averaging).  Minimal size is 1, maximal 1024.
 +
- For MPL3115 this is the oversampling value. The actual oversampling is performed
- by the sensor and the higher value the higher accuracy and longer conversion time
- (although nothing to worry about in the collectd context). Supported values are:
- 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
- the closest supported one. Default is 128.
++For I<MPL3115> this is the oversampling value. The actual oversampling is
++performed by the sensor and the higher value the higher accuracy and longer
++conversion time (although nothing to worry about in the collectd context).
++Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
++adjusted by the plugin to the closest supported one.
++
++For I<BMP085> this is the oversampling value. The actual oversampling is
++performed by the sensor and the higher value the higher accuracy and longer
++conversion time (although nothing to worry about in the collectd context).
++Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
+ the closest supported one.
  
 -For I<BMP085> this is the oversampling value. The actual oversampling is performed
 -by the sensor and the higher value the higher accuracy and longer conversion time
 -(although nothing to worry about in the collectd context). Supported values are:
 -1, 2, 4, 8. Any other value is adjusted by the plugin to the closest supported one.
 -
  =item B<PressureOffset> I<offset>
  
- You can further calibrate the sensor by supplying pressure and/or temperature offsets.
- This is added to the measured/caclulated value (i.e. if the measured value is too high
- then use negative offset).
+ Optional parameter for MPL3115 only.
+ 
 -You can further calibrate the sensor by supplying pressure and/or temperature offsets.
 -This is added to the measured/caclulated value (i.e. if the measured value is too high
 -then use negative offset).
++You can further calibrate the sensor by supplying pressure and/or temperature
++offsets.  This is added to the measured/caclulated value (i.e. if the measured
++value is too high then use negative offset).
  In hPa, default is 0.0.
  
  =item B<TemperatureOffset> I<offset>
  
- You can further calibrate the sensor by supplying pressure and/or temperature offsets.
- This is added to the measured/caclulated value (i.e. if the measured value is too high
- then use negative offset).
+ Optional parameter for MPL3115 only.
+ 
 -You can further calibrate the sensor by supplying pressure and/or temperature offsets.
 -This is added to the measured/caclulated value (i.e. if the measured value is too high
 -then use negative offset).
++You can further calibrate the sensor by supplying pressure and/or temperature
++offsets.  This is added to the measured/caclulated value (i.e. if the measured
++value is too high then use negative offset).
  In C, default is 0.0.
  
  =item B<Normalization> I<method>
@@@ -960,14 -937,14 +991,16 @@@ Supported values of the C<method> (inte
         do not need to configure C<Altitude> or C<TemperatureSensor>.
  
  =item B<1> - international formula for conversion ,
- See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
 -See L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
--For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
--(uses fixed global temperature average instead).
++See
++L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
++For this method you have to configure C<Altitude> but do not need
++C<TemperatureSensor> (uses fixed global temperature average instead).
  
  =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
  Meteorological Service).
- See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
- For this method you have to configure both  C<Altitude> and C<TemperatureSensor>.
+ See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
 -For this method you have to configure both  C<Altitude> and C<TemperatureSensor>.
++For this method you have to configure both  C<Altitude> and
++C<TemperatureSensor>.
  
  =back
  
@@@ -978,49 -955,16 +1011,49 @@@ The altitude (in meters) of the locatio
  
  =item B<TemperatureSensor> I<reference>
  
- Temperature sensor which should be used as a reference when normalizing the pressure.
- When specified more sensors a minumum is found and uses each time.
 -Temperature sensor(s) which should be used as a reference when normalizing the pressure
 -using C<Normalization> method 2.
 -When specified more sensors a minumum is found and used each time.
--The temperature reading directly from this pressure sensor/plugin
--is typically not suitable as the pressure sensor
- will be probably inside while we want outside temperature.
 -will be probably inside while we want outside temperature. 
--The collectd reference name is something like
++Temperature sensor(s) which should be used as a reference when normalizing the
++pressure using C<Normalization> method 2.
++When specified more sensors a minumum is found and used each time.  The
++temperature reading directly from this pressure sensor/plugin is typically not
++suitable as the pressure sensor will be probably inside while we want outside
++temperature.  The collectd reference name is something like
  <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
--(<type_instance> is usually omitted when there is just single value type).
--Or you can figure it out from the path of the output data files.
++(<type_instance> is usually omitted when there is just single value type). Or
++you can figure it out from the path of the output data files.
 +
 +=back
 +
 +=head2 Plugin C<battery>
 +
 +The I<battery plugin> reports the remaining capacity, power and voltage of
 +laptop batteries.
 +
 +=over 4
 +
 +=item B<ValuesPercentage> B<false>|B<true>
 +
 +When enabled, remaining capacity is reported as a percentage, e.g. "42%
 +capacity remaining". Otherwise the capacity is stored as reported by the
 +battery, most likely in "Wh". This option does not work with all input methods,
 +in particular when only C</proc/pmu> is available on an old Linux system.
 +Defaults to B<false>.
 +
 +=item B<ReportDegraded> B<false>|B<true>
 +
 +Typical laptop batteries degrade over time, meaning the capacity decreases with
 +recharge cycles. The maximum charge of the previous charge cycle is tracked as
 +"last full capacity" and used to determine that a battery is "fully charged".
 +
 +When this option is set to B<false>, the default, the I<battery plugin> will
 +only report the remaining capacity. If the B<ValuesPercentage> option is
 +enabled, the relative remaining capacity is calculated as the ratio of the
 +"remaining capacity" and the "last full capacity". This is what most tools,
 +such as the status bar of desktop environments, also do.
 +
 +When set to B<true>, the battery plugin will report three values: B<charged>
 +(remaining capacity), B<discharged> (difference between "last full capacity"
 +and "remaining capacity") and B<degraded> (difference between "design capacity"
 +and "last full capacity").
  
  =back