# Helio

> Helio is a free, open-source (MIT) web dashboard for rooftop solar systems that use an Eybond WiFi datalogger reporting to the ShineMonitor cloud (the cloud behind the SmartClient app). It shows exact daily units (kWh) read from the inverter's own energy counter, live power, a five-minute power curve for any day, 30-day, yearly and lifetime history, and the money value at the user's own tariff and currency. Each user deploys their own copy to Vercel in about five minutes; there is no database and the ShineMonitor login never reaches the browser.

Key facts:
- Made by Rishi Shah (https://rishishah.in). Source code: https://github.com/byrishi/helio
- Live demo with sample data: https://helio.rishishah.in/demo
- Works with: Eybond / ShineMonitor / SmartClient systems only. Not Solarman, Growatt ShinePhone, SolisCloud, iSolarCloud or FusionSolar.
- Measures generation only, not household consumption or grid import/export, so savings are shown as a range.
- Data updates every five minutes, the stick's reporting interval.
- Cost: free. Runs on Vercel's free plan. Requires a ShineMonitor account.

## Set up

- [Getting started](https://helio.rishishah.in/docs/getting-started): What you need, the five-minute deploy to Vercel, and your first sign-in to your own Helio solar dashboard.
- [Connect the WiFi stick](https://helio.rishishah.in/docs/wifi-stick): Put an offline Eybond WiFi datalogger back on your home WiFi, step by step, until its NET and SRV lights come on.
- [ShineMonitor account](https://helio.rishishah.in/docs/shinemonitor-account): Register on ShineMonitor or SmartClient, add your plant with the stick's PN number, and fix the plant settings.
- [Configuration](https://helio.rishishah.in/docs/configuration): Every Helio setting: logins, tariff, export rate, currency, time zone, custom domain, sharing and updating.

## Understand

- [Accuracy and savings](https://helio.rishishah.in/docs/accuracy-and-savings): Where each number in Helio comes from, why today's units match your inverter, and how savings are worked out.
- [Limitations](https://helio.rishishah.in/docs/limitations): What Helio can't do yet, honestly: supported systems, consumption, the unofficial API, batteries and alerts.
- [Security](https://helio.rishishah.in/docs/security): How Helio protects your dashboard and your ShineMonitor login, and the known gaps you should know about.

## Fix

- [Troubleshooting](https://helio.rishishah.in/docs/troubleshooting): Every Helio and ShineMonitor error message, including ERR_NOT_FOUND_USR, and what to do about each one.
- [FAQ](https://helio.rishishah.in/docs/faq): Short answers about cost, accuracy, data storage, multiple plants, branding and what happens if ShineMonitor changes.

## Build on it

- [API](https://helio.rishishah.in/docs/api): Helio's JSON endpoints for the overview and any single day, with example responses you can build on.
- [Architecture](https://helio.rishishah.in/docs/architecture): How Helio fits together: Next.js, the ShineMonitor client, signed sessions, project structure and local development.

## FAQ

- Is Helio free? Yes. Helio is MIT licensed and runs comfortably on Vercel's free plan. A custom domain is optional.
- Which solar systems does it work with? Any inverter with an Eybond WiFi datalogger that reports to ShineMonitor, the cloud behind the SmartClient app. Many inverters sold in India and elsewhere use one. If the SmartClient app or shinemonitor.com shows your plant, Helio will work.
- Is the number exact? Today's and lifetime units come from the inverter's own counters, the same figures ShineMonitor shows. The curve is sampled every five minutes.
- Do I need a computer running at home? No. The WiFi stick uploads to the cloud on its own and Helio runs on Vercel.
- Does Helio store my data? No. There's no database. It asks ShineMonitor on each visit and keeps the answer for at most a minute.
- Can I use my own electricity rate and currency? Yes. Set defaults when you deploy, or tap Edit rates on the dashboard to change them on any device.
- Is it an official app? No. It's an independent open-source project that reads your data with your own ShineMonitor login.

## Optional

- [Full documentation in one file](https://helio.rishishah.in/llms-full.txt)
- [Source code and README](https://github.com/byrishi/helio)