mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 00:36:49 +00:00
Alignment to new doc standards (#6624)
* Fixes to configuration description and example. Alignment with new documentation guidelines (https://developers.home-assistant.io/docs/en/documentation_standards.html) * Fixed of sample config and documentation Alignment with new documentation guidelines. * Update sensor.waqi.markdown * Update sensor.bom.markdown * Update sensor.bom.markdown
This commit is contained in:
parent
1dd1d815a1
commit
b5cd4dc921
@ -25,8 +25,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
|
||||||
station: IDS60801.94675
|
|
||||||
name: Adelaide
|
|
||||||
monitored_conditions:
|
monitored_conditions:
|
||||||
- apparent_t
|
- apparent_t
|
||||||
- cloud
|
- cloud
|
||||||
@ -64,11 +62,74 @@ To get the station ID for any BOM station:
|
|||||||
- The URL will look like: http://www.bom.gov.au/products/IDx60801/[station].shtml
|
- The URL will look like: http://www.bom.gov.au/products/IDx60801/[station].shtml
|
||||||
- For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`.
|
- For Adelaide, the URL will look like `http://www.bom.gov.au/products/IDS60801/IDS60801.94675.shtml`; the station ID is `IDS60801.94675`.
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
station:
|
||||||
- **station** (*Optional*): The station ID string as identified from the BOM website. If not given, defaults to the closest station.
|
description: The station ID string as identified from the BOM website.
|
||||||
- **name** (*Optional*): The name you would like to give to the weather station.
|
required: false
|
||||||
- **monitored_conditions** (*Required*): A list of the conditions to monitor.
|
type: string
|
||||||
|
default: If not given, defaults to the closest station based on location data in configuration.yaml.
|
||||||
|
name:
|
||||||
|
description: The name you would like to give to the weather station.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
monitored_conditions:
|
||||||
|
description: A list of the conditions to monitor.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
apparent_t:
|
||||||
|
description: Feels like temperature in C.
|
||||||
|
cloud:
|
||||||
|
description: Cloud cover.
|
||||||
|
cloud_base_m:
|
||||||
|
description: Cloud Base in m.
|
||||||
|
cloud_oktas:
|
||||||
|
description: Cloud Oktas.
|
||||||
|
cloud_type_id:
|
||||||
|
description: Cloud type ID.
|
||||||
|
cloud_type:
|
||||||
|
description: Cloud type description.
|
||||||
|
delta_t:
|
||||||
|
description: Delta temperature in C.
|
||||||
|
gust_kmh:
|
||||||
|
description: Wind gust in km/h.
|
||||||
|
gust_kt:
|
||||||
|
description: Wing gust in kt.
|
||||||
|
air_temp:
|
||||||
|
description: Air temperature in C.
|
||||||
|
dewpt:
|
||||||
|
description: Drew point in C.
|
||||||
|
press:
|
||||||
|
description: Pressure in mbar.
|
||||||
|
press_qnh:
|
||||||
|
description: Pressure in qnh.
|
||||||
|
press_msl:
|
||||||
|
description: Pressure in msl.
|
||||||
|
press_tend:
|
||||||
|
description: Pressure trend.
|
||||||
|
rain_trace:
|
||||||
|
description: Raing today in mm.
|
||||||
|
rel_hum:
|
||||||
|
description: Relative Humidity in %.
|
||||||
|
sea_state:
|
||||||
|
description: Sea state.
|
||||||
|
swell_dir_worded:
|
||||||
|
description: Swell direction.
|
||||||
|
swell_height:
|
||||||
|
description: Swell hight in m.
|
||||||
|
swell_period:
|
||||||
|
description: Swell period.
|
||||||
|
vis_km:
|
||||||
|
description: Visibility in km.
|
||||||
|
weather:
|
||||||
|
description: Weather summary.
|
||||||
|
wind_dir:
|
||||||
|
description: Wind direction.
|
||||||
|
wind_spd_kmh:
|
||||||
|
description: Wind speed in km/h.
|
||||||
|
wind_spd_kt:
|
||||||
|
description: Wind speed in kt.
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
<p class='note'>
|
<p class='note'>
|
||||||
This sensor is an alternative to the [`bom`](/components/weather.bom/) weather platform.
|
This sensor is an alternative to the [`bom`](/components/weather.bom/) weather platform.
|
||||||
|
@ -26,15 +26,22 @@ sensor:
|
|||||||
token: AQICN_API_TOKEN
|
token: AQICN_API_TOKEN
|
||||||
locations:
|
locations:
|
||||||
- beijing
|
- beijing
|
||||||
stations:
|
|
||||||
- Beijing US Embassy, Beijing
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
token:
|
||||||
- **locations** (*Required*): A list of location names to look for air quality data. In case a specific location has multiple registered stations all of them will be added to Home Assistant.
|
description: The token for the AQICN public API.
|
||||||
- **token** (*Required*): The token for the AQICN public API.
|
required: true
|
||||||
- **stations** (*Optional*): A list of station names to look for air quality data. Station should be within locations specified above.
|
type: string
|
||||||
|
locations:
|
||||||
|
description: A list of location names to look for air quality data. In case a specific location has multiple registered stations all of them will be added to Home Assistant.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
stations:
|
||||||
|
description: A list of station names to look for air quality data. Station should be within locations specified above.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
The value reported is an overall AQ index for the location. The values of the index can be interpreted as following:
|
The value reported is an overall AQ index for the location. The values of the index can be interpreted as following:
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user