1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.4.
2 .TH PSENSOR-SERVER "1" "March 2012" "psensor-server 0.6.2.17" "User Commands"
4 psensor-server \- Temperature and system monitoring Web server
11 psensor\-server is an HTTP server for monitoring hardware sensors remotely.
14 It provides a JSON Web service which can be used by psensor(1) to
15 monitor remotely the hardware sensors of a computer.
17 It can provide information about:
18 * the temperature of the motherboard and CPU sensors (using lm\-sensors).
19 * the temperature of the Hard Disk Drives (using hddtemp).
20 * the rotation speed of the fans (using lm\-sensors).
22 It is also possible to connect to the psensor\-server with a browser, a
23 simple Web page is displaying the sensors information and the CPU
26 The URL http://hostname:3131/api/1.0/sensors/[id] returns a JSON
27 object containing all information about a sensor. [id] is the uniq
28 identifier of the sensor.
30 Here is an example of the JSON object of type 'sensor':
32 { "id": "lmsensor acpitz\-virtual\-0 temp1",
37 "measures": [ { "value": 47.800000, "time": 1311374873 },
38 { "value": 49.800000, "time": 1311374878 },
39 { "value": 49.800000, "time": 1311374883 } ],
40 "last_measure": { "value": 49.800000, "time": 1311374883 }
43 Fields of the type 'sensor':
45 * id: the uniq identifier of the sensor.
46 * name: a humean readable name of the sensor (might not be uniq).
47 * type: the type of sensor. Look at src/lib/psensor.h for the
49 * min: the minimal value of the sensor.
50 * max: the maximal value of the sensor.
51 * measures: all measures of the sensor.
52 * last_measure: the last value of the sensor.
53 * time: the time of a measure as the number of seconds since
56 The URL http://hostname:3131/api/1.0/sensors returns a JSON array
57 containing all JSON objects of type 'sensor'.
59 If run in debug mode, psensor\-server can be stopped by sending an HTTP
60 request with the URL 'http://hostname:port/api/1.0/server/stop'.
63 \fB\-h\fR, \fB\-\-help\fR
64 display this help and exit
66 \fB\-v\fR, \fB\-\-version\fR
67 display version information and exit
72 \fB\-p\fR,\-\-port=PORT
75 \fB\-w\fR,\-\-wdir=DIR
76 directory containing webserver pages
79 psensor\-server does not provide any way to restrict the connection to
80 the HTTP server, worst, no effort has been made against malicious HTTP
81 attacks. You should make the psensor\-server port available only to a
82 network or computer you trust by using the usual network security
83 tools of the system (for example, iptables(8) ).
85 Report bugs to: jeanfi@gmail.com
87 psensor home page: <http://wpitchoune.net/psensor>
89 Copyright \(co 2010\-2012 jeanfi@gmail.com
90 License GPLv2: GNU GPL version 2 or later <http://www.gnu.org/licenses/old\-licenses/gpl\-2.0.html>
92 This is free software: you are free to change and redistribute it.
93 There is NO WARRANTY, to the extent permitted by law.
96 psensor(1), sensors(1), sensors\-detect(8)