All Projects → meltaxa → Solariot

meltaxa / Solariot

Licence: mit
Leverage your IoT enabled Solar PV Inverter to stream your solar energy usage data to a real time dashboard.

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to Solariot

Netdata
Real-time performance monitoring, done right! https://www.netdata.cloud
Stars: ✭ 57,056 (+72122.78%)
Mutual labels:  influxdb, iot, dashboard
Dashboard
🌟 Create IoT applications. Wire devices together regardless their brand or technology.
Stars: ✭ 283 (+258.23%)
Mutual labels:  iot, dashboard
Fuxa
Web-based Process Visualization (SCADA/HMI/Dashboard) software
Stars: ✭ 262 (+231.65%)
Mutual labels:  iot, dashboard
Ockam
End-to-end encrypted messaging and mutual authentication between cloud and edge-device applications
Stars: ✭ 395 (+400%)
Mutual labels:  influxdb, iot
Pfsense Dashboard
A functional and useful dashboard for pfSense that utilizes influxdb, grafana and telegraf
Stars: ✭ 208 (+163.29%)
Mutual labels:  influxdb, dashboard
telemetry collector
build telemetry software stack for Cisco nx-os, support both telemetry dial-out and gNMI dial-in
Stars: ✭ 39 (-50.63%)
Mutual labels:  influxdb, telemetry
Cernan
telemetry aggregation and shipping, last up the ladder
Stars: ✭ 306 (+287.34%)
Mutual labels:  influxdb, telemetry
Platypush
A versatile and extensible platform for home and life automation with hundreds of supported integrations
Stars: ✭ 192 (+143.04%)
Mutual labels:  iot, dashboard
Datastream.io
An open-source framework for real-time anomaly detection using Python, ElasticSearch and Kibana
Stars: ✭ 814 (+930.38%)
Mutual labels:  iot, dashboard
Junos monitoring with healthbot
Healthbot configuration examples. Scripts to manage Healthbot. Closed loop automation. Healthbot building blocks description and troubleshooting guide
Stars: ✭ 17 (-78.48%)
Mutual labels:  influxdb, telemetry
Pgwatch2
PostgreSQL metrics monitor/dashboard
Stars: ✭ 960 (+1115.19%)
Mutual labels:  influxdb, dashboard
Grafana
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
Stars: ✭ 45,930 (+58039.24%)
Mutual labels:  influxdb, dashboard
Unifi Poller
Application: Collect ALL UniFi Controller, Site, Device & Client Data - Export to InfluxDB or Prometheus
Stars: ✭ 1,050 (+1229.11%)
Mutual labels:  influxdb, dashboard
kotori
A flexible data historian based on InfluxDB, Grafana, MQTT and more. Free, open, simple.
Stars: ✭ 73 (-7.59%)
Mutual labels:  influxdb, telemetry
Chronograf
Open source monitoring and visualization UI for the TICK stack
Stars: ✭ 1,245 (+1475.95%)
Mutual labels:  influxdb, dashboard
Openremote
100% open-source IoT Platform - Integrate your assets, create rules, and visualize your data
Stars: ✭ 254 (+221.52%)
Mutual labels:  iot, dashboard
Angular5 Iot Dashboard
Multipurpose dashboard admin for IoT softwares, remote control, user interface. Develop your client dashboards in Angular 5 with vast variety of components available.
Stars: ✭ 148 (+87.34%)
Mutual labels:  iot, dashboard
Smarthome Tutorial
🎓 Tutorial: smart-home dashboard UI concept.
Stars: ✭ 190 (+140.51%)
Mutual labels:  iot, dashboard
Ceph Dash
Flask based api / dashboard for viewing a ceph clusters overall health status
Stars: ✭ 398 (+403.8%)
Mutual labels:  influxdb, dashboard
Solarthing
Monitors an Outback MATE and a Renogy Rover - MPPT Charge Controller. Integrates with Grafana, PVOutput and more!
Stars: ✭ 33 (-58.23%)
Mutual labels:  influxdb, dashboard

Solariot

Leverage your IoT enabled Solar PV Inverter to stream your solar energy usage data to a real time dashboard.

Solariot will connect directly to your Inverter using Modbus TCP.

Currently, Solariot is able to talk to a SMA Sunny Boy and Sungrow SH5K & SG5KD inverters. Solariot is designed to allow any Modbus TCP enabled inverter to be queried using a Modbus register map.

