Adapters for Home Assistant and NodeRED integration are added.
Akkudoktor-EOS can now be run as Home Assistant add-on and standalone.
As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard
in Home Assistant.
The fix includes several bug fixes that are not directly related to the adapter
implementation but are necessary to keep EOS running properly and to test and
document the changes.
* fix: development version scheme
The development versioning scheme is adaptet to fit to docker and
home assistant expectations. The new scheme is x.y.z and x.y.z.dev<hash>.
Hash is only digits as expected by home assistant. Development version
is appended by .dev as expected by docker.
* fix: use mean value in interval on resampling for array
When downsampling data use the mean value of all values within the new
sampling interval.
* fix: default battery ev soc and appliance wh
Make the genetic simulation return default values for the
battery SoC, electric vehicle SoC and appliance load if these
assets are not used.
* fix: import json string
Strip outer quotes from JSON strings on import to be compliant to json.loads()
expectation.
* fix: default interval definition for import data
Default interval must be defined in lowercase human definition to
be accepted by pendulum.
* fix: clearoutside schema change
* feat: add adapters for integrations
Adapters for Home Assistant and NodeRED integration are added.
Akkudoktor-EOS can now be run as Home Assistant add-on and standalone.
As Home Assistant add-on EOS uses ingress to fully integrate the EOSdash dashboard
in Home Assistant.
* feat: allow eos to be started with root permissions and drop priviledges
Home assistant starts all add-ons with root permissions. Eos now drops
root permissions if an applicable user is defined by paramter --run_as_user.
The docker image defines the user eos to be used.
* feat: make eos supervise and monitor EOSdash
Eos now not only starts EOSdash but also monitors EOSdash during runtime
and restarts EOSdash on fault. EOSdash logging is captured by EOS
and forwarded to the EOS log to provide better visibility.
* feat: add duration to string conversion
Make to_duration to also return the duration as string on request.
* chore: Use info logging to report missing optimization parameters
In parameter preparation for automatic optimization an error was logged for missing paramters.
Log is now down using the info level.
* chore: make EOSdash use the EOS data directory for file import/ export
EOSdash use the EOS data directory for file import/ export by default.
This allows to use the configuration import/ export function also
within docker images.
* chore: improve EOSdash config tab display
Improve display of JSON code and add more forms for config value update.
* chore: make docker image file system layout similar to home assistant
Only use /data directory for persistent data. This is handled as a
docker volume. The /data volume is mapped to ~/.local/share/net.akkudoktor.eos
if using docker compose.
* chore: add home assistant add-on development environment
Add VSCode devcontainer and task definition for home assistant add-on
development.
* chore: improve documentation
This change introduces a GitHub Action to automate release creation, including
proper tagging and automatic addition of a development marker to the version.
A hash is also appended to development versions to make their state easier to
distinguish.
Tests and release documentation have been updated to reflect the revised
release workflow. Several files now retrieve the current version dynamically.
The test --full-run option has been rename to --finalize to make
clear it is to do commit finalization testing.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Improve enhancement template to not use fenced python chapters.
Add chapter to describe the enhancement.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Wait 90 days until stale indication, wait another 30 days until closing.
Excempt "enhancement" and "feature request" issues from stale handling.
Excempt "in progress" pull reuquests from stale handling.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Add GitHub workflow to close requests/issues after 60 days of inactivity.
Requests/ issues may be blocked from closing by adding the In progress label.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
* Cleanup: parameters: extra=forbid, optimize: battery, inverter optional
* Don't allow extra fields for parameters/REST-API (at least for now while
changing API).
* Allow both battery and inverter to be set optionally (atm optional
battery not implemented, no API constraints).
* inverter: Remove default max_power_wh
* single_test_optimization: Add more cli-parameters
* Workflow docker-build: Don't try to authenticate for PRs
* Secrets are not available anyway for forks.
* workflow: docker-build upload to DockerHub
- Upload on release, tag, push to main.
- Build on pr to main (amd64 only).
* docker:
- Update documentation.
- Temporarily set akkudoktor/eos:main in compose.yml (with
releases/tags it should be replaced by latest again)
* Add EOS_CONFIG_DIR to set config dir (relative path to EOS_DIR or
absolute path).
- config_folder_path read-only
- config_file_path read-only
* Default values to support app start with empty config:
- latitude/longitude (Berlin)
- optimization_ev_available_charge_rates_percent (null, so model
default value is used)
- Enable Akkudoktor electricity price forecast (docker-compose).
* Fix some endpoints (empty data, remove unused params, fix types).
* cacheutil: Use cache dir. Closes#240
* Support EOS_LOGGING_LEVEL environment variable to set log level.
* tests: All tests use separate temporary config
- Add pytest switch --check-config-side-effect to check user
config file existence after each test. Will also fail if user config
existed before test execution (but will only check after the test has
run).
Enable flag in github workflow.
- Globally mock platformdirs in config module. Now no longer required
to patch individually.
Function calls to config instance (e.g. merge_settings_from_dict)
were unaffected previously.
* Set Berlin as default location (default config/docker-compose).
* optimization states for AC, DC and IDLE now similar probab. Also AC states taken from config. Maybe a single config option for AC and E-Auto States is sensefull.
* test_class_optimize: Update testdata
* Write pdf and json to test/testdata/new.... so it can be analyzed
manually or just copied as new expected result.
* workflow: Upload pytest optimization result artifacts (pdf, json)
- Added recommended settings for the Pylance and Pyright extensions
- Enabled pytest and debugging support in configuration
- Reformatted code with Prettier
---------
Co-authored-by: Chris <git@nootch.de>
* Dockerfile: Use non-root user, buildx cache, setup for readonly
container, remove unused apt deps.
For now don't install pip package and keep development flask server
as this will be replaced in the future (fastapi). Then a proper
webserver (e.g. nginx) should be used and the pip package can be
created and deployed just to the run-stage (with the webserver).
* docker-compose: Set to readonly (anonymous volumes declared in
Dockerfile should maintain all writable data).
Mount config.py for easier development. Should be replaced by
environment support for all config file variables.
* Remove unused runtime dependencies: mariadb, joblib, pytest,
pytest-cov.
* Move pytest-cov to dev dependencies.
* Add output_dir to config.py.
* Fix visualization_results.pdf endpoint.
* Update docs.
Previously tests did not run after merging.
This lead to incompatible changes being merged right after one another.
By running tests on main we will notice breaks earlier.
Other options would be to require every PR to rebase on main before merging.
This is known as requiring linear history and can be changed in the project settings.
A test fixture to start the server and a first test case is added.
The fixture tries to assure that the server is installed and running.
If it is not installed the fixture uses pip to install it.
The server and the installation by pip is run bei the same Python
executable that also runs pytest.
The github workflow for pytest is adapted to install akkudoktor-eos.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>