Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-10-30 22:36:21 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
Files
5d1962aeabdb8a9ded9a4667d78dc651d372e6a7
EOS/docs/akkudoktoreos/integration.md

42 lines
1.5 KiB
Markdown
Raw Normal View History

Add Documentation 3 (#353) Add documentation that covers: - Architecture - Optimization (only empty template) - Integration. Add some PNG figures for architecture documentation including open document format sources to enable document maintainance. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:52:57 +01:00
% SPDX-License-Identifier: Apache-2.0
Conceptual documentation (#463) Added new instruction.md, changed index.md accordingly and deleted the no longer needed about.md of new documentation structure. Refinement of differences to other solutions and features of EOS. Co-authored-by: Eric Hirsch <git@familie-hirsch.net>
2025-03-23 13:27:40 +01:00
(integration-page)=
Add Documentation 3 (#353) Add documentation that covers: - Architecture - Optimization (only empty template) - Integration. Add some PNG figures for architecture documentation including open document format sources to enable document maintainance. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:52:57 +01:00
# Integration
EOS operates as a [REST](https://en.wikipedia.org/wiki/REST) [API](https://restfulapi.net/) server,
allowing for seamless integration with a wide range of home automation systems.
## EOSdash
`EOSdash` is a lightweight support dashboard for EOS. It is pre-integrated with EOS. When enabled,
it can be accessed by navigating to [http://localhost:8503](http://localhost:8503) in your browser.
## Node-RED
[Node-RED](https://nodered.org/) is a programming tool designed for connecting hardware devices,
APIs, and online services in creative and practical ways.
Andreas Schmitz uses [Node-RED](https://nodered.org/) as part of his home automation setup.
Add Markdown linter Add Markdown linter (pymarkdown) to pre-commit. Adapt current markdown files to fulfill linter rules. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-02-12 14:24:17 +01:00
### Node-Red Resources
Add Documentation 3 (#353) Add documentation that covers: - Architecture - Optimization (only empty template) - Integration. Add some PNG figures for architecture documentation including open document format sources to enable document maintainance. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:52:57 +01:00
fix: logging, prediction update, multiple bugs (#584) * Fix logging configuration issues that made logging stop operation. Switch to Loguru logging (from Python logging). Enable console and file logging with different log levels. Add logging documentation. * Fix logging configuration and EOS configuration out of sync. Added tracking support for nested value updates of Pydantic models. This used to update the logging configuration when the EOS configurationm for logging is changed. Should keep logging config and EOS config in sync as long as all changes to the EOS logging configuration are done by set_nested_value(), which is the case for the REST API. * Fix energy management task looping endlessly after the second update when trying to update the last_update datetime. * Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance. * Fix usage of model classes instead of model instances in nested value access when evaluation the value type that is associated to each key. * Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider. * Fix documentation qirks and add EOS Connect to integrations. * Support deprecated fields in configuration in documentation generation and EOSdash. * Enhance EOSdash demo to show BrightSky humidity data (that is often missing) * Update documentation reference to German EOS installation videos. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-06-10 22:00:28 +02:00
- [Installation Guide (German)](https://www.youtube.com/playlist?list=PL8_vk9A-s7zLD865Oou6y3EeQLlNtu-Hn)
\— A detailed guide on integrating EOS with `Node-RED`.
Add Documentation 3 (#353) Add documentation that covers: - Architecture - Optimization (only empty template) - Integration. Add some PNG figures for architecture documentation including open document format sources to enable document maintainance. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:52:57 +01:00
## Home Assistant
[Home Assistant](https://www.home-assistant.io/) is an open-source home automation platform that
emphasizes local control and user privacy.
Conceptual documentation (#463) Added new instruction.md, changed index.md accordingly and deleted the no longer needed about.md of new documentation structure. Refinement of differences to other solutions and features of EOS. Co-authored-by: Eric Hirsch <git@familie-hirsch.net>
2025-03-23 13:27:40 +01:00
(duetting-solution)=
Add Markdown linter Add Markdown linter (pymarkdown) to pre-commit. Adapt current markdown files to fulfill linter rules. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-02-12 14:24:17 +01:00
### Home Assistant Resources
Add Documentation 3 (#353) Add documentation that covers: - Architecture - Optimization (only empty template) - Integration. Add some PNG figures for architecture documentation including open document format sources to enable document maintainance. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-01-09 16:52:57 +01:00
- Duetting's [EOS Home Assistant Addon](https://github.com/Duetting/ha_eos_addon) — Additional
Add Markdown linter Add Markdown linter (pymarkdown) to pre-commit. Adapt current markdown files to fulfill linter rules. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-02-12 14:24:17 +01:00
details can be found in this [discussion thread](https://github.com/Akkudoktor-EOS/EOS/discussions/294).
fix: logging, prediction update, multiple bugs (#584) * Fix logging configuration issues that made logging stop operation. Switch to Loguru logging (from Python logging). Enable console and file logging with different log levels. Add logging documentation. * Fix logging configuration and EOS configuration out of sync. Added tracking support for nested value updates of Pydantic models. This used to update the logging configuration when the EOS configurationm for logging is changed. Should keep logging config and EOS config in sync as long as all changes to the EOS logging configuration are done by set_nested_value(), which is the case for the REST API. * Fix energy management task looping endlessly after the second update when trying to update the last_update datetime. * Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance. * Fix usage of model classes instead of model instances in nested value access when evaluation the value type that is associated to each key. * Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider. * Fix documentation qirks and add EOS Connect to integrations. * Support deprecated fields in configuration in documentation generation and EOSdash. * Enhance EOSdash demo to show BrightSky humidity data (that is often missing) * Update documentation reference to German EOS installation videos. Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-06-10 22:00:28 +02:00
## EOS Connect
[EOS connect](https://github.com/ohAnd/EOS_connect) uses `EOS` for energy management and optimization,
and connects to smart home platforms to monitor, forecast, and control energy flows.
Reference in New Issue Copy Permalink