Data is collected and can be streamed to destinations like dweet.io, MQTT, InfluxDB or PVOutput. To visual the telemetry, use a dashboard such as Grafana. For example, this is Meltaxa's Grafana dashboard on solarspy.live:

Pre-requisites

  • The Inverter must be accessible on the network using TCP.

  • This Python script should work on most Inverters that talk Modbus TCP. You can customise your own modbus register file.

  • Run on Python 3.5+.

Installation

  1. Download or clone this repository to your local workstation.

    git clone https://github.com/meltaxa/solariot.git
    cd solariot
    
  2. Install the required libraries.

    pip install -r requirements.txt
    
  3. Update the config.py with your values, such as the Inverter's IP address, port, inverter model (which corresponds to the modbus register file) and the register addresses Solariot should scan from. Enable optional support for MQTT, PVOutput, InfluxDB and more.

  4. Run the solariot.py script.

    ./solariot.py
    
    • Command line options:
    -c             Python module to load as our config. Default is config.py.
    -v             Level of verbosity 0=ERROR 1=INFO 2=DEBUG.
    --one-shot     Run solariot just once then exit.
    

Docker

  1. Create a directory for the config file [config.py].

  2. Create a config.py (see config-example.py) and place it in the config directory.

  3. Run the Docker image with the volume switch to mount your config directory as /config in the image

    • docker run -v <localpath>:/config meltaxa/solariot

Next Steps

Now that you are collecting the inverter's data, you'll want to ultimately display it in a dashboard as seen above.

There are many methods to stream the data. Here are a couple options, which both can be enabled in Solariot. Let me know if you have other methods, such as MQTT as the pub/sub service or another IoT Time Series database.

Dweet.io and Freeboard

This is the quickest method and is a good place to start.

Metrics are streamed to dweet.io a free IoT messaging service. No sign up is required. All you need to do is create a unique identifier by updating the dweepy_uuid value in the config.py file.

Data can then be visualised using a free dashboard service from Freeboard. You'll need to create your own dashboard, using dweet.io as your data source.

MQTT Support

This is a good way to push data to MQTT topics that you might subscribe various tools such as Node-Red or Home Assistant to. Running your own MQTT server will mean you can also retrieve these values when your internet is offline.

All you need to do is to set the mqtt_server, mqtt_port, mqtt_username, mqtt_password and mqtt_topic values in config.py file and you'll be up and running.

InfluxDB and Grafana

Use a time series database such as InfluxDB to store the inverter data as it streams in. You'll need to install this on your own server.

To display the data in real time dashboard, you can use Grafana to pull the metrics from InfluxDB. You can either install your own Grafana server or use their free Grafana hosted solution.

A json export of solarspy.live Grafana dashboard is available under the grafana folder. The file will require editing to match your InfluxDb settings.

PVOutput.org

We offer direct integration to publishing metrics to the 'Add Status' API endpoint of PVOutput.

Supported values are v1 through to v6 and an assumption that v1 and v3 are values are incremental and reset every day.

All you need to do is set the pvoutput_api, pvoutput_sid and pvoutput_rate_limit values in config.py file and you'll be publishing in no time!

Integration with PVOutput.org and Grafana

If you are using Grafana as your dashboard, a neat little trick is to then incorporate your Grafana panels with your PVOutput as system photos. From your PV Ladder page, click on your photos to view the real time Grafana images:

alt tag

  1. Obtain your Grafana panel direct link, see their documentation: http://docs.grafana.org/reference/sharing/#direct-link-rendered-image.

  2. In your PVOutput "Edit System" page, add your Grafana panel link in the "Image Link" field. Append "&png" to the link. Note, if the URL is longer than 100 characters, use a URL shortener service instead (such as https://goo.gl). Don't forget to append the "&png" string to your URL.

  3. Now go to your system in the PV Ladder page and click on the photos.

💡 Tip: You can add any URL image, such as the latest weather radar image 😉

Contributions

If you have created a modbus register map for an inverter, please submit your file as a pull request for Solariot inclusion.

Acknowledgements

  • michael-robbins for Docker support, modbus contrib and other improvements.
  • rpvelloso for the SungrowModbusTcpClient class that enables decryption of comms.
  • ShogunQld for the SMA Sunnuyboy modbus map.
  • zyrorl for MQTT support contrib.
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].