Merge remote-tracking branch 'origin/master'

_faqs/alarms_play_at_max_volume.adoc

@@ -9,7 +9,7 @@ tags:
 
 - Most likely, your <</alarms/backup#,Backup alarm>> went off after your regular alarm failed tp wake you up. T Backup alarm is triggered when there is no interaction (no snooze, no dismiss) for more than 20 minutes.
 
-- Make sure you are using a loud enough volume in _Settings -> Alarms -> Ringtone_, or enable Gentle Volume increase in _Settings -> Alarms -> Gentle volume increase_
+- Make sure you are using a loud enough volume in _Settings -> Alarms -> Ringtone_, or enable Gentle Volume in _Settings -> Alarms -> Gentle volume_
 - Try vibrations (_Settings -> Alarms -> Vibrate_).
 
 

alarms/alarm_settings.adoc

@@ -13,7 +13,7 @@ redirect_from:
 *Alarm settings help you make your wake-up experience refreshing and enjoyable.*
 
 * <</sleep/smart_wake_up#,Smart wake up>> wakes you at the right stage of sleep
-* <<gentle_alarm, Gentle volume increase>> finds the minimum sound to wake you up
+* <<gentle_alarm, Gentle volume>> feature finds the minimum sound to wake you up
 * <</devices/smart_light#,Smartlight>> natural sunrise alarm
 * Make sure you don't oversleep with our <</alarms/captcha#,CAPTCHA>> feature
 *  And many more
