home-energy-optimizer
Makes a home's energy devices work together.
A home's distributed energy resources (DERs) — a battery, an EV charger, a hot-water tank, a heat pump, solar panels — often come from different makers, and each optimises for itself. Planned one at a time they work against each other: two batteries charge into the same solar surplus and import to do it; the water heater runs from the grid while the battery could have covered it.
home-energy-optimizer lets them cooperate. Each device keeps its own model and its own optimiser — a linear or quadratic programme, a dynamic programme, a manufacturer's black box — and answers the same few questions through one interface. A coordinator turns the answers into one plan for the whole house, around solar output, tariffs and grid limits:
- Dantzig–Wolfe, the default, blends the devices' plans in a small linear programme and bounds how far the result can be from the best possible plan.
- ADMM steers the devices with one shared price, and needs no LP solver.
The house reaches a better outcome than its devices would alone, and the saving is split among the solar and each device by what it contributed, so every device is fairly rewarded for cooperating. No single solver is the point: each device uses whichever answers its questions best. A dynamic programme, for instance, suits a device with one state variable and also gives a policy for every state; a linear programme solves a battery exactly.
flowchart LR
M["Dantzig–Wolfe coordinator<br/>an LP over the meter, the grid limits and the batteries<br/>picks the cheapest blend of offers"]
D["Each other device (tank, heat pump, EV)<br/>its best plan at those prices,<br/>by its own solver"]
M -- "prices, one per slot" --> D
D -- "offers: a plan and its private cost" --> M
M -.-> R(["one plan per device,<br/>with a bound on how far it is from the best"])
flowchart LR
T["Every device, in parallel<br/>its cheapest plan near a target,<br/>by its own solver"]
H["ADMM coordinator (the house)<br/>averages the imbalance,<br/>raises the price where it persists"]
T -- "plans" --> H
H -- "imbalance and price" --> T
H -.-> R(["the best runnable plan, polished"])
It feeds Home Assistant and
evcc. Try it in your browser:
Smart Home Energy Optimizer.
The theory, with the evidence behind every number, is in
docs/theory.pdf. The Python package is
home-energy-optimizer (import home_energy_optimizer).
Install
git clone https://github.com/ameetdesh/home-energy-optimizer && cd home-energy-optimizer
python3 -m venv .venv
.venv/bin/pip install -e . # numpy only
scipy is needed only for the benchmarks in bench/:
.venv/bin/pip install -e ".[test]" scipy
.venv/bin/python -m pytest # the full suite; a few reference checks skip without scipy or osqp
Theory notes
docs/theory.pdf sets out the problem, the device interface
and both coordinators, with the evidence behind every number. It is built from
docs/theory.tex:
tools/build-theory # -> docs/theory.pdf
tools/build-theory --figs # regenerate docs/figs/ first (needs the bench extras)
It uses tectonic if installed (it
fetches missing LaTeX packages itself), else latexmk, else three pdflatex
passes.
The single-file browser pages rebuild with admm/wasm/build.sh and
dw/wasm/build.sh, which embed the Python with tools/make_standalone.py and,
if one has been built (wasm/build_wheel.sh, needs Docker), the compiled-kernel
wheel. The embedded Python is obfuscated; that is kept as a proof of concept,
since the source is here.
Three ways to use it
1. As a library
Plan a site, then act between plans from the battery's own solver - here its
dynamic programme, whose value function answers "what now, from this state?"
without a re-solve. plan() (below) picks the coordinator.
from home_energy_optimizer import (
SiteConfig, BatteryConfig, Horizon, PolicySnapshot,
coordinate, demo_forecasts, action, marginal_value, reservation_prices,
)
site = SiteConfig(horizon=Horizon(dt=0.25, hours=48.0),
battery=BatteryConfig(capacity_kwh=10.0),
water_heater=None, hvac=None)
fc = demo_forecasts(site.horizon, tariff="dynamic")
# Slow tier: solve on the cadence forecasts actually change (15 min is fine)
result = coordinate(site, fc)
snap = PolicySnapshot.from_result(site, fc, result)
snap.save("policy.npz")
# Fast tier: a process that never runs the solver
snap = PolicySnapshot.load("policy.npz")
t = snap.step_for(hours_from_start=6.5)
action(snap, t, soe=4.2) # kW, + = charge
marginal_value(snap, t, soe=4.2) # λ, currency/kWh
reservation_prices(snap, t, soe=4.2) # {'import_below':…, 'export_above':…}
Safety limits are clamped outside the solver, never left to a penalty term:
from home_energy_optimizer import clamp, HardLimits
safe, bound_by = clamp(action(snap, t, soe), other_load_kw=3.1,
limits=HardLimits(max_import_kw=17.25))
2. Local GUIs: ADMM or Dantzig–Wolfe
There are two testbed UIs, one per coordinator. They use different ports, so both can run at once and be compared on the same settings.
| ADMM coordinator, and the policy/evcc endpoints | Dantzig–Wolfe coordinator, with ADMM as an option (dw/) |
|
|---|---|---|
| start | .venv/bin/python admm/gui/server.py |
.venv/bin/python dw/gui/server.py |
| opens | http://127.0.0.1:8765 | http://127.0.0.1:8766 |
| needs | numpy | numpy (the DW master uses the built-in solver in src/home_energy_optimizer/dw/lpsolver.py; scipy only for the optional HiGHS cross-check) |
| shows | ADMM iterations, λ, policy replay on hover | column-generation iterations, lower bound, meter price π, λ from the master |
# terminal 1 - ADMM
.venv/bin/python admm/gui/server.py # http://127.0.0.1:8765
# terminal 2 - Dantzig-Wolfe
.venv/bin/python dw/gui/server.py # http://127.0.0.1:8766
Both servers open a browser tab on start. Pass --no-browser to the DW server
(dw/gui/server.py 8766 --no-browser) to skip that, and a number to either
to change the port. Stop them with Ctrl-C. Both UIs accept deep links such as
?n_batteries=2&max_import_kw=7&tariff=day_night. The DW UI also accepts
view=relaxed or view=<iteration>. What the DW UI shows, and how to read
it, is in dw/README.md. In the DW UI (and its standalone page) the import
and export prices, the household load and the hot-water draw can be edited:
drag the hourly dots (on the bold lines) on the Prices and Power charts, and it
re-solves on release. The draw is the heat taken from the tank, in kW. Export is kept at
or below import; reset (or a new tariff or horizon) restores the preset.
The room's comfort band is edited the same way on the Room chart: one
low and one high dot per hour, flat 22–26 °C until dragged, with its own
reset under Advanced (a new horizon restores it too).
The same page can plan with ADMM instead (Method), with a slider for its
tether ρ, an "Adapt ρ" switch, each battery's step (its DP or its exact LP) and
a cold or warm start, so the two can be compared on one site.
While a solve runs, the runnable plan, lower bound and gap update after every
iteration (ADMM has no bound). With Batteries in LP off, DW keeps every
plan and smooths prices harder ("auto" pool and smoothing), which closes the
gap several times faster (bench/dw_accel.py).
The rest of this section describes the ADMM UI.
Sliders for capacity, power, efficiency, solar, horizon, number of batteries (1–3) and grid import/export limits; toggles for each device and for PV curtailment. Charts for prices with the no-trade band shaded, battery state of energy, power flows and thermal state.
Hovering the battery chart replays the optimal policy from whatever state the cursor is over, with no re-solve — the value function used directly. Clicking prices a forced action against the optimum.
3. Home Assistant
Publishes the plan and the price signals as HA sensors. Walkthrough below.
Which coordinator plans
from home_energy_optimizer import plan
res = plan(site, fc) # Dantzig-Wolfe (default)
res = plan(site, fc, method="admm") # ADMM (proximal message passing)
res.gap, res.lower_bound # DW only: the plan is within `gap` of the best
res.meter_price # DW only: cost of one more kWh at the meter, per slot
Both return the same CoordinationResult, so PolicySnapshot, Home Assistant
and evcc work unchanged. DW puts plain batteries (and a modulating tank) into a
small LP and lets everything else (on/off tank, HVAC, EVs with a charger
minimum or a SoC goal) bid plans from its own DP. If DW cannot run (an export
price above the import price in some slot), plan() falls back to ADMM and
says why in res.note. docs/theory.tex explains both - the device interface
they share (section 2), each coordinator as a problem and an algorithm (sections
3-4) - and compares them (section 8); bench/run_planners.py reproduces the
comparison.
Home Assistant, from scratch
Step 1 — run Home Assistant
docker run -d --name ha -p 8123:8123 -v "$PWD/ha-config:/config" \
-e TZ=UTC homeassistant/home-assistant:stable
Give it a minute, then open http://localhost:8123.
Step 2 — create an account
Complete the onboarding wizard: create a user, set a location, skip device discovery. Any username and password will do for a local trial.
Step 3 — get a long-lived access token
In Home Assistant: click your user avatar (bottom left) → Security tab → scroll to Long-lived access tokens → Create token. Copy it; it is shown only once.
Step 4 — create the dashboard
HA_TOKEN=<your token> .venv/bin/python tools/ha-lambda-demo/setup_dashboard.py
# -> dashboard ready at http://127.0.0.1:8123/home-energy-optimizer
Doing this explicitly matters: entities published through the REST API are orphan states with no entity-registry entry, and Home Assistant's auto-generated Overview dashboard may not list them. The script creates a dashboard with three views — Trade, Power flows, Thermal — over the websocket API.
Step 5 — stream data into it
HA_TOKEN=<your token> .venv/bin/python tools/ha-lambda-demo/run.py --speed 2
The slow tier plans with Dantzig–Wolfe; add --method admm for ADMM (each re-solve starts from the last one's state).
--speed 2 runs a simulated day in about 12 real minutes, slow enough for the
history graphs to draw curves. --speed 400 is a day in 4 seconds, useful as a
smoke test. Then open http://localhost:8123/home-energy-optimizer.
What lands in Home Assistant
| entity | meaning |
|---|---|
sensor.hems_import_below |
import while the grid price is below this (from the battery's DP) |
sensor.hems_export_above |
export while the grid price is above this (from the battery's DP) |
sensor.hems_lambda |
λ, the value of a stored kWh, with a forecast array |
sensor.hems_worth_running |
run a flexible load while its value/kWh exceeds this |
sensor.hems_battery_action |
battery setpoint now (kW, + = charge) |
sensor.hems_battery_soe |
battery state of energy (kWh, plus soc_percent) |
sensor.hems_import_price |
the prevailing tariff |
sensor.hems_meter_price |
DW: the plan's cost of one more kWh at the meter, whole house (with forecast) |
sensor.hems_plan_gap |
DW: the plan is at most this far from the best possible; unknown under ADMM |
sensor.hems_pv, _load, _net_grid |
power flows (kW) |
sensor.hems_water_heater_temp, _power |
tank temperature and heater draw |
sensor.hems_hvac_temp, _power |
room temperature and HVAC draw |
sensor.hems_outdoor_temp |
outdoor temperature |
Using it in an automation
A load worth about 0.25/kWh to run:
automation:
- alias: Run the dryer when energy is cheap enough
trigger:
- platform: state
entity_id: sensor.hems_worth_running
condition:
- condition: numeric_state
entity_id: sensor.hems_worth_running
below: 0.25 # a kWh currently costs less than it is worth to us
action:
- service: switch.turn_on
target:
entity_id: switch.tumble_dryer
The dryer is modelled nowhere in the optimiser — it just reads a price. That is the point: adding devices does not grow the optimisation.
For a battery you control directly, gate on the band instead:
- condition: template
value_template: >
{{ states('sensor.hems_import_price')|float
< states('sensor.hems_import_below')|float }}
Charting the forecast
sensor.hems_lambda carries a forecast attribute, so ApexCharts works:
type: custom:apexcharts-card
header: {show: true, title: Marginal value of stored energy}
series:
- entity: sensor.hems_lambda
data_generator: |
return entity.attributes.forecast.map(p =>
[Date.now() + p.hours_ahead * 3600000, p.lambda]);
Caveats for the Home Assistant path
- The demo uses synthetic forecasts. Point it at real data with
home_energy_optimizer.feeds(keyless Open-Meteo PV, CSV, or a list from any tariff integration). - States are pushed over the REST API, so they disappear when Home Assistant restarts. A durable deployment wants MQTT discovery or a custom component.
Prices from a battery's dynamic programme
A convenience of one device solver, not the heart of the method. When the battery is solved by a dynamic programme, its value function gives three prices at whatever state the battery is in, which the Home Assistant path publishes between plans (a battery solved as an LP gives its plan, and λ only along it). They are easy to conflate, and not interchangeable.
| formula | answers | |
|---|---|---|
λ marginal_value |
∂V/∂s | what a kWh inside a battery is worth. One per battery |
reservation prices reservation_prices |
λ·η_c / λ/η_d |
the grid prices at which importing or exporting starts to pay |
meter price meter_price |
min(buy, λ/η_d, sell if surplus) |
what one more kWh of consumption costs |
Use the reservation band for trading decisions and the meter price for whether to run a load. The band's width is exactly the round-trip loss, so it is a genuine no-trade region: inside it, holding beats both directions.
Compare the band against the price actually faced — the import tariff while importing, the export price while exporting. A discharge that displaces household load realises the import price, not the export price.
Also supported
evcc. src/home_energy_optimizer/evcc.py implements the optimizer HTTP contract used
by evcc (POST /optimize/charge-schedule), so a local server
can serve its OPTIMIZER_URI endpoint. Handles multiple batteries, loadpoints
modelled as charge-only batteries, per-slot charge demands and state-of-charge
goals, and a charger's minimum power as a semi-continuous floor. docs/PLAN.md
lists what is and is not mapped. Requests are planned with Dantzig–Wolfe: an
EV bids charging plans from its DP, evcc's grid limits are enforced in the
plan, and the response carries an extra _hems_policy_certificate. Start the
server with HEMS_METHOD=admm for ADMM.
Real forecasts. home_energy_optimizer.feeds provides keyless Open-Meteo PV and
temperature, CSV and list ingestion, and measured-value blending — anchoring the
first forecast slot to what was just measured and decaying back over four slots.
Layout
src/home_energy_optimizer/ the package (import home_energy_optimizer)
types.py config + result dataclasses
dp_battery.py battery DP; returns the value function and policy
dp_thermal.py hot-water and HVAC DPs, and their thermostat baselines
coordinate.py plan scoring shared by both coordinators; coordinate() runs ADMM
planner.py plan(): Dantzig-Wolfe (default) or ADMM, one result type
policy.py value function -> actions, prices, counterfactuals
feeds.py real forecast inputs
ha.py Home Assistant publishing
evcc.py evcc optimizer wire contract
profiles.py synthetic forecasts for tests and demos
dw/ Dantzig-Wolfe: coordinator, LP solver, integrate (to HA and evcc),
attribution (who saves what), webapi (the DW app's backend)
admm/ ADMM: coordinator, battery_qp (exact LP battery step),
webapi (the ADMM app's backend and the policy API)
dw/ the DW app: gui/ (server + page), wasm/ (single-file page), design notes
admm/ the ADMM app: gui/ (server + page; also the evcc endpoint), wasm/
wasm/ shared browser-build tooling: the compiled-kernel wheel, keep_names.py
bench/ exact references (continuous LP, joint DP, MILP, duals) and studies
tools/ theory build, page builder, HA dashboard setup, evcc checks
docs/theory.tex theory notes (tools/build-theory makes the PDF)
docs/NOTES.md measured findings
docs/PLAN.md state and next steps
Evidence
All measured; each number and the script behind it is in docs/theory.pdf, Appendix C.
Cooperation pays. For a battery and an on/off water heater over a day, against an exact MILP of the same model (our own formulation, solved with HiGHS), Dantzig–Wolfe captures 98.7–99.4% of the available savings in 0.6–0.7 s and ADMM 97.3–99.1% in 4–8 s. On the Home Assistant demo site (battery, water heater, HVAC) Dantzig–Wolfe captures 98–99% and ADMM 97–98%, and every Dantzig–Wolfe plan carries its certified gap.
Grid limits hold. Dantzig–Wolfe meets a limit exactly or prices and reports the breach; ADMM left at most 5 W over on 72 test sites.
The split is fair. Against the Shapley value, which needs a plan for every coalition, the savings split came within 0.46 (within 0.13 for the batteries) on six test cases, from one extra plan.
The device solvers are accurate. A battery's dynamic programme captures 98.4–99.2% of what its exact LP does; its λ lies within 0.007–0.032/kWh of the LP's dual, and is published with a ±0.04/kWh band.
Licence
MIT; see LICENSE.
Metadata
Release files for home-energy-optimizer 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| home_energy_optimizer-0.1.0.tar.gz | 200.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| home_energy_optimizer-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 343.2 kB
Release files / home_energy_optimizer-0.1.0.tar.gz
| Download URL | home_energy_optimizer-0.1.0.tar.gz |
|---|---|
| Size | 200.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d13e1f76b3f9bc52cba3f69f9cc95b4e95dfcb0b51d534ef1e3584f2d73735c
|
|
BLAKE2b-256 checksum How to use checksums |
cb7fbd49e57172eafc6502d00c1712407e15632059b39248261923c54faf3c8d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / home_energy_optimizer-0.1.0-py3-none-any.whl
| Download URL | home_energy_optimizer-0.1.0-py3-none-any.whl |
|---|---|
| Size | 142.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45742f779fd797f08e3499b5a89cfca2dfa0a1d5951134e2b4fb3fe84b40e826
|
|
BLAKE2b-256 checksum How to use checksums |
a7f6052a293bfecdd44d6a14052bf2485029a091cebb4009b98f152da83f3d22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|