energy-device-gateway

Tool v0.1.0 TypeScript MIT

Friendly self-hosted gateway for watching local energy data in a browser and forwarding it to IAMMETER-compatible services.

View on GitHub Docs →
energy-device-gateway

energy-device-gateway

energy-device-gateway is a self-hosted energy gateway you can run on a NAS, a mini PC, or a Docker host. It connects to supported meters and inverters on your local network, shows the readings in a clean browser dashboard, and can forward the same data to IAMMETER-compatible services.

The goal is simple: make local energy data easier to collect, easier to watch, and easier to reuse without turning your setup into a full DIY software project.

energy-device-gateway live dashboard

The live view is built for everyday checking, not just debugging. You can quickly see:

  • current power and energy flow
  • phase-by-phase readings
  • whether the source device is online
  • what payload is being prepared for upload
  • recent runtime events in one place

Why People Would Choose It

Choose energy-device-gateway when you want the flexibility of software instead of a dedicated embedded device.

It is a good fit if you want:

  • one browser-based control panel for your local energy data
  • a login-protected setup that feels more like a home service than a firmware tool
  • easier backup because settings and uploads live on normal storage
  • deployment on hardware you already have, such as a NAS or small Linux box
  • a cleaner path for testing, tweaking, and expanding your setup over time

Gateway Or Edge?

energy-device-gateway and energy-device-edge solve a similar problem, but they are meant for different homes and different habits.

Choose energy-device-gateway if you prefer:

  • Docker or server-style deployment
  • richer browser access
  • persistent storage on a normal filesystem
  • managing the system like a home service

Choose energy-device-edge if you prefer:

  • a small dedicated device near the meter
  • an ESP32-C3 appliance-style deployment
  • Wi-Fi recovery and OTA firmware flow on embedded hardware

Supported Device Families

Right now the gateway focuses on a small, practical set of local devices:

  • IAMMETER WEM3080T
  • Fronius SunSpec inverters
  • Shelly Pro 3EM

That small scope is deliberate. The aim is to keep setup clear and predictable instead of advertising a long compatibility list that is hard to trust in real homes.

Getting Started

You do not need special hardware to try energy-device-gateway. If you already have a NAS, a mini PC, or any small Linux machine that can run Docker or Node.js, that is usually enough.

The simplest first run looks like this:

  1. Pick the machine that will stay on your network.
  2. Start the gateway there.
  3. Open the web page in your browser.
  4. Enter the address of your meter or inverter.
  5. Choose where the normalized data should go.

For people who want the fastest path, a Docker-style run is often the most convenient:

docker build -t energy-device-gateway .
docker run --rm -p 8080:8080 energy-device-gateway

After the service starts, open:

  • http://127.0.0.1:8080

If it is running on another machine, replace 127.0.0.1 with that device's LAN address.

energy-device-gateway settings view

The settings screen is where most people will spend their setup time. It brings the important pieces together in one place:

  • source device type
  • device address on the LAN
  • upload destination
  • administrator password and access control
  • service controls when you need to restart or reset

What Setup Feels Like In Practice

For a typical home or lab install, the setup is closer to configuring a small web app than flashing a firmware image.

You normally:

  • decide where the service should live
  • point it at one supported device
  • check the live dashboard to confirm readings look right
  • enable upload only after you trust the local data

That order matters because it keeps the experience friendly. You can confirm the basics locally before worrying about cloud targets, automation, or long-term hosting.

Day-To-Day Use

Once the gateway is running, most of the ongoing work is simple:

  • glance at the live dashboard when you want to confirm the source device is healthy
  • open settings only when the source address, upload target, or password needs to change
  • keep the host running so the gateway can continue polling in the background

The project is designed to feel stable and quiet in normal use. It should not demand attention every day.

What You Can Change Later

The configuration model stays practical and homeowner-friendly. You can adjust:

  • which supported device family the gateway reads from
  • the local network address of that device
  • where normalized payloads should be uploaded
  • password protection for the browser console
  • runtime behavior such as polling and upload timing

Best Fit

energy-device-gateway is especially useful when you want to build a dependable local monitoring layer first, then decide later how much cloud upload, dashboarding, or automation you want on top.

If that sounds too heavy for your setup, energy-device-edge may be the better choice. If you want the flexibility of software and a full browser-based control surface, energy-device-gateway is the better fit.

← Back to our projects