mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-01-01 00:06:18 +00:00
feat: add Home Assistant and NodeRED adapters (#764)
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 commit is contained in:
Bobby Noelte
GitHub
@@ -328,8 +328,11 @@ For detailed Docker instructions, refer to [Installation Guideline](install-page
|
||||
|
||||
#### Step 4.1 - Create a development branch
|
||||
|
||||
Create a local development branch and make it know on your GitHub repo.
|
||||
|
||||
```bash
|
||||
git checkout -b <MY_DEVELOPMENT_BRANCH>
|
||||
git push --set-upstream origin <MY_DEVELOPMENT_BRANCH>
|
||||
```
|
||||
|
||||
Replace `<MY_DEVELOPMENT_BRANCH>` with the development branch name. The branch name shall be of the
|
||||
@@ -591,6 +594,10 @@ Ensure your changes do not break existing functionality:
|
||||
|
||||
Keep your code consistent with existing style and conventions.
|
||||
|
||||
#### Keep Python Docstrings RST Compatible
|
||||
|
||||
The docstrings will be parsed by Sphinx in automatic documentation generation.
|
||||
|
||||
### Use Issues for Discussion
|
||||
|
||||
Before making major changes, open an issue or discuss with maintainers.
|
||||
@@ -598,3 +605,100 @@ Before making major changes, open an issue or discuss with maintainers.
|
||||
### Document Changes
|
||||
|
||||
Update docstrings, comments, and any relevant documentation.
|
||||
|
||||
### Start or Reopen the Home Assistant Dev Container in VS Code
|
||||
|
||||
### 1. Open Visual Studio Code
|
||||
|
||||
Start Visual Studio Code.
|
||||
|
||||
### 2. Open the Command Palette
|
||||
|
||||
Open the Command Palette:
|
||||
|
||||
- **Windows / Linux:** `Ctrl + Shift + P`
|
||||
- **macOS:** `Cmd + Shift + P`
|
||||
|
||||
### 3. Reopen the Workspace in the Dev Container
|
||||
|
||||
In the Command Palette, select:
|
||||
|
||||
```text
|
||||
Dev Containers: Reopen in Container
|
||||
```
|
||||
|
||||
VS Code will:
|
||||
|
||||
- Build the dev container (if required)
|
||||
- Start the container
|
||||
- Reopen the workspace inside the container
|
||||
|
||||
### 4. Start Home Assistant
|
||||
|
||||
Open the Command Palette again and select:
|
||||
|
||||
```text
|
||||
Dev Terminal: Run Task... → Start Home Assistant
|
||||
```
|
||||
|
||||
:::{admonition} Note
|
||||
:class: note
|
||||
Startup may take several minutes while the Home Assistant Supervisor initializes.
|
||||
:::
|
||||
|
||||
If startup fails you may retry with container rebuild before:
|
||||
|
||||
```text
|
||||
Dev Containers: Rebuild Container without Cache
|
||||
```
|
||||
|
||||
### 5. Open Home Assistant
|
||||
|
||||
Once startup is complete, open your browser and navigate to:
|
||||
|
||||
```text
|
||||
http://localhost:7123/
|
||||
```
|
||||
|
||||
If this is your first start, complete the standard Home Assistant onboarding process.
|
||||
|
||||
### 6. Install the Local Akkudoktor-EOS Add-on
|
||||
|
||||
#### 6.1 Open the Add-on Store
|
||||
|
||||
In Home Assistant, navigate to:
|
||||
|
||||
```text
|
||||
Settings → Add-ons → Add-on Store
|
||||
```
|
||||
|
||||
Open the top-right menu (⋮), then select:
|
||||
|
||||
```text
|
||||
Repositories → Local add-ons
|
||||
```
|
||||
|
||||
Choose **Akkudoktor-EOS**.
|
||||
|
||||
#### 6.2 Install the Add-on
|
||||
|
||||
The Akkudoktor-EOS add-on is automatically available.
|
||||
Click **Install** to begin installation.
|
||||
|
||||
#### 6.3 Start the Add-on
|
||||
|
||||
After installation completes, click **Start** in the add-on panel.
|
||||
|
||||
#### 6.4 Open the EOS Web Interface
|
||||
|
||||
In the add-on panel, click **Open Web UI** to access the EOS dashboard.
|
||||
|
||||
#### 6.5 Configure EOS (Optional)
|
||||
|
||||
In the EOS dashboard, navigate to:
|
||||
|
||||
```text
|
||||
Config
|
||||
```
|
||||
|
||||
to adjust configuration settings as needed.
|
||||
|
||||
Reference in New Issue
Block a user