emics / ham_radio_propagation Goto Github PK

Custom Integration that allows Home Assistant to receive information on Radio Propagation based on solar conditions and the degree of refraction of the Ionosphere. It also allows you to know the status for the different HF frequency bands and the maximum usable frequency through hundreds of stations installed on earth.

License: MIT License

Python 100.00%

assistant hacs hacs-integration ham-radio home home-assistant homeassistant

ham_radio_propagation's Introduction

HAM Radio Propagation for Home Assistant

Introduction

Welcome to my repository Home Assistant - Custom Component for HAM Radio Propagation connected to the hamqsl.com and kc2g.com API.

Installation

Using HACS Home Assistant Community Store (recommended)

Click on the button below to automatically navigate to the repository within HACS:

Alternatively, follow the steps below:

Go to HACS "Integrations >" section
In the lower right click + Explore & Download repositories
Search for "HAM Radio" and add it
Restart Home Assistant.

Manual installation

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called ham_radio_propagation.
Download file ham_radio_propagation.zip from the latest release section in this repository.
Extract all files from this archive you downloaded in the directory (folder) you created.
Restart Home Assistant.

Configuration

Click on the button below to add the integration:

Alternatively, follow the steps below:

Install this integration.
Navigate to the Home Assistant Integrations page (Settings --> Devices & Services)
Click the + ADD INTEGRATION button in the lower right-hand corner
Search for HAM
Select if you want to start the configuration through
- Solar Data
- MUF from ionosonde data
If your choice is MUF option you can select a Station from the dropdown list. Select the station nearest your location for best result.

You can do this steps as many times as you want and configure multiple MUF Station in the same Integration

Dashboard

You can go in the Device page and at the bottom click ADD TO DASHBOARD

Manual

Add an Entities Card and paste this code.

type: entities
entities:
  - entity: sensor.ham_radio_propagation_solar_hf_12_10_day
    name: HF Conditions 12m-10m Day
  - entity: sensor.ham_radio_propagation_solar_hf_12_10_night
    name: HF Conditions 12m-10m Night
  - entity: sensor.ham_radio_propagation_solar_hf_17_15_day
    name: HF Conditions 17m-15m Day
  - entity: sensor.ham_radio_propagation_solar_hf_17_15_night
    name: HF Conditions 17m-15m Night
  - entity: sensor.ham_radio_propagation_solar_hf_30_20_day
    name: HF Conditions 30m-20m Day
  - entity: sensor.ham_radio_propagation_solar_hf_30_20_night
    name: HF Conditions 30m-20m Night
  - entity: sensor.ham_radio_propagation_solar_hf_80_40_day
    name: HF Conditions 80m-40m Day
  - entity: sensor.ham_radio_propagation_solar_hf_80_40_night
    name: HF Conditions 80m-40m Night
  - entity: sensor.ham_radio_propagation_solar_geomag_field
    name: HF Conditions Geomag Field
  - entity: sensor.ham_radio_propagation_solar_sig_noise_lvl
    name: HF Conditions Noise Level
  - entity: sensor.ham_radio_propagation_solar_a_index
    name: Solar A-Index
  - entity: sensor.ham_radio_propagation_solar_bz
    name: Solar Bz
  - entity: sensor.ham_radio_propagation_solar_flux_index
    name: Solar Flux Index
  - entity: sensor.ham_radio_propagation_solar_fof2
    name: Solar foF2
  - entity: sensor.ham_radio_propagation_solar_k_index
    name: Solar K-Index
  - entity: sensor.ham_radio_propagation_solar_sunspots
    name: Solar Sunspots
  - entity: sensor.ham_radio_propagation_solar_wind
    name: Solar Wind
  - entity: sensor.ham_radio_propagation_solar_xray
    name: Solar xRay Class
  - entity: sensor.ham_radio_propagation_solar_xray_scale
    name: Solar xRay Scale
title: Solar Data

This is the card result:

CSS Card

Thanks to our friend Mikko a special card with CSS to visualize data.

How To section

How to read sensor value

Solar Flare Notification

* * *

Contributions are welcome!

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Special thanks to:

@kwirk
@dragonjon
@Toni
@ViPeR5000
@CT2HUU
@Mikko (Telegram contributor)

Trademark Legal Notices

All product names, trademarks and registered trademarks in the images in this repository, are property of their respective owners. All images in this repository are used by the author for identification purposes only. The use of these names, trademarks and brands appearing in these image files, do not imply endorsement.

ham_radio_propagation's People

Contributors

Stargazers

Watchers

Forkers

viper5000 spencerx

ham_radio_propagation's Issues

Enhancement request: please add VHF sensors

Any chance to add VHF or even UHF data?

ADD INTEGRATION HAM Radio Propagation

Hello everyone,

I installed HAM Radio Propagation via HACS.

I now wanted to add the integration

Unfortunately, the integration is not offered to me for selection.

