From 7d4ac74a78659242bbed226d9502afb2b3ea1ba7 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Orsini Date: Sat, 23 Jul 2011 00:19:16 +0000 Subject: [PATCH] updated manpages, added information about ATI/AMD monitoring and description of the JSON web service --- src/description.txt | 5 +++++ src/server/description.txt | 36 +++++++++++++++++++++++++++++++++--- 2 files changed, 38 insertions(+), 3 deletions(-) diff --git a/src/description.txt b/src/description.txt index 27d3db9..5e60040 100644 --- a/src/description.txt +++ b/src/description.txt @@ -10,6 +10,7 @@ temperature alert is raised. It can monitor: * the temperature of the motherboard and CPU sensors (using lm\-sensors). * the temperature of the NVidia GPUs (using XNVCtrl). + * the temperature and fan rotation speed of the ATI GPUs. * the temperature of the Hard Disk Drives (using hddtemp). * the rotation speed of the fans (using lm\-sensors). * the sensors of a remote computer (using psensor\-server). @@ -27,6 +28,10 @@ For remote monitoring: * start psensor\-server(1) on the remote computer * run psensor with '\-\-url' option: 'psensor \-\-url=http://localhost:3131' +ATI/AMD GPUs monitoring is available if the library libatiadlxx is +present in the directory /usr/lib and psensor has been compiled with +the ATI ADL SDK. + [SEE ALSO] psensor\-server(1), sensors(1), sensors\-detect(8), hddtemp(8) diff --git a/src/server/description.txt b/src/server/description.txt index 309bfed..11e65fb 100644 --- a/src/server/description.txt +++ b/src/server/description.txt @@ -10,13 +10,43 @@ It can provide information about: * the temperature of the Hard Disk Drives (using hddtemp). * the rotation speed of the fans (using lm\-sensors). -The entry point of the JSON Web service is: -http://hostname:3131/api/1.0/sensors. - It is also possible to connect to the psensor\-server with a browser, a simple Web page is displaying the sensors information and the CPU usage. +The URL http://hostname:3131/api/1.0/sensors/[id] returns a JSON +object containing all information about a sensor. [id] is the uniq +identifier of the sensor. + +Here is an example of the JSON object of type 'sensor': + +{ "id": "lmsensor acpitz\-virtual\-0 temp1", + "name": "temp1", + "type": 257, + "min": 47.800000, + "max": 60.800000, + "measures": [ { "value": 47.800000, "time": 1311374873 }, + { "value": 49.800000, "time": 1311374878 }, + { "value": 49.800000, "time": 1311374883 } ], + "last_measure": { "value": 49.800000, "time": 1311374883 } +} + +Fields of the type 'sensor': + + * id: the uniq identifier of the sensor. + * name: a humean readable name of the sensor (might not be uniq). + * type: the type of sensor. Look at src/lib/psensor.h for the + different types. + * min: the minimal value of the sensor. + * max: the maximal value of the sensor. + * measures: all measures of the sensor. + * last_measure: the last value of the sensor. + * time: the time of a measure as the number of seconds since + 1970/01/01. + +The URL http://hostname:3131/api/1.0/sensors returns a JSON array +containing all JSON objects of type 'sensor'. + If run in debug mode, psensor\-server can be stopped by sending an HTTP request with the URL 'http://hostname:port/api/1.0/server/stop'. -- 2.7.4