Skip to content

Instantly share code, notes, and snippets.

@dirkjanfaber
Last active April 27, 2024 19:07
Show Gist options
  • Star 6 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save dirkjanfaber/d83d3224f241ec4abf6f9f119bbee9cc to your computer and use it in GitHub Desktop.
Save dirkjanfaber/d83d3224f241ec4abf6f9f119bbee9cc to your computer and use it in GitHub Desktop.
Solar yield forecasting using forecast.solar

This subflow uses the http request node to fetch solar forecasts for geographical positions, using the API from https://forecast.solar/. Please check their website and consider getting a paid account.

Solar forecast flow

Do note that, on a free account, you are limited in the number of requests to do. Also note that the data only gets updated once every 15 minutes, so there is no reason to query more often. There is rate limiting built in the subflow not to perform requests more than once every 15 minutes.

Configuration

Solar forecast properties

It uses the parameters as described on: http://doc.forecast.solar/doku.php

  • :apikey - personal API key for registered users
  • :lat - latitude of location, -90 (south) … 90 (north); Internal precission is 0.0001 or abt. 10 m
  • :lon - longitude of location, -180 (west) … 180 (east); Internal precission is 0.0001 or abt. 10 m
  • :dec - plane declination, 0 (horizontal) … 90 (vertical); Internal precission is integer
  • :az - plane azimuth, -180 … 180 (-180 = north, -90 = east, 0 = south, 90 = west, 180 = north); Internal precission is integer
  • :kwp - installed modules power in kilo watt peak (kWp)

You can choose between 3 different type of requests. Note that only estimate is available on the free plan.

In case of estimates, one of the following options can be selected:

  • watts - Watts (power) average for the period
  • watt_hours_period - Watt hours (energy) for the period
  • watt_hours - Watt hours (energy) summarized over the day
  • watt_hours_day - Watt hours (energy) summarized for each day

For the graph output there are some extra settings available:

  • Output in kWh - when checked output can be set to kWh instead of Wh
  • Show todays forecast - whether or not to include todays forecast
  • Days to forecast - the number of days to forecast (excluding today). Note that you can not get more days forecasted than your API key allows.
  • Widen graph - widen the graph to only show non-zero values
  • Show day instead of date - Show the day instead of the date in the series

The optional horizon field can be filled out in case an object blocks your solar panels from the sun. See the description here on what numbers to fill out. Leave it empty if you have no objects blocking your panels.

Input

It triggers when injecting a message into the node.

Output

There are two outputs. The first output is an object with the result and a status message stored into the msg.payload.

Most important is the msg.payload.result, which contains the estimated production of the panels. E.g.:

payload: object
  result: object
    2022-11-28: 23
    2022-11-29: 35

The msg.payload.message gives information on how successful the query was, the exitcode of the query and the status of the rate limit (how many queries you have left).

The second output can be directly linked to a line or a bar chart, quickly giving a once-glance overview for the predicted forecast.

Forecast chart

Status

Initially the status of the note will be a blue dot, showing "Unknown limit", as it is unaware of the set ratelmits. After the first request, the returned ratelimit will be put in the text in the form of remaining/limit. If more than half the limit is remaining, the dot will be green. If less then half the limit is remaining, the dot will be yellow. If no limit is left, the dot will turn red. Please keep in mind that the ratelimit will be reset after one hour, so you can send a new request after that hour.

Example: stacked chart

If you have solar panels facing different directions, it might be helpful to have them both together in the same chart.

Example: stacked chart flow

The following (part of) the flow does exactly that. Import this and link it to the second output of the solar forecast node (as in the screenshot):

