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-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minimizing of the configuration sample (#1042)

Browse Source
This commit is contained in:
Fabian Affolter 2016-10-02 17:14:42 +02:00 committed by GitHub
parent c72ec348e4
commit dc07843704
10 changed files with 84 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
source/_components/sensor.bom.markdown
View File

@ -26,7 +26,6 @@ To add the BOM weather observation to your installation, add the following to yo
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
- platform: bom - platform: bom
name: "optional name"
zone_id: IDS60801 zone_id: IDS60801
wmo_id: 94675 wmo_id: 94675
monitored_conditions: monitored_conditions:

56
source/_components/sensor.forecast.markdown
View File

@ -26,34 +26,34 @@ To add Forecast.io to your installation, add the following to your `configuratio
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: forecast - platform: forecast
api_key: YOUR_APP_KEY api_key: YOUR_APP_KEY
monitored_conditions: monitored_conditions:
- summary - summary
- icon - icon
- nearest_storm_distance - nearest_storm_distance
- nearest_storm_bearing - nearest_storm_bearing
- precip_type - precip_type
- precip_intensity - precip_intensity
- precip_probability - precip_probability
- temperature - temperature
- apparent_temperature - apparent_temperature
- dew_point - dew_point
- wind_speed - wind_speed
- wind_bearing - wind_bearing
- cloud_cover - cloud_cover
- humidity - humidity
- pressure - pressure
- visibility - visibility
- ozone - ozone
- minutely_summary - minutely_summary
- hourly_summary - hourly_summary
- daily_summary - daily_summary
- temperature_max - temperature_max
- temperature_min - temperature_min
- apparent_temperature_max - apparent_temperature_max
- apparent_temperature_min - apparent_temperature_min
- precip_intensity_max - precip_intensity_max
``` ```
Configuration variables: Configuration variables:

14
source/_components/sensor.nest_weather.markdown
View File

@ -23,13 +23,13 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml ```yaml
sensor: sensor:
platform: nest - platform: nest
monitored_conditions: monitored_conditions:
- 'weather_temperature' - 'weather_temperature'
- 'weather_humidity' - 'weather_humidity'
- 'weather_condition' - 'weather_condition'
- 'wind_speed' - 'wind_speed'
- 'wind_direction' - 'wind_direction'
``` ```
Configuration variables: Configuration variables:

26
source/_components/sensor.netatmo.markdown
View File

@ -14,8 +14,6 @@ ha_category: Weather
The `netatmo` sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) device. The `netatmo` sensor platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) device.
To enable the Netatmo sensor, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`: To enable the Netatmo sensor, you first have to set up [netatmo](/components/netatmo/), and add the following lines to your `configuration.yaml`:
```yaml ```yaml
@ -26,37 +24,15 @@ sensor:
modules: modules:
module_name1: module_name1:
- temperature - temperature
- humidity
- noise
- pressure
- co2
- rain
- sum_rain_1
- sum_rain_24
- wifi_status
module_name2: module_name2:
- temperature - temperature
- battery_vp - battery_vp
- min_temp
- max_temp
rainmeter_name3:
- rain
- sum_rain_1
- sum_rain_24
- battery_vp
- rf_status
windmodule_name4:
- WindAngle
- WindStrength
- GustAngle
- GustStrength
- rf_status
``` ```
Configuration variables: Configuration variables:
- **station** (*Optional*): The name of the weather station. Needed if several stations are associated with the account. - **station** (*Optional*): The name of the weather station. Needed if several stations are associated with the account.
- **modules** (*Required*): Modules to use. Multiple entries allowed. - **modules** (*Required*): Modules to use. Multiple entries allowed. Please checkthe next section about how to retrieve the module names.
- **module_name** array (*Required*): Name of the module. - **module_name** array (*Required*): Name of the module.
- **temperature**: Current temperature. - **temperature**: Current temperature.
- **co2**: CO2 concentration in ppm. - **co2**: CO2 concentration in ppm.

23
source/_components/sensor.openweathermap.markdown
View File

@ -22,18 +22,17 @@ To add OpenWeatherMap to your installation, add the following to your `configura
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: openweathermap - platform: openweathermap
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
forecast: 0 or 1 monitored_conditions:
monitored_conditions: - weather
- weather - temperature
- temperature - wind_speed
- wind_speed - humidity
- humidity - pressure
- pressure - clouds
- clouds - rain
- rain - snow
- snow
``` ```
Configuration variables: Configuration variables:

