Skip to content

Commit

Permalink
Add services to Readme, optimize project markdown config (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
torbennehmer authored Jul 25, 2023
2 parents 04daceb + 2e89c30 commit 820ca4c
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
"extensions": [
"DavidAnson.vscode-markdownlint",
"github.vscode-pull-request-github",
"joffreykern.markdown-toc",
"ms-python.black-formatter",
"ms-python.python",
"ms-python.vscode-pylance",
"ryanluker.vscode-coverage-gutters",
"stkb.rewrap",
"visualstudioexptteam.vscodeintellicode"
"visualstudioexptteam.vscodeintellicode",
"yzhang.markdown-all-in-one"
],
"settings": {
"editor.formatOnPaste": false,
Expand All @@ -31,6 +31,7 @@
"editor.tabSize": 4,
"files.eol": "\n",
"files.trimTrailingWhitespace": true,
"markdown.extension.toc.levels": "2..6",
"python.analysis.autoSearchPaths": false,
"python.editor.codeActionsOnSave": {
"source.organizeImports": true
Expand Down
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
},
"python.formatting.provider": "none"

}
54 changes: 53 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,28 @@ serial numbers etc., I recommend not to attach this to the issue directly, get
in touch on the issue and I'll give you a filedrop hosted on a private server of
me.

- [Disclaimer](#disclaimer)
- [Installation](#installation)
- [HACS Installation](#hacs-installation)
- [Manual Installation](#manual-installation)
- [Configuration](#configuration)
- [RSCP configuration](#rscp-configuration)
- [Probable causes of connection problems](#probable-causes-of-connection-problems)
- [Password limitations](#password-limitations)
- [Network restriction](#network-restriction)
- [Unsupported features configuration schemes](#unsupported-features-configuration-schemes)
- [Services](#services)
- [Set power limits](#set-power-limits)
- [Clear current power limits](#clear-current-power-limits)
- [Initate manual battery charging](#initate-manual-battery-charging)
- [Upstream source](#upstream-source)

## Disclaimer

This integration is provided without any warranty or support by E3DC
(unfortunately). I do not take responsibility for any problems it may cause in
all cases. Use it at your own risk.

## Installation

The recommend way to install this extension is using HACS. If you want more
Expand Down Expand Up @@ -138,6 +160,36 @@ Currently, the following features of pye3dc are not supported:
- Web Connections
- Local connections when offline, using the backup user.
## Services
The integration currently provides these services to initiate more complex
commands to the E3DC unit:
### Set power limits
Use the service `set_power_limits` to limit the maximum charging or discharging
rates of the battery system. Both values can be controlled individually, each
call replaces the settings made by the last. It will not allow you to change the
system defined minimum discharge rate at the moment, as I am not sure if this is
actually a sensible thing to do.

### Clear current power limits

`clear_power_limits` will drop any active power limit. It will not emit an error
if none has been set. Prefer this to use `set_power_limits` and setting the
values to the system defined maximum.

### Initate manual battery charging

The service `manual_charge` will start charging the specified amount of energy
into the battery, taking it from the grid if neccessary. The idea behind this is
to take advantage of dynamic electricity providers like Tibber. Charge your
battery when electricity is cheap even if you have no solar power available, for
example in windy winter nights/days.

Be aware, that calls to this operation seem to be limited, however, this is not
documented. As always, use at your own risk and discretion.

## Upstream source

The extension is based on [Python E3DC
Expand All @@ -156,7 +208,7 @@ library](https://github.com/fsantini/python-e3dc) from @fsantini. The general co
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
-->
[forum-shield]: https://img.shields.io/badge/Community%20Forum-Home%20Assistant-blue?style=for-the-badge&logo=homeassistant
[forum]: https://community.home-assistant.io/
[forum]: https://community.home-assistant.io/t/e3dc-remote-storage-control-protocol-rscp/595280
[hacs]: https://github.com/hacs/integration
[hacs-shield]: https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge&logo=homeassistantcommunitystore
[license-shield]: https://img.shields.io/github/license/torbennehmer/hacs-e3dc?style=for-the-badge&color=blue&logo=gnu
Expand Down

0 comments on commit 820ca4c

Please sign in to comment.