Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
**Optimize your electricity costs by re-charging your PV battery when electricity is cheap and there is not enough solar power available.**
To integrate batcontrol with Home Assistant, use the following repository: [ha_addons](https://github.com/muexxl/ha_addons/)
To integrate batcontrol with Home Assistant, use the following repository: [batcontrol_ha_addon](https://github.com/MaStr/batcontrol_ha_addon)

[![Pylint](https://github.com/muexxl/batcontrol/actions/workflows/pylint.yml/badge.svg?branch=main)](https://github.com/muexxl/batcontrol/actions/workflows/pylint.yml)
[![Docker Image CI](https://github.com/muexxl/batcontrol/actions/workflows/docker-image.yml/badge.svg?branch=main)](https://github.com/muexxl/batcontrol/actions/workflows/docker-image.yml)
[![Pylint](https://github.com/MaStr/batcontrol/actions/workflows/pylint.yml/badge.svg?branch=main)](https://github.com/MaStr/batcontrol/actions/workflows/pylint.yml)
[![Docker Image CI](https://github.com/MaStr/batcontrol/actions/workflows/docker-image.yml/badge.svg?branch=main)](https://github.com/MaStr/batcontrol/actions/workflows/docker-image.yml)


[Wiki/Documentation](https://github.com/muexxl/batcontrol/wiki)
[Wiki/Documentation](https://github.com/MaStr/batcontrol/wiki)

## Prerequisites:

Expand Down Expand Up @@ -124,7 +124,7 @@ client.loop_forever()

## Install:
```sh
git clone https://github.com/muexxl/batcontrol.git
git clone https://github.com/MaStr/batcontrol.git
cd batcontrol
```

Expand Down Expand Up @@ -171,7 +171,7 @@ python -m batcontrol # When venv is activated
mkdir -p ./config -p ./logs
```

- Download the the latest [batcontrol_config.yaml](https://raw.githubusercontent.com/muexxl/batcontrol/refs/heads/main/config/batcontrol_config_dummy.yaml) sample, adjust and place it to config/batcontrol_config.yaml.
- Download the the latest [batcontrol_config.yaml](https://raw.githubusercontent.com/MaStr/batcontrol/refs/heads/main/config/batcontrol_config_dummy.yaml) sample, adjust and place it to config/batcontrol_config.yaml.

- Use the default load_profile (automatically) or create your own.-
### Plain Docker
Expand Down Expand Up @@ -278,7 +278,7 @@ To uninstall batcontrol and restore the inverter settings follow these steps:
For running batcontrol off the repository for development puroposes, it is required to uses pip with [Developermode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)

```sh
git clone https://github.com/muexxl/batcontrol.git
git clone https://github.com/MaStr/batcontrol.git
cd batcontrol
python -m venv .venv
# Activate your environment with:
Expand Down
16 changes: 8 additions & 8 deletions config/batcontrol_config_dummy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#--------------------------
# Batcontrol Configuration
# See more Details in: https://github.com/muexxl/batcontrol/wiki/Batcontrol-Configuration
# See more Details in: https://github.com/MaStr/batcontrol/wiki/Batcontrol-Configuration
#--------------------------
timezone: Europe/Berlin #your time zone. not optional.
time_resolution_minutes: 60 # Time resolution for forecasts: 15 (quarter-hourly) or 60 (hourly). Default: 60
Expand All @@ -21,7 +21,7 @@ battery_control:

#--------------------------
# Battery Control Expert Tuning Parameters
# See more Details in: https://github.com/muexxl/batcontrol/wiki/battery_control_expert
# See more Details in: https://github.com/MaStr/batcontrol/wiki/battery_control_expert
#--------------------------
battery_control_expert:
charge_rate_multiplier: 1.1 # Increase (>1) calculated charge rate to compensate charge inefficencies.
Expand All @@ -34,7 +34,7 @@ battery_control_expert:

#--------------------------
# Inverter
# See more Details in: https://github.com/muexxl/batcontrol/wiki/Inverter-Configuration
# See more Details in: https://github.com/MaStr/batcontrol/wiki/Inverter-Configuration
#
# IMPORTANT: This configuration uses a "dummy" inverter for demonstration purposes.
# The dummy inverter returns static values to make batcontrol work out of the box.
Expand All @@ -61,7 +61,7 @@ inverter:

#--------------------------
# Dynamic Tariff Provider
# See more Details in: https://github.com/muexxl/batcontrol/wiki/Dynamic-tariff-provider
# See more Details in: https://github.com/MaStr/batcontrol/wiki/Dynamic-tariff-provider
#--------------------------
utility:
type: awattar_de # [tibber, awattar_at, awattar_de, evcc, energyforecast]
Expand All @@ -72,7 +72,7 @@ utility:

#--------------------------
# MQTT API
# See more Details in: https://github.com/muexxl/batcontrol/wiki/MQTT-API
# See more Details in: https://github.com/MaStr/batcontrol/wiki/MQTT-API
#--------------------------
mqtt:
enabled: false
Expand All @@ -94,7 +94,7 @@ mqtt:

#--------------------------
# Forecast Solar
# See more Details in: https://github.com/muexxl/batcontrol/wiki/Solar-Forecast
# See more Details in: https://github.com/MaStr/batcontrol/wiki/Solar-Forecast
#
# Supported providers:
# - fcsolarapi: Third-party solar forecast API (configured below, default)
Expand Down Expand Up @@ -129,7 +129,7 @@ pvinstallations:

#--------------------------
# Forecast Consumption
# See more Details in: https://github.com/muexxl/batcontrol/wiki/Consumption-forecast
# See more Details in: https://github.com/MaStr/batcontrol/wiki/Consumption-forecast
#
# Option 1: CSV-based forecast (default)
# Option 2: HomeAssistant API-based forecast
Expand All @@ -156,7 +156,7 @@ consumption_forecast:
#--------------------------
# evcc connection
# listen to evcc mqtt messages to lock the battery if the car is charging
# See more Details in: https://github.com/muexxl/batcontrol/wiki/evcc-connection
# See more Details in: https://github.com/MaStr/batcontrol/wiki/evcc-connection
#--------------------------
evcc:
enabled: false
Expand Down
4 changes: 2 additions & 2 deletions entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ if test ! -f "$CONFIG_FILE" ; then
echo ""
echo " You can download the latest sample config from:"
if [ "snapshot" = "$BATCONTROL_VERSION" ]; then
echo " https://raw.githubusercontent.com/muexxl/batcontrol/${BATCONTROL_GIT_SHA}/config/batcontrol_config_dummy.yaml"
echo " https://raw.githubusercontent.com/MaStr/batcontrol/${BATCONTROL_GIT_SHA}/config/batcontrol_config_dummy.yaml"
else
echo " https://raw.githubusercontent.com/muexxl/batcontrol/refs/tags/${BATCONTROL_VERSION}/config/batcontrol_config_dummy.yaml"
echo " https://raw.githubusercontent.com/MaStr/batcontrol/refs/tags/${BATCONTROL_VERSION}/config/batcontrol_config_dummy.yaml"
fi
echo ""
fi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ async def _websocket_connect(self):

# Set max_size to 4MB to handle large Home Assistant instances
# Default is 1MB which causes crashes for installations with many entities
# See: https://github.com/muexxl/batcontrol/issues/241
# See: https://github.com/MaStr/batcontrol/issues/241
websocket = await connect(ws_url, max_size=4 * 1024 * 1024)

# Step 1: Receive auth_required message
Expand Down