.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
.TH PSENSOR-SERVER "1" "March 2012" "psensor-server 0.6.2.17" "User Commands"
.SH NAME
psensor-server \- Temperature and system monitoring Web server
.SH SYNOPSIS
.B psensor-server
[\fIOPTION\fR]...
.SH DESCRIPTION

.PP
psensor\-server is an HTTP server for monitoring hardware sensors remotely.
.PP

It provides a JSON Web service which can be used by psensor(1) to
monitor remotely the hardware sensors of a computer.

It can provide information about:
  * the temperature of the motherboard and CPU sensors (using lm\-sensors).
  * the temperature of the Hard Disk Drives (using hddtemp).
  * the rotation speed of the fans (using lm\-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'.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
display version information and exit
.TP
\fB\-d\fR,\-\-debug
run in debug mode
.TP
\fB\-p\fR,\-\-port=PORT
webserver port
.TP
\fB\-w\fR,\-\-wdir=DIR
directory containing webserver pages
.SH WARNING

psensor\-server does not provide any way to restrict the connection to
the HTTP server, worst, no effort has been made against malicious HTTP
attacks.  You should make the psensor\-server port available only to a
network or computer you trust by using the usual network security
tools of the system (for example, iptables(8) ).
.SH "REPORTING BUGS"
Report bugs to: jeanfi@gmail.com
.PP
psensor home page: <http://wpitchoune.net/psensor>
.SH COPYRIGHT
Copyright \(co 2010\-2012 jeanfi@gmail.com
License GPLv2: GNU GPL version 2 or later <http://www.gnu.org/licenses/old\-licenses/gpl\-2.0.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"

psensor(1), sensors(1), sensors\-detect(8)