@@ -180,7 +180,7 @@ 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 increase[[gentle_alarm]]
+== Gentle volume [[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.
 

alarms/captcha.adoc

@@ -150,6 +150,7 @@ Solve up to 15 selected tasks in a row. You can select the tasks in  in _Setting
 
 == 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)
 Guide the lost sheep through the fences and wolves to safety - tap to jump over obstacles.

devices/smart_light.adoc

@@ -26,7 +26,7 @@ toc::[]
 Enables smartlight support.
 
 == Maximum intensity
-Seta 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.
+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 <<sunrise_alarm_guide, the guide below>> on how to configure this in your settings.
@@ -96,9 +96,9 @@ After you've done the above steps to connect and enable the smartlight of your c
 
 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.
 
-Without the delayed sound start, you can control the speed of sun-rise effect by changing the period of <</alarm/alarm_settings/gentle_alarm#,Gentle volume increase>>. The longer the period is, the longer it takes to get from dark to full light.
+Without the delayed sound start, you can control the speed of sun-rise effect by changing the period of <</alarm/alarm_settings/gentle_alarm#,Gentle volume>>. The longer the period is, the longer it takes to get from dark to full light.
 
 
 [EXAMPLE]
-*Sunrise alarm with delayed sound* - start of the alarm sound is set for 3 minutes = the light level will start increasing from alarm time, till the start of the sound. So after 3 minutes, the smart lights will be at the highest brightness. Duration of gentle volume increase does not play any role.
+*Sunrise alarm with delayed sound* - start of the alarm sound is set for 3 minutes = the light level will start increasing from alarm time, till the start of the sound. So after 3 minutes, the smart lights will be at the highest brightness. Duration of gentle volume does not play any role.
 *Sunrise alarm with gentle volume increase, sound not delayed* - gentle volume increase is set to 24 minutes = the light level will start increase from alarm time, and it will take 24 minutes to reach the highest brightness.

general/release_notes.adoc

@@ -7,7 +7,51 @@ nav_order: 206
 
 You can download any older version from https://sleep.urbandroid.org/more/download/[our web here].
 
-== Latest version 20230621
+== Latest version 20231001
+
+*NEWS*
+
+* Experimental Sleep Regularity Index calculation: Sleep Score card, Charts and Advice (Many thanks to Jeff Huang, Ji Won contribution)
+* Health Connect Android 14 migration
+
+* New sound noise files features
+** Storing AAC noise recordings in M4A container which allows adding meta data
+** Tagging sleep noises stored in media library with metadata: author, album… (both OGG and M4A)
+** Sleep as Android Album art for M4A and OGG
+** You can find your newly starred noises is the “Best of Noises” album by “Sleep as Android” in your favorite music player
+** Migration of older starred noises to the new album can be done manually by removing star and re-adding
+** Migration to new phone: backup of Android Media Store through Google One, or manual copy of /Music/Sleep
+
+
+*Fixes and updates*
+* Fix for a regression in IKEA Tradfri integration
+* Fix for Drive, Dropbox backup not working when local storage backup is off in: [Settings – Privacy]
+* Fix for a sleep score rendering glitch on the Sleep Score card
+
+== 20230810
+
+*NEWS*
+
+* Targeting Android 13 API level
+* Support for per-app language settings on Android 13+
+* Migration to latest build tools
+
+*Fixes and updates*
+
+* Next alarm is shown above weather on the morning screen
+* Fix in MQTT and potentially other automation tasks, if more tasks were triggered at once some may have got missing
+* Fix for a regression in MQTT because of new build tools
+* Fix for sleep tracking button when long pressing quick settings tile in tabbed home screen
+* Fix for using per-alarm smart wake up for “not before ideal” smart wake up feature
+* Analog time picker for one-time alarm time changes
+* Fix for inactive notification dismiss button on Android 11-
+* Fixed in ringtone picker – playlist vs. single mode
+* Auto-refreshing device default alarm ringtone every 8h
+* Fix for missing Indonesian
+* Fix for last used lullaby not updated
+* Hiding WiFi control settings on Android Q+ as this is no more possible, thanks Google!
+
+== 20230621
 
 *NEWS*
 

services/google_calendar.adoc

@@ -50,7 +50,7 @@ Examples:
 #alarm+2h30:: postpones the alarm for 2 hours 30 min
 #alarm+2:15:: postpones the alarm for 2 hours 15 min
 
-You will always get a notification whenever any of your alarms is going to be rescheduled, with an option to revert that.
+You will always get a notification whenever any of your alarms is going to be rescheduled, with an option to revert the automatic option back to the original alarm time.
 
 == Add Sleep data to calendar
 If enabled, your sleep records will be synced into your Google Calendar.

sleep/chrono_jetlag.adoc

@@ -1,12 +1,12 @@
 ---
 layout: default
-title: Chronotype, Social jetlag, Sleep irregularity
+title: Chronotype, Social jetlag, Sleep Regularity
 nav_order: 2
 parent: /sleep/0parent.html
 ---
 :toc: macro
 
-*Sleep as Android watches your sleep pattern trends and can tell you your chronotype, social-jet-lag and sleep-irregularity.*
+*Sleep as Android watches your sleep pattern trends and can tell you your chronotype, social-jet-lag and sleep Regularity.*
 
 
 ---
@@ -65,9 +65,20 @@ In <<figure-chrono-weekdays>> you see there is no obvious clustering for this us
 .Weekdays vs. Weekends clustering
 image::chrono_weekdays.png[]
 
-== Sleep irregularity
+
+[[regularity]]
+
+== Sleep Regularity
 To get maximum of your sleep time, it is crucial to sleep regularly – go to sleep at the same time every day and sleep for a fixed period of time.
 
 Sleep as Android tracks your sleep irregularity and shows you in <</sleep/charts#,Charts>> how irregular your sleep is.
 
 The irregularity shown is the https://en.wikipedia.org/wiki/Variance[variance] of your mid sleep hour.
+
+
+[[sri]]
+
+=== Sleep Regularity Index
+SRI is a metric calculated as the probability of an individual being in the same state (asleep or awake) at any two time points 24 hours apart, averaged over 7-days (range 0–100, with 100 being perfectly regular).
+This index can be used for monitoring your risk of health issues - read about the link  https://www.ncbi.nlm.nih.gov/pmc/articles/PMC10153326/[between SRI and mortality], or the link https://www.nature.com/articles/s41598-017-03171-4[between SRI and academic performance].
+You can also read how https://academic.oup.com/sleep/article/44/10/zsab103/6232042[SRI compares to other sleep metrics].

sleep/sleep_tracking.adoc

@@ -93,6 +93,8 @@ This feature has no real effect if you're using Sound Recording or Sonar, becaus
 
 WARNING: Due to Doze mode, starting from Android 6 we need to schedule a user-visible alarm every minute to be able to use sensor batching. This alarm will never ring, but will be visible on your status bar and lockscreen.
 
+WARNING: Enabling sensor batching may break awake detection.
+
 == Tracking screen
 
 <<sleep-tracking-screen-1>> shows common elements of the tracking screen

sleep/sleepscore.adoc

@@ -34,7 +34,7 @@ The app will point out some notable trends and also suggest some changes in the
 == Sleep score dimensions
 
 There are eight dimensions that contribute to sleep quality. Each of the dimensions has a healthy range and an unhealthy range.
-The app combines all dimensions into one "Sleep Score" for simplification (only new version).
+The app combines all dimensions into one "Sleep Score" for simplification.
 
 [cols="^,<,<,<,<", options="header"]
 |===
@@ -44,6 +44,15 @@ The app combines all dimensions into one "Sleep Score" for simplification (only
 |Bottom figure
 |Healthy / Unfavourable range
 
+a|image::score_pie.png[]
+*Sleep Score*
+|Overall score combining all your other sleep metrics.
+|Percentage of the score (0,100).
+|
+|Healthy: as close to 100% as possible
+Unfavourable:
+
+
 a|image::hrv_pie.png[]
 *HRV gain*
 |The difference between your HRV measured during the first low activity period (hrv before) of your sleep and the HRV measure at the last low activity period before awake up (hrv after) (see details https://sleep.urbandroid.org/hrv-tracking/[here]).
@@ -61,11 +70,11 @@ a|image::BR_pie.png[]
 Unfavourable: over 20
 
 a|image::irregularity_pie.png[]
-*Irregularity*
-|How irregular your sleep is. Variance of your mid-sleep hour.
+*Regularity*
+|How regular your sleep is. Variance of your mid-sleep hour.
 |Deviation of sleep duration and mid sleep hour.
-|
-|Healthy: under 0.5 hours
+|SRI, <</sleep/chrono_jetlag#sri,more details here>>
+|Healthy: under 0.5 hours for regularity, as close to 100 for SRI as possible.
 Unfavourable: over 1 hour
 
 a|image::deepsleep_pie.png[]