jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minimizing of the configuration sample (#1044)

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-02 17:14:29 +02:00 committed by GitHub
parent a2776110aa
commit c840d6bb72
10 changed files with 106 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
source/_components/sensor.cpuspeed.markdown
View File

@ -20,8 +20,7 @@ To add this platform to your installation, add the following to your `configurat
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: cpuspeed - platform: cpuspeed
name: CPU
``` ```
Configuration variables: Configuration variables:

4
source/_components/sensor.fastdotcom.markdown
View File

@ -23,7 +23,7 @@ Once per hour, on the hour (default):
```yaml ```yaml
sensor: sensor:
platform: fastdotcom - platform: fastdotcom
``` ```
More examples: More examples:
@ -32,7 +32,7 @@ Every half hour of every day:
```yaml ```yaml
sensor: sensor:
platform: fastdotcom - platform: fastdotcom
minute: minute:
- 0 - 0
- 30 - 30

2
source/_components/sensor.fritzbox_callmonitor.markdown
View File

@ -24,7 +24,7 @@ To use the Fritz!Box call monitor in your installation, add the following to you
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: fritzbox_callmonitor - platform: fritzbox_callmonitor
``` ```
Configuration variables: Configuration variables:

8
source/_components/sensor.glances.markdown
View File

@ -35,10 +35,8 @@ To enable the glances sensor, add the following lines to your `configuration.yam
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: glances - platform: glances
name: Glances sensor
host: IP_ADDRESS host: IP_ADDRESS
port: 61208
resources: resources:
- 'disk_use_percent' - 'disk_use_percent'
- 'disk_use' - 'disk_use'
@ -58,8 +56,8 @@ sensor:
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your host, eg. 192.168.1.32. - **host** (*Required*): The IP address of your host, eg. `192.168.1.32`.
- **port** (*Option*): The network port to connect to. Default is 61208. - **port** (*Option*): The network port to connect to. Default is `61208`.
- **name** (*Optional*): Name of the Glances sensor. - **name** (*Optional*): Name of the Glances sensor.
- **resources** (*Required*): Entries to monitor. - **resources** (*Required*): Entries to monitor.
- **disk_use_percent**: Used disk space in percent - **disk_use_percent**: Used disk space in percent

35
source/_components/sensor.hp_ilo.markdown
View File

@ -31,9 +31,8 @@ To use this component in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: hp_ilo - platform: hp_ilo
host: IP_ADDRESS or HOSTNAME host: IP_ADDRESS or HOSTNAME
port: PORT
username: USERNAME username: USERNAME
password: PASSWORD password: PASSWORD
monitored_variables: monitored_variables:
@ -52,19 +51,19 @@ sensor:
Configuration variables: Configuration variables:
- **host** (*Required*): The hostname or IP address on which the ILO can be reached - **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 - **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 - **username** (*Required*): The username used to connect to the ILO.
- **password** (*Required*): The password 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` - **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_name**: Get the name of the server this iLO is managing.
- **server_fqdn**: Get the fqdn 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_host_data**: Get SMBIOS records that describe the host.
- **server_oa_info**: Get information about the Onboard Administrator of the enclosing chassis - **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_status**: Whether the server is powered on or not.
- **server_power_readings**: Get current, min, max and average power readings - **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_power_on_time**: How many minutes ago has the server been powered on.
- **server_asset_tag**: Gets the server asset tag - **server_asset_tag**: Gets the server asset tag.
- **server_uid_status**: Get the status of the UID light - **server_uid_status**: Get the status of the UID light.
- **server_health**: Get server health information - **server_health**: Get server health information.
- **network_settings**: Get the iLO network settings - **network_settings**: Get the iLO network settings.

2
source/_components/sensor.linux_battery.markdown
View File

@ -20,8 +20,6 @@ To setup a battery sensor to your installation, add the following to your `confi
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: linux_battery - platform: linux_battery
name: Laptop
battery: 1
``` ```
Configuration variables: Configuration variables:

3
source/_components/sensor.pi_hole.markdown
View File

@ -22,9 +22,6 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: pi_hole - platform: pi_hole
host: 192.168.1.2
ssl: True
verify_ssl:
``` ```
Configuration variables: Configuration variables:

10
source/_components/sensor.snmp.markdown
View File

@ -21,19 +21,15 @@ To enable this sensor in your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: snmp - platform: snmp
name: Load
host: 192.168.1.32 host: 192.168.1.32
port: 161
community: public
baseoid: 1.3.6.1.4.1.2021.10.1.3.1 baseoid: 1.3.6.1.4.1.2021.10.1.3.1
unit_of_measurement: "%"
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your host, eg. 192.168.1.32. - **host** (*Required*): The IP address of your host, eg. `192.168.1.32`.
- **port** (*Option*): The SNMP port of your host. Defaults to 161. - **port** (*Option*): The SNMP port of your host. Defaults to `161`.
- **name** (*Optional*): Name of the SNMP sensor. - **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). - **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. - **baseoid** (*Required*): The OID where the information is located. It's advised to use the numerical notation.

76
source/_components/sensor.speedtest.markdown
View File

@ -22,42 +22,9 @@ To add a Speedtest.net sensor to your installation, add the following to your `c
Once per hour, on the hour (default): Once per hour, on the hour (default):
```yaml ```yaml
# Example configuration.yaml entry
sensor: sensor:
platform: speedtest platform: speedtest
server_id: 1234
monitored_conditions:
- ping
- download
- upload
```
More examples:
Every half hour of every day:
```yaml
sensor:
platform: speedtest
minute:
- 0
- 30
monitored_conditions:
- ping
- download
- upload
```
Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:
```yaml
sensor:
platform: speedtest
minute: 30
hour:
- 0
- 6
- 12
- 18
monitored_conditions: monitored_conditions:
- ping - ping
- download - download
@ -78,3 +45,44 @@ Configuration variables:
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. 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. 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
```
### {% 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
hour:
- 0
- 6
- 12
- 18
monitored_conditions:
- ping
- download
- upload
```

3
source/_components/sensor.supervisord.markdown
View File

@ -18,8 +18,7 @@ To use this sensor in your installation, add the following to your `configuratio
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: supervisord - platform: supervisord
url: http://192.168.1.1:9001/RPC2
``` ```
Configuration variables: Configuration variables: