Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document AEMET image entities #35942

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Document AEMET image entities #35942

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion source/_integrations/aemet.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ ha_config_flow: true
ha_domain: aemet
ha_platforms:
- diagnostics
- image
- sensor
- weather
ha_integration_type: integration
Expand All @@ -19,8 +20,9 @@ ha_codeowners:

The AEMET weather platform uses [AEMET OpenData](https://opendata.aemet.es/) as a source for current meteorological data for your location. AEMET stands for "Agencia Estatal de Meteorología", which is the Spanish Meteorological Agency.

There is currently support for the following device types within Home Assistant:
There is currently support for the following entity types within Home Assistant:

- Image
- Sensor
- Weather

Expand Down Expand Up @@ -68,4 +70,6 @@ For each condition, the following sensors are created:
| wind_max_speed | Max Wind speed. |
| wind_speed | Wind speed. |

The integration creates an image entity for the weather radar if the radar option is enabled.

Comment on lines +73 to +74
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Additional radar image documentation needed

While the basic functionality is documented, users would benefit from more detailed information about:

  1. How to enable the radar option
  2. What geographical area the radar covers
  3. Any configuration options for the radar image
  4. Update frequency or limitations

Consider adding a new section specifically for the radar feature, similar to this:

 The integration creates an image entity for the weather radar if the radar option is enabled.
+
+## Radar Image
+
+The radar image feature provides weather radar imagery for Spain. To enable this feature:
+
+1. Navigate to the integration options
+2. Enable the radar option
+
+{% details "Radar Image Details" %}
+
+- Update Frequency: [specify frequency]
+- Coverage Area: [specify coverage]
+- Image Format: [specify format]
+- Additional Configuration Options: [list if any]
+
+{% enddetails %}

Committable suggestion skipped: line range outside the PR's diff.

Details about the API are available in the [AEMET OpenData documentation](https://opendata.aemet.es/dist).