Skip to content

Commit

Permalink
Privacy update
Browse files Browse the repository at this point in the history
Garmin supported models update
New graph detail update
  • Loading branch information
rl885 committed Mar 26, 2024
1 parent b6b7c5e commit d8d2924
Show file tree
Hide file tree
Showing 12 changed files with 126 additions and 93 deletions.
Binary file modified assets/images/graph_acti.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/graph_colored.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/graph_noise.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/graph_phase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/graph_score.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 12 additions & 9 deletions devices/garmin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,27 @@ WARNING: On some watches (mainly Vivoactive 3) there is a long-standing firmware

https://raw.githubusercontent.com/urbandroid-team/Sleep-as-Android-Garmin-Addon/master/SleepGarmin-watch2/manifest.xml[List of supported Garmin wearables].

* Garmin D2 air, D2 Airx10, D2 Delta, D2 Delta PX, D2 Delta S
* Garmin Descent Mk2, Mk2S
* Garmin Approach S70 42mm, Approach S70 47mm
* Garmin D2 air, D2 Airx10, D2 Delta, D2 Delta PX, D2 Delta S, D2 Mach1
* Garmin Descent G1, Descent Mk2, Mk2S
* Garmin Enduro
* Garmin Epix 2
* Garmin Epix 2, Epix 2PRO 42mm, Epix 2PRO 47mm, Epix 2PRO 51mm
* Garmin Fenix 5, Fenix 5 Plus, Fenix 5S, Fenix 5S Plus, Fenix 5X, Fenix 5X Plus
* Garmin Fenix 6, Fenix 6 Pro, Fenix 6S, Fenix 6s Pro, Fenix 6x Pro
* Garmin Fenix 7, Fenix 7S, Fenix 7X, Fenix Chronos
* Garmin Fenix 7, Fenix 7 Pro, Fenix 7S, Fenix 7S Pro, Fenix 7X, Fenix 7X Pro, Fenix Chronos
* Garmin Forerunner 245, Forerunner245M
* Garmin Forerunner 255, Forerunner 255M, Forerunner 255D, Forerunner 255SM
* Garmin Forerunner 55
* Garmin Forerunner 645, Forerunner 645M
* Garmin Forerunner 265, Forerunner 265S
* Garmin Forerunner 745,
* Garmin Forerunner 935
* Garmin Forerunner 945, Forerunner 945 LTE
* Garmin Forerunner 955
* Garmin Instinct 2, Instinct 2S
* Garmin Forerunner 955, Forerunner 955 LTE
* Garmin Forerunner 965
* Garmin Instinct 2, Instinct 2S, Instinct Crossover, Instinct 2X
* Garmin Legacy Hero Captain Marvel, First Avenger
* Gamin Legacy Saga Darth Vader, Rey
* Gamin MARQ Adventurer, MARQ Athlete, MARQ Aviator, MARQ Captain, MARQ Commander, MARQ Expedition, MARQ Golfer
* Garmin Venu, Venu 2, Venu 2 Plus, Venu 2S, Venu D, Venu SQ, Venu SQM
* Garmin Vivoactive 3, Vivoactive 3M, Vivoactive 3M LTE, Vivoactive 4, Vivoactive 4S
* Gamin MARQ Adventurer, MARQ Athlete, MARQ Aviator, MARQ Captain, MARQ Commander, MARQ Driver, MARQ Expedition, MARQ Golfer, MARQ2 Aviator
* Garmin Venu, Venu 2, Venu 2 Plus, Venu 2S, Venu D, Venu SQ, Venu SQ2, Venu SQM, Venu SQ2M
* Garmin Vivoactive 3, Vivoactive 3M, Vivoactive 3M LTE, Vivoactive 4, Vivoactive 4S, Vivoactive 5
50 changes: 31 additions & 19 deletions general/privacy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,57 +16,69 @@ _Settings -> Personalize -> Privacy_
toc::[]
:toclevels: 1

=== Analytics
== Privacy policy

https://team.urbandroid.org/privacy-policy/[A link] to our Privacy Policy and Data consent policy for all our apps.

== Terms of use
Detailed terms of use of the Sleep as Android app.

== Analytics
Allows you to opt-out from anonymous data usage stats.
The anonymous data are for example - how many users have certain app's version, how many users have certain type of Android, how many users have sonar selected as the sensor...

NOTE: No personally identifiable data is collected even when this option is enabled.

=== Don't personalize ads
== Don't personalize ads
Allows you to opt-out from the the Android Ads Personalization; it will take you to the system settings page, where you can turn off this feature.

=== Settings
NOTE: Ads are only present in the free version past the trial. If you see any ads in the premium app, please follow <</faqs/purchase_not_unlocked#,the guide for unlocking the paid version>>.

