node-red-contrib-solaredge-optimizers 0.6.0

Read optimizer data from solaredge cloud

npm install node-red-contrib-solaredge-optimizers

SolarEdge optimizers node for Node-RED

This is a node for Node-RED to scrape optimizer data from your SolarEdge cloud. You'll need your login data (username, password) and your site ID.

Installation

In your Node-RED directory:

npm install node-red-contrib-solaredge-optimizers

Usage

There are three nodes available with different approaches to scrape data from the solaredge monitoring platform. Their usage will be explained below

solaredge-optimizers node (deprecated)

This node is deprecated and no longer works. SolarEdge retired the API endpoints it relied on (the old session-based login and the layout/playbackData endpoints); the node now only reports a deprecation error instead of data.

Please migrate to the solaredge-diagram-data-scraper node below - select OPTIMIZER under Types to get equivalent per-optimizer data. The diagram-data-scraper node covers everything this node did (and more), using SolarEdge's current authentication.

solaredge-diagram-data-scraper Node

This node collects data from the diagram page of the solaredge monitoring platform for the current day.

The node needs the following inputs as required parameters:

• Username: Your username at https://monitoring.solaredge.com.
• Password: The corresponding password
• Site ID: The ID of your site.

A basic example flow (without InfluxDB formatting) is provided in examples/basicExample.json.

Furthermore, optional parameters can be specified:

• Time Zone Settings *: Choose the time zone of the output data timestamps:
  • UTC: Returns timestamps in UTC time
  • Local: Returns timestamps in local time zone
• Collect Lifetime Energy: Scrapes the monitoring page for the lifetime energy at the time the node is triggered. Note: Lifetime data is not included in the diagram page and needs to be collected separately. Hence, lifetime energy returns only the current value and no time series data. Only for the selected component types lifetime energy will be returned.
• Format For InfluxDB: Returns the data in a format so that it can be directly sent to an InfluxDB batch node from node-red-contrib-influxdb (tested for InfluxDB 2.0). An example flow is provided in examples/diagramDataScraperInfluxDbExample.json. Note: The Time Precision of the InfluxDb batch node has to be set to "Milliseconds (ms)".
• InfluxDB Measurement: In case Format for InfluxDB is checked, the name of the measurement.
• Types: Select the type of components for which data shall be collected. At the time, this includes SITE, INVERTER, STRING, OPTIMIZER, METER, BATTERY
• Parameters: For each selected component type you can choose the parameters that shall be collected.

solaredge-custom-analysis-scraper Node

This node collects data from the same API as SolarEdge's "Custom Analysis" page (/services/cni/ui-api/.../generate-chart). Unlike solaredge-diagram-data-scraper, it supports a configurable measurement interval - the diagram-page API it uses is permanently fixed at 5-minute resolution.

The trade-off: this API uses a different metric-naming scheme than the diagram page (e.g. active_power instead of AC_PRODUCTION_POWER), and a few parameters available on the diagram page have no equivalent here - site-level power values, inverter consumption, KWH_KWP_RATIO, and battery charge/discharge power.

The node needs the same required inputs as solaredge-diagram-data-scraper (Username, Password, Site ID), plus:

• Measurement Interval: Resolution of the returned time series - 5 minutes, 15 minutes, 1 hour or 1 day.
• Legacy Parameter Names: Old solaredge-diagram-data-scraper parameter names (e.g. AC_PRODUCTION_POWER) are always accepted as input on this node too, so switching over doesn't require reselecting parameters you already had configured. By default, however, the output field names (and therefore InfluxDB field names) use this node's new names. Enable this option to have the output use the old names instead, for continuity with data already collected under those field names. Only parameters with a verified old-name equivalent are affected.
• All other options (Time Zone Settings, Collect Lifetime Energy, Format For InfluxDB, InfluxDB Measurement, Types, Parameters) work the same way as on solaredge-diagram-data-scraper, just against this node's own parameter catalog.

Sources / Credits

The scraping code from the layout page is based on this gist and translated from Python to JavaScript. The scraping for the additional information for the optimizer-node was inspired by the youtube video of meintechblog.de

Credits to @waltterli for finding a way to collect the data from the diagram page. This node would not exist without you :).

License

MIT