[Feature] Fetch additional data from Cloud Ambient Weather API

philosowaffle / ambientweather-local-server

A server for receiving metrics from your local Ambient Weather Console and exposing them as Prometheus Metrics

https://philosowaffle.github.io/ambientweather-local-server/

GNU General Public License v3.0

30 stars 5 forks source link

[Feature] Fetch additional data from Cloud Ambient Weather API #1

Closed philosowaffle closed 1 year ago

philosowaffle commented 2 years ago

The metrics reported by the local console seem incomplete. We could additionally poll the AmbientWeather API and add that data to the Prometheus metrics.

Can use this library: https://github.com/ChaseDRedmon/Cirrus

philosowaffle commented 2 years ago

Socket https://github.com/ChaseDRedmon/Cirrus/blob/release/Cirrus/Wrappers/CirrusRealtimeWrapper.cs

api docs https://ambientweather.docs.apiary.io/#reference/ambient-realtime-api/query-device-data

api key instructions https://ambientweather.com/faqs/question/view/id/1811/

socketio https://github.com/doghappy/socket.io-client-csharp https://github.com/sta/websocket-sharp

philosowaffle commented 2 years ago

Gave up on Socket impl, tried a couple different libraries, no cigar. Went with polling the Rest API.

philosowaffle commented 2 years ago

[x] Finish impl
[x] See about adding tests
[x] Check logging and error handling
- [x] Handle 401 and retry later
- [x] Handle 429 and retry later
- [x] Handle timeout exception
[x] Check tracing
- [x] Add tracing for background service
[x] Check metrics
[x] Update Grafana dashboard to also pull in Cloud metrics
- [x] add dew point
[x] Update docs
- https://github.com/ambient-weather/api-docs/wiki/Device-Data-Specs
[x] Update release notes and version