Skip to content

astrandb/weatherlink

 
 

Repository files navigation

weatherlink hacs_badge Validate with hassfest Maintenance weatherlink_downloads Weatherlink_downloads

Weatherlink Integration for Home Assistant

This integration will represent your data from Davis Weaterlink in Home Assistant. It will query the cloud API every 5 minutes. The data update frequency in the API is depending on your subscription level. I e if you have the free "Basic" level, the observations data will only be updated every 15 minutes.

The integration does not have the ambition to display everything that a Davis weatherstation can report. It is a reasonable compromise between details and clutter. It also tries to "normalize" the data so that e.g. outdoor temperature is labelled "Temperature out" irrespective of model of the station and the gateway device.

Some sensors, that are more rarely requested, are disabled and hidden by default. They can be enabled by the user in the device overview page.

If a sensor is showing unknown value it means that the value is unavailable, either temporarily or because it is not available with the current hardware.

Limitations

There are lots of combinations of station types and sensor types. Please report an issue here if you are missing something essential.

This version will mainly display data from primary devices, such as Vantage Vue and Vantage Pro. It will detect the presence of some extra sensor suites or similar add-ons. A more complete support if such devices will be addressed in upcoming releases. No delivery time promised!

Current version has limited error detection and recovery and will therefore log detailed error descriptions if unforeseen things happen. If you see recurring stack traces from this integration in your log, please file an issue report.

Installation

Make sure you have the credentials available for your account with Weatherlink cloud service. You will need API Token and API Secret when using API V2. For the legacy API V1 you will need the DID for your Davis weather station, your password and the API V1 access token.

If you have another weatherlink integration installed you must remove it before installing this one. You cannot have two different integrations with the same name in Home Assistant.

Preferred download and setup method

  • Use HACS
  • Search for the integration Weatherlink and download the integration.
  • Restart Home Assistant
  • Go to Settings->Devices & Services->Integrations and press Add Integration. Search for Weatherlink and select it. Follow the prompts.

Manual download and setup method

  • Copy all files from custom_components/weatherlink in this repo to your config custom_components/weatherlink
  • Restart Home Assistant
  • Go to Settings->Devices & Services->Integrations and press Add Integration. Search for Weatherlink and select it. Follow the prompts.

Support

Support and dicussions forum

Discord chat

Development and contributions

The repo contains a development container that will simplify development and testing. Use VSCode and select Dev Containers: Clone Repository in Named Container Volume.

Contributions are most welcome. Optimizations, new features, translations... Please submit a PR or just leave an issue in the repo.

Translation

To handle submission of translations we are using Lokalise. They provide us with an amazing platform that is easy to use and maintain.

To help out with the translation of Weatherlink integration you need to join the project on Localise, the easiest way is to click here then select "Log in with GitHub".

If you want to add a new language, please open an issue here in this repo. When you get a response that the new language is added you can start to translate in Lokalise.

The translations are pulled when a new release of the integration is prepared. So you must wait until there is a new release until your look for your updates.

If you want to add new elements that needs translation you should enter them in /translations/en.json and submit a PR. The new keys will appear in Lokalise when the PR is merged.

Disclaimer

The package and its author are not affiliated with Davis Instruments or Weatherlink. Use at your own risk.

License

The package is released under the MIT license.

Support and cooperation

This project is supported by