From f3de118e3e43c46614da5ed638412c0d4839a8a6 Mon Sep 17 00:00:00 2001 From: Avi Miller Date: Mon, 19 Dec 2022 16:15:52 +1100 Subject: [PATCH] docs: update README.md Signed-off-by: Avi Miller --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a56057e..1234fc7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# SOMA Connect (Custom) for Home Assistant +# SOMA Connect for Home Assistant [![GitHub Release][releases-shield]][releases] [![GitHub Activity][commits-shield]][commits] @@ -9,13 +9,21 @@ This custom component is intended to be used instead of the core `soma` integrat It uses more resilient methods of communicating with the SOMA Connect device and provides additional entities including battery and light levels. -**This component will set up the following platforms.** +## Platforms + +This integration creates entities in the following platforms: Platform | Description -- | -- -`cover` | A `cover` entity is created for each Shade or Tilt device discovered. +`cover` | A `cover` entity is created for each Shade device discovered. `sensor` | Two `sensor` entities are created for each device: one for the battery level and the other for the light level. -. + +The cover entity supports Open, Close, Stop and Set Position. + +### Limitations + +This integration does not (yet) support Tilt devices as I don't have one to test +with. If I get one, I'll add support for it. ## Installation