1
source/_components/sensor.swiss_hydrological_data.markdown
View File

@ -23,7 +23,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: swiss_hydrological_data platform: swiss_hydrological_data
name: Aare
station: STATION_ID station: STATION_ID
``` ```

7
source/_components/sensor.wunderground.markdown
View File

@ -25,9 +25,8 @@ To add Wunderground to your installation, add the following to your `configurati
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: wunderground - platform: wunderground
api_key: your_api_key api_key: your_api_key
pws_id: enter_pws_id
monitored_conditions: monitored_conditions:
- weather - weather
- temp_f - temp_f
@ -60,8 +59,8 @@ sensor:
``` ```
Configuration variables: Configuration variables:
- **api_key** (Required): See above - **api_key** (Required): See above.
- **pws_id** (Optional): You can enter a Personal Weather Station id. The current list of Wunderground PWS stations is available [here](https://www.wunderground.com/weatherstation/ListStations.asp). If you do not enter a PWS ID, the current location information (latitude and longitude) from your `configuration.yaml` will be used to display weather conditions. - **pws_id** (Optional): You can enter a Personal Weather Station ID. The current list of Wunderground PWS stations is available [here](https://www.wunderground.com/weatherstation/ListStations.asp). If you do not enter a PWS ID, the current location information (latitude and longitude) from your `configuration.yaml` will be used to display weather conditions.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored. - **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
- **weather**: A human-readable text summary with picture from Wunderground. - **weather**: A human-readable text summary with picture from Wunderground.
- **temp_f**: Current temperature in Fahrenheit - **temp_f**: Current temperature in Fahrenheit

50
source/_components/sensor.yr.markdown
View File

@ -19,34 +19,9 @@ weather forecast is delivered by the Norwegian Meteorological Institute and the
To add YR to your installation, add the following to your `configuration.yaml` file: To add YR to your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Will show a symbol for the current weather as default: # Example configuration.yaml entry
sensor: sensor:
platform: yr - platform: yr
# Will show temperatue and wind direction:
sensor:
platform: yr
monitored_conditions:
- temperature
- windDirection
# Will show all available sensors:
sensor:
platform: yr
monitored_conditions:
- temperature
- symbol
- precipitation
- windSpeed
- pressure
- windDirection
- humidity
- fog
- cloudiness
- lowClouds
- mediumClouds
- highClouds
- dewpointTemperature
``` ```
Configuration variables: Configuration variables:
@ -66,3 +41,24 @@ Configuration variables:
- **mediumClouds**: Medium cloud level. - **mediumClouds**: Medium cloud level.
- **highClouds**: High cloud level. - **highClouds**: High cloud level.
A full configuration example can be found below:
```yaml
# Example configuration.yaml entry
sensor:
- platform: yr
monitored_conditions:
- temperature
- symbol
- precipitation
- windSpeed
- pressure
- windDirection
- humidity
- fog
- cloudiness
- lowClouds
- mediumClouds
- highClouds
- dewpointTemperature
```

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

@ -26,30 +26,17 @@ To add Yahoo Weather to your installation, add the following to your `configurat
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:
platform: yweather - platform: yweather
woeid: YOUR_WOEID monitored_conditions:
forecast: 0 until 5 - weather
monitored_conditions: - weather_current
- weather - temp_min
- weather_current - temp_max
- temp_min - wind_speed
- temp_max - pressure
- wind_speed - visibility
- pressure - humidity
- visibility - temperature
- humidity
- temperature
# Example configuration.yaml entry with forecast
sensor:
platform: yweather
woeid: YOUR_WOEID
forecast: 3
name: OPTIONAL_NAME
monitored_conditions:
- weather
- temp_min
- temp_max
``` ```
Configuration variables: Configuration variables:

5
source/_components/sun.markdown
View File

@ -17,12 +17,7 @@ The sun component will use your current location to track if the sun is above or
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
homeassistant:
latitude: 32.87336
longitude: -117.22743
sun: sun:
elevation: 102
``` ```
Configuration variables: Configuration variables: