Skip to content

Latest commit

 

History

History
476 lines (306 loc) · 34.2 KB

RELEASE.md

File metadata and controls

476 lines (306 loc) · 34.2 KB
Raw

RELEASE NOTES

v4.4.5 - PW3 Updates

  • Powerwall 3 Setup Help - If local setup is selected, it will work with the Powerwall 3 but will produce errors in pypowerwall and not have the complete data. This updates setup.sh so ensure Powerwall 3 setups use full TEDAPI mode for local access. Raised by @pavandave in jasonacox#492.
  • Add check in setup.sh script to ensure user has permission to write to the current directory. Raised in jasonacox#494.
  • Update to latest pypowerwall, updates TEDAPI to provide correct Powerwall firmware version. Discovered by @geptto in jasonacox/pypowerwall#97. This function has been integrated into pypowerwall existing APIs and proxy features.

v4.4.4 - Bug Fixes

  • Fix setup.sh gateway detection logic to better work on Synology and other host without user ping commands as raised by @zcpnate in #488
  • Update to pypowerwall 0.10.6: pyLint code optimization, fix timeout logic for TEDAPI and FleetAPI modes, fix battery backup reserve level scaling for TEDPAI mode, fix grid status bug in FleetAPI mode and fix control mode error in proxy.

v4.4.3 - Minor Fixes

  • Update to pypowerwall 0.10.5:

    • Fix for TEDAPI "full" (e.g. Powerwall 3) mode, including grid_status bug resulting in false reports of grid status, level() bug where data gap resulted in 0% state of charge and alerts() where data gap from tedapi resulted in a null alert.
    • Add TEDAPI API call locking to limit load caused by concurrent polling.
    • Proxy - Add battery full_pack and remaining energy data to /pod API call for all cases.

v4.4.2 - Powerwall 3 Local Support

  • Update to pypowerwall v0.10.4 to add support for Powerwall 3 using local Gateway only.
  • Setup script adjusted to allow for Powerwall 3 local mode option.

v4.4.1 - FleetAPI Hotfix

  • Update to pypowerwall v0.10.2 to fix FleetAPI setup but as raised in jasonacox/pypowerwall#98.
  • Update setup.sh to add optional command line switch -f for standalone FleetAPI mode setup.

v4.4.0 - FleetAPI and TEDAPI

  • Add TEDAPI Support for Extended Device Metrics (the return of most of /vitals) - This requires connecting to Powerwall WiFi directly or setting up a network route on the Dashboard host to allow it to reach the GW address (192.168.91.1).

  • Add support for Tesla's official API, FleetAPI. This requires additional registration and configuration. Instructions are part of setup process or on the project page.

  • Run upgrade.sh and then run setup.sh to choose these new options.

  • Upgrade to pyPowerwall v0.10.0 proxy t58 - Release addresses some issues, including fixing Solar Only grid_status issues as reported by @lsgc123 in jasonacox#478

  • Fix setup.sh for docker group permission bug identified by @hulkster in #476

  • Addresses several open issues and discussions:

v4.3.2 - Solar Only Fix

  • Upgrade to pyPowerwall v0.8.5 proxy t56
  • Fix bug with setup for certain Solar Only systems where clod mode process fails due to missing site_name. Identified by @hulkster in jasonacox#475

v4.3.1 - Control APIs

  • Upgrade to pyPowerwall v0.8.4 proxy t55
  • Fix /pod API to add time_remaining_hours and backup_reserve_percent for cloud mode.
  • Dashboard: Removed Powerwall temperature panel in default dashboard (data is no longer available with latest Firmware)
  • Added GET /control/mode and /control/reserve APIs to retrieve operating mode and back reserve settings
  • Added POST /control/mode and /control/reserve APIs to set operating mode and back reserve settings. Requires running setup and setting PW_CONTROL_SECRET for pypowerwall in pypowerwall.env. Use with caution.
# Setup cloud mode for pypowerwall container
docker exec -it pypowerwall python3 -m pypowerwall setup [email protected]

MODE=self_consumption
RESERVE=20
PW_CONTROL_SECRET=mySecretKey

# Set Mode
curl -X POST -d "value=$MODE&token=$PW_CONTROL_SECRET" http://localhost:8675/control/mode

# Set Reserve
curl -X POST -d "value=$RESERVE&token=$PW_CONTROL_SECRET" http://localhost:8675/control/reserve

# Read Settings
curl http://localhost:8675/control/mode
curl http://localhost:8675/control/reserve

v4.3.0 - pyPowerwall 0.8.2

  • Upgrade to pyPowerwall proxy v0.8.2 - Major refactoring of code in jasonacox/pypowerwall#77 and jasonacox/pypowerwall#78 and addition of new Alerts.
  • Disable GF_PATHS_PROVISIONING from grafana.env base to speed up Grafana startup by @BuongiornoTexas in #461

v4.2.1 - Docker V2 Fix

  • Fixed upgrade.sh to support docker-compose (V2) command as discussed in #459.
  • Updated setup.sh to check for Docker Compose V2.

v4.2.0 - Remove Docker V1

  • Remove support for Docker V1 since it is obsolete. Upgrade progress will alert V1 users to upgrade to V2 before proceeding. Updates by @BJReplay in jasonacox#454.

v4.1.3 - Alerts & Strings

  • Updated to using pyPowerwall to v0.7.12 which brings some Alerts and String data back for systems with Firmware 23.44.0+. New library uses /api/solar_powerwall instead of now depreciated /api/devices/vitals by @DerickJohnson in jasonacox/pypowerwall#75 and by @jasonacox in jasonacox/pypowerwall#76.

v4.1.2 - Cache 404 Responses

  • Updated pyPowerwall to v0.7.11 to add cache and extended TTL for 404 responses from Powerwall as identified in issue jasonacox#449 by @jgleigh. This will help reduce load on Powerwall gateway that may be causing rate limiting for some users (Firmware 23.44.0+).
  • Updated logic to disable vitals API calls for Firmware 23.44.0+
  • Added rate limit detection (429) and cooldown mode to allow Powerwall gateway time to recover.

v4.1.1 - Revert Change

  • Problems identified with older docker-compose versions. Revering upgrade.sh changes but pushing new plugin list in grafana.env.sample for new installations.

v4.1.0 - Grafana Plugin Updates

  • Update plugin list for Grafana, removing unneeded plugins (e.g. flux datasource) and adding logic to upgrade script to prune old grafana.env settings by @BuongiornoTexas in #442 #433

v4.0.5 - Dashboard Updates

  • Updated timezone variable in dashboard.json to tz:text to ensure the Time Zone string is output as-is. This will make upgrading Grafana easier later on and future-proof the variables by @s-crypt in #439.
  • Removed $tz from any queries that do not have a GROUP BY statement by @s-crypt in #439.
  • Updated pyPowerwall Proxy t42 - Adds Power Flow Animation style (set PW_STYLE="solar") for Solar-Only display. Removes the Powerwall image and related text to display a Grid + Solar + Home power flow animation.

v4.0.4 - Cloud Grid Status

  • Update to pyPowerwall v0.7.9 - Bug fix to render correct grid status for Solar-Only systems on cloud mode (see #437)

v4.0.3 - Cloud Mode Fixes

  • Fix enumeration of energy sites during cloud mode setup to handle incomplete sites with Unknown names or types by @dcgibbons in jasonacox/pypowerwall#72
  • pyPowerwall Proxy t41 Updates - Bug fixes for Solar-Only systems using cloud mode (see jasonacox#437).

v4.0.2 - Dashboard Update

  • Update default dashboard.json to not connect null values over 1hr threshhold (corrctly representing data gaps) by @youzer-name in #430.
  • Stack powerwall current energy values in Powerwall Capacity panel by @youzer-name in #430.
  • Add "Off Grid" indicators to the bottom of the Frequency and Voltages panels by @youzer-name in #430.

v4.0.1 - Powerwall Voltages

  • Added CQs and updated dashboard.json to include voltages from battery block vitals by @mcbirse in jasonacox#426. This addresses users no longer seeing Powerwall voltages in the dashboard with firmware 23.44.0 or later - See related jasonacox#109 (reply in thread)

v4.0.0 - Cloud Mode Support

  • Using pyPowerwall for both Local Access and Tesla Cloud mode by @jasonacox and @mcbirse in jasonacox#414 (replaces Tesla-history service, but the Tesla-history tool will continue to be used to fill in historic data or gaps) - See related jasonacox/pypowerwall#59
  • Removal of Docker Compose profiles (helps with some older systems that don't fully support this) and the v1 related legacy support.
  • Updated setup.sh and upgrade.sh to support transition to pyPowerwall for Tesla Cloud mode.
  • Updated verify.sh to support Tesla Cloud mode.
  • Updated dashboard for solar-only users to include Powerflow Animation panel.

v3.0.8 - Critical Bug Fix

  • Fixes bug in pypowerwall proxy container version before jasonacox/pypowerwall:0.7.6t39 related to API calls and 404 HTTP status codes handling. Powerwall Firmware version 23.44.0 has eliminated /api/devices/vitals resulting in a 404 response from the Powerwall Gateway (TEG) when this is requested. There was a bug in the pypowerwall code that will treat this 404 like an authentication failure which will result in attempts to log in over and over, eventually hitting the rate limit. This is especially impactful for those using the proxy for things like Powerwall-Dashboard as the rate limit will prohibit other data gathering.

v3.0.7 - InfluxDB Environment Variables

  • Add support to define InfluxDB configuration options by environment variable by @mcbirse. This allows the default configuration settings to be overridden and addresses jasonacox#408 raised by @youzer-name
  • Change InfluxDB statistics recording to false by default to reduce CPU load by @youzer-name in jasonacox#410
  • Update example backup script to use tar.xz (-J option) by @s-crypt in jasonacox#404 and jasonacox#405 see jasonacox#337
  • [Tools] - default to bash in pwstatus script for better compatibility by @mcbirse see jasonacox#249 (comment)

v3.0.6 - Powerflow Animation Update

  • Update to latest pypowerwall proxy t29:
  • Default page loaded by proxy (http://localhost:8675/) will render Powerflow Animation. Animation assets (html, css, js, images, fonts, svg) will render from local filesystem instead of pulling from Powerwall TEG portal resulting in faster render time.

v3.0.5 - Bug Fix for MacOS

v3.0.3 - Setup Profiles Updates

  • Updated setup.sh process descriptions to include Tesla Cloud data source in profile options (see below). This is currently the only option for Powerwall 3 owners (see #387) by @mcbirse
  • Update setup.sh to allow config changes.
  • Added weather data to dashboard-no-animation.json dashboard.
  • [Tools] - Revise pwstatus and weather-history retry handling by @mcbirse.
1 - Local Access (Powerwall 1, 2, or + using extended data from Tesla Gateway on LAN) - Default
2 - Tesla Cloud (Solar-only, Powerwall 1, 2, +, or 3 using data from Tesla Cloud)

v3.0.2 - Docker-Compose Fixes

  • Add future deprecation WARNING for older docker-compose versions.
  • Add support for docker-compose >= 1.28.0 to use compose profiles.
  • Change logic in compose-dash.sh to default to Docker compose V2.

v3.0.1 - Fix for Docker-Compose V1

  • This fixes an issue introduced by v3.0.0 for old Docker-Compose V1 systems in jasonacox#389
  • Updates example backup script to use xz compression in #337

v3.0.0 - Integrate Solar Only Support

  • Added Solar Only support as a setup option when installing Powerwall Dashboard by @mcbirse in jasonacox#386 see jasonacox#183 and https://github.com/jasonacox/Powerwall-Dashboard/tree/main/tools/solar-only
  • Updated Solar Only dashboard with user adjustable tz and cost variables, and removed Grid Status & Current State panels
  • Updated Docker Compose environment to support compose profiles and updated setup, upgrade and verify scripts
  • Added checks to setup script for common issues such as user/group problems
  • Added migration for beta Solar Only installs to upgrade script

v2.10.0 - Docker Compose and Container Updates

  • Update versions: Telegraf (v1.28.2) and pyPowerwall (v0.6.2t28)
  • Updated to pyPowerwall Proxy t28 to support newer Grafana versions. Adds new PW_STYLE setting for grafana-dark mode.
  • Updated setup.sh and upgrades.sh to support adding additional PW_STYLE setting.
  • Docker Compose Config Improvements by @mcbirse - ref #366
  • Update powerwall.yml to use variables for "user" and "ports" in containers, per #357 and #360 noted by @hulkster
  • Updated compose.env.sample with explanation of latest supported options
  • Updated powerwall.yml to use "unless-stopped" as the default restart policy for containers going forward

v2.9.12 - Weather411 and pyPowerwall Updates

  • Fix weather411 to exit gracefully with SIGTERM by @rcasta74 in jasonacox#354
  • Update to pyPowerwall t27 to exit gracefully with SIGTERM.

v2.9.11 - Updated Default Dashboard

  • Updated dashboard.json to isolate Powerwall+ string data to make it easier for those without Powerwall+ to close those empty panels as raised in jasonacox#320. Also changed browser default timezone to TZ set by user.
  • Dashboard-new formatting fixes and unlink library panels by @s-crypt in jasonacox#316
  • Fix dashboard.json in README by @longzheng in jasonacox#319
  • Update verify.sh to carry state of all tests back to calling shell by @vikrum in jasonacox#321
  • Fix mean in solar energy yr panel #330 by @jasonacox in jasonacox#331
  • Shared crosshair by @longzheng in jasonacox#338

v2.9.10 - Updated Default Dashboard

  • Updated default dashboard.json to incorporate timeseries migrations by @s-crypt in jasonacox#295 and jasonacox#297 see jasonacox#290
  • Updated "Grid Status" to new timeseries graph with red/yellow/green status.

v2.9.9 - Tools, Solar Only Support and Dashboard Updates

Instructions / Cleanup and Misc Tool Updates

Solar Only Support

Powerwall-Dashboard Usage Micro Service

Migrate Dashboard Panels

v2.9.8 - Tool Updates and Bug Fixes

  • Update to Powerwall Status Monitor tool to prevent false grid status alerts during Powerwall firmware updates by @mcbirse as raised in jasonacox#109 (reply in thread)
  • Bug fix to Weather History Tool to resolve crash during setup process when weather411.conf is not found by @mcbirse

v2.9.7 - Backup Script Quickfix

  • Quickfix for permissions issues after repo cleanup. This addresses permission issues that interrupt the upgrade script for users of the backup script. Fix by @YesThatAllen in jasonacox#272 as raised in jasonacox#265

v2.9.6 - Add Git Attributes

v2.9.5 - Repo Cleanup

v2.9.4 - pyPowerwall Proxy t26

  • Update pyPowerwall Proxy to t26 with updated default PW_POOL_MAXSIZE of 15 as raised by @jgleigh and @mcbirse in jasonacox#261 (reply in thread)
  • Dashboard Update - Update "costs/credit per kWh" for buy vs. sell by @jgleigh in jasonacox#266

v2.9.3 - Adjustable kWh Cost

  • Dashboard Update - Make "costs/credit per kWh" and "timezone" user adjustable variables in Grafana by @emptywee in jasonacox#266

v2.9.2 - Additional Powerwall Support

  • Add support for up to 12 Powerwalls (added PW7 to PW12) for temperature data, frequencies, voltages and capacity as requested in jasonacox#253 and issue jasonacox#256.

v2.9.1 - Minimize Grafana Plugins

  • Minimize the number of default Grafana plugins as defined in the grafana.env.sample file (installed as localized grafana.env) for new installations by @jasonacox in jasonacox#234
  • Update power flow animation panel code to display Grafana loading image while power flow graphics are loaded by @dkerr64 as discussed in jasonacox#216 (comment)

v2.9.0 - Pinned Versions

  • Tools - Reinstate setting timezone from history on 1st run by @mcbirse in jasonacox#236
  • Pinned versions in compose file for controlled upgrades and repeatable setups. Fix jasonacox#237 issue by removing image pruning in upgrade.sh script by @GrimmiMeloni in jasonacox#240

v2.8.11 - Animation Auto-Scale

  • Add code to power flow animation dashboard panel to auto-scale based on window size by @dkerr64 in jasonacox#216

v2.8.10 - Revert Animation Auto-Scale

  • Problem with scaling causing scrollbar and clipping reported and reproducible on Windows 11 as raised in jasonacox#216
  • Tools - InfluxDB 2.x fixes and moved to grafana variables use instead of grafana.ini by @ThePnuts in #233

v2.8.9 - Animation Auto-Scale

  • Solar Only Support Development - Fix timezone for solar only sites using an offset by @mcbirse in jasonacox#226
  • Add code to power flow animation dashboard panel to auto-scale based on window size by @dkerr64 in jasonacox#216 and PR jasonacox#228
  • Tools - InfluxDB 2.x updates to instructions and dashboard by @ThePnuts in jasonacox#232

v2.8.8 - pyPowerwall Cache-Control

v2.8.7 - Preserve Peaks in Graphs

v2.8.6 - Weather Updates

v2.8.5 - Verify Tool for Setup

  • Added verify.sh tool to test setup and operation of the main components for the Dashboard (pypowerwall, telegraf, influxdb, grafana, weather411) by @jasonacox as raised in jasonacox#187
./verify.sh # optional: -no-color

image

v2.8.4 - Custom Docker Compose Support

  • Added support for extending docker-compose setup via powerwall.extend.yml by @BJReplay in jasonacox#186
  • Renamed backup.sh to backup.sh.sample to allow local settings changes without impacting upgrade by @BJReplay in jasonacox#186

v2.8.3 - New Dashboard Meters

  • Added "Net Grid Usage" meter by @wreiske and "% Solar Powered" meter by @jasonacox in jasonacox#179 jasonacox#181
  • Dashboard archived and versioned in ./dashboards
  • Moved Alert Data from 3 day retention policy to separate "alerts" infinite (INF) retention policy.

v2.8.2 - Bug Fix Grid Voltage Data Migration

  • Grid Voltage Upgrade - This will fix the run-once script so tags are also copied with historic data by @mcbirse in jasonacox#177

Note: For anyone that already upgraded to 2.8.0 or later, there is an option to fix the untagged data by running the Fix Month Tags Tool. Thanks to @mcbirse for spotting this issue, submitting the fix and the great fixmonthtags tool!

v2.8.1 - Backup Reserve

  • Add Powerwall backup reserve setting (%) to Energy Usage graph thanks to @mp09 in jasonacox#174

v2.8.0 - Grid Voltage Upgrade

  • Now using ISLAND_VLxN_Main data for Grid voltage (instead of METER_x_VLxN) as this appears to be more common across systems. Upgrade script executes a run-once query to copy historic data over. jasonacox#167
  • Added logic to Voltage panel to sum Powerwall L1 and L2 voltages for 230V grid users thanks to @longzheng in jasonacox#165
  • Change frequency panel to 3 decimal places by @longzheng in jasonacox#163
  • Update README.md - Indent powerwall.yml snippet so that it can be cut and pasted directly into powerwall.yml by @BJReplay in jasonacox#168

v2.7.1 - Powerwall Alert Data and Panel

  • Add Powerwall Alert data to dashboard - Credit to @DerickJohnson in jasonacox#158
  • Updated Tools and Contrib READMEs by @BJReplay in jasonacox#160

v2.7.0 - PyPowerwall t24 and Ecowitt Weather Support

v2.6.7 - History Tools and Powerwall Firmware Version

  • Add Powerwall Firmware version to Power-Flow animation. #112
  • Fix Self-Powered calculations to factor in Grid charging of Powerwall. #135
  • Upgrade to pyPowerwall Proxy t22 to better handle Powerwall Firmware updates. This introduces no-cache headers and hopefully eliminates the need for proxy restart. #112
  • Fix timezone script (tz.sh) to process file in the dashboards folder. jasonacox#63
  • Eliminate horizontal scrollbars on iPhone. by @cwagz in jasonacox#114
  • Updated animation and yearly image by @cwagz in jasonacox#117
  • Tesla History Tool - Fix bug with error output when dateutil is missing by @mcbirse in jasonacox#123
  • Fix Month Tool - Added tool to fix incorrect month tags of InfluxDB by @mcbirse in jasonacox#124 and jasonacox#126
  • Weather History Tool - Added tool to retrieve weather history data by @mcbirse in jasonacox#147

v2.6.6 - History Import Tool & Windows 11 Compatibility

v2.6.5 - Upgrade pyPowerwall Proxy t18

  • Upgrade to pyPowerwall Proxy t18 with enhanced error handling and logging
  • Update backup.sh to validate directories before starting backup process #85
  • Fix panel size for Animation to prevent scroll/clipping of data #98

v2.6.4 - Upgrade Fix

  • Upgrade issue identified in #85 that keeps files from updating (upgrade fails). New method will stash and rebase all but non-tracked files (e.g. grafana.env and pypowerwall.env local config files).

v2.6.3 - Dashboard Updates

  • Converts the "Energy Usage" graph to a new Grafana 9 time series graph - dashboard.json by @youzer-name in jasonacox#86
  • Add timezone to telegraf so tags are localized by @mcbirse in jasonacox#81

v2.6.2 - Current State Panel "No Data" Fix (No Archive)

  • Fix bug in yesoreyeram-boomtable-panel that causes random "No data" errors in table. This uses the v1.5.0-alpha.3 boomtable by @yesoreyeram. #49

v2.6.1 - Month and Year Tag Fix (No Archive)

  • Add timezone to telegraf so tags are localized by @mcbirse in jasonacox#81
  • Fix dashboard.json bugs and update the rest of dashboard-*.json files for Grafana v9.

v2.6.0 - Grafana v9.1.2 Upgrade

  • Update dashboards and setup to use Grafana v9.1.2 by @techlover1 in jasonacox#73
  • Bug fix missing space in weather.sh by @mcbirse in jasonacox#72

v2.5.2 - Bug Fix

  • Fix upgrade.sh to prevent sudo/root from running this script. #42

v2.5.1 - Bug Fix

  • Fix bug in weather.sh that causes the script to error on location entry. #72

v2.5.0 - Weather Data

v2.4.5 - pyPowerwall v0.6.0

  • Upgraded to pyPowerwall v0.6.0 Proxy t17 - Persistent HTTP Connections
  • Added setup warning. Raspbian GNU/Linux 10 (buster) has a bug in the libseccomp2 library that causes the pypowerwall container to fail. See details an fix in #56

v2.4.4 - Dashboard Updates

  • Fixed Current State panel so it is not affected by different time range selections, and "No Data" issue by @mcbirse in https://github.com/jasonacox/Powerwall-Dashbsoard/pull/50
  • Made the power flow animation dashboard the default (dashboard.json). Original dashboard is still available as dashboard-no-animation.json.

v2.4.3 - Upgrade Fixes

  • Externalize Grafana environment settings into grafana.env to allow for additional customizations.
  • Update and fixes to setup.sh and upgrade.sh.

v2.3.0 - Bug Fixes

  • Fix pypowerwall.env format and timezone bug in setup #23
  • Add check in setup.sh to ensure not running as root/sudo.
  • Added self-upgrade feature to upgrade.sh with set -e to stop on errors #45
  • Added VERSION tracking to help with upgrades (upgrade.sh and setup.sh).

v2.2.0 - Power Flow Animation

  • Added new Grafana dashboard and panel for iFrame for pyPowerwall Proxy passthrough Power Flow Animation - see dashboard-animation.json.
  • Fixed Timezone management for tz.sh, setup.sh and upgrade.sh for easier repeat setup and upgrades. #23

image

v2.0.0 - Frequency and Voltage Graphs

  • Add graph
  • pyPowerwall v0.4.0

v1.0.0 - Initial Release

  • Initial Release
  • Tested on Ubuntu 18.04.6 LTS, Ubuntu 18.04.6 and 20.04 LTS, Raspberry Pi OS 32-Bit Debian Bullseye (armv7) and MacOS (x86_64, arm64)
  • pyPowerwall v0.3.0