Minimizing of the configuration sample (#1042)

2025-07-23 09:17:06 +00:00 · 2016-10-02 17:14:42 +02:00 · 2016-10-02 17:14:42 +02:00 · dc07843704
commit dc07843704
parent c72ec348e4
10 changed files with 84 additions and 134 deletions
--- a/source/_components/sensor.bom.markdown
+++ b/source/_components/sensor.bom.markdown
@ -26,7 +26,6 @@ To add the BOM weather observation to your installation, add the following to yo
 # Example configuration.yaml entry
 sensor:
  - platform: bom
-    name: "optional name"
    zone_id: IDS60801
    wmo_id: 94675
    monitored_conditions:
--- a/source/_components/sensor.forecast.markdown
+++ b/source/_components/sensor.forecast.markdown
@ -26,34 +26,34 @@ To add Forecast.io to your installation, add the following to your `configuratio
 ```yaml
 # Example configuration.yaml entry
 sensor:
-  platform: forecast
-  api_key: YOUR_APP_KEY
-  monitored_conditions:
-    - summary
-    - icon
-    - nearest_storm_distance
-    - nearest_storm_bearing
-    - precip_type
-    - precip_intensity
-    - precip_probability
-    - temperature
-    - apparent_temperature
-    - dew_point
-    - wind_speed
-    - wind_bearing
-    - cloud_cover
-    - humidity
-    - pressure
-    - visibility
-    - ozone
-    - minutely_summary
-    - hourly_summary
-    - daily_summary
-    - temperature_max
-    - temperature_min
-    - apparent_temperature_max
-    - apparent_temperature_min
-    - precip_intensity_max
+  - platform: forecast
+    api_key: YOUR_APP_KEY
+    monitored_conditions:
+      - summary
+      - icon
+      - nearest_storm_distance
+      - nearest_storm_bearing
+      - precip_type
+      - precip_intensity
+      - precip_probability
+      - temperature
+      - apparent_temperature
+      - dew_point
+      - wind_speed
+      - wind_bearing
+      - cloud_cover
+      - humidity
+      - pressure
+      - visibility
+      - ozone
+      - minutely_summary
+      - hourly_summary
+      - daily_summary
+      - temperature_max
+      - temperature_min
+      - apparent_temperature_max
+      - apparent_temperature_min
+      - precip_intensity_max
 ```

 Configuration variables:
--- a/source/_components/sensor.nest_weather.markdown
+++ b/source/_components/sensor.nest_weather.markdown
@ -23,13 +23,13 @@ To set it up, add the following information to your `configuration.yaml` file:

 ```yaml
 sensor:
-  platform: nest
-  monitored_conditions:
-    - 'weather_temperature'
-    - 'weather_humidity'
-    - 'weather_condition'
-    - 'wind_speed'
-    - 'wind_direction'
+  - platform: nest
+    monitored_conditions:
+      - 'weather_temperature'
+      - 'weather_humidity'
+      - 'weather_condition'
+      - 'wind_speed'
+      - 'wind_direction'
 ```

 Configuration variables:
--- a/source/_components/sensor.netatmo.markdown
+++ b/source/_components/sensor.netatmo.markdown
@ -14,8 +14,6 @@ ha_category: Weather

 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`:

 ```yaml
@ -26,37 +24,15 @@ sensor:
  modules:
    module_name1:
      - temperature
-      - humidity
-      - noise
-      - pressure
-      - co2
-      - rain
-      - sum_rain_1
-      - sum_rain_24
-      - wifi_status
    module_name2:
      - temperature
      - 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:

 - **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.
    - **temperature**: Current temperature.
    - **co2**: CO2 concentration in ppm.
--- a/source/_components/sensor.openweathermap.markdown
+++ b/source/_components/sensor.openweathermap.markdown
@ -22,18 +22,17 @@ To add OpenWeatherMap to your installation, add the following to your `configura
 ```yaml
 # Example configuration.yaml entry
 sensor:
-  platform: openweathermap
-  api_key: YOUR_API_KEY
-  forecast: 0 or 1
-  monitored_conditions:
-    - weather
-    - temperature
-    - wind_speed
-    - humidity
-    - pressure
-    - clouds
-    - rain
-    - snow
+  - platform: openweathermap
+    api_key: YOUR_API_KEY
+    monitored_conditions:
+      - weather
+      - temperature
+      - wind_speed
+      - humidity
+      - pressure
+      - clouds
+      - rain
+      - snow
 ```

 Configuration variables:
--- a/source/_components/sensor.swiss_hydrological_data.markdown
+++ b/source/_components/sensor.swiss_hydrological_data.markdown
@ -23,7 +23,6 @@ To enable this sensor, add the following lines to your `configuration.yaml` file
 # Example configuration.yaml entry
 sensor:
  platform: swiss_hydrological_data
-  name: Aare
  station: STATION_ID
 ```

--- a/source/_components/sensor.wunderground.markdown
+++ b/source/_components/sensor.wunderground.markdown
@ -25,9 +25,8 @@ To add Wunderground to your installation, add the following to your `configurati
 ```yaml
 # Example configuration.yaml entry
 sensor:
-    platform: wunderground
+  - platform: wunderground
    api_key: your_api_key
-    pws_id: enter_pws_id
    monitored_conditions:
      - weather
      - temp_f
@ -60,8 +59,8 @@ sensor:
 ```

 Configuration variables:
- **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. 
+- **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. 
 - **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.
  - **temp_f**: Current temperature in Fahrenheit
--- a/source/_components/sensor.yr.markdown
+++ b/source/_components/sensor.yr.markdown
@ -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:

 ```yaml
-# Will show a symbol for the current weather as default:
+# Example configuration.yaml entry
 sensor:
-  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
+  - platform: yr
 ```

 Configuration variables:
@ -66,3 +41,24 @@ Configuration variables:
  - **mediumClouds**: Medium 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
+```
--- a/source/_components/sensor.yweather.markdown
+++ b/source/_components/sensor.yweather.markdown
@ -26,30 +26,17 @@ To add Yahoo Weather to your installation, add the following to your `configurat
 ```yaml
 # Example configuration.yaml entry
 sensor:
-  platform: yweather
-  woeid: YOUR_WOEID
-  forecast: 0 until 5
-  monitored_conditions:
-   - weather
-   - weather_current
-   - temp_min
-   - temp_max
-   - wind_speed
-   - pressure
-   - visibility
-   - 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
+  - platform: yweather
+    monitored_conditions:
+      - weather
+      - weather_current
+      - temp_min
+      - temp_max
+      - wind_speed
+      - pressure
+      - visibility
+      - humidity
+      - temperature
 ```

 Configuration variables:
--- a/source/_components/sun.markdown
+++ b/source/_components/sun.markdown
@ -17,12 +17,7 @@ The sun component will use your current location to track if the sun is above or

 ```yaml
 # Example configuration.yaml entry
-homeassistant:
-  latitude: 32.87336
-  longitude: -117.22743
-
 sun:
-  elevation: 102
 ```

 Configuration variables: