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

Update README.md

Browse source
This commit is contained in:
sudoxnym 2025-04-13 13:38:44 -06:00 committed by GitHub
parent ed4d2f082a
commit 1d64ce87bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 79 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

94
README.md
View file

@ -13,24 +13,13 @@ Sleep As Android Status is my solution for wake/sleep state within HA. It listen
<h4>💡 This integration works best with a Xioami MiBand (7 or older) mixed with the Notify app and Sleep As Android configured.</h4> <h4>💡 This integration works best with a Xioami MiBand (7 or older) mixed with the Notify app and Sleep As Android configured.</h4>
<h3>✅ Known working:</h3>
<ul>
<li>📟 Xioami Mi Band 7</li>
<li>📟 Xioami Mi Band 8 and 9 may work, but they have a different os that jumps through hoops to work.</li>
<li>⌚ Garmin Fenix 7X with Garmin Alternative, <b>NOT</b> the free one.</li>
<li>⌚ Xioami Amazfit GTR Mini, may require root, I am rooted so I just did what's in this guide but there may be alternative ways to get the key</li>
</ul>
<h3>🧱 This integration will create:</h3> <h3>🧱 This integration will create:</h3>
<ul>
<li>8 Sensors</li>
<li>8 Buttons</li>
<li>1 Service</li>
<li>1 Device per user</li>
</ul>
<h3>📡 Sensors</h3>
<ul> <ul>
<li>
<details>
<summary><strong>📡 8 Sensors</strong></summary>
<ul>
<li>Message Received *State</li> <li>Message Received *State</li>
<li>Wake Status</li> <li>Wake Status</li>
<li>Sound</li> <li>Sound</li>
@ -39,12 +28,14 @@ Sleep As Android Status is my solution for wake/sleep state within HA. It listen
<li>Lullaby</li> <li>Lullaby</li>
<li>Sleep Tracking</li> <li>Sleep Tracking</li>
<li>Sleep Stage</li> <li>Sleep Stage</li>
</ul> </ul>
<p>This should intelligently and dynamically allow for state changes in the Wake Status Sensor.</p>
<p>This should intelligently and dynamically allow for state changes in the Wake Status Sensor.</p> </details>
</li>
<h3>🎛️ Buttons</h3> <li>
<ul> <details>
<summary><strong>🎛️ 8 Buttons</strong></summary>
<ul>
<li>Alarm Dismiss</li> <li>Alarm Dismiss</li>
<li>Alarm Snooze</li> <li>Alarm Snooze</li>
<li>Lullaby Stop</li> <li>Lullaby Stop</li>
@ -53,17 +44,39 @@ Sleep As Android Status is my solution for wake/sleep state within HA. It listen
<li>Sleep Tracking Start</li> <li>Sleep Tracking Start</li>
<li>Sleep Tracking Start with Optimal Alarm</li> <li>Sleep Tracking Start with Optimal Alarm</li>
<li>Sleep Tracking Stop</li> <li>Sleep Tracking Stop</li>
</ul> </ul>
</details>
<h3>🛠️ Service</h3> </li>
<pre> <li>
<details>
<summary><strong>🛠️ 1 Service</strong></summary>
<pre>
service: saas.saas_example_alarm_set service: saas.saas_example_alarm_set
data: data:
message: Example Message! message: Example Message!
day: monday day: monday
hour: 7 hour: 7
minute: 30 minute: 30
</pre> </pre>
</details>
</li>
<li>
<details>
<summary><strong>🔗 1 Device per user</strong></summary>
<p>One HA device is created per configured user instance to link sensors, services, and buttons.</p>
</details>
</li>
</ul>
<details>
<summary><strong>✅ Known working</strong></summary>
<ul>
<li>📟 Xioami Mi Band 7</li>
<li>📟 Xioami Mi Band 8 and 9 may work, but they have a different OS that jumps through hoops to work.</li>
<li>⌚ Garmin Fenix 7X with Garmin Alternative, <b>NOT</b> the free one.</li>
<li>⌚ Xioami Amazfit GTR Mini — may require root. I am rooted so I just did what's in this guide, but there may be alternative ways to get the key.</li>
</ul>
</details>
<h2>🧪 Installation:</h2> <h2>🧪 Installation:</h2>
<ul> <ul>
@ -150,29 +163,32 @@ sqlite3 origin_db_1234567890 "SELECT AUTHKEY FROM DEVICE;"
<li>Wearables > Xiaomi Mi Band > Test sensor</li> <li>Wearables > Xiaomi Mi Band > Test sensor</li>
</ol> </ol>
<h2>📦 Changes:</h2> <details>
<b>0.0.6a</b> <summary><strong>📦 Changes</strong></summary>
<ul> <b>0.0.6a</b>
<ul>
<li>Initial Beta Release</li> <li>Initial Beta Release</li>
<li>Added persistent states</li> <li>Added persistent states</li>
<li>Alarm Event sensor attributes</li> <li>Alarm Event sensor attributes</li>
</ul> </ul>
<b>0.1.0</b> <b>0.1.0</b>
<ul> <ul>
<li>Fixed Wake Status Timing</li> <li>Fixed Wake Status Timing</li>
<li>Bug fixes on Sound sensor</li> <li>Bug fixes on Sound sensor</li>
<li>Accurate updates to AlarmEvent, Disturbance, Sound</li> <li>Accurate updates to AlarmEvent, Disturbance, Sound</li>
<li>Organized README</li> <li>Organized README</li>
</ul> </ul>
</details>
<h2>🚨 Known issues:</h2> <details>
<pre> <summary><strong>🚨 Known Issues</strong></summary>
<pre>
Logger: homeassistant.helpers.service Logger: homeassistant.helpers.service
Source: /usr/src/homeassistant/homeassistant/helpers/service.py:708 Source: /usr/src/homeassistant/homeassistant/helpers/service.py:708
Failed to load integration: saas Failed to load integration: saas
NoneType: None NoneType: None
</pre> </pre>
<p>💬 No known effects. Just an error message, everything works as expected.</p>
<p>💬 No known effects. Just an error message, everything works as expected.</p> <p>This is my first integration.</p>
<p>This is my first integration.</p> </details>