Optimise battery charging/discharging with hourly electricity prices for maximised profit, with the option to include solar panel production forecast. (added Jan 30, 2023)
This is a python program that creates a planning for charging and discharging a home battery system to optimise profit. It can be run in standalone mode or in Domoticz integration mode. (with the -s or -d command line argument)
The standalone mode will interactively request user input and provide feedback on the screen. The Domoticz mode will take the input from Domoticz variables and devices, load the planning onto a Domoticz text device for display and trigger the next action from the planning. The standalone mode will only produce a planning (into a file and onto the screen) and not trigger any action.
The domoticz version has the option to include solar panel production forecast in the planning (with the -p command line argument). It will take location and pv panel configuration data from domoticz variables and obtain production forecast for current and next day from the website forecast.solar
The program will need as input:
- Your own API token from transparancy.entsoe.eu (to be adapted in the program, see below)
- The planning period
- The battery characteristics: maximum capacity and maximum charge and discharge speed
The main purpose of the program is to plan today and tomorrow (if the prices for tomorrow are already available, normally after 15:00 hours). It can be re-run at any time to re-plan the remaining period, given an initial charge of that moment. It can also be used to run on historic price data to simulate what could have been achieved and to evaluate return on investment for a battery system. At the end of the planning period the remaining charge will be zero and profit optimised.
If the price data from entsoe.eu has been downloaded before it can be re-used from existing files, instead of requesting it again.
The progress, intermediate steps and finals results will be displayed on screen and an output file will be created that can be loaded into a spreadsheet. The level of output can be controlled by command line arguments:
- -t for tracing. This is a debug mode with full display of intermediate steps and results.
- -v for verbose. This still shows each next step in the planning and the impact on the overall plan.
- -q for quiet. Minimal output. Default.
-s is the command line argument for standalone mode and is the default.
Note the price data from the entsoe website is stored in local xml files with a timestamp and not automatically removed, so some manual maintenance of the file system will be required at some point.
For this integration both the python program and the dzVents scripts (published here as .txt files) are needed. The dzVents file contents should be copied and pasted into a script via the Domoticz interface. The python program is expected in the domoticz/python folder (please adapt the dzVents script if a different folder is used)
The program will take input from Domoticz variables and devices and will trigger output onto Domoticz devices. The idx numbers for these devices will need to be adapted in the program and in the Domoticz script(s) as these differ for each operating environment.
The following Domoticz variables and devices need to be set up and adapted in the python program:
Variables:
- securityTokenIDX=12 # the IDX of the Domoticz user variable holding the API security token for transparency.entsoe.eu
- maxBatteryCapacityIDX=14 # the IDX of the Domoticz user variable holding the value for the maximum available battery charge capacity
- maxBatteryChargeSpeedIDX=15 # the IDX of the Domoticz user variable holding the value for the maximum charge speed
- maxBatteryDischargeSpeedIDX=16 # the IDX of the Domoticz user variable holding the value for the maximum discharge speed
Devices:
- planningDisplayIDX=111 # the IDX number of a Domoticz text device to use for display of the planning
- batterySwitchIDX=112 # the IDX of the Domoticz selector switch for controlling the battery system actions # (API commands for control of the battery system need to be set in the "selector action" fields of the device)
- batteryOffCode=0 # the 3 level numbers as defined in the selector switch for Off/Charge/Discharge (0,10 and 20 by default)
- batteryChargeCode=10
- batteryDischargeCode=20
- batteryChargeLevelIDX=113 # the IDX of the Domoticz device with updated actual battery charge level, in percent (should be updated through the battery system API)
The Domoticz integration mode is normally triggered by a call from the Domoticz dzVents script. The dzVents script requires also some of the same idx numbers as the python program. The Domoticz integration mode can also be run from the Unix command line for testing using the "-d" command line argument (so type "python3 dz-battery-planning.py -d"). The Domoticz mode creates a planning for maximum one day ahead, depending on availability of prices.
Every time a new planning is created, the next required action is fed back into the dzVents script and then the relevant API commands are given to the battery system by the script. The total planning is displayed in the log of the text device and also highlights the top 5 lowest prices in the remaining free/unclassified hours (provided those are below the average price of the day). Those are the best times for heavy electricity consumers, like tumbledryers, washing machines, electric cars etc.
Note that the current version is for simulation purposes only so no actual battery interface is present and the interface is assumed to be very simple. The battery system sends a current charge level and can receive three commands: Off, Charge, Discharge. The controlling script will send those commands depending on the action and the target charge level received from the planning program verus current charge level.
A separate dzVents script is created to simulate a battery system in absence of a real setup.
The Domoticz mode re-uses the entsoe.xml file (without timestamp in the name) for storing price data so no manual maintenance of the file system is required.
If the -p option is added to the call of the python program, then the forecasted production of the PV panels will be included in the planning. For this the location (latitude/longitude) settings in Domoticz need to be defined and the following user variables need to be set up (with IDX numbers adapted to the environment)
- pvPanelAngleIDX=17 # the IDX of the Domoticz user variable holding the value of the PV panel angle (horizontal = 0)
- pvPanelAzimuthIDX=18 # the IDX of the Domoticz user variable holding the value of the PV panel azimuth (south = 0)
- pvPanelMaxPeakIDX=19 # the IDX of the Domoticz user variable holding the value of the PV panel max peak kWH
The forecast will be obtained from forecast.solar and shown as separate lines in the planning. For each line it will be defined whether to store the production in the battery system or to return it to the grid. The charge/discharge action related to the price line in the same hour will be adapted accordingly.
As the PV production is a forecast only and actual PV production will deviate, it is recommended to re-run the planning frequently, but please note that the free API of forecast.solar will only allow 10 calls per hour.
The control of the battery system will be based on target charge level for the hour, including the PV forecast.
It does not take into account any tax effects in the planning as these will differ strongly from country to country, but this could easily be added.
It assumes a 100% efficiency in the process, i.e. the energy received and paid for from the grid is fully stored in the battery (and vice versa). Once a real efficiency is known, this could be included in the profitability calculation of each charge/discharge and discharge/charge action pair. It also assumes a linear charge/discharge curve (when calculating remaining charge/discharge capacity for part of an hour).
It does not plan for electricity consumption in the home network. It can however be used to re-plan after a situation has changed as result of consumption. It also indicates the remaining cheapest hours without any planned action (with low_1, low_2 etc).
To get an API token (it is free):
- Register for an account at https://transparency.entsoe.eu/dashboard/show
- Send an email with subject "Restful API access" and your account email address in the body.
- After receipt of their confirmation, go into your account and generate your token.
- Copy and paste the token to replace the xxxxxx on the line indicated in the python program where it says securitytoken="xxxxxxxxxxx" (line 52). For the Domoticz mode copy and paste the token onto the Domoticz user variable.
A short description of the internals of the program:
- Prices are loaded onto a hourPriceList and a displayList. The displayList is for display and for tracking of the results. The hourPriceList is used for the planning process.
- The hourPriceList is combined with itself to form pairs of charge-discharge and discharge-charge actions. These are put onto the pairList and are sorted top-down for maximum profitability.
- The pairList is run down from top to bottom to select the pairs that still fit onto the planning, taking into account previously planned actions and maximum battery capacity and maximum charge and discharge speeds. It restarts from the top after each action, since a discharge/charge action could open up capacity for a charge/discharge that did not exist before due to maximum capacity. This continues until the end of the list is reached.
- The next period is processed by re-starting at step 1.
Two dzVents scripts are provided. One to trigger the launch of the python program, receive the resulting action and send the command to the battery system, and a second to simulate a battery system charging/discharging and providing a current charge level back through the interface.
The tracking of actual profit will be added as next step.
The switch for manually triggering the planning
The user variables (except for the security token)
The battery selector switch icon
and the setup of the selector switch
The icon of the text display device for the planning
And the detail log of the text display device (note the domoticz font was changed to monospace to get a tabular format)
