diff --git a/source/components/sensor.glances.markdown b/source/components/sensor.glances.markdown new file mode 100644 index 00000000000..bc00344fa87 --- /dev/null +++ b/source/components/sensor.glances.markdown @@ -0,0 +1,83 @@ +--- +layout: page +title: "Glances sensor support" +description: "Instructions how to integrate Glances sensors into Home Assistant." +date: 2015-09-14 19:10 +sidebar: false +comments: false +sharing: true +footer: true +--- + + +The glances sensor platform is consuming the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant. + +This sensors needs a running isntance of `glances` on the host: + +```bash +glances -w +Glances web server started on http://0.0.0.0:61208/ +``` + +To enable the glances sensor, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + platform: glances + name: Glances sensor + host: IP_ADDRESS + port: 61208 + resources: + - 'disk_use_percent' + - 'disk_use' + - 'disk_free' + - 'memory_use_percent' + - 'memory_use' + - 'memory_free' + - 'swap_use_percent' + - 'swap_use' + - 'swap_free' + - 'processor_load' + - 'process_running' + - 'process_total' + - 'process_thread' + - 'process_sleeping' +``` + +Configuration variables: + +- **host** (*Required*): The IP address of your host, eg. 192.168.1.32. +- **port** (*Option*): The network port to connect to. Default is 61208. +- **name** (*Optional*): Name of the Glances sensor. +- **resources** (*Required*): Entries to monitor. + - **'disk_use_percent'**: Used disk space in percent + - **'disk_use'**: Used disk space + - **'disk_free'**: Free disk space + - **'memory_use_percent'**: Used memory in percent + - **'memory_use'**: Used memory + - **'memory_free'**: Free memory + - **'swap_use_percent'**: Used swap space in percent + - **'swap_use'**: Used swap space + - **'swap_free'**: Free swap space + - **'processor_load'**: Load + - **'process_running'**: Number of running processes + - **'process_total'**: Total number of processes + - **'process_thread'**: Number of threads + - **'process_sleeping'**: Number of sleeping processes + +

+Make sure that the URL matches exactly your endpoint or resource. +

+ +`curl` could help you with the identification of the variable you want to display in your Home Assistant frontend. The example below show the JSON response of a device that is running with [aREST](http://arest.io/). + +```bash +$ curl -X GET http://192.168.1.31/temperature/ +{"temperature": 77, "id": "sensor02", "name": "livingroom", "connected": true} +``` + +resources +*Required +Resources to monitor on the host. See the configuration example above for a +list of all available conditions to monitor.