mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-26 12:06:50 +00:00
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
---
|
|
title: NOAA Tides
|
|
description: Instructions to add NOAA Tide information to Home Assistant.
|
|
ha_category:
|
|
- Environment
|
|
ha_release: 0.75
|
|
ha_iot_class: Cloud Polling
|
|
ha_domain: noaa_tides
|
|
ha_codeowners:
|
|
- '@jdelaney72'
|
|
ha_platforms:
|
|
- sensor
|
|
ha_integration_type: integration
|
|
ha_quality_scale: legacy
|
|
---
|
|
|
|
The `noaa_tides` sensor {% term integration %} uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States.
|
|
|
|
## Setup
|
|
|
|
This {% term integration %} requires the use of a NOAA station ID. Search [NOAA Tide Predictions](https://tidesandcurrents.noaa.gov/tide_predictions.html) to find a location. Use the ID from the search results in your configuration. Alternatively, you can determine a station ID from a URL. For example, `8721164` in the following URL: `https://tidesandcurrents.noaa.gov/noaatidepredictions.html?id=8721164`
|
|
|
|
## Configuration
|
|
|
|
To use this {% term integration %}, add the following to your {% term "`configuration.yaml`" %} file.
|
|
{% include integrations/restart_ha_after_config_inclusion.md %}
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: noaa_tides
|
|
station_id: 8721164
|
|
```
|
|
|
|
{% configuration %}
|
|
station_id:
|
|
description: ID of the station you'd like to track from <https://tidesandcurrents.noaa.gov/tide_predictions.html>.
|
|
required: true
|
|
type: string
|
|
name:
|
|
description: User-supplied sensor name.
|
|
required: false
|
|
default: NOAA Tides.
|
|
type: string
|
|
time_zone:
|
|
description: User-selected timezone.
|
|
required: false
|
|
default: Local Standard Time/Local Daylight Time.
|
|
type: list
|
|
keys:
|
|
gmt:
|
|
description: Greenwich Mean Time.
|
|
lst:
|
|
description: Local Standard Time. The time local to the requested station.
|
|
lst_ldt:
|
|
description: Local Standard/Local Daylight Time. The time local to the requested station.
|
|
unit_system:
|
|
description: Specify the unit system. Use `metric` (Celsius, meters, cm/s) or `english` (fahrenheit, feet, knots) units.
|
|
required: false
|
|
default: Defaults to `metric` or `imperial` based on the Home Assistant configuration.
|
|
type: string
|
|
{% endconfiguration %}
|