== Manage consent
Options for controlling the personal data for personalized advertising.

NOTE: Ads are only present in the free version past the trial. If you see any ads in the premium app, please follow <</faqs/purchase_not_unlocked#,the guide for unlocking the paid version>>.

== Facebook ads
Redirects you to the Facebook Ads preferences.

NOTE: The app does not share your personal data.
NOTE: The app does not share your personal data. Advertisement is present only for the free version of the app after the trial.
The app only asks to display an unspecified ad, the provider of the advertisement will serve the ad based on the advertising ID, that can be disabled (see Don't personalize ads option above)
You can read more details at our https://team.urbandroid.org/privacy/[https://team.urbandroid.org/privacy/].

NOTE: Ads are only present in the free version past the trial. If you see any ads in the premium app, please follow <</faqs/purchase_not_unlocked#,the guide for unlocking the paid version>>.

=== SleepCloud:
== SleepCloud:
Access to the https://play.google.com/store/apps/details?id=com.urbandroid.sleep.addon.port&hl=cs&gl=US[SleepCloud addon], if installed and used.

=== Android app data backup
== Android app data backup
Allows you to opt-out from the standard Android app data backup service. You can configure the Android backup in _system settings -> Privacy -> Back up_.

=== Local storage backup
== Local storage backup
Enables daily local storage, which saves "0/com.urbandroid.sleep/files/sleep-data/sleep-export.zip" file.

NOTE: The location of backup storage path may differ on each Android version. If you go to _Left_ ≡ _menu -> Backup -> Export data_, the app shows you the current storage location on the dialogue.

=== Scoped storage
== Scoped storage
Enables https://source.android.com/devices/storage/scoped[Scoped storage]; when enabled, the access of the app is restricted only to its designated folder. Substitutes the older read_storage permission.

=== Google Fit
Enables *Read only access* for Sleep app in the Google Fit integration.

=== Weather
Enables weather data gathering for <</sleep/how_to_read_sleep_graphs#morning_screen, morning briefing>> weather tile. The app only checks coarse location (± 5 km).

=== Restore settings
== Restore settings
Deletes all your recent changes in the settings, and restore them from the latest backup.

=== Don't store sleep location

== Don't store sleep location
Opts you out of location data collecting. The app only gathers coarse location (± 5km) for <</sleep/tags#geo,geotagging>>.

=== Reset home location
== Reset home location
Resets your current home location - useful when you move.

=== Disable experimental features
== Weather
Enables weather data gathering for <</sleep/how_to_read_sleep_graphs#morning_screen, morning briefing>> weather tile. The app only checks coarse location (± 5 km).

== Disable experimental features
Opt you out from our new experimental features (like new actigraphy data processing, new neuron network for sound classification...).

=== Handle phone calls
== Handle phone calls
Mutes alarms and lullabies, and pauses sound recording when in phone call. The phone permission is needed.


26 changes: 25 additions & 1 deletion general/release_notes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,31 @@ nav_order: 206

You can download any older version from https://sleep.urbandroid.org/more/download/[our web here].

== Latest version 20240129
== Latest version 20240220


*Redesign*

* Sleep detail, Graph edit and Morning briefing screen
* Sleep detail and Morning screen is now presented in a dashboard style with removable and pinnable cards
See https://sleep.urbandroid.org/personalized-sleep-detail-and-morning-briefing/
* Time pickers both analog and digital and switching to naps

*Features*

* Improved sharing from Detail, Edit, Morning screen, Stats and Charts
* Search screen graphics

*Fixes*

* Timeline for pinned cards
* Improved goal target typing
* Sleep variance is now called Irregularity where SRI is Regularity
* Several UX fixes


== 20240129


*New features*

Expand Down
104 changes: 47 additions & 57 deletions sleep/how_to_read_sleep_graphs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,42 +16,54 @@ tags:
toc::[]
:toclevels: 1

[[morning_screen]]
== Morning screen

The first screen you see in the morning is *Morning briefing* and it offers you important information at a glance.


NOTE: You can customize the screen by swiping away the cards you don't need, or pinning the ones you like the most with a long-press.
To edit the screen, use the *Hide / Show* button at the bottom or _Settings -> Personalize -> Morning screen_, see details <</ux/personalize#morning_screen_set, here>>.

[horizontal]
Sleep score:: See details in <</sleep/sleepscore#,sleep score chapter>>. If this options is missing, you have *Hide stats before rating* enabled in _Settings -> Personalize -> Morning screen_
Rating:: Rate you sleep with stars to add important feedback for stats, or add <</sleep/tags#, tags>>.
Graph overview:: Simplified hypnogram graph, tap to expand it to the <<graph_explain, full graph>>.
Noise card:: Simplified noise level graph.
Sensor card:: Simplified sensor data graph.
Weather card:: MetNorway or OpenWeather data.
Can be disabled in _Settings -> Personalize -> Morning screen > Weather_.
Dismiss:: If you end the tracking before alarm, you can simply dismiss the upcoming alarm.


[[graph_explain]]
== Sleep graph detail, edit screen

== Sleep graph screen
The graph screen shows up to three graphs:
The full detailed graph shows all data measured or calculated by the app at once. This screen also allows you to edit the graph, add or remove awakes, or edit the tracking duration.


- <<statistics,Statistics>>: sleep score for the whole day
- <<actigraph,Actigraph>>: your activity or movement during sleep
- <<hypnogram,Hypnogram>>: your sleep phases
- <<sensor, Sensor data>>: data from various sensors - HR, HRV, light level, breath rate, SpO2
- <<noise-graph,Noise graph>>: ambient noise level (when <</sleep/sleep_noise_recording#,noise recording>> is enabled).

Graph screen also shows <<statistics,statistics>> about your night, along with an option to rate and annotate the record.

The app uses Actigraphy – activity-based sleep tracking – as the method of estimating your sleep phases. We have shown in a study that our approach produces a very good match with Polysonography – the de-facto golder standard for clinical sleep tracking with a fraction of the costs. See link:https://sleep.urbandroid.org/sleep-lab-comparison/[How does Sleep as Android compare to the sleeplab].
NOTE: You can hide or reveal all the graph elements with the buttons at the bottom. These buttons also serve as a hints - they show you which color, or icon the element uses.


=== Statistics
The app uses Actigraphy – activity-based sleep tracking – as the method of estimating your sleep phases. We have shown in a study that our approach produces a very good match with Polysonography – the de-facto golder standard for clinical sleep tracking with a fraction of the costs. See link:https://sleep.urbandroid.org/sleep-lab-comparison/[How does Sleep as Android compare to the sleep lab].

=== Sleep score
[cols="1,2"]
|===
a|
.Sleep record statistics
image::graph_score.png[]
a|*End date*:: <</faqs/why_sleep_counts_for_the_end_date#, Why end and not start?>>

*Share icon*:: sharing resulting graphs with your friends, doctor, or support

*(?)*:: Help button with graph's legend

*(⁝) menu*::
- Comment - adds a note to your graph
- Noise - opens the list of recorded files
- Color palette - changes the look
- Delete awake - deletes awakes detected by the app
- Delete - deletes the whole graph
- Clip to clipboard
- Undo -reverts changes done to the graph

*Sleep score pie charts*::
- Sleep score pie charts are scrollable, and their order can be changed.
a|*Sleep score pie charts*::
- The small "speedometers" pie charts represent all the metrics measured in a simplified way.
- Read more details about sleep score in <</sleep/sleepscore#,sleep score chapter>>.
- Sleep score pie charts are scrollable, and their order can be changed.

|===

Expand All @@ -61,10 +73,7 @@ a|*End date*:: <</faqs/why_sleep_counts_for_the_end_date#, Why end and not start
|===
a|.Actigraph
image::graph_acti.png[]
a|*Rating*::
- Rate your sleep each morning - it will give the app your subjective evaluation for statistics.

*Actigraph*::
a|*Actigraph*::
- Shows the intensity of your nightly movements.
- The higher the peak, the more you’ve been moving.

Expand Down Expand Up @@ -92,18 +101,7 @@ image::red.png[]
a|Red sections on your graph indicate that the app did not receive data from sensors at that time. This usually happens when using wearables due to lost connection to the wearable. The phone's accelerometer can also (very rarely) malfunction.
|===

=== Noise graph

[cols="1,2"]
|===
a|.Noise graph
image::graph_noise.png[]
a|*The noise graph*::
- Shows how much noise (sleep talk, snoring, environmental) was there throughout the night.
- When <</sleep/sound_recognition#,sound recognition>> is enabled, sounds (cry, laugh, sneeze or cough, snoring and talking) are marked with <<markers-and-icons,icons>>.
|===

=== Colored lines
=== Sensor data

[cols="1,2"]
|===
Expand All @@ -128,6 +126,17 @@ a|- *Blue line* = blood oxygen level if you are using oximeter. Blue dots with n

|===

=== Noise graph

[cols="1,2"]
|===
a|.Noise graph
image::graph_noise.png[]
a|*The noise graph*::
- Shows how much noise (sleep talk, snoring, environmental) was there throughout the night.
- When <</sleep/sound_recognition#,sound recognition>> is enabled, sounds (cry, laugh, sneeze or cough, snoring and talking) are marked with <<markers-and-icons,icons>>.
|===

=== Markers and Icons
Besides deep sleep, REM phase and light sleep, there are several other events depicted in the sleep graphs.

Expand All @@ -154,25 +163,6 @@ icon:ic_action_dream[] Lucid dreaming

|===

[[morning_screen]]
== Morning rating screen

The first screen you see in the morning is *Morning briefing* and it offers you important information at a glance.

NOTE: You can customize the screen in _Settings -> Personalize -> Morning screen_, see details <</ux/personalize#morning_screen_set, here>>.

[horizontal]
Sleep score:: See details in <</sleep/sleepscore#,sleep score chapter>>.
Graph overview:: Simplified graph, tap to expand it to the <<graph_explain, full graph>>.
Noise card:: Simplified noise level graph.
Sensor card:: Simplified sensor data graph.
Weather card:: MetNorway or OpenWeather data.
Can be disabled in _Settings -> Personalize -> Morning screen > Weather_.
Dismiss:: If you end the tracking before alarm, you can simply dismiss the upcoming alarm.
Rating:: Rate you sleep with stars to add important feedback for stats, or add <</sleep/tags#, tags>>.




== Guides

Expand Down
14 changes: 10 additions & 4 deletions sleep/statistics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The list of days is based on the period selection in top right (Week, 14 days, M
Optionally aggregates by Tags can be expanded by tapping on the button in the top right corner. This will tell you how does your Duration, Deep sleep and Snoring differ, when a certain tag is used to your Sleep score for all nights. The aggregates are calculated for the selected period which can be changed in top right.


== Daily sleep duration goal
== Sleep duration goal
What is your ideal sleep duration target for a typical day. This is used calculate your _Sleep deficit = Daily sleep duration goal - Average sleep duration for selected period_. Read mode on <</sleep/ideal_daily_sleep#,daily sleep duration goal>>.

[EXAMPLE]
Expand All @@ -33,9 +33,6 @@ Your ideal duration is 8 hours. Your average sleep for the last week is 7 and ha
== Sleep day cutoff
Sleeps finished after this hour will be considered part of the next day. By default Graphs belong to the same day if their end time belongs to the same day. But this can be modified in case of specific sleeping schedules.

== Irregularity:
By default *Sleep irregularity* – one of the important dimensions in your <</sleep/sleepscore#, Sleep score>> – uses UTC times to calculate how regular your sleep is. This means travelling to a different time zone or day light saving events will affect your regularity. We believe this is correct as in such events your body will really suffer with less quality sleep. On the other hand if you prefer to keep local times, this is your option.

== Prioritize
Rearrange your sleep score pie charts, will apply to pie charts on Sleep score and graphs too.

Expand All @@ -45,6 +42,15 @@ Determined your age with is use for Sleep score and the healthy sleep duration r
== Color palette
Enables additional color spectrum used for your Sleep Score pie charts. When enabled, each pie chart have assigned color across the whole app.

== Regularity
By default *Sleep Regularity* – one of the important dimensions in your <</sleep/sleepscore#, Sleep score>> – uses UTC times to calculate how regular your sleep is. This means travelling to a different time zone or day light saving events will affect your regularity. We believe this is correct as in such events your body will really suffer with less quality sleep. On the other hand if you prefer to keep local times, this is your option.








//Automatic sleep tagging:: This option allows all automatic tags to be turned off. Sleep graphs can be <</sleep/tags#, Tagged>> with additional lifestyle information. For instance \#sport or \#alcohol. But some tags are calculated automatically for your graphs. Those include your 4 most frequent locations, moon cycle, ambient <</sleep/light_level#, light>> in the room, sensors used and more, see full list of <</sleep/tags/automatic-tags#, automatic tags>>.
//Show the rating screen after tracking:: Enables automatic loading of the rating screen right after you finish the tracking.
Expand Down
2 changes: 1 addition & 1 deletion sleep/tags.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ icon:ic_action_menses[]#menses

[[tags_auto]]
== Automatically added tags
Some tags are calculated and added to your sleep record automatically. You can turn this feature off in _Settings -> Sleep -> More -> Stats -> Automatic tagging_.
Some tags are calculated and added to your sleep record automatically. You can turn this feature off in _Settings -> Personalize -> Morning screen -> Automatic sleep tagging_.

|===
a|Automatically added tags
Expand Down
2 changes: 0 additions & 2 deletions ux/personalize.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ Time:: All your alarms will be sorted by time regardless on which day are they s
== Analog time picker[[analog-picker]]
A round analog clock time picker will be shown when creating new alarms instead of the digital one.

== Material time picker[[material-picker]]
A round analog clock time picker from Google Material You design.

== Release notes
If disabled, you won't be seeing release notes card/dialog when Sleep is updated to a new version. To check the release notes at will, tap _Left ☰ menu -> icon:ic_help[] Support -> Release notes_.
Expand Down

0 comments on commit d8d2924

Please sign in to comment.