[{"id":"043b44c03a398e65","type":"ui_chart","z":"d378cf57268ffe49","name":"","group":"c616f24820f867fe","order":9,"width":"24","height":"8","label":"Combined","chartType":"bar","legend":"true","xformat":"HH:mm:ss","interpolate":"linear","nodata":"","dot":false,"ymin":"","ymax":"","removeOlder":1,"removeOlderPoints":"","removeOlderUnit":"3600","cutout":0,"useOneColor":true,"useUTC":false,"colors":["#1f77b4","#aec7e8","#ff7f0e","#2ca02c","#98df8a","#d62728","#ff9896","#9467bd","#c5b0d5"],"outputs":1,"useDifferentColor":false,"className":"","x":950,"y":660,"wires":[[]]},{"id":"8609aef758bafece","type":"change","z":"d378cf57268ffe49","name":"","rules":[{"t":"set","p":"solar.east","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":490,"y":640,"wires":[["1df1050aaf92a8e6"]]},{"id":"fa2b24315e845352","type":"change","z":"d378cf57268ffe49","name":"","rules":[{"t":"set","p":"solar.west","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":490,"y":680,"wires":[["1df1050aaf92a8e6"]]},{"id":"1df1050aaf92a8e6","type":"function","z":"d378cf57268ffe49","name":"Combine multiple inputs","func":"let solar = flow.get('solar') || []\nif (solar.length === 0) {\n  return;\n}\n\nlet series = []\nlet data = []\nlet labels = []\n\nfor (const key in solar) {\n    for (const s in solar[key][0].series) {\n        series.push(solar[key][0].series[s] + ' ' + key)\n    }\n    for (const d in solar[key][0].data) {\n        data.push(solar[key][0].data[d])\n    }\n    // data.push(solar[key][0].data[0])\n    labels = solar[key][0].labels\n\n}\n\nmsg.payload = [{\n    series,\n    data,\n    labels\n    }]\n\nmsg.ui_control = {\n     options: {\n        scales: {\n            xAxes: [{\n                stacked: true\n            }],\n            yAxes: [{\n                stacked: true\n            }]\n        }\n    }\n}\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":730,"y":660,"wires":[["043b44c03a398e65"]]},{"id":"c616f24820f867fe","type":"ui_group","name":"Visualisations","tab":"dbb3a86540d4aef4","order":5,"disp":true,"width":"24","collapse":false,"className":""},{"id":"dbb3a86540d4aef4","type":"ui_tab","name":"Solar predictions","icon":"dashboard","disabled":false,"hidden":false}]

Note that this does take the legend label from the name in the change nodes. Adjust the naming there if you want to use different names.

The reason that above is only part of the flow is to prevent you importing the solar forecast subflow twice.

Example: stacked chart

[
{
"id": "93f485839dfa27a8",
"type": "subflow",
"name": "Solar forecast",
"info": "This subflow uses the http request node to fetch solar forecasts for geographical positions, using the API from https://forecast.solar/. Please check their website and consider getting a paid account.\n\nDo note that, on a free account, you are limited in the number of requests to do. Also note that the data only gets updated once every 15 minutes, so there is no reason to query more often. There is rate limiting built in the subflow not to perform requests more than once every 15 minutes.\n\n# Configuration\n\nIt uses the parameters as described on: http://doc.forecast.solar/doku.php\n\n - `:apikey` - personal API key for registered users\n - `:lat` - latitude of location, -90 (south) … 90 (north); Internal precission is 0.0001 or abt. 10 m\n - `:lon` - longitude of location, -180 (west) … 180 (east); Internal precission is 0.0001 or abt. 10 m\n - `:dec` - plane declination, 0 (horizontal) … 90 (vertical); Internal precission is integer\n - `:az` - plane azimuth, -180 … 180 (-180 = north, -90 = east, 0 = south, 90 = west, 180 = north); Internal precission is integer\n - `:kwp` - installed modules power in kilo watt peak (kWp)\n\nYou can choose between 3 different type of requests. Note that only `estimate` is available on the free plan.\n\n- `estimate` - this is the forecasted estimate that your panels should produce (given the right parameter settings)\n- `history` - historycal data\n- `clear sky` - estimate given if there would be a clear sky tomorrow\n\nIn case of estimates, one of the following options can be selected:\n- `watts` - Watts (power) average for the period\n- `watthours/period` - Watt hours (energy) for the period\n- `watthours` - Watt hours (energy) summarized over the day\n- `watthours/day` - Watt hours (energy) summarized for each day\n\nFor the graph output there are some extra settings available:\n\n- _Output in kWh_ - when checked output can be set to kWh instead of Wh\n- _Show todays forecast_ - whether or not to include todays forecast\n- _Days to forecast_ - the number of days to forecast (excluding today). Note that you can not get more days forecasted than your API key allows.\n- _Widen graph_ - widen the graph to only show non-zero values\n- _Show day instead of date_ - Show the day instead of the date in the series and labels\n\nThe optional _horizon_ field can be filled out in case an object blocks\nyour solar panels from the sun. See the description [here](https://doc.forecast.solar/horizon)\non what numbers to fill out.\nLeave it empty if you have no objects blocking your panels.\n\n# Input \n\nThe input is for triggering the solar forecast request. \nIt triggers when injecting a message into the node.\n\n# Output\n\nThere are two outputs. The first output is an object with the result and a status message stored into the `msg.payload`.\n\nMost important is the `msg.payload.result`, which contains the estimated production of the panels. E.g.:\n\n```\npayload: object\n result: object\n 2022-11-28: 23\n 2022-11-29: 35\n```\n\nThe `msg.payload.message` gives information on how successful the query was, the exitcode of the query and the status of the rate limit (how many queries you have left).\n\nThe **second** output can be directly linked to a line or a bar chart, quickly giving a once-glance overview for the predicted forecast.\n\n# Status\n\nInitially the status of the note will be a blue dot, showing \"_Unknown limit_\", as it is unaware of the set ratelmits. After the first request, the returned ratelimit will be put in the text in the form of `remaining/limit`. If more than half the limit is remaining, the dot will be green. If less then half the limit is remaining, the dot will be yellow. If no limit is left, the dot will turn red.\nPlease keep in mind that the ratelimit will be reset after one hour, so you can send a new request after that hour.\n\nIf something is wrong in the API request, the dot will turn red\nand the message will contain the msg.payload with the error. This\nhappens typically when the API is temporally down for maintenance.",
"category": "",
"in": [
{
"x": 240,
"y": 100,
"wires": [
{
"id": "c8dc6aa14b9f3e92"
}
]
}
],
"out": [
{
"x": 760,
"y": 260,
"wires": [
{
"id": "2f42837904c91d73",
"port": 0
},
{
"id": "fcc8d69a3ab88e6d",
"port": 0
}
]
},
{
"x": 770,
"y": 340,
"wires": [
{
"id": "5b0a430fb61e70e7",
"port": 0
}
]
}
],
"env": [
{
"name": "latitude",
"type": "num",
"value": "51.3",
"ui": {
"icon": "font-awesome/fa-location-arrow",
"label": {
"en-US": "Latitude"
},
"type": "input",
"opts": {
"types": [
"num"
]
}
}
},
{
"name": "longitude",
"type": "num",
"value": "5.6",
"ui": {
"icon": "font-awesome/fa-location-arrow",
"label": {
"en-US": "Longitude"
},
"type": "input",
"opts": {
"types": [
"num"
]
}
}
},
{
"name": "declination",
"type": "num",
"value": "37",
"ui": {
"icon": "font-awesome/fa-chevron-up",
"label": {
"en-US": "Declination"
},
"type": "input",
"opts": {
"types": [
"num"
]
}
}
},
{
"name": "azimuth",
"type": "num",
"value": "0",
"ui": {
"icon": "font-awesome/fa-compass",
"label": {
"en-US": "Azimuth"
},
"type": "spinner",
"opts": {
"min": -180,
"max": 180
}
}
},
{
"name": "modules power",
"type": "num",
"value": "1",
"ui": {
"icon": "font-awesome/fa-power-off",
"label": {
"en-US": "Modules power (kWp)"
},
"type": "input",
"opts": {
"types": [
"num"
]
}
}
},
{
"name": "apikey",
"type": "cred",
"ui": {
"icon": "font-awesome/fa-key",
"label": {
"en-US": "API key"
},
"type": "input",
"opts": {
"types": [
"cred"
]
}
}
},
{
"name": "type",
"type": "str",
"value": "estimate",
"ui": {
"label": {
"en-US": "Type"
},
"type": "select",
"opts": {
"opts": [
{
"l": {
"en-US": "Estimate"
},
"v": "estimate"
},
{
"l": {
"en-US": "History"
},
"v": "history"
},
{
"l": {
"en-US": "Clear sky"
},
"v": "clearsky"
}
]
}
}
},
{
"name": "watt",
"type": "str",
"value": "watts",
"ui": {
"icon": "font-awesome/fa-question-circle-o",
"label": {
"en-US": "Watt"
},
"type": "select",
"opts": {
"opts": [
{
"l": {
"en-US": "Watts (power) average for the period"
},
"v": "watts"
},
{
"l": {
"en-US": "Watt hours (energy) for the period"
},
"v": "watthours/period"
},
{
"l": {
"en-US": "Watt hours (energy) summarized over the day"
},
"v": "watthours"
},
{
"l": {
"en-US": "Watt hours (energy) summarized for each day"
},
"v": "watthours/day"
}
]
}
}
},
{
"name": "kwhoutput",
"type": "bool",
"value": "false",
"ui": {
"label": {
"en-US": "Output in kWh (in the graph)"
},
"type": "checkbox"
}
},
{
"name": "showtoday",
"type": "bool",
"value": "true",
"ui": {
"label": {
"en-US": "Show todays forecast"
},
"type": "checkbox"
}
},
{
"name": "daystoforecast",
"type": "str",
"value": "-1",
"ui": {
"label": {
"en-US": "Days to forecast"
},
"type": "select",
"opts": {
"opts": [
{
"l": {
"en-US": "Max"
},
"v": "-1"
},
{
"l": {
"en-US": "0"
},
"v": "0"
},
{
"l": {
"en-US": "1"
},
"v": "1"
},
{
"l": {
"en-US": "2"
},
"v": "2"
},
{
"l": {
"en-US": "3"
},
"v": "3"
},
{
"l": {
"en-US": "4"
},
"v": "4"
},
{
"l": {
"en-US": "5"
},
"v": "5"
},
{
"l": {
"en-US": "6"
},
"v": "6"
}
]
}
}
},
{
"name": "widengraph",
"type": "bool",
"value": "true",
"ui": {
"label": {
"en-US": "Widen graph"
},
"type": "checkbox"
}
},
{
"name": "showday",
"type": "bool",
"value": "false",
"ui": {
"label": {
"en-US": "Show day instead of date"
},
"type": "checkbox"
}
},
{
"name": "horizon",
"type": "str",
"value": "",
"ui": {
"icon": "font-awesome/fa-tree",
"label": {
"en-US": "(optional) horizon"
},
"type": "input",
"opts": {
"types": [
"str"
]
}
}
}
],
"meta": {
"module": "Solar Forecast",
"version": "0.0.14",
"author": "dfaber@victronenergy.com",
"desc": "Get solar forecasting per location",
"keywords": "solar,forecast,api",
"license": "GPL-3.0"
},
"color": "#FFCC66",
"inputLabels": [
"trigger"
],
"outputLabels": [
"output",
"graph",
""
],
"icon": "font-awesome/fa-sun-o",
"status": {
"x": 680,
"y": 560,
"wires": [
{
"id": "1bfc1cde3ee94e4b",
"port": 0
},
{
"id": "a798fbe66cf133d5",
"port": 0
}
]
}
},
{
"id": "c706820c0d61f023",
"type": "http request",
"z": "93f485839dfa27a8",
"name": "",
"method": "GET",
"ret": "txt",
"paytoqs": "ignore",
"url": "",
"tls": "",
"persist": false,
"proxy": "",
"insecureHTTPParser": false,
"authType": "",
"senderr": false,
"headers": [],
"x": 390,
"y": 180,
"wires": [
[
"1b5ccaa05d54f7c3"
]
]
},
{
"id": "b9488734852cd0ca",
"type": "function",
"z": "93f485839dfa27a8",
"name": "create forecast.solar url",
"func": "msg.url = 'https://api.forecast.solar/';\n\nif (env.get('apikey')) {\n msg.url += env.get('apikey') + '/';\n }\n\nmsg.url += env.get('type') + '/';\n\nmsg.url += env.get('watt') + '/';\n\nmsg.url += env.get('latitude') + '/' +\n env.get('longitude') + '/' +\n env.get('declination') + '/' +\n env.get('azimuth') + '/' +\n env.get('modules power');\n\nif (env.get('horizon')) {\n msg.url += '?horizon=' + env.get('horizon')\n}\nmsg.topic = 'solar forecast: '+(env.get('type') || '');\nmsg.topic += (' '+env.get('watt') || '');\nif (env.get('kwhoutput')) {\n msg.topic += ' (kWh)';\n}\n\nreturn msg;",
"outputs": 1,
"timeout": "",
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 630,
"y": 100,
"wires": [
[
"975daf96f15cfb61"
]
]
},
{
"id": "1b5ccaa05d54f7c3",
"type": "json",
"z": "93f485839dfa27a8",
"name": "Convert to json",
"property": "payload",
"action": "",
"pretty": false,
"x": 680,
"y": 180,
"wires": [
[
"e718a22973cc2864"
]
]
},
{
"id": "559391d1288f762a",
"type": "function",
"z": "93f485839dfa27a8",
"name": "update ratelimit",
"func": "var remaining = msg.payload.message.ratelimit.remaining || 0;\nvar limit = msg.payload.message.ratelimit.limit;\n\nflow.set('forecast.solar.ratelimit.remaining', remaining)\nflow.set('forecast.solar.ratelimit.limit', limit)\n\nreturn msg;",
"outputs": 1,
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 520,
"y": 480,
"wires": [
[
"e56826252134b93a"
]
]
},
{
"id": "e718a22973cc2864",
"type": "link out",
"z": "93f485839dfa27a8",
"name": "link out 1",
"mode": "link",
"links": [
"3fa24f2d08195961",
"0a20e852662c8cec"
],
"x": 815,
"y": 180,
"wires": []
},
{
"id": "3fa24f2d08195961",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 1",
"links": [
"e718a22973cc2864"
],
"x": 385,
"y": 480,
"wires": [
[
"559391d1288f762a"
]
]
},
{
"id": "0a20e852662c8cec",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 2",
"links": [
"e718a22973cc2864"
],
"x": 225,
"y": 260,
"wires": [
[
"fcc8d69a3ab88e6d"
]
]
},
{
"id": "4734b6f403e1f03e",
"type": "inject",
"z": "93f485839dfa27a8",
"name": "",
"props": [
{
"p": "payload"
},
{
"p": "topic",
"vt": "str"
}
],
"repeat": "",
"crontab": "",
"once": true,
"onceDelay": 0.1,
"topic": "",
"payload": "",
"payloadType": "date",
"x": 530,
"y": 440,
"wires": [
[
"e56826252134b93a"
]
]
},
{
"id": "1bfc1cde3ee94e4b",
"type": "function",
"z": "93f485839dfa27a8",
"name": "update status",
"func": "var remaining = flow.get('forecast.solar.ratelimit.remaining') || -1;\nvar limit = flow.get('forecast.solar.ratelimit.limit') || -1\n\nvar text = remaining.toString() + '/' + limit.toString();\nvar fill = \"green\";\n\nif (remaining == 0) {\n fill = \"red\";\n text = \"Limit used\";\n}\n\nif (remaining > 0 && remaining < limit / 2) {\n fill = \"yellow\"\n}\n\nif (remaining == -1 ) {\n fill = \"blue\"\n text = \"Limits unknown\"\n}\n\nmsg.payload = ({ fill: fill, text: text });\n\nreturn msg;",
"outputs": 1,
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 520,
"y": 580,
"wires": [
[]
]
},
{
"id": "a18e96179ec2d987",
"type": "function",
"z": "93f485839dfa27a8",
"name": "Create graph output",
"func": "var m = {};\nm.labels = [];\nm.data = [];\nm.series = [];\n\nfor (let j = 0; j <= msg.days; j++) {\n m.data[j] = [];\n}\n\nif (msg.watt === 'watt_hours_day' || msg.watt === 'watthours/day') {\n var i = 0;\n if (msg.kwhoutput) {\n m.series.push(\"kWh per day\");\n } else {\n m.series.push(\"Watt hours per day\");\n }\n for (const key in msg.payload.result) {\n m.labels.push(key);\n if (msg.kwhoutput) {\n m.data[i] = +(Math.round(msg.payload.result[key]/100)*.1).toFixed(1);\n } else {\n m.data[i] = msg.payload.result[key];\n }\n i++;\n }\n m.data = [m.data];\n return { payload: [m] };\n}\n\nfor (let i = 0; i <= 23; i++) {\n\n m.labels.push(i.toString()+':00');\n if (msg.resolution === 4) {\n m.labels.push(i.toString()+':15');\n }\n if (msg.resolution === 2 || msg.resolution == 4) {\n m.labels.push(i.toString()+':30');\n }\n if (msg.resolution === 4) {\n m.labels.push(i.toString()+':45');\n }\n\n for (let j = 0; j <= msg.days; j++) {\n m.data[j].push(0);\n if (msg.resolution === 4) {\n m.data[j].push(0)\n }\n if (msg.resolution === 2 || msg.resolution == 4) {\n m.data[j].push(0)\n }\n if (msg.resolution === 4) {\n m.data[j].push(0)\n }\n\n }\n}\n\nvar offset = 0;\nfor (const key in msg.payload.result) {\n var d = new Date(key)\n if (m.series.indexOf(d.toISOString().split('T')[0]) === -1) {\n m.series.push(d.toISOString().split('T')[0])\n }\n\n var h = d.getHours();\n var minutes = d.getMinutes();\n\n if (minutes === 0 ) {\n offset = 0;\n } else {\n offset++;\n }\n\n if (msg.kwhoutput) {\n m.data[m.series.length - 1][h*msg.resolution+offset] = +(Math.round(msg.payload.result[key]/100)*.1).toFixed(1);\n } else {\n m.data[m.series.length - 1][h*msg.resolution+offset] = msg.payload.result[key];\n }\n}\n\nif (msg.watt === 'watt_hours') {\n for (const i in m.data) {\n let x = m.data[i][0]\n for (const d in m.data[i]) {\n if ( x > m.data[i][d]) {\n m.data[i][d] = x \n }\n x = m.data[i][d]\n }\n }\n}\n\nreturn { payload: [m] };\n",
"outputs": 1,
"timeout": "",
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 360,
"y": 340,
"wires": [
[
"5b0a430fb61e70e7"
]
]
},
{
"id": "975daf96f15cfb61",
"type": "link out",
"z": "93f485839dfa27a8",
"name": "link out 7",
"mode": "link",
"links": [
"14f2e68e572f4ef8"
],
"x": 805,
"y": 100,
"wires": []
},
{
"id": "14f2e68e572f4ef8",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 18",
"links": [
"975daf96f15cfb61"
],
"x": 245,
"y": 180,
"wires": [
[
"c706820c0d61f023"
]
]
},
{
"id": "c4307905e114824f",
"type": "catch",
"z": "93f485839dfa27a8",
"name": "",
"scope": null,
"uncaught": false,
"x": 260,
"y": 440,
"wires": [
[
"f427f19392c399ce"
]
]
},
{
"id": "e56826252134b93a",
"type": "link out",
"z": "93f485839dfa27a8",
"name": "link out 8",
"mode": "link",
"links": [
"dbaf8f5f5a920686"
],
"x": 685,
"y": 480,
"wires": []
},
{
"id": "dbaf8f5f5a920686",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 19",
"links": [
"e56826252134b93a"
],
"x": 385,
"y": 580,
"wires": [
[
"1bfc1cde3ee94e4b"
]
]
},
{
"id": "f427f19392c399ce",
"type": "link out",
"z": "93f485839dfa27a8",
"name": "link out 9",
"mode": "link",
"links": [
"2ded0c14a222b4d9",
"2f42837904c91d73"
],
"x": 375,
"y": 440,
"wires": []
},
{
"id": "2ded0c14a222b4d9",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 20",
"links": [
"f427f19392c399ce"
],
"x": 385,
"y": 540,
"wires": [
[
"a798fbe66cf133d5"
]
]
},
{
"id": "a798fbe66cf133d5",
"type": "function",
"z": "93f485839dfa27a8",
"name": "Set error status",
"func": "node.warn(msg.payload)\nmsg.payload = ({ fill: \"red\", text: msg.payload });\n\nreturn msg;",
"outputs": 1,
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 520,
"y": 540,
"wires": [
[]
]
},
{
"id": "2f42837904c91d73",
"type": "link in",
"z": "93f485839dfa27a8",
"name": "link in 21",
"links": [
"f427f19392c399ce"
],
"x": 665,
"y": 280,
"wires": [
[]
]
},
{
"id": "fcc8d69a3ab88e6d",
"type": "function",
"z": "93f485839dfa27a8",
"name": "Processed info",
"func": "msg.resolution = 60;\nmsg.days = 1;\nmsg.type = env.get('type');\nmsg.watt = env.get('watt');\nmsg.kwhoutput = env.get('kwhoutput');\n\nvar key1 = Object.keys(msg.payload.result)[1];\nvar key2 = Object.keys(msg.payload.result)[2];\nvar key3 = Object.keys(msg.payload.result)[Object.keys(msg.payload.result).length-1];\n\nvar d1 = new Date(key1);\nvar d2 = new Date(key2); \nvar d3 = new Date(key3);\nmsg.resolution = 3600000 / (d2.getTime() - d1.getTime());\n\nmsg.days = Math.floor((d3.getTime() - d1.getTime()) / (1000 * 3600 * 24));\n\nif (msg.watt === 'watt_hours_day' || msg.watt === 'watthours/day') {\n msg.resolution = null;\n}\n\nreturn msg;",
"outputs": 1,
"timeout": "",
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 360,
"y": 260,
"wires": [
[
"a18e96179ec2d987"
]
],
"info": "Function to process the result from forecast.solar to add\nextra information, which is handy for either graphing or\nto store in a database.\n\n\nThe extra values added:\n- `msg.resolution` - The number of measurements per hour. If\nno API key is used, this will be 1. Other values may be 2 or 4.\n- `msg.days` - The number of days in the forcast. If no API\n- key is used this will be 1. Other values may be 3 or 6."
},
{
"id": "5b0a430fb61e70e7",
"type": "function",
"z": "93f485839dfa27a8",
"name": "Filter graph",
"func": "\nif (env.get('showday')) {\n const weekday = [\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"];\n msg.payload[0].labels.forEach(function (/** @type {string | number | Date} */ date, /** @type {string | number} */ index, /** @type {{ [x: string]: string; }} */ array) {\n const d = new Date(date)\n if (!isNaN(d)) {\n array[index] = weekday[d.getDay()]\n }\n })\n msg.payload[0].series.forEach(function (/** @type {string | number | Date} */ date, /** @type {string | number} */ index, /** @type {{ [x: string]: string; }} */ array) {\n const d = new Date(date)\n if (!isNaN(d)) {\n array[index] = weekday[d.getDay()]\n }\n })\n}\n\nif (env.get('watt') === 'watt_hours_day' || env.get('watt') === 'watthours/day') {\n if (!env.get('showtoday')) {\n msg.payload[0].data[0].shift();\n msg.payload[0].labels.shift();\n }\n return msg;\n}\n\nif (!env.get('showtoday')) {\n msg.payload[0].data.shift();\n msg.payload[0].series.shift();\n}\n\nvar forecasted = msg.payload[0].series.length;\n\nif ((Number(env.get('daystoforecast')) > -1) && (Number(env.get('daystoforecast')) < forecasted)) {\n for (let i = 1; i <= (forecasted - Number(env.get('daystoforecast'))); i++ ) {\n msg.payload[0].data.pop();\n msg.payload[0].series.pop();\n }\n}\n\nif (env.get('widengraph')) {\n var c = msg.payload[0].labels.length;\n var x = 0;\n for (let i = 0; i < c; i++) {\n var remove = true;\n for (let d = 0; d < msg.payload[0].data.length; d++) {\n if (msg.payload[0].data[d][x] > 0) {\n remove = false;\n }\n }\n if (remove) {\n msg.payload[0].labels.splice(x, 1);\n for (let d = 0; d < msg.payload[0].data.length; d++) {\n msg.payload[0].data[d].splice(x, 1);\n }\n x--;\n }\n x++;\n }\n // Still the first and last datapoints should be zero, so\n // add those again\n msg.payload[0].labels.unshift('');\n msg.payload[0].labels.push('');\n for (let d = 0; d < msg.payload[0].data.length; d++) {\n msg.payload[0].data[d].unshift(0);\n msg.payload[0].data[d].push(0);\n } \n}\n\nreturn msg;",
"outputs": 1,
"timeout": "",
"noerr": 0,
"initialize": "",
"finalize": "",
"libs": [],
"x": 590,
"y": 340,
"wires": [
[]
]
},
{
"id": "c8dc6aa14b9f3e92",
"type": "delay",
"z": "93f485839dfa27a8",
"name": "1 msg/15 minutes",
"pauseType": "rate",
"timeout": "5",
"timeoutUnits": "seconds",
"rate": "1",
"nbRateUnits": "15",
"rateUnits": "minute",
"randomFirst": "1",
"randomLast": "5",
"randomUnits": "seconds",
"drop": false,
"allowrate": false,
"outputs": 1,
"x": 390,
"y": 100,
"wires": [
[
"b9488734852cd0ca"
]
]
},
{
"id": "5fdbadbaa356f79d",
"type": "subflow:93f485839dfa27a8",
"z": "d378cf57268ffe49",
"name": "East - Watt hours (energy) summarized for each day",
"env": [
{
"name": "declination",
"value": "15",
"type": "num"
},
{
"name": "azimuth",
"value": "-90",
"type": "num"
},
{
"name": "modules power",
"value": "7.830",
"type": "num"
},
{
"name": "apikey",
"type": "cred"
},
{
"name": "watt",
"value": "watthours/day",
"type": "str"
},
{
"name": "kwhoutput",
"type": "bool",
"value": "true"
},
{
"name": "showday",
"type": "bool",
"value": "true"
}
],
"x": 520,
"y": 60,
"wires": [
[],
[
"595c17ba9e21e1af",
"f491f6591a2cc87a"
]
]
}
]
@dirkjanfaber
Copy link
Author

dirkjanfaber commented Mar 30, 2024

@Fishbowl1974 : I've just updated the flow with a proper fix. Also generating the graphs should now work again for the Watt hours (energy) summarized for each day selection.

@Fishbowl1974
Copy link

Thanks for the update, all the best. Cheers

@QBANIN
Copy link

QBANIN commented Apr 8, 2024

Hi! Is there any way to make all properties dynamic, msg. based?

EDIT: Never mind, I changed it myself :P

@johngb1234
Copy link

Hello, thanks very much for writing this. Please forgive the newbie questions but I can't seem to get the flow to work, i am encountering the same error as @Fishbowl1974 above.
image
I would like to keep things very simple to start with and use the Forecast.Solar prediction to compare to the Victron one, I don't need the graph function for now.
thank you

@dirkjanfaber
Copy link
Author

@johngb1234 I only notice one output on that "South roof panels" node. That leads me to believe that your subflow is either very old or otherwise broken.
I suggest deleting the subflow and re-importing it (unfortunately there is no way to simply update a subflow from node-red; at least not one that I know of). In order to do so, you need to double-click on the subflow in the right menu and then on the "delete subflow" on the top and confirm.
image

After that, you can re-import the subflow again from https://gist.githubusercontent.com/dirkjanfaber/d83d3224f241ec4abf6f9f119bbee9cc/raw/70f7a00645bd74950c37f09a0c10611e5d79b822/flow.json by copy / pasting all the text in the import box (ctrl-i from node-red)

@johngb1234
Copy link

OK thanks very much Dirk. I have deleted and re-imported and I think it's clean but still receiving the same error:
image

@dirkjanfaber
Copy link
Author

@johngb1234 Can you show a screenshot of the subflows edit panel?

@johngb1234
Copy link

Thanks for the quick response.
image
image

@dirkjanfaber
Copy link
Author

I did mean a screenshot of the actual edit panel (when you double click on the subflow). Like this:
image

@johngb1234
Copy link

Ah, sorry:
image

@dirkjanfaber
Copy link
Author

This is a hard one to trace remotely. I am getting data back with exactly the same values filled out as you.

image

I am sure the warning comes from Set error status node that got triggered by the catch:all in the subflow.

image

But am a in the dark on what causes that. What version of Node-RED are you running? I tested on 3.0.2.

@johngb1234
Copy link

Thanks again for looking into this. 3.1.5 I think?
image

@losttoo
Copy link

losttoo commented Apr 27, 2024

@dirkjanfaber. Hi, I experienced the same problem as @Fishbowl1974 and @johngb1234. The error disappeared after disabling (using //) the API call in the function node "create forecast.solar url", line 3, 4 and 5.

After doing so the node started working again. It seems that when using Solar Forecast's free option (not using an api) causes a conflict within the node. Hope this helps.

Pic 1 Pic 2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment