Skip to content

Minimizing of the configuration sample (System Monitor) #1044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2016
Merged

Minimizing of the configuration sample (System Monitor) #1044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions source/_components/sensor.cpuspeed.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ To add this platform to your installation, add the following to your `configurat
```yaml
# Example configuration.yaml entry
sensor:
platform: cpuspeed
name: CPU
- platform: cpuspeed
```

Configuration variables:
Expand Down
10 changes: 5 additions & 5 deletions source/_components/sensor.fastdotcom.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Once per hour, on the hour (default):

```yaml
sensor:
platform: fastdotcom
- platform: fastdotcom
```

More examples:
Expand All @@ -32,10 +32,10 @@ Every half hour of every day:

```yaml
sensor:
platform: fastdotcom
minute:
- 0
- 30
- platform: fastdotcom
minute:
- 0
- 30
```
Configuration variables:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/sensor.fritzbox_callmonitor.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To use the Fritz!Box call monitor in your installation, add the following to you
```yaml
# Example configuration.yaml entry
sensor:
platform: fritzbox_callmonitor
- platform: fritzbox_callmonitor
```

Configuration variables:
Expand Down
40 changes: 19 additions & 21 deletions source/_components/sensor.glances.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,31 +35,29 @@ To enable the glances sensor, add the following lines to your `configuration.yam
```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'
- platform: glances
host: IP_ADDRESS
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.
- **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
Expand Down
65 changes: 32 additions & 33 deletions source/_components/sensor.hp_ilo.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,40 +31,39 @@ To use this component in your installation, add the following to your `configura
```yaml
# Example configuration.yaml entry
sensor:
platform: hp_ilo
host: IP_ADDRESS or HOSTNAME
port: PORT
username: USERNAME
password: PASSWORD
monitored_variables:
- server_name
- server_fqdn
- server_host_data
- server_oa_info
- server_power_status
- server_power_readings
- server_power_on_time
- server_asset_tag
- server_uid_status
- server_health
- network_settings
- platform: hp_ilo
host: IP_ADDRESS or HOSTNAME
username: USERNAME
password: PASSWORD
monitored_variables:
- server_name
- server_fqdn
- server_host_data
- server_oa_info
- server_power_status
- server_power_readings
- server_power_on_time
- server_asset_tag
- server_uid_status
- server_health
- network_settings
```

Configuration variables:

- **host** (*Required*): The hostname or IP address on which the ILO can be reached
- **port** (*Optional*): The port on which the ILO can be reached, defaults to port 443
- **username** (*Required*): The username used to connect to the ILO
- **password** (*Required*): The password used to connect to the ILO
- **monitored_variables** array (*Optional*): Information to be collected from the ILO, defaults to `server_name`
- **server_name**: Get the name of the server this iLO is managing
- **server_fqdn**: Get the fqdn of the server this iLO is managing
- **server_host_data**: Get SMBIOS records that describe the host
- **server_oa_info**: Get information about the Onboard Administrator of the enclosing chassis
- **server_power_status**: Whether the server is powered on or not
- **server_power_readings**: Get current, min, max and average power readings
- **server_power_on_time**: How many minutes ago has the server been powered on
- **server_asset_tag**: Gets the server asset tag
- **server_uid_status**: Get the status of the UID light
- **server_health**: Get server health information
- **network_settings**: Get the iLO network settings
- **host** (*Required*): The hostname or IP address on which the ILO can be reached.
- **port** (*Optional*): The port on which the ILO can be reached, defaults to port `443`.
- **username** (*Required*): The username used to connect to the ILO.
- **password** (*Required*): The password used to connect to the ILO.
- **monitored_variables** array (*Optional*): Information to be collected from the ILO, defaults to `server_name`.
- **server_name**: Get the name of the server this iLO is managing.
- **server_fqdn**: Get the fqdn of the server this iLO is managing.
- **server_host_data**: Get SMBIOS records that describe the host.
- **server_oa_info**: Get information about the Onboard Administrator of the enclosing chassis.
- **server_power_status**: Whether the server is powered on or not.
- **server_power_readings**: Get current, min, max and average power readings.
- **server_power_on_time**: How many minutes ago has the server been powered on.
- **server_asset_tag**: Gets the server asset tag.
- **server_uid_status**: Get the status of the UID light.
- **server_health**: Get server health information.
- **network_settings**: Get the iLO network settings.
2 changes: 0 additions & 2 deletions source/_components/sensor.linux_battery.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ To setup a battery sensor to your installation, add the following to your `confi
# Example configuration.yaml entry
sensor:
- platform: linux_battery
name: Laptop
battery: 1
```

Configuration variables:
Expand Down
3 changes: 0 additions & 3 deletions source/_components/sensor.pi_hole.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry
sensor:
- platform: pi_hole
host: 192.168.1.2
ssl: True
verify_ssl:
```