When I open the Botten from the side, the following message appears in the Home Assistant

Übersetzter Text :-)

Mistake
This integration does not support UI configuration. If you followed this link from the Home Assistant website, make sure you're running the latest version of Home Assistant.

If I understand your instructions correctly, I'm not making a mistake.

Maybe you can help me?

Thanks says Dirk DL4DP

Add foF2 info

Issue requested via mail from toni SA6EAL

Is it possible for you to add foF2 also?

Not really an issue, but a suggestion

Hi again!
Would it be possible to add an entity with the Confidence value of the selected Ionosonde?
Have a look on https://twitter.com/HB9VQQ/status/1667829304384802816?t=D7orJRQF3Iq0aOR-9PoSMw&s=08 (not me) to see a few ideas. Or in https://www.ursi.org/files/CommissionWebsites/INAG/web-73/confidence_score.pdf
Also would be nice to have a way to select how often I would like the MUF sensor to be updated, every 5 min, 10min, etc...
Great work you have done, 73.

Add MUF info

Issue requested in Community Forum from kwirk

A great feature to add would be to include a (or multiple) MUFs from @arodland KC2G’s website, with configuration option to select which station is of interest.

Integration reports inaccurate data

When stations report N/A for a given value, GIRO presents as such (foe for example):

Which is also correctly displayed on prop.kc2g.com (no value displayed):

However the integration seems to be substituting this with 0.000:

This is inaccurate, and causes lots of drops in graphs over time. Instead, the integration should simply report unavailable when a given value is reported N/A.

Given measurements are not available from all stations at all times, I've created aggregate template sensors that take nearby station data and handle gaps as a workaround. While cumbersome, this effectively takes the average of 1 or more datapoints, and if all datapoints are 0 the state will fail to render as you cannot average an empty list of values, and the sensor will correctly report unavailable.

    - unique_id: sensor.ham_radio_propagation_solar_hf_foe_average
      attributes:
        friendly_name: Solar Data HF foE Average
      icon: mdi:format-wrap-inline
      unit_of_measurement: MHz
      state_class: measurement
      state: >
        {% set sensor_list = [
            states('sensor.ham_radio_propagation_solar_hf_foe_ga762') | float(default=0),
            states('sensor.ham_radio_propagation_solar_hf_foe_mhj45') | float(default=0),
            states('sensor.ham_radio_propagation_solar_hf_foe_pf765') | float(default=0)
          ]
        %}
        {{ sensor_list | reject('==', 0) | average | round(3) }}

Results with all sources shown:

Average template sensor output with gaps coinciding with N/A:

Expected behavior would be for the integration to take care of this natively. If a station is reporting N/A, do not substitute a 0 value.

Austin, TX no longer updating

Austin, and many other stations are no longer updating.

Valid units for the sensors

Hi @emics , this is in the log. Thank for this work.

Entity sensor.ham_radio_propagation_solar_wind (<class 'custom_components.ham_radio_propagation.sensor.HamRadioSensor'>) is using native unit of measurement 'km/s' which is not a valid unit for the device class ('wind_speed') it is using; expected one of ['mph', 'kn', 'km/h', 'ft/s', 'm/s']; Please update your configuration if your entity is manually configured, otherwise report it to the custom integration author.
Entity sensor.ham_radio_propagation_solar_sig_noise_lvl (<class 'custom_components.ham_radio_propagation.sensor.HamRadioSensor'>) is using native unit of measurement 'None' which is not a valid unit for the device class ('signal_strength') it is using; expected one of ['dBm', 'dB']; Please update your configuration if your entity is manually configured, otherwise report it to the custom integration author.
Sensor sensor.ham_radio_propagation_solar_geomag_field has device class None, state class measurement and unit None thus indicating it has a numeric value; however, it has the non-numeric value: UNSETTLD (<class 'str'>); Please update your configuration if your entity is manually configured, otherwise report it to the custom integration author.

Thanks in advanced
Jon
EA7KDW - AJ6TP
73

More FoF2

Hi,
What about adding all info per station from https://prop.kc2g.com/stations/? Then can you chose the most close station to your QTH.
Regards Toni
SA6EAL

Can you add a sensor that detects Solar Flares?

I'm trying to find a way to create a sensor that detects Solar Flares. As an Ham Radio operator I will take advantage on that.
I'm not getting much info for HA, but there is a project that is close (https://community.home-assistant.io/.../solar-flux.../434299) but not relating the NOAA data into a sensor that results in a sensor that says "A Flare just happened! It's a C9 flare".
Can you help?

MUF from Los Roquetes stopped updating

Hi
Everything was working fine, but on the 24th of may MUF from Los Roquetes Spain stopped updating. Just checked it on source and it is 29.617MHz and my HA says 14.78Mhz since 24 of may. I have other friends HA having the same issue.
Looking at source site, looks like it received an update https://prop.kc2g.com/stations/
Can you help?