diff --git a/README.md b/README.md index fb599b6..7d8e017 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,42 @@ -SAAS - Sleep As Android Status +

SAAS - Sleep As Android Status

+

Description:


+Sleep As Android Status is my solution for wake/sleep state within HA. It listens for the Sleep As Android MQTT Messages, so it does require being on the same network.

+ +When finished this integration will create 7 entities and 1 device per user:

+Message Received *State
+Wake Status
+Sound
+Disturbance
+Alarm
+Lullaby
+Sleep Tracking
-THIS INTEGRATION IS FUNCTIONAL BUT NOT FINISHED! +This should intelligently and dynamically allow for state changes in the Wake Status Sensor.

+ +

Installation:

+ +   [![Add to HACS](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge&logo=home%20assistant&labelColor=202020&color=41BDF5)](https://hacs.xyz/docs/faq/custom_repositories)
+   Add https://www.github.com/sudoxnym/saas to your Custom Repositories in HACS
+ +   Search and Download SAAS - Sleep As Android Status
+   Restart Home Assistant
+   [![Add To My Home Assistant](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=saas)
+   Add Integration: SAAS - Sleep As Android Status

+ + +

Configuration:

+ +   Name: Name of user
+   Topic: MQTT Topic from Sleep As Android
+   QoS: Quality of Service

+ +   Awake Duration: Time in seconds in which awake states = true to indicate awake
+   Asleep Duration: Time in seconds in which sleep states = true to indicate asleep
+   Awake States: States to indicate being awake
+   Asleep States: States to indicate being asleep

+ +Please report any issues.
+This is my first integration. Built this in less than a week, with no prior knowledge of Python. - -When finished this integration will create 6 sensors per user. (x works, O needs work) - -x State - -x Sound - -x Disturbance - -x Alarm Event - -x Sleep Tracking - -O Lullaby State - -O Wake Status - -This should intelligently and dynamically allow for state changes. As of right now some states work and some don't.