home-assistant.io/source/_integrations/worldtidesinfo.markdown
2024-11-27 18:57:16 +01:00

1.5 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_platforms, ha_integration_type, related, ha_quality_scale
title description ha_category ha_release ha_iot_class ha_domain ha_platforms ha_integration_type related ha_quality_scale
World Tides Instructions on how to add Tides information to Home Assistant.
Environment
0.52 Cloud Polling worldtidesinfo
sensor
integration
docs title
/docs/configuration/ Configuration file
legacy

The worldtidesinfo {% term integration %} uses details from World Tides to provide information about the prediction for the tides for any location in the world.

Setup

Get your API key from your account at https://www.worldtides.info/.

Configuration

To use this {% term integration %}, add the following to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
sensor:
  - platform: worldtidesinfo
    api_key: YOUR_API_KEY

{% configuration %} api_key: description: Your API key. required: true type: string name: description: Name to use in the frontend. required: false type: string default: WorldTidesInfo latitude: description: Latitude of the location to display the tides. required: false type: float default: "The latitude in your configuration.yaml file." longitude: description: Longitude of the location to display the tides. required: false type: float default: "The longitude in your configuration.yaml file." {% endconfiguration %}