worldtidesinfocustom

world tides info custom component for Home Assistant.

This component is used to retrieve tide information for a dedicated location (all over the world) : https://www.worldtides.info/

This component allows to :

• display the tide curve (height)
• give the current height
• give a forcast height (1 hour)
• give the next tide
• give tide tendancy, amplitude
• display location on default map
• display tide prediction over user defined period
• insert tide extrema in calendar

==> the monitored location is either static, either given by GPS data (tracker)

WorldTidesInfo uses credit. Hereafter example with 1 day prediction :

• In static, refresh rate (Scan Interval) is every 15minutes with refresh of data from server once a day (3 credits). NB: At init 5 credits.

• In motion, refresh rate (Scan Interval) is every 15minutes with refresh of data from server once a day (3 credits), or if the position has moved more than a user parameter defined in UI (the new position information are then request : 5 credits)

• Please refer to https://www.worldtides.info/developer for pricing (as few requests are done per month, prepaid seems to be the best deal).

  • As an example, in static, as the request per day per location uses 3 credits : for one location, 20000 credits will last ~18 years

Installation

Either use HACS (default), either manual

HACS (Home Assistant Community Store)

1. Go to HACS page on your Home Assistant instance
2. Select integration
3. Press add icon and search for worldtidesinfocustom
4. Select worldtidesinfocustom and install

Manual

Breaking change

Using the component

• Get API key from https://www.worldtides.info/developer (buy prepaid)

• During configuration, you can define a Vertical Reference (default is LAT). Please go to this page that explain https://www.sailingissues.com/navcourse7.html

• Either UI (prefered), either YAML (deprecated) :

  • Use UI (Integration)

  • Deprecated in configuration.yaml, declare :

• Several sensors and several cameras are provided with attibutes. To see some attributes as sensor, you have to use template inside configuration.yaml.
  Please follow the hereafter example

##configuration.yaml example
sensor:
  - platform: template
    sensors:
      tide_royan_next_high:
        value_template: '{{ as_timestamp(states.sensor.royan_tides.attributes.high_tide_time_utc) | timestamp_custom("%a %d/%m/%Y %H:%M") }}'
        friendly_name: "Royan Next High Tide"
      tide_royan_next_low:
        value_template: '{{ as_timestamp(states.sensor.royan_tides.attributes.low_tide_time_utc) | timestamp_custom("%a %d/%m/%Y %H:%M") }}'
        friendly_name: "Royan Next Low Tide"
      tide_royan_next_high_height:
        value_template: "{{ state_attr('sensor.royan_tides','high_tide_height')  }}"
        friendly_name: "Royan Next High Tide Height"
        unit_of_measurement: m
#change m into ft , if you are in imperial
      tide_royan_next_low_height:
        value_template: "{{ state_attr('sensor.royan_tides','low_tide_height')  }}"
        friendly_name: "Royan Next Low Tide Height"
        unit_of_measurement: m
#change m into ft , if you are in imperial
      tide_royan_credit:
        value_template: "{{ state_attr('sensor.royan_tides','CreditCallUsed')  }}"
        friendly_name: "Royan Tide Credit"
        unit_of_measurement: credit
      tide_royan_current_height:
        value_template: "{{ state_attr('sensor.royan_tides','current_height')  }}"
        friendly_name: "Royan Tide Current Height"
        unit_of_measurement: m
#change m into ft , if you are in imperial
      tide_royan_station:
        value_template: "{{ state_attr('sensor.royan_tides','tidal_station_used')  }}"
        friendly_name: "Royan Tide Station used"
      tide_royan_coeff_mws:
        value_template: "{{ state_attr('sensor.royan_tides','Coeff_resp_MWS')  }}"
        friendly_name: "Royan Tide Coeff MWS"
        unit_of_measurement: "%"
      tide_royan_amplitude:
        value_template: "{{ state_attr('sensor.royan_tides','tide_amplitude')  }}"
        friendly_name: "Royan Tide Amplitude"
        unit_of_measurement: m
#change m into ft , if you are in imperial

## CAMERA
camera:
  - platform: generic
    name: Royan_tides_curve
    still_image_url: https://127.0.0.1:8123/local/royan_tides.png
    verify_ssl: false

Dashboard example

Hereafter the display of attributes within lovelace UI

Hereafter an example under lovelace UI

(NB: plot_color, plot_background options can be used to change color for plot curve)

and a dedicated view on tide amplitude / coeff (over Mean Water Spring) on several days

and a dedicated view credit (the station monitored and all other declared)

An example of the camera that plot the current tide height respect to current prediction

(NB: mat_plot_transparent_background option can be used to have transparent background)

Hereafter an example of picture element card under lovelace UI

(NB: plot_color, plot_background options can be used to change color for plot curve)

Hereafter an example of the default map under lovelace UI

Hereafter an example of the prediction within Calendar

Hereafter an example of update thanks to a boat tracker :

• blue : a boat tracker
• purple : the difference place where tide info has been taken

NB: a boat tracker can be easily given by running HomeAssistant Application on your phone. The application offers to you a tracker with lat/long of your current position.

with the change of tide station

Each time the position is changed (distance greater than the UI parameter) the information is request to server (shown by the credit used)

Detail Configuration parameter for UI, (Deprecated for YAML for sensor)

Camera are automatically created by UI , Hereafter deprecated method for camera for YAML

Detail Sensor attribute description

The sensor "NAME" has a set of attributes describes hereafter

Detail Option parameter for UI

The value has the default one or the last set (either during 1rst declaration through UI, either during option phase through UI).

Wish/Todo list

• make this integration as default in home assistant

Thanks to

Idea of picture element card given within community.home-assistant.io/t/world-tide-info-v2-api-graph

Thanks for all contributors !

Thanks home-assitant community !

Thanks Home-assistant project !

Credit / Use Of / Purpose

Since V1.0.0 :

• use of WorldTidesInfo results
• to be used within Home Assistant.

Since V5.0.0 :

• matplotlib is used

Since V8.0.0 :

• pyworldtidesinfo is used. The package was formely included within worldtidesinfo custom.