-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
translation completed working on translations finally "all" sensors are there handle indexError fixing sensor lookups - case-sensitive just sucks binary_sensor support OFF icons numbers polished number cco added (consumption for APP display only) numbers finished work on numbers [times] work on numbers (started only) added button(s) selects implemented fix "no" error messages on write implemented switches binary_sensors complete reading first (binary) sensors!
- Loading branch information
Showing
26 changed files
with
4,350 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Problem Report | ||
description: please report any technical issue with this home assistant integration - please note this is not a official Waterkotte repository or service | ||
labels: bug | ||
body: | ||
- type: checkboxes | ||
id: checklist | ||
attributes: | ||
label: Checklist | ||
description: Please go though this short checklist - TIA | ||
options: | ||
- label: I have installed the **latest** release (or BETA) version of the integration and home assistant. | ||
required: true | ||
- label: I have prepared DEBUG log output (for technical issues) | In most of the cases of a technical error/issue I would have the need to ask for DEBUG log output of the integration. There is a short [tutorial/guide 'How to provide DEBUG log' here](https://github.com/marq24/ha-senec-v3/blob/master/docs/HA_DEBUG.md) | ||
required: true | ||
- label: I confirm it's really an issue | In the case that you want to understand the functionality of a certain feature/sensor Please be so kind and make use if the discussion feature of this repo (and do not create an issue) - TIA | ||
- type: textarea | ||
id: content | ||
attributes: | ||
label: Add a description | ||
placeholder: "Please provide details about your issue - in the best case a short step by step instruction how to reproduce the issue - TIA." | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Add your DEBUG log output | ||
placeholder: "Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks." | ||
render: shell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
name: Feature Request | ||
description: Suggest an idea for this home assistant integration | ||
labels: enhancement | ||
body: | ||
- type: textarea | ||
id: content | ||
attributes: | ||
label: Description | ||
placeholder: "Let me know what do you miss..." | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: List of tags | ||
placeholder: "Please use the inspect feature of your browser (while using the default waterkotte web client) in order to extract the corresponding TAGs that should be used to previde the requested data - TIA" | ||
render: shell |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: HACS Action | ||
|
||
on: | ||
push: | ||
pull_request: | ||
schedule: | ||
- cron: "0 0 * * *" | ||
|
||
jobs: | ||
hacs: | ||
name: HACS Action | ||
runs-on: "ubuntu-latest" | ||
steps: | ||
- uses: "actions/checkout@v2" | ||
- name: HACS Action | ||
uses: "hacs/action@main" | ||
with: | ||
category: "integration" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: Validate with hassfest | ||
|
||
on: | ||
push: | ||
pull_request: | ||
schedule: | ||
- cron: '0 0 * * *' | ||
|
||
jobs: | ||
validate: | ||
runs-on: "ubuntu-latest" | ||
steps: | ||
- uses: "actions/checkout@v2" | ||
- uses: "home-assistant/actions/hassfest@master" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
__pycache__ | ||
pythonenv* | ||
.python-version | ||
.coverage | ||
venv | ||
.venv | ||
core.* | ||
*.iml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 marq24 | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,81 @@ | ||
# ha-goecharger-api-2 | ||
No clue why nobody else providing a HA integration that's will directly communicating with the go-eCharger API 2.0. So I will give it a try! | ||
# Home Assistant Integration 'go-eCharger APIv2 Connect' | ||
|
||
![logo](https://github.com/marq24/ha-ha-goecharger-api2/raw/main/logo.png) | ||
|
||
Support vor all go-eCharger Wallboxes supporting APIv2 - all Fields documented [in the official go-eCharger github repository](https://github.com/goecharger/go-eCharger-API-v2/blob/main/apikeys-en.md) are supported. | ||
|
||
This integration also support a German translated interface and sensor names & values. | ||
|
||
For all go-eCharger (status) fields that support a numeric status code, this code is available as separate sensor. | ||
|
||
Please note that the configuration data will be read only every 24hours from the hardware (to save data) - but you can update the sensors any time with an 'update' button. | ||
|
||
[![hacs_badge][hacsbadge]][hacs] [![BuyMeCoffee][buymecoffeebadge]][buymecoffee] [![PayPal][paypalbadge]][paypal] | ||
|
||
|
||
## Disclaimer | ||
|
||
Please be aware, that we are developing this integration to best of our knowledge and belief, but cant give a guarantee. Therefore, use this integration **at your own risk**. | ||
|
||
### HACS | ||
|
||
1. Add a custom integration repository to HACS: [ha-goecharger-api2](https://github.com/marq24/ha-goecharger-api2) | ||
1. Install the custom integration | ||
1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "go-eCharger APIv2 Connect" | ||
1. Setup the waterkotte custom integration as described below | ||
|
||
<!--1. In HACS Store, search for [***marq24/ha-goecharger-api2***]--> | ||
|
||
### Manual | ||
|
||
1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`). | ||
2. If you do not have a `custom_components` directory (folder) there, you need to create it. | ||
3. In the `custom_components` directory (folder) create a new folder called `goecharger_api2`. | ||
4. Download _all_ the files from the `custom_components/goecharger_api2/` directory (folder) in this repository. | ||
5. Place the files you downloaded in the new directory (folder) you created. | ||
6. Restart Home Assistant | ||
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "go-eCharger APIv2 Connect" | ||
|
||
## Adding or enabling the integration | ||
|
||
### My Home Assistant (2021.3+) | ||
|
||
Just click the following Button to start the configuration automatically: | ||
|
||
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=goecharger_api2) | ||
|
||
### Manual | ||
|
||
Use the following steps for a manual configuration by adding the custom integration using the web interface and follow instruction on screen: | ||
|
||
- Go to `Configuration -> Integrations` and add "Waterkotte" integration | ||
- Provide the IP address (or hostname) of your Waterkotte Heatpump web server | ||
- Select the Interface-Type of your Waterkotte (when you need to provide the user & password 'waterkotte' to login via your app/browser, then select `EcoTouch Mode`) | ||
- Select the number of TAGs that can be fetched in a single call to your device (older devices might need to adjust this value - for my in 2022 installed Waterkotte 75 is totally fine) | ||
- Provide area where the heatpump is located | ||
|
||
After the integration was added you can use the 'config' button to adjust your settings and you can additionally modify the update intervall | ||
|
||
Please note, that most of the available sensors are __not__ enabled by default. | ||
|
||
|
||
--- | ||
|
||
###### Advertisement / Werbung - alternative way to support me | ||
|
||
### Switch to Tibber! | ||
|
||
Be smart switch to Tibber - that's what I did in october 2023. If you want to join Tibber (become a customer), you might want to use my personal invitation link. When you use this link, Tibber will we grant you and me a bonus of 50,-€ for each of us. This bonus then can be used in the Tibber store (not for your power bill) - e.g. to buy a Tibber Bridge. If you are already a Tibber customer and have not used an invitation link yet, you can also enter one afterward in the Tibber App (up to 14 days). [[see official Tibber support article](https://support.tibber.com/en/articles/4601431-tibber-referral-bonus#h_ae8df266c0)] | ||
|
||
Please consider [using my personal Tibber invitation link to join Tibber today](https://invite.tibber.com/6o0kqvzf) or Enter the following code: 6o0kqvzf (six, oscar, zero, kilo, quebec, victor, zulu, foxtrot) afterward in the Tibber App - TIA! | ||
|
||
--- | ||
|
||
[hacs]: https://hacs.xyz | ||
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge&logo=homeassistantcommunitystore&logoColor=ccc | ||
|
||
[buymecoffee]: https://www.buymeacoffee.com/marquardt24 | ||
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a-coffee-blue.svg?style=for-the-badge&logo=buymeacoffee&logoColor=ccc | ||
|
||
[paypal]: https://paypal.me/marq24 | ||
[paypalbadge]: https://img.shields.io/badge/paypal-me-blue.svg?style=for-the-badge&logo=paypal&logoColor=ccc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
"""Dummy init so that pytest works.""" |
Oops, something went wrong.