Plugins 〉Solar Flow
Solar Flow
Solar Flow Visualisation
Solar Flow is a simple animated visualization of solar panel production flow, designed to be displayed as a plugin on a Grafana dashboard.
Installation
- Add the Solar Flow plugin to your Grafana dashboard
- Create a data source of your solar panel production data
- Provide the query for the PV and Grid data in the plugin settings
- Adjust the panel settings to your needs and observe your solar Production/Consumption/Waste ratio on your dashboard
Data Requirements
The plugin is expecting to receive the PV and Grid data in one query. If your data is stored in two separate tables, you can use Grafana's Data-Merge feature to combine them into one query. (Refer to Grafana's documentation for more information)
Options
Our plugin has some options that can be adjusted to your needs:
Solar/Grid Value:
These two are the most important settings in the plugin. They define the fields from your data source that contain the solar panel production and grid energy data. The plugin will use these values to calculate the load energy and visualize the flow of energy. After you provided an appropriate data source and query, you need to choose the Solar and Grid values from the dropdown list.
Zoom
This settings allows you to scale the visualization to your needs.
Offset
Allows you to adjust the offset of the plugin.
Show Legend
Simply toggle to true if you want the load and grid energy points to be labeled for clearer understanding
Color Palette
You can define such colors as:
Solar Color
- the color of the solar panel production flowGrid Color
- the color of the grid energy flowLoad Color
- the color of the load energy flowLines Color
- the color of the lines connecting the points
Final Result (example):
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Development Environment Setup
- Clone the repository
- Run
npm install
to install the dependencies - Run
npm run build
to build the plugin - Run
sudo docker compose up
to start the development environment - Run
sudo npm run dev
to start the actual plugin simultaneously - Open
http://localhost:3000
in your browser and login with the default credentials (admin:admin) - Add a new dashboard and add the Solar Flow plugin to it
- Create a new data source and provide the queries for the solar panel production data. Or create a grafana test data source
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Solar Flow on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Panel
Use the grafana-cli tool to install Solar Flow from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
Changelog
1.0.0 (Unreleased)
Initial release.