franklinwh-ha-cloud-analytics

The FranklinWH cloud's energy reporting, shared by the FranklinWH bridges. It sits next to a bridge's own (local) analytics behind a Local / Cloud switch: the same controls, two different sources, and the page always says which one it is showing.

• Periods: Day (5-min), Day (hourly), Week, Month, Year, Lifetime, with a date picker, ‹ › stepping and Today.
• Filters: a chip per series to show or hide it; Line | Area | Bars for any period; stacked bars as an energy balance. All remembered in the browser.
• Readout: hover or tap the chart for every value at that time.
• Chart: home load, solar, battery (discharge +, charge −) and grid (import +, export −) in the site's time zone.
• Totals: solar production (to home, battery, grid), battery flows (discharged by destination, charged by source), grid flows (imported / exported) and home load (by source), each value with how sure the source is of it.
• History: imported into the bridge's own database (closed months once, the current month refreshed) for monthly, annual and lifetime totals, queries and download.

Status: phase 1 (periods, chart payload, panel). The phased plan is in direct-connect-bridge #215.

How a bridge uses it

The bridge keeps the cloud credentials, its routes and its database. This package makes the cloud calls through franklinwh-cloud, builds one payload per period, and ships a dependency-free panel the bridge mounts under its Analytics page.

import franklinwh_ha_cloud_analytics as ca

cache = ca.Cache()                       # one per bridge; keyed by gateway below

# GET /api/analytics/cloud?period=month&date=2026-11-05
payload = await ca.fetch(client, "month", date(2026, 11, 5), today=site_today,
                         cache=cache, key=gateway_id)

client is a logged-in franklinwh-cloud client for the gateway, and site_today is today's date in the site's own time zone. Serve ca.static_dir() at /cloud-analytics/, then:

<link rel="stylesheet" href="cloud-analytics/cloud-analytics.css">
<script src="cloud-analytics/cloud-analytics.js"></script>
<script>FWHCloudAnalytics.mount(el, {endpoint: "api/analytics/cloud",
                                    params: () => ({gateway: currentGatewayId})});</script>

mount() returns {reload(), exportData("csv" | "json"), setPeriod(p), period()}. A host with one period picker for its local and cloud views passes {periodPicker: false, period: p}, calls setPeriod(p) (or setPeriod(p, date) to move the day in the same read) from its picker and remembers the period itself; the panel then draws no picker. FWHCloudAnalytics.PERIODS lists the periods as [value, label]. The host puts the export buttons where its own analytics has them; exportData downloads the shown period (fwh-cloud-<period>-<date>.csv), every series the cloud returned, empty where it has none. Likewise {stackControl: false, stacked} + setStacked() and {navControl: false, date} + setDate() / date() hand over the Stack toggle and the date stepping; --ca-grid sets the grid lines' colour and --ca-menu-bg sets the Details menu's background. A host with its own Line | Area | Bars passes {styleControl: false, style: s} and calls setStyle(s) (null = automatic); style() returns the style drawn. {height: 380} draws the chart that many pixels tall at any width (default 260, 220 on a phone), so it can match the host's own chart.

python -m franklinwh_ha_cloud_analytics.demo serves the panel over made-up data.

Periods

A Day request to get_power_details returns a single bucket, so both Day views read the 5-minute power. There, home, battery and grid are sums of the cloud's directional flows (solar → home, grid → battery, …), so they're marked derived (≈). Every series carries the weakest evidence rating of the fields it uses (franklinwh-cloud's field dictionary); INFERRED ones are labelled. Both Day views also draw the battery's state of charge (socArray) as a dashed line on its own 0–100 % axis at the right; the cloud's Week to Lifetime totals have no SoC. The cloud's other fields with data for the period (home from solar, grid and battery; battery charged from solar and grid; export from solar and battery; the 5-minute flows on a day) are listed under Details ▾; ticking one gives it a chip; fields with no data get none, but the payload's raw and the JSON export keep every array the cloud returned. The payload's flows is the period's kWh per arc (solar → home, battery → grid, …) for a Sankey, from the cloud's own breakdown (a day: the 5-minute flows). No data stays null, never 0. Signs: battery discharge +, charge −; grid import +, export −.

Caching: a period that today falls in is kept for 5 minutes, a finished one for 6 hours. The cloud's rate limit is per account, shared with the FranklinWH app.

Licence

MIT