Skip to main content

A Prometheus exporter for Solcast Home PV API data.

Project description

prometheus_solcast_exporter

A very quick and dirty unofficial Prometheus exporter for Solcast's free home solar forecast API. (So dirty it doesn't even have any tests!)

Usage

$ prometheus_solcast_exporter RESOURCE_ID --api-key=API_KEY

[!TIP]

The RESOURCE_ID is the ID used to identify a particular array and usually has the form XXXX-XXXX-XXXX-XXXX.

By default will run an Prometheus exporter on port 9534. See --help for further options.

Metrics

Produces two sets of metrics:

  • solcast_up{resource_id="..."}: 1 when the most recent Solcast API request succeeded, 0 otherwise.
  • solcast_forecast_watts{resource_id="...", time_offset="NNN", centile="..."}: The forecast solar power in Watts. The time_offset label gives the number of minutes into the future the forecast is for. The centile label is either empty (for the main estimate), 10 (for the 10th percentile estimate) or 90 (for the 90th percentile estimate).

Forecast data is fetched at an interval configured by the --max-age argument, defaulting to 180 minutes to avoid hitting the 10 requests per day API rate limit. The most recently fetched data (appropriately time shifted) is returned between requests.

Historic estimated values are not captured.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prometheus_solcast_exporter-0.0.1.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

prometheus_solcast_exporter-0.0.1-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file prometheus_solcast_exporter-0.0.1.tar.gz.

File metadata

File hashes

Hashes for prometheus_solcast_exporter-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e60b63a10b2c477c1dca9e89e1d449492dd2e8335c2375c585c4e772a08b32f1
MD5 2d683ad4eb3a3946c208485151d15870
BLAKE2b-256 16b4ea74d6e1c4188f68de1ae94363d7f42e8fbcf9a5d0a085d18d48de96d0bf

See more details on using hashes here.

File details

Details for the file prometheus_solcast_exporter-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for prometheus_solcast_exporter-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 911a73d4aa2a31e0bdc8b51d6405132827e0b077ecec38a2d4e43d51caf4af7d
MD5 2eb74affeee4c15a17aa8c81a331b488
BLAKE2b-256 db4c7598a2b200635fb02334095f821922d6685acab452e79641774024332f90

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page