From 6a89947a8f0fe4c32ab23ec4d4fd88241cd4deef Mon Sep 17 00:00:00 2001 From: Jimmy Everling Date: Sun, 11 Oct 2020 13:13:40 +0200 Subject: [PATCH] Some documentation updates --- README.md | 35 ++++++++++++++++++++---- custom_components/garo_wallbox/sensor.py | 4 +++ info.md | 23 +++++++++++++--- 3 files changed, 53 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 48a82ef..c192c50 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Garo Wallbox - HomeAssistant Integration +# Garo Wallbox (EVSE) - HomeAssistant Integration [![GitHub Release][releases-shield]][releases] [![License][license-shield]](LICENSE) @@ -13,11 +13,36 @@ This is a custom component to allow control of Garo Wallboxes in [HomeAssistant] - :coffee:  [Buy me a coffee](https://www.buymeacoffee.com/sockless) -# Configuration +## Installation + +### Install using HACS (recomended) +If you do not have HACS installed yet visit https://hacs.xyz for installation instructions. +In HACS go to the Integrations section hit the big + at the bottom right and search for **Garo Wallbox**. + +### Install manually +Clone or copy this repository and copy the folder 'custom_components/garo_wallbox' into '/custom_components/garo_wallbox' + +## Configuration + +Once installed the Garo Wallbox integration can be configured via the Home Assistant integration interface +where you can enter the IP address of the device. + +## Services + +### Set the mode of the EVSE +Service: `garo_wallbox.set_mode` +| Parameter | Description | Example | +| - | - | - | +| entity_id | Name of the entity to change | sensor.garage_charger | +| mode | The new mode available modes: `On`, `Off`, `Schema` | On | + +### Set the charge limit +Service: `garo_wallbox.set_current_limit` +| Parameter | Description | Example | +| - | - | - | +| entity_id | Name of the entity to change | sensor.garage_charger | +| limit | The new limit in Ampare | 10 | -The Garo Wallbox integration can be configured in two ways -* Automatically via the discovery integration. -* Via the Home Assistant user interface where it will let you enter the IP-address of your Garo Wallbox. [license-shield]: https://img.shields.io/github/license/sockless-coding/garo_wallbox.svg?style=for-the-badge [releases-shield]: https://img.shields.io/github/release/sockless-coding/garo_wallbox.svg?style=for-the-badge diff --git a/custom_components/garo_wallbox/sensor.py b/custom_components/garo_wallbox/sensor.py index 945cd6a..87eb0cc 100644 --- a/custom_components/garo_wallbox/sensor.py +++ b/custom_components/garo_wallbox/sensor.py @@ -68,6 +68,10 @@ def name(self): """Return the name of the sensor.""" return self._name + @property + def icon(self): + return "mdi:car-electric" + @property def state(self): """Return the state of the sensor.""" diff --git a/info.md b/info.md index 472f748..5858f21 100644 --- a/info.md +++ b/info.md @@ -8,8 +8,23 @@ This is a custom component to allow control of Garo Wallboxes in [HomeAssistant] - :coffee:  [Buy me a coffee](https://www.buymeacoffee.com/sockless) -# Configuration +## Configuration -The Garo Wallbox integration can be configured in two ways -* Automatically via the discovery integration. -* Via the Home Assistant user interface where it will let you enter the IP-address of your Garo Wallbox. \ No newline at end of file +Once installed the Garo Wallbox integration can be configured via the Home Assistant integration interface +where you can enter the IP address of the device. + +## Services + +### Set the mode of the EVSE +Service: `garo_wallbox.set_mode` +| Parameter | Description | Example | +| - | - | - | +| entity_id | Name of the entity to change | sensor.garage_charger | +| mode | The new mode available modes: `On`, `Off`, `Schema` | On | + +### Set the charge limit +Service: `garo_wallbox.set_current_limit` +| Parameter | Description | Example | +| - | - | - | +| entity_id | Name of the entity to change | sensor.garage_charger | +| limit | The new limit in Ampare | 10 | \ No newline at end of file