sudoxreboot/sleepd
1
0
Fork 0
mirror of https://github.com/sudoxnym/sleepd.git synced 2026-04-14 11:37:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md v0.1.0

Browse source
This commit is contained in:
sudoxnym 2024-05-30 19:51:59 -06:00 committed by GitHub
parent 5c6b43cc36
commit 289801380f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 40 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
README.md
View file

@ -1,11 +1,9 @@
[![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)<br>
[![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)
<h1>SAAS - Sleep As Android Status</h1>
<h2>Description:</h2></br>
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.</br></br>
<h2>Description:</h2>
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.</br>
<h3>This integration works best with a Xioami MiBand (7 or older) mixed with the Notify app and Sleep As Android configured.</h3>
<h3>This integration will create 8 Sensors, 8 Buttons, 1 service, and 1 device per user:</h3></br>
<h3>This integration will create 8 Sensors, 8 Buttons, 1 service, and 1 device per user:</h3>
<h3>Sensors</h3>
Message Received *State</br>
Wake Status</br>
@ -14,10 +12,8 @@ Disturbance</br>
Alarm</br>
Lullaby</br>
Sleep Tracking</br>
Sleep Statge</br>
Sleep Statge</br></br>
This should intelligently and dynamically allow for state changes in the Wake Status Sensor.</br></br>
<h3>Buttons</h3>
Alarm Dismiss</br>
Alarm Snooze</br>
@ -39,53 +35,26 @@ data:
minute: 30
</pre>
<h2>Installation:</h2>
&nbsp;&nbsp;Add https://www.github.com/sudoxnym/saas to your Custom Repositories in HACS</br>
Add https://www.github.com/sudoxnym/saas to your Custom Repositories in HACS</br>
&nbsp;&nbsp;Search and Download SAAS - Sleep As Android Status</br>
&nbsp;&nbsp;Restart Home Assistant</br>
&nbsp;&nbsp;[![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)<br>
&nbsp;&nbsp;Add Integration: SAAS - Sleep As Android Status</br></br>
Search and Download SAAS - Sleep As Android Status</br>
Restart Home Assistant</br>
[![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)<br>
Add Integration: SAAS - Sleep As Android Status</br></br>
<h2>Configuration:</h2>
<h2>Configuration:</h3>
Name: Name of user</br>
Topic: MQTT Topic from Sleep As Android</br>
QoS: Quality of Service</br></br>
&nbsp;&nbsp;Name: Name of user</br>
&nbsp;&nbsp;Topic: MQTT Topic from Sleep As Android</br>
&nbsp;&nbsp;QoS: Quality of Service</br></br>
&nbsp;&nbsp;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.</br>
&nbsp;&nbsp;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.</br>
&nbsp;&nbsp;Awake States: States to indicate being awake</br>
&nbsp;&nbsp;Asleep States: States to indicate being asleep</br>
&nbsp;&nbsp;Mobile App: Target for buttons </br></br>
<h3>Changes:</h3>
0.0.6a</br>
Initial Beta Release
Added persistant states through HA restart
Added attributes for the Alarm Event sensor
<h3>Known issues:</h3>
Error in logs:
<pre>
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</pre>
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. <s>Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay.</s> <b>FIXED</b></br>
Asleep Duration: This is for tuning. Time in seconds in which sleep states = true to indicate asleep. <s>Sensor usually updates within 30 seconds or so after the duration, not entirely sure why the delay.</s> <b>FIXED</b></br>
Awake States: States to indicate being awake</br>
Asleep States: States to indicate being asleep</br>
Mobile App: Target for buttons <b>REQUIRES COMPANION APP</b></br></br>
<h3>Set Up Notify for <a href="https://www.amazon.com/Xiaomi-Activity-Tracker-High-Res-Bluetooth/dp/B0B2DK5YCP">MiBand 7</a> (as of May 29, 2024)</h3>
1. Pair MiBand 7 as you normally would with <a href="https://play.google.com/store/apps/details?id=com.xiaomi.wearable&hl=en_US">Mi Fitness</a> app </br>
@ -129,6 +98,27 @@ awk -F ", " '{print $17}' | grep authKey | tail -1 | awk -F "=" '{print $2}'</pr
&nbsp;&nbsp;4d. Pair tracking (optional)</br>
5. Enjoy (optional)</br></br>
<h2>Changes:</h2>
<b>0.0.6a</b></br>
Initial Beta Release</br>
Added persistant states through HA restart</br>
Added attributes for the Alarm Event sensor</br>
<b>0.1.0</b></br>
Fixed Wake Status Timing <b>(HUGE)</b></br>
Fixed bug with Sound sensor</br>
Modified AlarmEvent, Disturbance, and Sound sensors to update to None accurately</br>
Organized Readme.md</br>
<h2>Known issues:</h2>
Error in logs:
<pre>
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</pre>
No known effects. Just an error message, everything works as expected.
Please report any issues.</br>
This is my first integration.