diff --git a/alarms/alarm_settings.adoc b/alarms/alarm_settings.adoc index 8c4d4c3..337aab3 100644 --- a/alarms/alarm_settings.adoc +++ b/alarms/alarm_settings.adoc @@ -43,10 +43,10 @@ If <> is enabled, the application will read //image:alarm_label.png[width=70%] -== Time +== Time (per-alarm only) You can choose one of three time pickers - wheel picker, analogue picker, and Material YOU picker (see <>). -== Repeat +== Repeat (per-alarm only) Chooses the pattern of the repetition: [horizontal] @@ -154,7 +154,7 @@ If you want a specific calendar event to move your alarm by a specific time (ove NOTE: You will always be notified when one of your alarms can be rescheduled, with the option to cancel the change. -== Smart period +== Smart wake up See <>. You can have a different smart period for each alarm - a longer period for weekends, and a shorter period for your workdays. @@ -180,16 +180,18 @@ NOTE: We strongly recommend setting a sound delay instead of setting the alarm t NOTE: We strongly recommend setting a sound delay instead of setting the alarm to silent, especially if the backup alarm is also silent. -== Gentle volume [[gentle_alarm]] +== Gentle wake up [[gentle_alarm]] Gentle volume ensures you wake up with the minimum volume necessary for a more pleasant wake-up experience. The alarm starts at the minimum volume and gradually increases to the maximum volume. +=== Gentle volume + [horizontal] Disabled:: Alarm sounds at the system's alarm stream volume (or media stream if using streaming services or changing the _Alarm Output_ settings). For more details see the <> section. 30 seconds:: A brief period of increased sound followed by sound at the current system volume. 1-24 minutes:: Sets how long it takes to reach the maximum volume; the longer the time, the slower the volume increases and the longer it takes to reach the maximum. -== Vibrate +=== Vibrate Enables phone vibrations (not to be confused with wearable vibrations). [horizontal] @@ -198,34 +200,38 @@ From start:: Vibrations start at alarm time. After 30 seconds:: Vibrate start after 30 seconds. After 1-24 minutes:: Vibrations start after the set time. -== Delayed sound [[sound_delay]] +=== Delayed sound [[sound_delay]] You may want to give <> or vibrations a chance to wake you up before the alarm sounds. [horizontal] Disabled:: Sound starts at alarm time. 30 seconds - 24 minutes:: Sound starts after the set time. -== Play alarm in silent profile +=== Play alarm in silent profile The alarm sound overrides the phone's silent mode. +=== Sunrise wake up +Enable to use your phone's screen as a smartlight for the sunrise alarm. See <> on how to configure this in your settings. + +=== Flashlight wake up +If enabled, your phone's flashlight will be flashing during alarm. + +=== Use smartlight +Opens additional smartlight settings in <>. == Bedtime notifications See <>). -== Sleep duration goal (per-alarm only) +=== Sleep duration goal (per-alarm only) A special option for polyphasic sleep (see <>). - == Snooze Changes the snooze limits for this alarm, you can limit the snooze in counts, or in time, see <>. -== Flip to snooze -Lets you snooze an alarm by flipping the phone (screen to back and vice versa). - -== Volume or camera button effect -Allows you to snooze or cancel the alarm using the volume buttons. +== Fullscreen alarm +Alarm will never show up as a heads-up notification. This includes Android 10 where this feature requires the _Draw / Display over other apps_ permission. == Long press A long press on the dismiss button is required to dismiss the alarm. This can be useful if you accidentally dismiss your alarms. @@ -237,16 +243,15 @@ A long press on the dismiss button is required to dismiss the alarm. This can be NOTE: Won't completely disable the alarm, so it won't affect the next alarms. - -== Sunrise -Lets you use your phone screen as a smart light for your sunrise alarm. It uses the brightness of the screen to gently wake you up with light. - -== Always fullscreen alarm -Alarm will never show up as a heads-up notification. This includes Android 10 where this feature requires the _Draw / Display over other apps_ permission. +== Flip to snooze +Lets you snooze an alarm by flipping the phone (screen to back and vice versa). == No screen orientation changes Prevents screen orientation from being changed while the alarm is ringing (prevents accidental snooze or dismiss during orientation change). +== Volume or camera button effect +Allows you to snooze or cancel the alarm using the volume buttons. + == Backup alarm (alarm default only) See <>. diff --git a/alarms/captcha.adoc b/alarms/captcha.adoc index 6a5195d..70fd036 100644 --- a/alarms/captcha.adoc +++ b/alarms/captcha.adoc @@ -17,9 +17,7 @@ CAPTCHAs make sure you wake up on time and don't be late for your daily duties. --- toc::[] -:toclevels: 3 - -= Options in Settings +:toclevels: 5 == Default CAPTCHA CAPTCHA for all alarms. @@ -78,18 +76,18 @@ To get more time, tap the _+_ icon in the top right corner. Download a free extension with more CAPTCHA tasks from https://play.google.com/store/apps/details?id=com.urbandroid.sleep.captchapack[Play Store]. It has 10 new tasks, including Multi and Random CAPTCHA - they allow you to combine more tasks in one alarm. -= Guides for CAPTCHA tasks +== Guides for CAPTCHA tasks -== Simple math +=== Simple math Choose the correct answer to a math problem from a list of 4 answers. -== Typed math +=== Typed math Type the correct answer to a math problem without a hint. -== Sleeping sheep [[sheep]] +=== Sleeping sheep [[sheep]] Find an awake sheep hidden in a flock of sleeping sheep. -== QR code and NFC tag CAPTCHA +=== QR code and NFC tag CAPTCHA [[QR_NFC]] The QR and NFC CAPTCHAs are the ultimate wake-up solution. You can place a QR code or NFC tag in your bathroom or kitchen. The alarm won't stop until you get out of bed and scan the code/tag. @@ -101,75 +99,75 @@ NFC CAPTCHA:: You can use any credit card, some membership cards or ID cards. NOTE: For security reasons, NFC CAPTCHA always requires unlocking the screen first. -=== Only at home +==== Only at home Allows you to skip CAPTCHA if you are far away from your home, and you forgot the code / tag at home. NOTE: Your location must be significantly different from your home (at least 2.5 km), as the app does not collect fine location information -=== Must scan all codes +==== Must scan all codes If enabled, you must scan all saved codes. -=== How to learn new QR code / NFC tag +==== How to learn new QR code / NFC tag . Go to _Settings -> Alarms -> CAPTCHA -> Settings_. . Tap on the *Learn* button. -=== How to delete a QR code / NFC tag +==== How to delete a QR code / NFC tag . Go to _Settings -> Alarms -> CAPTCHA -> Settings_. . Tap on the icon:ic_action_discard[] trash can. -=== How to solve the task without the code / tag +==== How to solve the task without the code / tag If you happen to lose the code, or you cannot solve the NFC and QR CAPTCHA for some reason, there is a fallback task - <>. The difficulty of this task depends on the difficulty configured for the NFC or QR CAPTCHA in _Settings -> Alarms -> Capcha -> Difficulty_. NOTE: If you are tempted to avoid solving this task by choosing the Sleeping Sheep task instead, increase the difficulty to the highest level. If this is still not enough motivation, you can disable this fallback solution in _Settings -> Alarms -> CAPTCHA -> Settings -> Lost code, fallback task_. Use with caution! -== Shake it +=== Shake it Shake your phone until the amount of motion displayed on your phone reaches 100%. -== Dream diary +=== Dream diary Write down your dream (minimum 10 characters for difficulty 1). You can see how many characters you have left before reaching the minimum in the top right corner. NOTE: Dream diary entries are saved in your sleep record comments. If there is no sleep record, they will only be saved to your clipboard - so you can paste them elsewhere. -== Say cheese! +=== Say cheese! Smile at the front camera, with more difficulty you need to cast a more charming smile! -== Laugh Out Loud +=== Laugh Out Loud Laugh into your phone's microphone until the level reaches 100%. -== Captcha CAPTCHA (CAPTCHA add-on) +=== Captcha CAPTCHA (CAPTCHA add-on) Classic CAPTCHA from the early days of the Internet - type in the letters of a distorted picture. -== Random CAPTCHA (CAPTCHA add-on) +=== Random CAPTCHA (CAPTCHA add-on) Solve more tasks every morning, the app will choose 5 of them for you from all the tasks, or you can pre-select the options for the app in _Settings_ of this CAPTCHA, and the app will choose 5 of them. -== Multi Captcha (CAPTCHA add-on) +=== Multi Captcha (CAPTCHA add-on) Solve up to 15 selected tasks in a row. You can select the tasks in in _Settings_ of this CAPTCHA; the order is given by the order you select these tasks. -== Mirror text (CAPTCHA add-on) +=== Mirror text (CAPTCHA add-on) Read and type a text from a mirror-flipped quote - predefined or your own (configured in _Settings -> Alarms -> CAPTCHA -> Settings_). You can choose to Mirror the text, allow online database (with about 75k quotes), configure your own quotes for morning mantras, or as reminders -== Jumping sheep (CAPTCHA add-on) +=== Jumping sheep (CAPTCHA add-on) Guide the lost sheep through the fences and wolves to safety - tap to jump over obstacles. -== Swearing (CAPTCHA add-on) +=== Swearing (CAPTCHA add-on) Swear your way to dismiss (English only). -== Zombie Walk (CAPTCHA add-on) +=== Zombie Walk (CAPTCHA add-on) Walk 14-74 meters with the phone (depending on difficulty). NOTE: If your counter does not increase the step count as you walk, the step counter from the system does not send updates. -== Let there be light (CAPTCHA add-on) +=== Let there be light (CAPTCHA add-on) Hold your phone up to a light source and hold it until the threshold is reached. -== Fun with Flags (CAPTCHA add-on) +=== Fun with Flags (CAPTCHA add-on) Select the correct flag from three options. -== Spin around (CAPTCHA add-on) +=== Spin around (CAPTCHA add-on) While holding your thumbs on the on-screen buttons, rotate until you fill in the entire circle. NOTE: If the circle does not seem to respond properly, the system compass may not be calibrated. diff --git a/assets/images/achievements.png b/assets/images/achievements.png new file mode 100644 index 0000000..4a04940 Binary files /dev/null and b/assets/images/achievements.png differ diff --git a/assets/images/goal_progress.png b/assets/images/goal_progress.png index fca69bd..67c134a 100644 Binary files a/assets/images/goal_progress.png and b/assets/images/goal_progress.png differ diff --git a/assets/images/goal_progress_card.png b/assets/images/goal_progress_card.png new file mode 100644 index 0000000..7a6ab25 Binary files /dev/null and b/assets/images/goal_progress_card.png differ diff --git a/assets/images/goal_setup.png b/assets/images/goal_setup.png new file mode 100644 index 0000000..0696844 Binary files /dev/null and b/assets/images/goal_setup.png differ diff --git a/devices/smart_light.adoc b/devices/smart_light.adoc index 85a347e..87b5c79 100644 --- a/devices/smart_light.adoc +++ b/devices/smart_light.adoc @@ -18,36 +18,12 @@ Features: _Settings -> Services -> Smartlight_ toc::[] -:toclevels: 2 +:toclevels: 4 -= Options == Use smartlight Enables smartlight support. -== Maximum intensity -Set a a global limit for brightness a smartlight would be allowed to achieve when controlled by Sleep. This is useful for sunrise alarm where 100% might be too bright for some people. - -== Sunrise -Enable to use your phone's screen as a smartlight for the sunrise alarm. See <> on how to configure this in your settings. - -== Wake up with flashlight -If enabled, your phone's flashlight will be flashing during alarm. - -WARNING: Might be unreliable on some phones. - -== Keep light up after -Set whether the light should stay on after dismissing alarm, snoozing alarm or both. Or none. - -== Pee-light -If this is set, a pause in sleep tracking will turn on a red light on your set smartlight. If this is set to "Tracking is paused", the pee-light will be on for the whole pause. - -== Lucid dreaming -Use smartlight as a cue for lucid dreaming. When your REM phase is detected, your set light will flash. - -== Anti-snoring -Use smartlight as a cue for anti-snoring. When snoring is detected, your set light will flash. See - == Philips HUE, IKEA Trådfri @@ -75,26 +51,47 @@ NOTE: On Android 8 and later, you need to have https://play.google.com/store/app == Sleep Mask +Use Sleep Mask:: Enable to use your https://www.happy-electronics.eu/shop/en/home/32-sleep-mask-for-sleep-as-android.html[Sleep Mask] as a smartlight. + +== Maximum intensity +Set a a global limit for brightness a smartlight would be allowed to achieve when controlled by Sleep. This is useful for sunrise alarm where 100% might be too bright for some people. +== Nightlight +If this is set, a pause in sleep tracking will turn on a red light on your set smartlight. If this is set to "Tracking is paused", the pee-light will be on for the whole pause. -Use Sleep Mask:: Enable to use your https://www.happy-electronics.eu/shop/en/home/32-sleep-mask-for-sleep-as-android.html[Sleep Mask] as a smartlight. +== Lucid dreaming +Use smartlight as a cue for lucid dreaming. When your REM phase is detected, your set light will flash. + +== Anti-snoring +Use smartlight as a cue for anti-snoring. When snoring is detected, your set light will flash. See + +== Keep light up after +Set whether the light should stay on after dismissing alarm, snoozing alarm or both. Or none. + +== Sunrise +Enable to use your phone's screen as a smartlight for the sunrise alarm. See <> on how to configure this in your settings. + +== Wake up with flashlight +If enabled, your phone's flashlight will be flashing during alarm. + +WARNING: Might be unreliable on some phones. -= Guide +== Guide [[sunrise_alarm_guide]] -== How to setup sunrise alarm (sunrise-like wakeup) +=== How to setup sunrise alarm (sunrise-like wakeup) -. Enable _Settings -> Services -> Smartlight -> Use smartlight_ +. Enable _Settings -> Services -> Smartlight -> Enabled_. . Select your smartlight: -* Use phone's screen as a smartlight: Enable _Smartlight -> Use screen light_ -* Use a smartbulb as a smartlight: Connect using _Smartlight -> Philips HUE, IKEA Trådfri (disconnected)_ -* Use Sleep Phaser as a smartlight: Connect using _Smartlight -> Sleep Phaser (disconnected)_ and enable _Smartlight_ right under it. +* Use phone's screen as a smartlight: Enable _Settings -> Services -> Smartlight -> Sunrise_ or _Settings -> Alarms -> Gentle wakeup -> Sunrise_. +* Use a smartbulb as a smartlight: Connect using _Settings -> Services -> Smartlight -> Philips HUE, IKEA Trådfri (disconnected)_ +* Use Sleep Phaser as a smartlight: Connect using _Settings -> Services -> Smartlight -> Sleep Phaser (disconnected)_ and enable _Smartlight_ right under it. * Use cable-type Sleep Mask as a smartlight: Connect using _Smartlight -> Use Sleep Mask_. After you've done the above steps to connect and enable the smartlight of your choice, all of your alarms will turn on the smartlight when they start ringing. Now, to have a truly sunrise wakeup, you probably want the smartlight to turn on _before_ the alarm rings. -To set that up, head to _Settings -> Alarms -> Sound delay_ and set it to some period. At the time of the alarm, only the smartlight will turn on at the lowest brightness and gradually brighten up until the set period passes. Then the alarm starts ringing. +To set that up, head to _Settings -> Alarms -> Gentle wakeup -> Delayed alarm sound start_ and set it to some period. At the time of the alarm, only the smartlight will turn on at the lowest brightness and gradually brighten up until the set period passes. Then the alarm starts ringing. Without the delayed sound start, you can control the speed of sun-rise effect by changing the period of <>. The longer the period is, the longer it takes to get from dark to full light. diff --git a/general/release_notes.adoc b/general/release_notes.adoc index d1b8051..cbe2df8 100644 --- a/general/release_notes.adoc +++ b/general/release_notes.adoc @@ -7,7 +7,41 @@ nav_order: 206 You can download any older version from https://sleep.urbandroid.org/more/download/[our web here]. -== Latest version 20231023 +== Latest version 20231221 + +*Sleep regularity index* + +* Default Regularity measure in Sleep Score +* Now also used in Goals +* Default in Chart card + +*New Goals* + +* Goal type selection screen +* Goal charts to better indicate progress +* New goal progress calculation +* Redesign of Goal target and Goal detail screens +* Redesign of goal card on dashboard + +*Achievements* + +* New motivation to explore features in the app and earn badges +* Dashboard card + +*Charts* + +* Different Bedtime and Fall asleep time charts +Settings +* Nicer awake detection and sound recognition settings screens +* Smartlight settings reorganized +* New Gentle wake up settings screen + +*Fixes* + +* Fix for a glitch in noise cards layout +* Fix for Spotify volume jump in case of Gentle volume 30 seconds up to device volume + +== 20231023 *Features* diff --git a/services/backup_data.adoc b/services/backup_data.adoc index cb30ffa..15068a9 100644 --- a/services/backup_data.adoc +++ b/services/backup_data.adoc @@ -16,12 +16,11 @@ _Settings -> Privacy -> Backup_ --- toc::[] -:toclevels: 2 +:toclevels: 4 // Google Drive:: See <> // Dropbox:: See <> -= Types of backup == Local backup [[local_backup]] @@ -54,7 +53,7 @@ You an also do a manual export/import process: . Copy the directory you see on the dialogue to your new phone's SD card. . Install Sleep as Android on the new phone and immediately go to _Left_ ☰ _menu -> icon:ic_cloud_upload[] Backup -> Import_. -NOTE: If you don't import immediately, the app will replace your `sleep-export.zip` file after the next sleep record is created. The old `sleep-export.zip` file will be renamed to `sleep-export.backup.zip`. See <>. +NOTE: If you don't import immediately, the app will replace your `sleep-export.zip` file after the next sleep record is created. The old `sleep-export.zip` file will be renamed to `sleep-export.backup.zip`. See <>. [[csv_export]] diff --git a/sleep/achievements.adoc b/sleep/achievements.adoc new file mode 100644 index 0000000..0a39ba7 --- /dev/null +++ b/sleep/achievements.adoc @@ -0,0 +1,21 @@ +--- +layout: default +title: Achievements +nav_order: 2 +parent: /sleep/0parent.html +--- +:toc: macro + +Sleep Achievements are reward badges for your accomplishments and milestones, representing your progress. They give you something to strive for. You can collect them all, and share your accomplishments with your friends. + +To get started with Achievements, you can either tap on the Achievement card on the Dashboard, or open the section from the Left ≡ menu. + +Each Achievement requires you to complete certain goals (sleeping enough hours, getting to the bed earlier) to earn points. After you gather enough points, you will earn one of the badges (Bronze, Gold, Diamond). + +image:achievements.png[] + + +Tapping on the card will guide you to the feature settings, or to the related <> - unless you already have one goal running (we support only one goal at a time). + + + diff --git a/sleep/goals.adoc b/sleep/goals.adoc index f035b78..e86ea13 100644 --- a/sleep/goals.adoc +++ b/sleep/goals.adoc @@ -13,38 +13,48 @@ _Left ☰ menu -> Goal_ Goals are free to use – but let’s be honest to ourselves. Motivation to change your habits is much higher if there is something tangible at stake. Let’s say a few dollars. +[[goal_start]] == Set up a goal -In the Goal screen, tap on the icon:plus[] button. -[[adding-goal]] -.Adding a new goal -image::goal_progress_succesful.png[] - -. Select area in which you’d like to improve over the next 1 month (Duration, Fall asleep hour, Regularity, Awake, Deep sleep, Snoring, Snooze) -. Choose your motivation. You can try the goal for free, or you can bet a few bucks on yourself. - * You can bet a smaller wager or a bigger wager. In the US, a small wager is around $2, big wager around $4. When you select the wager and confirm the goal, you will see the exact price and then you can confirm or decline the payment. +. In the Goal screen, choose one of the goals you wish to improve over the next 1 month from the list. +. Adjust the goal with (+) and (-) icons on the sides - the number in the middle of the large bubble will guide you about what is the final goal. +. Choose your Motivation, if you wish (it is not necessary). You can try the goal for free, or you can bet a few bucks on yourself - you can bet a smaller wager or a bigger wager. In the US, a small wager is around $2, big wager around $4. When you select the wager and confirm the goal, you will see the exact price and then you can confirm or decline the payment. - [.line-through]#$# = free - $ = about $2 - +++$$+++ = about $4 -. Your current standing in the selected area (Here, sleep irregularity) -. Set your goal for the next 1 month! +. Tap *Set your goal* at the bottom. -== Goal progress +[[adding-goal]] +.Adding a new goal +image::goal_setup.png[] -After you create a goal you can check on the progress in _Left ☰ menu -> Goal_, or you can see it in glance on your Dashboard <> card. -In <> you see an example of a goal in progress. It consists of 3 series: -* The [color-orange]#orange# line shows your target, where you want to get -* The [color-green]#green# line is the guideline. To maximize change for a successful goal and to make your transition smooth we recommend to try to keep under or over the guideline at all times depending whether your try to increase or decrease aon of your sleep <>. -* The [color-blue]#blue# line shows your current average value of the dimension you are trying to change. -+ -NOTE: Before the start of the goal we show a 30 days rolling average of the measure you try to change. But after we show the average from only the values after in the goal time range. This means at the beginning the values will probably be quite bumpy before they start to converge into more stable values. +== Goal progress + +After you create a goal you can check on the progress in _Left ☰ menu -> Goal_, or you can see it in glance on your Dashboard Goal card. + +image:goal_progress_card.png[] +This timeline progress shows your progress (the human) vs the time. If your human is behind the hourglass, you are falling behind your schedule, and you need to try harder in the next days. [[goal-progress-screen]] -.Checking goal progress -image::goal_progress.png[] +image:goal_progress.png[] + +* Overview - showing the initial value, the progress in percentage and the progress value (for example current bedtime, or sleep duration), and your goal. +//* Timeline progress - the same as on the Goal card. +* Current value progress: +** Orange line shows the goal, each column is one day +** Accent color columns - you met your goal (accent color columns) that day +** Red columns - you did not met hte goal on a give day. +* Average value progress: +** The *orange* line shows your target, where you want to get. +//* The [color-green]#green# line is the guideline. To maximize change for a successful goal and to make your transition smooth we recommend to try to keep under or over the guideline at all times depending whether your try to increase or decrease aon of your sleep <>. +** The line in accent color shows your current average value of the dimension you are trying to change. The points on the line represents one day. +//+ +//NOTE: Before the start of the goal we show a 30 days rolling average of the measure you try to change. But after we show the average from only the values after in the goal time range. This means at the beginning the values will probably be quite bumpy before they start to converge into more stable values. + +