WeatherLink Live: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m (Changed occurrences of WL.com to weatherlink.com) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 6: | Line 6: | ||
There are a few caveats around this though... |
There are a few caveats around this though... |
||
* You must have at least a Pro subscription for your device on |
* You must have at least a Pro subscription for your device on weatherlink.com to grant access to the historic data. |
||
* The new APIv2 used to access the data. |
* The new APIv2 used to access the data. |
||
* The APIv2 keys are now available via |
* The APIv2 keys are now available via weatherlink.com. |
||
If you meet the criteria, then these are the steps you need to follow... |
If you meet the criteria, then these are the steps you need to follow... |
||
# Sign on to the Davis weatherlink.com web site with your normal username/password |
# Sign on to the Davis weatherlink.com web site with your normal username/password |
||
# On |
# On weatherlink.com open your user profile, you will see a section titled API Key v2 |
||
# If you do not already have a key and secret displayed, click "Generate v2 key" to create them. Copy these strings somewhere safe so you can later paste them into Cumulus |
# If you do not already have a key and secret displayed, click "Generate v2 key" to create them. Copy these strings somewhere safe so you can later paste them into Cumulus |
||
# Ensure you are running Cumulus MX v3.4.0 or later |
# Ensure you are running Cumulus MX v3.4.0 or later |
||
| Line 20: | Line 20: | ||
## In the WLL section enter your API key and secret. LEAVE THE STATION ID BLANK |
## In the WLL section enter your API key and secret. LEAVE THE STATION ID BLANK |
||
## Set up your sensor to transmitter ID mappings if different from the defaults |
## Set up your sensor to transmitter ID mappings if different from the defaults |
||
## It is not necessary to enter the WLL IP address if you only have one device, Cumulus should just find it on your network. But if you know it it does not harm to enter it, Cumulus will change it anyway if your WLL ever changes address. |
## It is not necessary to enter the WLL IP address if you only have one device, Cumulus should just find it on your network. But if you know it, it does not harm to enter it, Cumulus will change it anyway if your WLL ever changes address. |
||
## Save the setup |
## Save the setup |
||
## |
## Restart Cumulus |
||
# If you only have a single station registered with |
# If you only have a single station registered with weatherlink.com, then Cumulus should discover its ID automatically and start using it |
||
# But if you have more than one, the Cumulus will list their API IDs and names in the console window. |
# But if you have more than one, the Cumulus will list their API IDs and names in the console window. |
||
# Note the ID you want to use. Go back into the Station setup and enter the ID there. You do not need to restart Cumulus after that. |
# Note the ID you want to use. Go back into the Station setup and enter the ID there. You do not need to restart Cumulus after that. |
||
# Enjoy! Cumulus should now download missing data for periods it is stopped. |
# Enjoy! Cumulus should now download missing data for periods it is stopped. |
||
Eventually once the APIv2 is out of testing, then you should be able to retrieve your APIv2 key and secret via the normal WL.com page along with the existing APIv1 (until it is retired). |
|||
| Line 35: | Line 32: | ||
Davis impose rate and data limits on the APIv usage- currently they are... |
|||
* 300 API calls per hour, or 2 API calls per second |
* 300 API calls per hour, or 2 API calls per second |
||
* 24 hours of data in any one call |
* 24 hours of data in any one call |
||
Latest revision as of 22:05, 9 November 2024
Davis WeatherLink Live
The Davis WeatherLink Live device is fully supported by Cumulus MX.
Cumulus MX also supports historic data catch-up by using the Davis WeatherLink.com cloud data source - though this does require you to have a Pro licence to enable the feature.
There are a few caveats around this though...
- You must have at least a Pro subscription for your device on weatherlink.com to grant access to the historic data.
- The new APIv2 used to access the data.
- The APIv2 keys are now available via weatherlink.com.
If you meet the criteria, then these are the steps you need to follow...
- Sign on to the Davis weatherlink.com web site with your normal username/password
- On weatherlink.com open your user profile, you will see a section titled API Key v2
- If you do not already have a key and secret displayed, click "Generate v2 key" to create them. Copy these strings somewhere safe so you can later paste them into Cumulus
- Ensure you are running Cumulus MX v3.4.0 or later
- If this your first run of CumulusMX.
- Add a local firewall rule on your server to enable UDP port 22222 inbound
- Go into the Station setup and select Davis WLL as the station type
- In the WLL section enter your API key and secret. LEAVE THE STATION ID BLANK
- Set up your sensor to transmitter ID mappings if different from the defaults
- It is not necessary to enter the WLL IP address if you only have one device, Cumulus should just find it on your network. But if you know it, it does not harm to enter it, Cumulus will change it anyway if your WLL ever changes address.
- Save the setup
- Restart Cumulus
- If you only have a single station registered with weatherlink.com, then Cumulus should discover its ID automatically and start using it
- But if you have more than one, the Cumulus will list their API IDs and names in the console window.
- Note the ID you want to use. Go back into the Station setup and enter the ID there. You do not need to restart Cumulus after that.
- Enjoy! Cumulus should now download missing data for periods it is stopped.
There is effectively no limit on how much historic data you can download++, I have tested using a four day catch-up without issues.
Davis impose rate and data limits on the APIv usage- currently they are...
- 300 API calls per hour, or 2 API calls per second
- 24 hours of data in any one call
Cumulus honours these restrictions.
The APIv2 uses both a key and a secret that encrypts part of the URL making playback or emulating the API calls by another user impossible. A nice feature other web APIs could emulate.
++Cumulus MX will get the max 24 hours data per call if required, which will give a limit of 300 days of historic data catch-up.
