mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Fix configuration formatting of zamg sensor and weather component (#6686)
* Fix formatting of zamg configuration * Fix formatting of zamg weather configuration * Fix formatting of yahoo weather sensor configuration * Add type * Add type * Add default values * Add default values * Fix types and add default values * Fix problem * Fix wrong default value * Fix typo
This commit is contained in:
parent
6326dbfc00
commit
18dd481a9e
@ -20,7 +20,7 @@ The `yweather` platform uses [Yahoo Weather](https://www.yahoo.com/news/weather/
|
||||
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
|
||||
</p>
|
||||
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it generate it from Home Assistant's latitude and longitude.
|
||||
The `woeid` (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at [Yahoo Weather](https://www.yahoo.com/news/weather/). If you don't add a WOEID it is generated from Home Assistant's latitude and longitude.
|
||||
|
||||
To add Yahoo Weather to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -40,21 +40,46 @@ sensor:
|
||||
- temperature
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **woeid** (*Optional*): See above.
|
||||
- **forecast** (*Optional*): Day of forecast. The default is the current day to display conditions.
|
||||
- **name** (*Optional*): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. Defaults to `Yweather`.
|
||||
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
|
||||
- **weather**: A human-readable text summary with picture from yahoo.
|
||||
- **weather_current**: A human-readable text summary with picture from yahoo from current condition.
|
||||
- **temperature**: The current temperature.
|
||||
- **temp_min**: The minimal temperature of this day.
|
||||
- **temp_max**: The maximum temperature of this day.
|
||||
- **wind_speed**: The wind speed.
|
||||
- **humidity**: The relative humidity.
|
||||
- **pressure**: The sea-level air pressure in millibars.
|
||||
- **visibility**: The average visibility.
|
||||
{% configuration %}
|
||||
woeid:
|
||||
required: false
|
||||
description: See above.
|
||||
type: string
|
||||
default: "Defaults to a WOEID generated from coordinates defined in your `configuration.yaml` file."
|
||||
forecast:
|
||||
required: false
|
||||
description: Day of forecast. The default is the current day to display conditions.
|
||||
type: integer
|
||||
default: 0
|
||||
name:
|
||||
required: false
|
||||
description: "The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option."
|
||||
type: string
|
||||
default: "`Yweather`"
|
||||
monitored_conditions:
|
||||
required: true
|
||||
description: Conditions to display in the frontend.
|
||||
type: list
|
||||
keys:
|
||||
weather:
|
||||
description: A human-readable text summary with picture from yahoo.
|
||||
weather_current:
|
||||
description: A human-readable text summary with picture from yahoo from current condition.
|
||||
temperature:
|
||||
description: The current temperature.
|
||||
temp_min:
|
||||
description: The minimal temperature of this day.
|
||||
temp_max:
|
||||
description: The maximum temperature of this day.
|
||||
wind_speed:
|
||||
description: The wind speed.
|
||||
humidity:
|
||||
description: The relative humidity.
|
||||
pressure:
|
||||
description: The sea-level air pressure in millibars.
|
||||
visibility:
|
||||
description: The average visibility.
|
||||
{% endconfiguration %}
|
||||
|
||||
Example of forecast using multiple days. In example, first sensor shows tomorrow's forecast, second sensor shows the next day and so on:
|
||||
|
||||
@ -85,4 +110,3 @@ sensor:
|
||||
```
|
||||
|
||||
Details about the API are available in the [Yahoo! Developer Network](https://developer.yahoo.com/weather/).
|
||||
|
||||
|
@ -25,24 +25,55 @@ sensor:
|
||||
- platform: zamg
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **station_id** (*Optional*): The ID number for a supported ZAMG station.
|
||||
- **name** (*Optional*): Additional name for the sensors. Defaults to platform name.
|
||||
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file.
|
||||
- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file.
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend.
|
||||
- **pressure**: Pressure at station level
|
||||
- **pressure_sealevel**: Pressure at sea Level
|
||||
- **humidity**: Humidity
|
||||
- **wind_speed**: Wind speed
|
||||
- **wind_bearing**: Wind bearing
|
||||
- **wind_max_speed**: Top wind speed
|
||||
- **wind_max_bearing**: Top wind bearing
|
||||
- **sun_last_hour**: Sun last hour percentage
|
||||
- **temperature**: Temperature
|
||||
- **precipitation**: Precipitation
|
||||
- **dewpoint**: Dew point
|
||||
{% configuration %}
|
||||
station_id:
|
||||
required: false
|
||||
description: The ID number for a supported ZAMG station.
|
||||
type: string
|
||||
name:
|
||||
required: false
|
||||
description: Additional name for the sensors. Defaults to platform name.
|
||||
default: zamg
|
||||
type: string
|
||||
latitude:
|
||||
required: false
|
||||
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
longitude:
|
||||
required: false
|
||||
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
monitored_conditions:
|
||||
required: false
|
||||
description: Conditions to display in the frontend.
|
||||
type: list
|
||||
default: temperature
|
||||
keys:
|
||||
pressure:
|
||||
description: Pressure at station level
|
||||
pressure_sealevel:
|
||||
description: Pressure at sea Level
|
||||
humidity:
|
||||
description: Humidity
|
||||
wind_speed:
|
||||
description: Wind speed
|
||||
wind_bearing:
|
||||
description: Wind bearing
|
||||
wind_max_speed:
|
||||
description: Top wind speed
|
||||
wind_max_bearing:
|
||||
description: Top wind bearing
|
||||
sun_last_hour:
|
||||
description: Sun last hour percentage
|
||||
temperature:
|
||||
description: Temperature
|
||||
precipitation:
|
||||
description: Precipitation
|
||||
dewpoint:
|
||||
description: Dew point
|
||||
{% endconfiguration %}
|
||||
|
||||
A full configuration example:
|
||||
|
||||
|
@ -27,12 +27,26 @@ weather:
|
||||
- platform: zamg
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **station_id** (*Optional*): The ID number for a supported ZAMG station.
|
||||
- **name** (*Optional*): A name for the weather platform.
|
||||
- **latitude** (*Optional*): Latitude coordinate to monitor weather of (required if **longitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file.
|
||||
- **longitude** (*Optional*): Longitude coordinate to monitor weather of (required if **latitude** is specified). Defaults to coordinates defined in your `configuration.yaml` file.
|
||||
{% configuration %}
|
||||
station_id:
|
||||
required: false
|
||||
description: The ID number for a supported ZAMG station.
|
||||
type: string
|
||||
name:
|
||||
required: false
|
||||
description: A name for the weather platform.
|
||||
type: string
|
||||
latitude:
|
||||
required: false
|
||||
description: "Latitude coordinate to monitor weather of (required if **longitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
longitude:
|
||||
required: false
|
||||
description: "Longitude coordinate to monitor weather of (required if **latitude** is specified)."
|
||||
default: "Defaults to coordinates defined in your `configuration.yaml` file."
|
||||
type: float
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note'>
|
||||
This platform is an alternative to the [`zamg`](/components/sensor.zamg/) sensor. The weather platform is easier to configure but less customizable.
|
||||
|
Loading…
x
Reference in New Issue
Block a user