FOSS
/
BangleApps
mirror of https://github.com/espruino/BangleApps
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
BangleApps/apps/sleeplog/README.md

177 lines
10 KiB
Markdown
Raw Normal View History

sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
# Sleep Log
This app logs and displays the four following states:
_unknown, not worn, awake, sleeping_
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
It derived from the [SleepPhaseAlarm](https://banglejs.com/apps/#sleepphasealarm) and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and
also provides a power saving mode using the built in movement calculation. The internal temperature is used to decide if the status is _sleeping_ or _not worn_.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
#### Operating Principle
* __ESS calculation__
The accelerometer polls values with 12.5Hz. On each poll the magnitude value is saved. When 13 values are collected, every 1.04 seconds, the standard deviation over this values is calculated.
Update README.md Update README.md - change missed beautified menu entries according to changes in settings.js
2022-02-15 20:17:07 +00:00
Is the calculated standard deviation lower than the "no movement" threshold (__NoMo Thresh__) a "no movement" counter is incremented. Each time the "no movement" threshold is reached the "no movement" counter will be reset. The first time no movement is detected the actual timestamp is cached (in _sleeplog.firstnomodate_) for logging.
When the "no movement" counter reaches the sleep threshold the watch is considered as resting. (The sleep threshold is calculated from the __Min Duration__ setting, Example: _sleep threshold = Min Duration * 60 / calculation interval => 10min * 60s/min / 1.04s ~= 576,9 rounded up to 577_)
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
* __Power Saving Mode__
Update README.md Update README.md - change missed beautified menu entries according to changes in settings.js
2022-02-15 20:17:07 +00:00
On power saving mode the movement value of bangle's build in health event is checked against the maximal movement threshold (__Max Move__). The event is only triggered every 10 minutes which decreases the battery impact but also reduces accurracy.
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
* ___Sleeping___ __or__ ___Not Worn___
Update README.md Update README.md - change missed beautified menu entries according to changes in settings.js
2022-02-15 20:17:07 +00:00
To check if a resting watch indicates a sleeping status, the internal temperature must be greater than the temperature threshold (__Temp Thresh__). Otherwise the watch is considered as not worn.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
* __True Sleep__
The true sleep value is a simple addition of all registert sleeping periods.
* __Consecutive Sleep__
Update README.md Update README.md - change missed beautified menu entries according to changes in settings.js
2022-02-15 20:17:07 +00:00
In addition the consecutive sleep value tries to predict the complete time you were asleep, even the light sleeping phases with registered movements. All periods after a sleeping period will be summarized til the first following non sleeping period that is longer then the maximal awake duration (__Max Awake__). If this sum is lower than the minimal consecutive sleep duration (__Min Consec__) it is not considered, otherwise it will be added to the consecutive sleep value.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
* __Logging__
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
To minimize the log size only a changed state is logged. The logged timestamp is matching the beginning of its measurement period.
When not on power saving mode a movement is detected nearly instantaneous and the detection of a no movement period is delayed by the minimal no movement duration. To match the beginning of the measurement period a cached timestamp (_sleeplog.firstnomodate_) is logged.
sleeplog: Fix LOW_MEMORY,MEMORY error #1835 Check and if neccessary reduce logsize to 1500 entries in writeLog() to prevent low mem error.
2022-05-17 07:18:39 +00:00
On power saving mode the measurement period is fixed to 10 minutes and all logged timestamps are also set back 10 minutes.
[sleeplog] Reduced log size further, see #1835 Reduced log size further to 750 entries
2022-05-17 15:51:10 +00:00
To prevent a LOW_MEMORY,MEMORY error the log size is limited to 750 entries, older entries will be overwritten.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
---
### Control
---
* __Swipe__
Swipe left/right to display the previous/following day.
* __Touch__ / __BTN__
Touch the screen to open the settings menu to exit or change settings.
---
### Settings
---
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Break Tod__ | break at time of day
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_0_ / _1_ / _..._ / __10__ / _..._ / _12_
Change time of day on wich the lower graph starts and the upper graph ends.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Max Awake__ | maximal awake duration
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_15min_ / _20min_ / _..._ / __60min__ / _..._ / _120min_
Adjust the maximal awake duration upon the exceeding of which aborts the consecutive sleep period.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Min Consec__ | minimal consecutive sleep duration
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_15min_ / _20min_ / _..._ / __30min__ / _..._ / _120min_
Adjust the minimal consecutive sleep duration that will be considered for the consecutive sleep value.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Temp Thresh__ | temperature threshold
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_20°C_ / _20.5°C_ / _..._ / __25°C__ / _..._ / _40°C_
The internal temperature must be greater than this threshold to log _sleeping_, otherwise it is _not worn_.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Power Saving__
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
_on_ / __off__
Update README.md Change description to icons
2022-02-16 12:00:39 +00:00
En-/Disable power saving mode. _Saves battery, but might decrease accurracy._
In app icon showing that power saving mode is enabled: ![](powersaving.png)
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Max Move__ | maximal movement threshold
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
(only available when on power saving mode)
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
_50_ / _51_ / _..._ / __100__ / _..._ / _200_
On power saving mode the watch is considered resting if this threshold is lower or equal to the movement value of bangle's health event.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __NoMo Thresh__ | no movement threshold
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
(only available when not on power saving mode)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_0.006_ / _0.007_ / _..._ / __0.012__ / _..._ / _0.020_
The standard deviation over the measured values needs to be lower then this threshold to count as not moving.
The defaut threshold value worked best for my watch. A threshold value below 0.008 may get triggert by noise.
sleeplog: Correct fix #1445, display loading info while calculating sleep data Update app.js - move complex data analysis into separate function - add displaying a loading info - faster feedback by calling the analysis through a timeout Update boot.js - correct fix #1445 as mentioned by splitting the `stop()` function to only remove the kill listener on a manual stop - optimize `start()` and `stop()` functions Update README.md - change beautified menu entries according to changes in settings.js Update settings.js - replace `circulate()` function with internal `wrap: true` - move delay for menu redraw as suggested in espruino/Espruino#2149 - beautify menu entries for new touchscreen E.showMenu system (> fw 2v.13.32)
2022-02-15 18:47:15 +00:00
* __Min Duration__ | minimal no movement duration
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
(only available when not on power saving mode)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
_5min_ / _6min_ / _..._ / __10min__ / _..._ / _15min_
If no movement is detected for this duration, the watch is considered as resting.
* __Enabled__
__on__ / _off_
Update README.md Change description to icons
2022-02-16 12:00:39 +00:00
En-/Disable the service (all background activities). _Saves the most battery, but might make this app useless._
In app icon showing that the service is disabled: ![](disabled.png)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
* __Logfile__
__default__ / _off_
En-/Disable logging by setting the logfile to _sleeplog.log_ / _undefined_.
Update README.md Change description to icons
2022-02-16 12:00:39 +00:00
If the logfile has been customized it is displayed with _custom_.
In app icon showing that logging is disabled: ![](nolog.png)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
---
### Global Object and Module Functions
---
For easy access from the console or other apps the following parameters, values and functions are noteworthy:
```
>global.sleeplog
={
enabled: true, // bool / service status indicator
logfile: "sleeplog.log", // string / used logfile
resting: false, // bool / indicates if the watch is resting
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
status: 2, // int / actual status:
/ undefined = service stopped, 0 = unknown, 1 = not worn, 2 = awake, 3 = sleeping
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
firstnomodate: 1644435877595, // number / Date.now() from first recognised no movement, not available in power saving mode
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
stop: function () { ... }, // funct / stops the service until the next load()
start: function () { ... }, // funct / restarts the service
...
}
>require("sleeplog")
={
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
setEnabled: function (enable, logfile, powersaving) { ... },
// restarts the service with changed settings
// * enable / bool / new service status
// * logfile / bool or string
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// - true = enables logging to "sleeplog.log"
// - "some_file.log" = enables logging to "some_file.log"
// - false = disables logging
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * (powersaving) / bool / new power saving status, default: false
// returns: true or undefined
// - true = service restart executed
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// - undefined = no global.sleeplog found
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
readLog: function (logfile, since, until) { ... },
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// read the raw log data for a specific time period
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * logfile / string / on no string uses logfile from global object or "sleeplog.log"
// * (since) / Date or number / startpoint of period, default: 0
// * (until) / Date or number / endpoint of period, default: 1E14
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// returns: array
// * [[number, int, string], [...], ... ] / sorting: latest first
// - number // timestamp in ms
// - int // status: 0 = unknown, 1 = not worn, 2 = awake, 3 = sleeping
// - string // additional information
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * [] = no data available or global.sleeplog not found
writeLog: function (logfile, input) { ... },
// append or replace log depending on input
// * logfile / string / on no string uses logfile from global object or default
// * input / array
// - append input if array length >1 and element[0] >9E11
// - replace log with input if at least one entry like above is inside another array
// returns: true or undefined
// - true = changest written to storage
// - undefined = wrong input
getReadableLog: function (printLog, since, until, logfile) { ... }
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// read the log data as humanreadable string for a specific time period
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * (printLog) / bool / direct print output with additional information, default: false
// * (since) / Date or number / see readLog(..)
// * (until) / Date or number / see readLog(..)
// * (logfile) / string / see readLog(..)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// returns: string
// * "{substring of ISO date} - {status} for {duration}min\n...", sorting: latest last
// * undefined = no data available or global.sleeplog found
restoreLog: function (logfile) { ... }
// eliminate some errors inside a specific logfile
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * (logfile) / string / see readLog(..)
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// returns: int / number of changes that were made
reinterpretTemp: function (logfile, tempthresh) { ... }
// reinterpret worn status based on given temperature threshold
sleeplog: Complete power saving mode + move all read/write log actions into lib.js * Complete new power saving mode after tests * Move all read/write log operations into lib/module Update app.js - update `readLog(...)` call Update boot.js - update maxmove default value - delete `log(..)`, merging into `writeLog(...)` from lib.js - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` from lib.js - add restoring the status after a restart (<5 min ago) to last known state - add deletion of unused settings on power saving mode - update log timestamp on power saving mode to always be 10min before now Update ChangeLog Update lib.js - update `readLog(...)`, prevent errors on reading, minimize workload if unfiltered - add `writeLog(...)` to append or replace log depending on input with plausibility checks on input - merging `log(...)` from boot.js into `writeLog(...)` - replace all read/write actions to the logfile with `readLog(...)`/`writeLog(...)` Update metadata.json - update version number - add power saving mode to description Update README.md - add power saving mode description - move sleeping/not worn decision description into its own section - add description for timestamp values to Logging section - update Global Object and Module Functions section Update settings.js - update maxmove setting and default value
2022-02-13 19:54:26 +00:00
// * (logfile) / string / see readLog(..)
// * (tempthresh) / float / new temperature threshold, on default uses tempthresh from global object or 27
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
// returns: int / number of changes that were made
}
```
---
### Worth Mentioning
---
#### To do list
* Send the logged information to Gadgetbridge.
_(For now I have no idea how to achieve this, help is appreciated.)_
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
* View, down- and upload log functions via App Loader.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
* Calculate and display overall sleep statistics.
sleeplog: Prevent removing other kill listeners #1445 Update boot.js - prevent removing other kill listeners #1445 Update README.md - change "only available" information for Settings - add new ideas to "To do list"
2022-02-13 21:39:57 +00:00
* Option to automatically change power saving mode depending on time of day.
sleeplog: Add Sleep Log App This app logs and displays the four following states: _unknown, not worn, awake, sleeping_ It derived from the SleepPhaseAlarm and uses the accelerometer to estimate sleep and wake states with the principle of Estimation of Stationary Sleep-segments ([ESS](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en)) and the internal temperature to decide _sleeping_ or _not worn_ when the watch is resting.
2022-02-11 08:29:02 +00:00
#### Requests, Bugs and Feedback
Please leave requests and bug reports by raising an issue at [github.com/storm64/BangleApps](https://github.com/storm64/BangleApps) or send me a [mail](mailto:banglejs@storm64.de).
#### Creator
Storm64 ([Mail](mailto:banglejs@storm64.de), [github](https://github.com/storm64))
#### Contributors
nxdefiant ([github](https://github.com/nxdefiant))
#### Attributions
* ESS calculation based on nxdefiant interpretation of the following publication by:
Marko Borazio, Eugen Berlin, Nagihan Kücükyildiz, Philipp M. Scholl and Kristof Van Laerhoven
[Towards a Benchmark for Wearable Sleep Analysis with Inertial Wrist-worn Sensing Units](https://ubicomp.eti.uni-siegen.de/home/datasets/ichi14/index.html.en),
ICHI 2014, Verona, Italy, IEEE Press, 2014.
* Icons used in this app are from [https://icons8.com](https://icons8.com).
#### License
[MIT License](LICENSE)