From 186f1649312ccb9287a993d3d4c1a207edf50411 Mon Sep 17 00:00:00 2001 From: Alex Deymo Date: Tue, 13 Aug 2013 00:29:55 -0700 Subject: [PATCH] aquaero: Documentation for aquaero plugin. This patch includes the manpage, smaller config sample file and the README and AUTHORS description. --- AUTHORS | 3 +++ README | 3 +++ src/collectd.conf.in | 5 ----- src/collectd.conf.pod | 23 +++++++++++++++++++++++ 4 files changed, 29 insertions(+), 5 deletions(-) diff --git a/AUTHORS b/AUTHORS index adb74813..2e6511b6 100644 --- a/AUTHORS +++ b/AUTHORS @@ -21,6 +21,9 @@ Akkarit Sangpetch Alessandro Iurlano - Initial filecount plugin. +Alex Deymo + - aquaero plugin. + Alvaro Barcellos - Don't-fork patch. diff --git a/README b/README index 3f65963a..0b70eaa3 100644 --- a/README +++ b/README @@ -26,6 +26,9 @@ Features Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and voltage sensors. + - aquaero + Various sensors in the Aquaero 5 watercooling board made by Aquacomputer. + - ascent Statistics about Ascent, a free server for the game `World of Warcraft'. diff --git a/src/collectd.conf.in b/src/collectd.conf.in index a96f6752..040b930c 100644 --- a/src/collectd.conf.in +++ b/src/collectd.conf.in @@ -240,12 +240,7 @@ # # -# # If you specify an empty string for the device (the default) it -# # will autodetect the first Aquaero 5 installed. # Device "" -# # Optionally, you can specify the device path, make sure the Aquaero -# # device is readable by collectd. -# #Device "/dev/usb/hiddev0" # # diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 11db1ccd..32f76a4a 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -730,6 +730,29 @@ default for backwards compatibility, the time will be reported in minutes. =back +=head2 Plugin C + +This plugin collects the value of the available sensors in an Aquaero 5 board. +Aquaero 5 is a watercooling controller board, manufactured by Aqua Computer GmbH +L, with a USB2 connection for monitoring and +configuration. The board can handle multiple temperature sensors, fans, water +pumps and water level sensors and adjust the output settings such as fan voltage +or power the water pump based on the available inputs using a configurable +controller included in the board. This plugin collects all the available inputs +as well as some of the output values choosen by this controler. The plugin is +based on the libaquaero5 library provided by aquatools-ng. + +=over 4 + +=item B I + +Device path of the HID USB device, usually of the form /dev/usb/hiddevX, where +the Aquaero 5 device is. If this option is no set or is the empty string the +plugin will try to autodetect the first Aquaero 5 USB device based on the +VendorID and ProductID. + +=back + =head2 Plugin C This plugin collects information about an Ascent server, a free server for the -- 2.11.0