modbus plugin: Add documentation and rename to "datagroup".

[collectd.git] / src / collectd.conf.pod

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index b63f486..f7ec2a8 100644 (file)
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1904,6 +1904,11 @@ Synopsis:
    Instance "input-2"
  </Data>
  
+ <Datagroup "device-type-1"
+   Collect  "voltage-input-1"
+   Collect  "voltage-input-2"
+ </Datagroup>
+ 
  <Host "modbus.example.com">
    Address "192.168.0.42"
    Port    "502"
@@ -1914,6 +1919,11 @@ Synopsis:
      Collect  "voltage-input-1"
      Collect  "voltage-input-2"
    </Slave>
+   
+   <Slave 2>
+     Instance "power-supply"
+     Datagroup "device-type-1"
+   </Slave>
  </Host>
 
 =over 4
@@ -1952,6 +1962,25 @@ unset, an empty string (no type instance) is used.
 
 =back
 
+=item E<lt>B<Datagroup> I<Name>E<gt> blocks
+
+Datagroup blocks define a group of B<Data>-definitions. Datagroups can be used
+to collect the same data from a number of similar devices.
+
+Within E<lt>DatagroupE<nbsp>/E<gt> blocks, the following options are allowed:
+
+=over 4
+
+=item B<Collect> I<DataName>
+
+Specifies which data to include in the datagroup. I<DataName> must be the same
+string as the I<Name> argument passed to a B<Data> block. You can specify this
+option multiple times to include more than one value in the datagroup. All
+values in the datagroup will be collected from the devices that use is. At
+least one B<Collect> option is mandatory.
+
+=back
+
 =item E<lt>B<Host> I<Name>E<gt> blocks
 
 Host blocks are used to specify to which hosts to connect and what data to read
@@ -1999,7 +2028,15 @@ By default "slave_I<ID>" is used.
 Specifies which data to retrieve from the device. I<DataName> must be the same
 string as the I<Name> argument passed to a B<Data> block. You can specify this
 option multiple times to collect more than one value from a slave. At least one
-B<Collect> option is mandatory.
+B<Collect> or B<Datagroup> option is mandatory.
+
+=item B<Datagroup> I<DatagroupName>
+
+Specifies which data to retrieve from the device. I<DatagroupName> must be the
+same string as the I<Name> argument passed to a B<Datagroup> block. All data
+specified in the Datagroup definition will be retrieved from the device. You
+can specify this option multiple or combine it with the B<Collect> option. At
+least one B<Collect> or B<Datagroup> option is mandatory.
 
 =back