Skip to content

A home assistant custom component to integrate with the NOAA Space Weather Prediction Center API

License

Notifications You must be signed in to change notification settings

tcarwash/home-assistant_noaa-space-weather

Repository files navigation

NOAA Space Weather

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance BuyMeCoffee

A (non-official) home assistant integration for the NOAA Space Weather Prediction Center API.

Neither this integration nor it's developer have any affiliation with NOAA.

This component will set up the following platforms.

Platform Description
sensor Show info from NOAA Space Weather API.

These sensors are currently available

Sensor Description
sensor.ssn Current Sunspot Number.
sensor.solar_flux_index Current Solar Flux Index.
sensor.planetary_k_index Current Planetary K-Index.
sensor.a_index Predicted A-Index.
sensor.a_index_2_day Predicted 2-Day A-Index.
sensor.a_index_3_day Predicted 3-Day A-Index.
sensor.polar_cap_absorption A color-scale indication of polar cap absorption
sensor.x_class_1_day_probability Probability of an X-Class flare within one day.
sensor.m_class_1_day_probability Probability of an M-Class flare within one day.

example

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called noaa_space_weather.
  4. Download all the files from the custom_components/noaa_space_weather/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "NOAA Space Weather"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/noaa_space_weather/translations/en.json
custom_components/noaa_space_weather/translations/fr.json
custom_components/noaa_space_weather/translations/nb.json
custom_components/noaa_space_weather/translations/sensor.en.json
custom_components/noaa_space_weather/translations/sensor.fr.json
custom_components/noaa_space_weather/translations/sensor.nb.json
custom_components/noaa_space_weather/translations/sensor.nb.json
custom_components/noaa_space_weather/__init__.py
custom_components/noaa_space_weather/api.py
custom_components/noaa_space_weather/binary_sensor.py
custom_components/noaa_space_weather/config_flow.py
custom_components/noaa_space_weather/const.py
custom_components/noaa_space_weather/manifest.json
custom_components/noaa_space_weather/sensor.py
custom_components/noaa_space_weather/switch.py

Configuration is done in the UI

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template