Configuration variables:
Expand Down
14 changes: 5 additions & 9 deletions source/_components/sensor.snmp.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,15 @@ To enable this sensor in your installation, add the following to your `configura
```yaml
# Example configuration.yaml entry
sensor:
platform: snmp
name: Load
host: 192.168.1.32
port: 161
community: public
baseoid: 1.3.6.1.4.1.2021.10.1.3.1
unit_of_measurement: "%"
- platform: snmp
host: 192.168.1.32
baseoid: 1.3.6.1.4.1.2021.10.1.3.1
```

Configuration variables:

- **host** (*Required*): The IP address of your host, eg. 192.168.1.32.
- **port** (*Option*): The SNMP port of your host. Defaults to 161.
- **host** (*Required*): The IP address of your host, eg. `192.168.1.32`.
- **port** (*Option*): The SNMP port of your host. Defaults to `161`.
- **name** (*Optional*): Name of the SNMP sensor.
- **community** (*Optional*): The SNMP community which is set for the device. Most devices have a default community set to to `public` with read-only permission (which is sufficient).
- **baseoid** (*Required*): The OID where the information is located. It's advised to use the numerical notation.
Expand Down
58 changes: 33 additions & 25 deletions source/_components/sensor.speedtest.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,34 +22,57 @@ To add a Speedtest.net sensor to your installation, add the following to your `c
Once per hour, on the hour (default):

```yaml
# Example configuration.yaml entry
sensor:
platform: speedtest
server_id: 1234
monitored_conditions:
- ping
- download
- upload
```

More examples:
Configuration variables:

- **monitored_conditions** array (*Required*): Sensors to display in the frontend.
- **ping**: Reaction time in ms of your connection, (how fast you get a response after you've sent out a request).
- **download**: Download speed in Mbps.
- **upload**: Upload speed in Mbps.
- **server_id** (*Optional*): Specify the speedtest server to perform test against.
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.

This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.

When Home Assistant first starts up, the values of the speedtest will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speedtest and populate the data or just wait for the next regularly scheduled test.

## {% linkable_title Examples %}

In this section you find some real life examples of how to use this sensor.

### {% linkable_title Run periodically %}

Every half hour of every day:

```yaml
# Example configuration.yaml entry
sensor:
platform: speedtest
minute:
- 0
- 30
monitored_conditions:
- ping
- download
- upload
- platform: speedtest
minute:
- 0
- 30
monitored_conditions:
- ping
- download
- upload
```

### {% linkable_title Run at a specific time %}

Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:

```yaml
# Example configuration.yaml entry
sensor:
platform: speedtest
minute: 30
Expand All @@ -63,18 +86,3 @@ sensor:
- download
- upload
```

Configuration variables:

- **monitored_conditions** array (*Required*): Sensors to display in the frontend.
- **ping**: Reaction time in ms of your connection, (how fast you get a response after you've sent out a request).
- **download**: Download speed in Mbps.
- **upload**: Upload speed in Mbps.
- **server_id** (*Optional*): Specify the speedtest server to perform test against.
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.

This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.

When Home Assistant first starts up, the values of the speedtest will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speedtest and populate the data or just wait for the next regularly scheduled test.
3 changes: 1 addition & 2 deletions source/_components/sensor.supervisord.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ To use this sensor in your installation, add the following to your `configuratio
```yaml
# Example configuration.yaml entry
sensor:
platform: supervisord
url: http://192.168.1.1:9001/RPC2
- platform: supervisord
```

Configuration variables:
Expand Down