search

tmjo / ha-norwegiantide

Tide information for Norway from Kartverket as a custom integration for Home Assistant. Provides tidal data such as time for high/low, ebb/flow and prediction, forecast and observation.
6 stars 0 forks source link
ebb fjaere flo flow high kartverket low norway ocean sea sealevel sehavniva tidal tide tidevann waterlevel

readme

Norwegian Tide

Buy Me A Coffee hacs_badge Maintenance

This is a Home Assistant custom integration for Norwegian Tide which is interfacing an open API by the Norwegian Mapping Authority (Kartverket), more precisely sehavniva.no which provides information about water levels and tidal predicitions and forecasts. All data is ©Norwegian Mapping Authority (Kartverket).

Unfortunately the service only provides data for geographical positions in Norway - this is a limitation in the API and not in this integration.

OBS! Does not work with HA 2024.2.1 or 2024.2.2 due to a compatibility issue with Matplotlib, but it should be fixed from 2024.2.3 and onwards.

Installation

There are different methods of installing the custom component. HACS is by far the simplest way for unexperienced users and is recomended.

HACS installation

The installation is currently not included in HACS as a default repo, but can be installed through HACS by adding this repo as a custom repository.

  1. Make sure you have HACS installed in your Home Assistant environment.
  2. Go to HACS, select Integrations.
  3. Click on the three dots in the upper right corner and select Custom repositories
  4. Copy/paste the URL for this repo https://github.com/tmjo/ha-norwegiantide into the URL-field, select Integration as category and then click Add.
  5. You should now find the Norwegian Tide integration by searching for it in HACS, proceed to install it.
  6. Restart Home Assistant (a warning should be shown in log saying you're using a custom integration).
  7. Continue to the Configuration-section.

Manual

  1. Navigate to you home assistant configuration folder.
  2. Create a custom_components folder of it does not already exist, then navigate into it.
  3. Download the folder norwegian-tide from this repo and add it into your custom_components folder.
  4. Restart Home Assistant (a warning should be shown in log saying you're using a custom integration).
  5. Continue to the Configuration-section.

Git installation

  1. Make sure you have git installed on your machine.
  2. Navigate to you home assistant configuration folder.
  3. Create a custom_components folder of it does not already exist, then navigate into it.
  4. Execute the following command: git clone https://github.com/tmjo/ha-norwegiantide ha-norwegiantide
  5. Run bash links.sh
  6. Restart Home Assistant (a warning should be shown in log saying you're using a custom integration).
  7. Continue to the Configuration-section.

Configuration

Configuration is done through UI/Lovelace. In Home Assistant, click on Configuration > Integrations where you add it with the + icon.

You will be asked to give your location a name and to provide latitude and longitude as geographical position for the location you want to track. Finally select which sensors you would like the integration to add. More detailed description of this will be added, but in short there is one main sensor which contains all info and for most people probably this may be sufficient. You do not need to add other entities unless you want, but several detailed entities are available if you prefer to have them as separate entities instead of attributes on the main sensor. There is also a camera entity which creates a plot of the data by using Matplotlib.

Entities can be added and removed by clicking Options in HA integreation view at any time. It is also possible to enable more than one location by adding the integration several times.

Usage

Use the integration as you please, but I highly recommend to take a look at the Apexchart-card by Romrider - it is an excellent graph card for lovelace which also enables the possibility to show future values. This is necessary to display prediction- and forecast values which are stored as attributes in the main sensor. Example:

apexchart-card

The camera entity can also be used for UI since it provides a nice plot using Matplotlib, but I personally prefer the Apexchart-card since it provides more dynamics. The camera on the other hand can be handy if you would like to send notifications with an included forecast image/plot. It will look something like this:

camera entity

More detailed description will follow, but worth mentioning:

If you are curious about specific details and definitions, please see www.sehavniva.no.

The main sensor will keep the current forecast value as state and will contain all or most data as attributes. The other entities will contain more specific data according to their name.

Issues and development

Please report issues on github. If you would like to contribute to development, please do so through PRs.

License

MIT © Tor Magne Johannessen. All data is ©Norwegian Mapping Authority (Kartverket).