-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Added documentation for aurorawatch #43852
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.
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
Draft
agentgonzo
wants to merge
3
commits into
home-assistant:next
Choose a base branch
from
agentgonzo:aurorawatch
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: AuroraWatch UK | ||
| description: Monitor aurora activity from AuroraWatch UK | ||
| ha_category: | ||
| - Environment | ||
| ha_iot_class: Cloud Polling | ||
| ha_release: 2026.5 | ||
| ha_domain: aurorawatch | ||
| ha_codeowners: | ||
| - '@agentgonzo' | ||
| ha_config_flow: true | ||
| ha_platforms: | ||
| - sensor | ||
| ha_integration_type: service | ||
| --- | ||
|
|
||
| The **AuroraWatch UK** {% term integration %} uses the [AuroraWatch UK service](https://aurorawatch.lancs.ac.uk) by Lancaster University to monitor geomagnetic activity and aurora alerts for the United Kingdom. This service helps you know when auroras (Northern Lights) might be visible from the UK. | ||
|
|
||
| The integration monitors the current aurora alert status, which indicates the likelihood of aurora visibility in the UK. The alert status ranges from green (no significant activity) through yellow and amber, to red (auroras very likely). It also provides the current geomagnetic activity measurement. | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| The AuroraWatch UK service is provided by Lancaster University and does not require any account or API key. The integration will automatically start monitoring aurora activity for the UK region once set up. | ||
|
|
||
| ## Sensors | ||
|
|
||
| The integration provides two sensors: | ||
|
|
||
| ### Aurora status | ||
|
|
||
| Shows the current aurora alert status for the UK. | ||
|
|
||
| Possible values: | ||
|
|
||
| - **Green**: No significant activity | ||
| - **Yellow**: Minor geomagnetic activity | ||
| - **Amber**: Amber alert - possible aurora | ||
| - **Red**: Red alert - auroras likely | ||
|
|
||
| Additional attributes: | ||
|
|
||
| - **Last updated**: Timestamp of the last data update from AuroraWatch UK | ||
| - **Project ID**: The AuroraWatch project identifier | ||
| - **Site ID**: The monitoring site identifier | ||
| - **Site URL**: URL to the AuroraWatch UK monitoring site | ||
| - **API version**: Version of the AuroraWatch API | ||
|
|
||
| ### Geomagnetic activity | ||
|
|
||
| Shows the current geomagnetic activity level measured in nanotesla (nT). Higher values indicate increased geomagnetic activity, which correlates with a higher likelihood of visible auroras. | ||
|
|
||
| ## Data updates | ||
|
|
||
| The integration {% term polling polls %} data from the AuroraWatch UK service every 5 minutes. This ensures you receive timely updates about changes in aurora activity and alert status. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.