Skip to content

Commit 6a5eddb

Browse files
committed
big update
1 parent d9ff843 commit 6a5eddb

214 files changed

Lines changed: 9613 additions & 3680 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

hugo/content/_index.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,40 @@
11
---
2+
title: Welcome to Sleep as Android Documentation
3+
layout: default
4+
---
5+
6+
# Sleep as Android Documentation
27

3-
# Feel free to add content and custom Front Matter to this file.
4-
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
8+
Welcome to the official documentation for **Sleep as Android**, your smart alarm clock and sleep cycle tracker. Here you will find everything you need to know about setting up the app, connecting devices, and understanding your sleep data.
59

6-
layout: home
7-
exclude_from_nav: true
8-
no_comments: true
910
---
1011

12+
## Quick Start
1113

12-
[.text-center]
13-
[Get the app](https://play.google.com/store/apps/details?id=com.urbandroid.sleep)
14+
<div class="text-center">
1415

16+
[**Get Sleep as Android on Google Play**](https://play.google.com/store/apps/details?id=com.urbandroid.sleep)
17+
18+
</div>
1519

1620
{{< youtube 6HHYxnvIPA0 >}}
1721

22+
---
23+
24+
## Explore the Documentation
25+
26+
* [**Getting Started**](/general/start): New to the app? Start here.
27+
* [**Alarms & Naps**](/alarms/alarm_settings): Configure your wake-up routine.
28+
* [**Sleep Tracking**](/sleep/sleep_tracking): Learn how we measure your sleep.
29+
* [**Connected Devices**](/devices/wearables): Set up your smartwatch or Sleep Phaser.
30+
* [**Connected Services**](/services/): Integrate with Google Fit, Health Connect, or IFTTT.
31+
32+
---
1833

34+
<div class="text-center">
1935

36+
### Need Help?
2037

38+
If you have questions or encounter issues, please visit our [**Support Forum**](https://forum.urbandroid.org/) or contact us directly at [**support@urbandroid.org**](mailto:support@urbandroid.org).
2139

22-
[.text-center]
23-
If you need any help with app,
24-
please contact us mailto:support@urbandroid.org[at our support email support@urbandroid.org].
40+
</div>

hugo/content/about.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
---
2-
3-
layout: page
42
title: About
5-
permalink: /about/
6-
no_troubleshooting: true
7-
exclude_from_nav: true
83
---
94

5+
This is the user manual for **Sleep as Android**, the #1 sleep tracking app for Android.
106

11-
This is the user manual for the #1 sleep tracking Android app **Sleep as Android**.
12-
13-
[Get the app here](https://play.google.com/store/apps/details?id=com.urbandroid.sleep).
7+
[**Get the app on Google Play**](https://play.google.com/store/apps/details?id=com.urbandroid.sleep)

hugo/content/addons.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
---
2-
3-
layout: page
4-
title: Addons
5-
permalink: /addons/
6-
no_troubleshooting: true
7-
nav_order: 60
8-
no_comments: true
2+
title: Add-ons
3+
weight: 60
94
---
105

6+
Enhance your Sleep as Android experience with these official add-ons and compatible services:
117

12-
- [SleepCloud](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.addon.port&hl=cs&gl=US)
13-
- [Sleep Phaser](https://www.happy-electronics.eu/shop7/en/21-sleep-as-android)
14-
- [Wearables](/devices/supported_wearable)
15-
- [Lullabies](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.addon.lullaby&hl=cs&gl=US)
16-
- [Oximeter](/devices/oximeter)
17-
- [CAPTCHA](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.captchapack&hl=cs&gl=US)
18-
- [Sleep Mask](https://www.happy-electronics.eu/shop7/en/21-sleep-as-android)
19-
- [Mindroid](https://play.google.com/store/apps/details?id=com.urbandroid.mind)
8+
* [**SleepCloud**](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.addon.port): Cloud backup and synchronization.
9+
* [**Sleep Phaser**](https://www.happy-electronics.eu/shop/en/21-sleep-as-android): Contactless smart bedside lamp.
10+
* [**Wearables**](/devices/supported_wearable): Smartwatch and fitness tracker integrations.
11+
* [**Lullabies**](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.addon.lullaby): Extra high-quality soundscapes.
12+
* [**Oximeter**](/devices/oximeter): Continuous SpO<sub>2</sub> monitoring.
13+
* [**CAPTCHA Pack**](https://play.google.com/store/apps/details?id=com.urbandroid.sleep.captchapack): More puzzles to wake you up.
14+
* [**Sleep Mask**](https://www.happy-electronics.eu/shop/en/21-sleep-as-android): Light stimulation for sleep and lucid dreaming.
15+
* [**Mindroid**](https://play.google.com/store/apps/details?id=com.urbandroid.mind): Binaural beat stimulation.

hugo/content/alarms/_index.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,47 @@
11
---
2-
3-
layout: default
42
title: Alarms
5-
nav_order: 10
6-
has_children: true
7-
no_comments: true
3+
bookCollapseSection: true
4+
weight: 10
5+
---
6+
7+
# Alarms
8+
9+
**Sleep as Android** provides a highly customizable alarm system designed to help you wake up refreshed and ensure you never oversleep.
10+
11+
From our signature **Smart Wake-up** that catches you in light sleep, to brain-teasing **CAPTCHAs** that ensure you're truly awake, use this section to build your perfect morning routine.
12+
13+
---
14+
15+
## The Basics
16+
Get started with creating and configuring your alarms.
17+
18+
* [**Create Alarm**](/alarms/create_alarm): A guide to setting your first alarm or nap.
19+
* [**Alarm Settings**](/alarms/alarm_settings): Explore default and per-alarm configuration options.
20+
821
---
922

23+
## Wake-up Features
24+
Tools to help you transition from sleep to wakefulness.
25+
26+
* [**Smart Wake-up**](/sleep/smart_wake_up): Learn how the app finds the ideal moment to wake you up.
27+
* [**Snooze**](/alarms/snooze): Configure snooze durations, limits, and the "halve-the-snooze" feature.
28+
* [**CAPTCHA**](/alarms/captcha): Mini-tasks (math, QR codes, etc.) you must solve to turn off the alarm.
29+
* [**Backup Alarm**](/alarms/backup): A fail-safe loud alarm that triggers if you ignore your primary wake-up call.
30+
31+
---
32+
33+
## Sound & Environment
34+
Customize how your alarm sounds and how it interacts with your room.
35+
36+
* [**Sound & Ringtones**](/alarms/ringtone): Choose nature sounds, local music, Spotify, or online radio.
37+
* [**Smartlight**](/devices/smart_light): Integrate sunrise-like wake-up lights with your alarm.
38+
39+
---
40+
41+
## Planning & Specialized Sleeping
42+
Stay on track with your sleep goals and unique schedules.
43+
44+
* [**Bedtime Notification**](/alarms/bedtime_notification): Friendly reminders to head to bed on time based on your sleep goal.
45+
* [**Naps**](/alarms/naps): Quick timers for power naps and restorative rest.
46+
* [**Power Nap**](/alarms/power_nap): A specialized smart alarm for flexible wake-up times.
47+
* [**Polyphasic Sleeping**](/alarms/polyphasic): Setup guides for complex multi-nap sleep schedules.

hugo/content/alarms/alarm_settings.md

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ redirect_from:
1010
- /sleep/alarm_settings.html
1111
---
1212

13+
# Alarm settings
14+
15+
1316
**Sleep as Android** gives you complete control over how and when your alarms trigger. You can customize global default settings that apply to all alarms or tweak individual settings for specific alarms (like giving yourself a longer smart wake-up window on weekends).
1417

1518

@@ -21,28 +24,32 @@ redirect_from:
2124
> [!TIP]
2225
> Per-alarm settings override global defaults! If an option is set directly within a specific alarm, it takes priority over the global settings menu.
2326
27+
<a id="alarm_default"></a>
2428

2529
## Default Alarm Options
2630

2731
These settings define the baseline behavior across all alarms set in `Settings``Alarms`.
2832

2933
| Setting | Description |
3034
| :--- | :--- |
31-
| **Smart wake up** | By detecting light sleep within your wake-up window, the app catches the perfect moment to wake you up. |
32-
| **CAPTCHA** | Select a [mandatory CAPTCHA task](/alarms/captcha) to solve before turning alarms. Perfect solution for heavy sleepers. |
33-
| **Sound** | Pick the perfect melody for perfect mornings. Read all details about ringtones in [Sound chapter here](/alarms/ringtone). |
34-
| **Bedtime notification** | Sends you a reminder to get ready for sleep in time, more details at [Bedtime notification chapter](/alarms/bedtime_notification). |
35-
| **Snooze** | Lets you temporarily delay your wake-up. Read more about snoozing in [Snooze chapter](/alarms/snooze). |
35+
| **[Smart wake up](/sleep/smart_wake_up)** | By detecting light sleep within your wake-up window, the app catches the perfect moment to wake you up. |
36+
| **[CAPTCHA](/alarms/captcha)** | Select a mandatory CAPTCHA task to solve before turning alarms. Perfect solution for heavy sleepers. |
37+
| **[Sound](/alarms/ringtone)** | Pick the perfect melody for perfect mornings. |
38+
| **[Gentle Wake up](#gentle_wake_up)** | A combination of features for a peaceful wake-up, including gradual volume ramp-up, independent vibration timing, and sunrise light emulation (via phone screen or external smart bulbs). |
39+
| **[Bedtime notification](/alarms/bedtime_notification)** | Sends you a reminder to get ready for sleep in time. |
40+
| **[Snooze](/alarms_snooze)** | Lets you temporarily delay your wake-up. |
3641
| **Fullscreen alarm** | Ensures alarms display full-screen over the lockscreen instead of appearing as a small heads-up notification banner. <br>*Requires granting the **Display / Draw over other apps** permission in System Settings.* |
3742
| **Flip to snooze** | Turn your phone face-down (or face-up) to instantly snooze the alarm. |
3843
| **Long press** | Requires holding down the Dismiss button for several seconds to prevent accidental turn-offs while half-asleep. |
3944
| **No screen orientation changes** | Locks the screen orientation during an active alarm to prevent accidental touches or premature snoozing caused by screen rotation. |
4045
| **Volume or camera button effect** | Reassign physical device buttons to snooze or dismiss. |
41-
| **Backup alarm** | Fail-safe alarm that triggers if your main alarm is left unhandled. Read more about the [Backup alarm chapter](/alarms/backup). |
46+
| **[Backup alarm](/alarms/backup)** | Fail-safe alarm that triggers if your main alarm is left unhandled. |
4247
| **Alarm timeout** | Sets how long your alarm will ring without a response before the application realizes you haven't woken up. Once time runs out, it automatically switches to a high-volume Backup Alarm. |
4348
| **Alarm output** | You can force audio through media sound stream into headphones to keep your wake-up routine private. ⚠️ Test first! |
4449

4550

51+
<a id="per_alarm"></a>
52+
4653
## Per-Alarm Features
4754

4855
These features can be tailored individually inside each alarm card to fit specific wake-up scenarios (e.g., intense wake-up routine for workdays vs. a gentle schedule on weekends).
@@ -54,19 +61,21 @@ These features can be tailored individually inside each alarm card to fit specif
5461
| **Repeat Rules** | Choose between weekly repeats, bi-weekly schedules (*Odd / Even weeks*), or non-weekly day intervals (e.g., *Every 3rd day*). |
5562
| **Repeat** | Select which days of the week the alarm should trigger (e.g., Weekdays, Weekends, or specific days). |
5663
| **Next Alarm Date** | Temporarily change the exact date of the next occurrence (e.g., shift tomorrow's 6:00 AM alarm to 8:00 AM for a single day—it automatically reverts afterward). |
57-
| **Smart period** | Adjust the smart wake-up period for this alarm. Use a wider window for workdays and a tighter or disabled window for weekends. |
58-
| **CAPTCHA Task** | Require a specific puzzle or task (Math, QR code, NFC, etc.) to dismiss high-importance alarms. |
59-
| **Wake up check** | Acts as a safety net by asking *"Are you still awake?"* shortly after you've dismissed the alarm. |
60-
| **Sound (Ringtone)** | Select the ringtone, custom music, online stream, or Spotify playlist for this specific alarm. For a complete guide on supported audio formats, see [Ringtones](/alarms/ringtone.html). |
61-
| **Gentle Volume** | Ramps audio up gradually from zero to maximum loudness over a duration ranging from 30 seconds to 24 minutes. |
62-
| **Bedtime notification** | Sends you a friendly *"Time to go to bed!"* reminder so you have enough time to wind down and get ready for sleep. |
63-
| **Snooze** | Cap the total number of allowed snoozes or maximum snooze duration for this alarm. |
64+
| **[Smart period](/sleep/smart_wake_up )** | Adjust the smart wake-up period for this alarm. Use a wider window for workdays and a tighter or disabled window for weekends. |
65+
| **[CAPTCHA](/alarms/captcha)** | Require a specific puzzle or task (Math, QR code, NFC, etc.) to dismiss high-importance alarms. |
66+
| **[Wake up check](/alarms/captcha#wake_up_check)** | Acts as a safety net by asking *"Are you still awake?"* shortly after you've dismissed the alarm. |
67+
| **[Sound](/alarms/ringtone)** | Select the ringtone, custom music, online stream, or Spotify playlist for this specific alarm. |
68+
| **[Gentle Volume](#gentle_volume)** | Ramps audio up gradually from zero to maximum loudness over a duration ranging from 30 seconds to 24 minutes. |
69+
| **[Bedtime notification](/alarms/bedtime_notification)** | Sends you a friendly *"Time to go to bed!"* reminder so you have enough time to wind down and get ready for sleep. |
70+
| **[Snooze](/alarms/snooze)** | Cap the total number of allowed snoozes or maximum snooze duration for this alarm. |
6471
| **Terminate tracking** | Automatically ends current sleep tracking when the alarm is dismissed. |
6572
| **Delete After Ringing** | Automatically deletes the alarm card completely once dismissed. *(Enabled by default for Naps).* |
6673

74+
<a id="gentle_wake_up"></a>
6775

68-
## Gentle Wake-Up
76+
## Gentle Wake-Up options
6977

78+
<a id="gentle_volume"></a>
7079
* **Gentle volume:** Starts the alarm at minimum volume and gradually ramps up to maximum loudness over a set period.
7180
* **Disabled:** Rings immediately at maximum volume.
7281
* **30 Seconds:** Short initial burst, then reaches system volume.
@@ -79,30 +88,36 @@ These features can be tailored individually inside each alarm card to fit specif
7988
* **Flashlight Wake-Up:** Flashes your camera’s LED light repeatedly when the alarm rings.
8089
* **Use smartlight:** Triggers external smart bulbs (e.g., Philips Hue, IKEA Trådfri) upon alarm activation.
8190

91+
---
8292

83-
## Frequently Asked Questions & Troubleshooting
93+
## FAQs & Troubleshooting
8494

8595
<details>
8696
<summary><strong>Why did my alarm trigger earlier than scheduled?</strong></summary>
8797

88-
**Smart Wake-Up** is active. The app tracks sleep movement and rings up to 30 minutes (or your configured Smart Period) early if it detects light sleep.
89-
* To stop this, shorten or disable the Smart Period inside the specific alarm settings or under `Settings``Alarms``Smart wake up`.
98+
* **Reason:** **Smart Wake-Up** is active. The app tracks sleep movement and rings early if it detects light sleep.
99+
* 👉 *Fix:* Shorten or disable the Smart Period inside the specific alarm settings or under <code>Settings ➔ Alarms ➔ Smart wake up</code>.
90100
</details>
91101

92102
<details>
93103
<summary><strong>Why is the screen flashing white during my alarm?</strong></summary>
94104

95-
You have **Sunrise Wake-Up** enabled on that alarm, which uses your display screen to simulate morning light. Turn this off in `Alarm settings``Gentle Wake-up``Sunrise wake up`.
105+
* **Reason:** You have **Sunrise Wake-Up** enabled on that alarm.
106+
* 👉 *Fix:* Turn this off in <code>Alarm settings ➔ Gentle Wake-up ➔ Sunrise wake up</code>.
96107
</details>
97108

98109
<details>
99110
<summary><strong>Why does my alarm volume jump to full loudness immediately?</strong></summary>
100111

101-
If **Delayed Sound** is configured alongside **Gentle Volume**, the gentle volume timer starts running silently when the alarm begins. If the sound delay is long, the volume curve may already reach maximum level by the time the audio stream starts.
112+
* **Reason:** If **Delayed Sound** is configured alongside **Gentle Volume**, the gentle volume timer starts running silently when the alarm begins.
113+
* 👉 *Fix:* Check if the sound delay is long; the volume curve may already reach maximum level by the time the audio stream starts.
102114
</details>
103115

104116
<details>
105117
<summary><strong>How do I stop my alarm from turning into a heads-up banner notification?</strong></summary>
106118

107-
Enable **Fullscreen Alarm** under global `Settings``Alarms``Fullscreen alarm` and ensure you grant the **Draw over other apps** permission when prompted by Android system preferences.
119+
* **Reason:** Android system behavior for background apps.
120+
* 👉 *Fix:* Enable **Fullscreen Alarm** under global <code>Settings ➔ Alarms ➔ Fullscreen alarm</code> and ensure you grant the **Draw over other apps** permission when prompted by Android system preferences.
108121
</details>
122+
123+
*Need further help? Contact us via **`Left ☰ Menu``Support``Report a bug`**.*

hugo/content/alarms/backup.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,34 @@ tags:
88
- backup
99
---
1010

11+
# Backup alarm
12+
13+
1114
**The Backup Alarm is a fail-safe feature that triggers a loud, maximum-volume alarm if you ignore your primary alarm.**
1215

1316
This ensures that even if you are an exceptionally heavy sleeper or accidentally sleep through your regular ringtone, you won't miss your wake-up call.
1417

1518
**Menu Path:** `Settings``Alarms``Backup alarm`
1619

17-
---
1820

19-
## Core Options
21+
## Key Settings Explained
22+
23+
| Option | Description |
24+
| :--- | :--- |
25+
| **[Backup alarm duration](#backup_duration)** | Sets how long the loud backup alarm will ring before automatically snoozing. |
26+
| **[Backup alarm Sound](#backup_sound)** | Choose the ringtone for your backup alarm, or set it to silent. |
27+
| **[Alarm timeout](#alarm-timeout)** | The period of inactivity after which the backup alarm is triggered. |
28+
| **[Repeat](#backup_repeat)** | Sets the maximum number of times the backup alarm sequence will repeat. |
29+
30+
31+
<a id="backup_duration"></a>
2032

2133
### Backup Alarm Duration
2234
Sets how long the backup alarm will ring. Once this duration expires, the alarm will automatically snooze for your default *Snooze Time* (but never less than 10 minutes).
2335

24-
### Ringtone
36+
<a id="backup_sound"></a>
37+
38+
### Backup alarm Sound
2539
Choose the sound for your backup alarm.
2640

2741
> [!NOTE]
@@ -31,9 +45,13 @@ Choose the sound for your backup alarm.
3145
>
3246
> *Note:* Selecting a silent ringtone for the backup alarm will **not** disable vibrations. The backup alarm is designed as a last resort to ensure you wake up.
3347
34-
### Alarm Timeout <a id="alarm-timeout"></a>
48+
<a id="alarm-timeout"></a>
49+
50+
### Alarm Timeout
3551
Defines the period of inactivity (ignoring the normal alarm) after which the backup alarm will trigger.
3652

53+
<a id="backup_repeat"></a>
54+
3755
### Repeat
3856
Sets the maximum number of times the backup alarm can repeat its cycle. After this limit is reached, no further alarms will sound for that session.
3957

@@ -53,3 +71,5 @@ Sets the maximum number of times the backup alarm can repeat its cycle. After th
5371
> 4. **7:22 AM:** Backup alarm starts again.
5472
>
5573
> This cycle continues until you dismiss the alarm or reach the maximum number of repeats.
74+
75+
*Need further help? Contact us via **`Left ☰ Menu``Support``Report a bug`**.*

0 commit comments

Comments
 (0)