Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Avi Miller <[email protected]>
  • Loading branch information
Djelibeybi committed Dec 19, 2022
1 parent 3ff06d4 commit f3de118
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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]
Expand All @@ -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

Expand Down

0 comments on commit f3de118

Please sign in to comment.