From d4b829fcfd94b19c4b3560d47670c6ee0b7ccbc0 Mon Sep 17 00:00:00 2001 From: Jezza34000 <57314417+Jezza34000@users.noreply.github.com> Date: Fri, 25 Nov 2022 14:14:08 +0100 Subject: [PATCH] update README.md --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b52ba51..ef9acd8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![](https://img.shields.io/github/release/Jezza34000/homeassistant_weback_component/all.svg?style=for-the-badge)](https://github.com/Jezza34000/homeassistant_weback_component) [![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration) -Home Assistant component for controling robot from brand like : Neatsvor / Tesvor / Orfeld / Abir... +Home Assistant component for controlling robot from brand like : Neatsvor / Tesvor / Orfeld / Abir... Who using WeBack or Tesvor apps. ## Installation @@ -36,9 +36,20 @@ weback_vacuum: **application** : if you use "WeBack" do not try to change this field. \ **client_id**, **api_version**, **language**: seems to have no effect. Do not use it. -> **Warning** : Some user are expericing problem with the use of sharing option in WeBack's app. I recommand to not use this option and remove shared account to ensure a proper working +Config example : + +``` YAML +weback_vacuum: + username: mymail@contactme.com + password: mysupersecuredpassword + region: 33 +``` + +> Do not use any leading/ending characters like < > " ' + + +Once configuration set you can restart Home Assistant. +After restart, a new vacuum entity is created with the name defined into WeBack apps. -Once set you can restart Home Assistant. ## Important : API change since 2022 @@ -52,6 +63,17 @@ Go to WeBack app : * Add your robot to your new account +## Issues + +If you find any bug or you're experiencing any problem, please set your Home Assistant log level to debug before opening any issues. And provide full log. +To set your HA into debug level copy this into your `configuration.yaml` : + +``` YAML +logger: + default: error + logs: + custom_components.weback_vacuum: debug +```