From 289801380fef95ba31accb73f0e6320e04b9e885 Mon Sep 17 00:00:00 2001
From: sudoxnym <76703581+sudoxnym@users.noreply.github.com>
Date: Thu, 30 May 2024 19:51:59 -0600
Subject: [PATCH] Update README.md v0.1.0
---
README.md | 90 +++++++++++++++++++++++++------------------------------
1 file changed, 40 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 476a41b..2053cc9 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,9 @@
-[](https://hacs.xyz/docs/faq/custom_repositories)
+[](https://hacs.xyz/docs/faq/custom_repositories)
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. As of 0.0.4 Buttons that link with the Companion app have been added.
+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. As of 0.0.4 Buttons that link with the Companion app have been added.
This integration works best with a Xioami MiBand (7 or older) mixed with the Notify app and Sleep As Android configured.
-
-This integration will create 8 Sensors, 8 Buttons, 1 service, and 1 device per user:
-
+This integration will create 8 Sensors, 8 Buttons, 1 service, and 1 device per user:
Sensors
Message Received *State
Wake Status
@@ -14,10 +12,8 @@ Disturbance
Alarm
Lullaby
Sleep Tracking
-Sleep Statge
-
+Sleep Statge
This should intelligently and dynamically allow for state changes in the Wake Status Sensor.
-
Buttons
Alarm Dismiss
Alarm Snooze
@@ -39,53 +35,26 @@ data:
minute: 30
-
-
-
-
-
Installation:
-
- Add https://www.github.com/sudoxnym/saas to your Custom Repositories in HACS
+Add https://www.github.com/sudoxnym/saas to your Custom Repositories in HACS
- Search and Download SAAS - Sleep As Android Status
- Restart Home Assistant
- [](https://my.home-assistant.io/redirect/config_flow_start/?domain=saas)
- Add Integration: SAAS - Sleep As Android Status
+Search and Download SAAS - Sleep As Android Status
+Restart Home Assistant
+[](https://my.home-assistant.io/redirect/config_flow_start/?domain=saas)
+Add Integration: SAAS - Sleep As Android Status
+Configuration:
-Configuration:
+Name: Name of user
+Topic: MQTT Topic from Sleep As Android
+QoS: Quality of Service
- Name: Name of user
- Topic: MQTT Topic from Sleep As Android
- QoS: Quality of Service
-
- Awake Duration: This is for tuning. Time in seconds in which awake states = true to indicate awake. Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay.
- Asleep Duration: This is for tuning. Time in seconds in which sleep states = true to indicate asleep Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay.
- Awake States: States to indicate being awake
- Asleep States: States to indicate being asleep
- Mobile App: Target for buttons
-
-
-
-Changes:
-0.0.6a
-Initial Beta Release
-Added persistant states through HA restart
-Added attributes for the Alarm Event sensor
-
-Known issues:
-Error in logs:
-
-Logger: homeassistant.helpers.service
-Source: /usr/src/homeassistant/homeassistant/helpers/service.py:708
-First occurred: 3:55:19 PM (1 occurrences)
-Last logged: 3:55:19 PM
-
-Failed to load integration: saas
-NoneType: None
-No known effects. Just an error message, everything works as expected.
+Awake Duration: This is for tuning. Time in seconds in which awake states = true to indicate awake. Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay. FIXED
+Asleep Duration: This is for tuning. Time in seconds in which sleep states = true to indicate asleep. Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay. FIXED
+Awake States: States to indicate being awake
+Asleep States: States to indicate being asleep
+Mobile App: Target for buttons REQUIRES COMPANION APP
Set Up Notify for MiBand 7 (as of May 29, 2024)
1. Pair MiBand 7 as you normally would with Mi Fitness app
@@ -129,6 +98,27 @@ awk -F ", " '{print $17}' | grep authKey | tail -1 | awk -F "=" '{print $2}'
5. Enjoy (optional)
+Changes:
+0.0.6a
+Initial Beta Release
+Added persistant states through HA restart
+Added attributes for the Alarm Event sensor
+0.1.0
+Fixed Wake Status Timing (HUGE)
+Fixed bug with Sound sensor
+Modified AlarmEvent, Disturbance, and Sound sensors to update to None accurately
+Organized Readme.md
+Known issues:
+Error in logs:
+
+Logger: homeassistant.helpers.service
+Source: /usr/src/homeassistant/homeassistant/helpers/service.py:708
+First occurred: 3:55:19 PM (1 occurrences)
+Last logged: 3:55:19 PM
+
+Failed to load integration: saas
+NoneType: None
+No known effects. Just an error message, everything works as expected.
Please report any issues.
This is my first integration.