Source: Fitbit/engine.js

  1. /*
  2.  * Copyright 2020-2022 Sleepdiary Developers <sleepdiary@pileofstuff.org>
  3.  *
  4.  * Permission is hereby granted, free of charge, to any person
  5.  * obtaining a copy of this software and associated documentation
  6.  * files (the "Software"), to deal in the Software without
  7.  * restriction, including without limitation the rights to use, copy,
  8.  * modify, merge, publish, distribute, sublicense, and/or sell copies
  9.  * of the Software, and to permit persons to whom the Software is
  10.  * furnished to do so, subject to the following conditions:
  11.  *
  12.  * The above copyright notice and this permission notice shall be
  13.  * included in all copies or substantial portions of the Software.
  14.  *
  15.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16.  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17.  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18.  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19.  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20.  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21.  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22.  * SOFTWARE.
  23.  */
  25. "use strict";
  27. /**
  28.  * @public
  29.  * @unrestricted
  30.  * @augments DiaryBase
  31.  *
  32.  * @example
  33.  * let diary = new_sleep_diary(contents_of_my_file));
  34.  *
  35.  * console.log(diary.records);
  36.  * -> [
  37.  *      {
  38.  *        "start"               : 12345678,
  39.  *        "end"                 : 23456789,
  40.  *        "Start Time"          : "2010-10-10 8:09PM",
  41.  *        "End Time"            : "2010-10-11 7:08AM",
  42.  *        "Minutes Asleep"      : "500",
  43.  *        "Minutes Awake"       : "50",
  44.  *        "Number of Awakenings": "30",
  45.  *        "Time in Bed"         : "500",
  46.  *        "Minutes REM Sleep"   : "100",
  47.  *        "Minutes Light Sleep" : "300",
  48.  *        "Minutes Deep Sleep"  : "100",
  49.  *      },
  50.  *      ...
  51.  *    ]
  52.  *
  53.  */
  54. class DiaryFitbit extends DiaryBase {
  56.     /**
  57.      * @param {Object} file - file contents
  58.      * @param {Function=} serialiser - function to serialise output
  59.      */
  60.     constructor(file,serialiser) {
  62.         super(file,serialiser); // call the DiaryBase constructor
  64.         /*
  65.          * PROPERTIES
  66.          */
  68.         let records = [];
  70.         /**
  71.          * Spreadsheet manager
  72.          * @protected
  73.          * @type {Spreadsheet}
  74.          */
  75.         this["spreadsheet"] = new Spreadsheet(
  76.             this,
  77.             [
  78.                 // Define one object per sheet in the spreadsheet:
  79.                 {
  80.                     "sheet" : "Records",
  81.                     "member" : "records",
  82.                     "cells": [
  83.                         {
  84.                             "member": "Start Time",
  85.                             "type": "time",
  86.                         },
  87.                         {
  88.                             "member": "End Time",
  89.                             "type": "time",
  90.                         },
  91.                         {
  92.                             "member": "Minutes Asleep",
  93.                             "type": "number",
  94.                         },
  95.                         {
  96.                             "member": "Minutes Awake",
  97.                             "type": "number",
  98.                         },
  99.                         {
  100.                             "member": "Number of Awakenings",
  101.                             "type": "number",
  102.                             "optional": true,
  103.                         },
  104.                         {
  105.                             "member": "Time in Bed",
  106.                             "type": "number",
  107.                             "optional": true,
  108.                         },
  109.                         {
  110.                             "member": "Minutes REM Sleep",
  111.                             "type": "number",
  112.                             "optional": true,
  113.                         },
  114.                         {
  115.                             "member": "Minutes Light Sleep",
  116.                             "type": "number",
  117.                             "optional": true,
  118.                         },
  119.                         {
  120.                             "member": "Minutes Deep Sleep",
  121.                             "type": "number",
  122.                             "optional": true,
  123.                         },
  124.                         {
  125.                             "members": [],
  126.                             "export": (array_element,row,offset) => true,
  127.                             "import": (array_element,row,offset) => {
  128.                                 array_element["end"] = array_element["End Time"];
  129.                                 array_element["start"] = array_element["Start Time"];
  130.                                 return true;
  131.                             },
  132.                         },
  133.                     ],
  134.                 },
  135.             ]
  136.         );
  138.         /*
  139.          * We use a regex-based parser here instead of the general CSV parser.
  140.          * The file begins with a magic number "Sleep\n", which is not currently
  141.          * handled by the general parser.  The rest of the format is simple
  142.          * enough not to bother adding complexity elsewhere.
  143.          */
  145.         const fitbit_header
  146.               = "Sleep\n"
  147.               + "Start Time,End Time,Minutes Asleep,Minutes Awake,Number of Awakenings,Time in Bed,Minutes REM Sleep,Minutes Light Sleep,Minutes Deep Sleep\n"
  148.         ;
  150.         const fitbit_footer = "\n";
  152.         const fitbit_timestamp = '"(([0-9][0-9]*)-([0-9][0-9]*)-([0-9][0-9]*) ([0-9][0-9]*):([0-9][0-9]*) *([AP])M)"';
  154.         const fitbit_number       = '"([0-9][0-9,]*)"';
  155.         const fitbit_maybe_number = '"([0-9][0-9,]*|N/A)"';
  157.         const fitbit_line
  158.               = fitbit_timestamp
  159.               + ',' + fitbit_timestamp
  160.               + ',' + fitbit_number // Minutes Asleep
  161.               + ',' + fitbit_number // Minutes Awake
  162.               + ',' + fitbit_maybe_number // Number of Awakenings
  163.               + ',' + fitbit_maybe_number // Time in Bed
  164.               + ',' + fitbit_maybe_number // Minutes REM Sleep
  165.               + ',' + fitbit_maybe_number // Minutes Light Sleep
  166.               + ',' + fitbit_maybe_number // Minutes Deep Sleep
  167.               + "\n"
  168.         ;
  170.         const fitbit_file_re = new RegExp(
  171.               '^'   + fitbit_header
  172.             + '(?:' + fitbit_line   + ')*'
  173.             +         fitbit_footer + '$',
  174.             'i'
  175.         );
  177.         function parse_timestamp( year, month, day, hour, minute, ap ) {
  178.             year = parseInt(year,10);
  179.             month = parseInt(month,10);
  180.             day = parseInt(day,10);
  181.             hour = parseInt(hour,10);
  182.             if ( hour == 12 ) {
  183.                 if ( ap == 'A' ) hour = 0;
  184.             } else if ( ap == 'P' ) {
  185.                 hour += 12;
  186.             }
  187.             minute = parseInt(minute,10);
  188.             if ( day > 31 ) { // DD-MM-YYYY instead of YYYY-MM-DD
  189.                 return new Date(day, month-1, year, hour, minute).getTime();
  190.             } else {
  191.                 return new Date(year, month-1, day, hour, minute).getTime();
  192.             }
  193.         }
  195.         function parse_number(str) {
  196.             return parseInt(str.replace(/,/g,''),10);
  197.         }
  199.         function parse_maybe_number(str) {
  200.             return ( str == "N/A" ) ? null : parse_number(str);
  201.         }
  203.         switch ( file["file_format"]() ) {
  205.         case "string":
  207.             const contents = file["contents"];
  208.             if ( !fitbit_file_re.test(contents) ) {
  210.                 return this.invalid(file);
  212.             } else {
  214.                 contents.replace(
  215.                     new RegExp(fitbit_line,'gi'),
  216.                     (_,
  217.                      start_time, start_year,start_month,start_day,start_hour,start_minute,start_ap,
  218.                      end_time, end_year,end_month,end_day,end_hour,end_minute,end_ap,
  219.                      minutes_asleep,minutes_awake,number_of_awakenings,time_in_bed,minutes_rem_sleep,minutes_light_sleep,minutes_deep_sleep
  220.                     ) => {
  221.                         let end = parse_timestamp( end_year, end_month, end_day, end_hour, end_minute, end_ap.toUpperCase() ),
  222.                             record = {
  223.                                 "End Time"            : end,
  224.                                 "Minutes Asleep"      : parse_number(minutes_asleep),
  225.                                 "Minutes Awake"       : parse_number(minutes_awake),
  226.                                 "Number of Awakenings": parse_maybe_number(number_of_awakenings),
  227.                                 "Time in Bed"         : parse_maybe_number(time_in_bed),
  228.                                 "Minutes REM Sleep"   : parse_maybe_number(minutes_rem_sleep),
  229.                                 "Minutes Light Sleep" : parse_maybe_number(minutes_light_sleep),
  230.                                 "Minutes Deep Sleep"  : parse_maybe_number(minutes_deep_sleep),
  231.                                 "end"                 : end,
  232.                             };
  233.                         record["Start Time"] = record["start"] = end - ( record["Minutes Asleep"] + record["Minutes Awake"] ) * 60*1000;
  234.                         records.push(record);
  235.                     }
  236.                 );
  238.                 this["records"] = records;
  240.             }
  241.             break;
  243.         default:
  245.             if ( this.initialise_from_common_formats(file) ) {
  246.                 this["records"].forEach(
  247.                     record => [
  248.                         "Number of Awakenings",
  249.                         "Time in Bed",
  250.                         "Minutes REM Sleep",
  251.                         "Minutes Light Sleep",
  252.                         "Minutes Deep Sleep"
  253.                     ].forEach( key => Object.prototype.hasOwnProperty.call(record,key) || ( record[key] = null ) )
  254.                 );
  255.                 return;
  256.             }
  258.             /**
  259.              * Individual records from the sleep diary
  260.              * @type {Array}
  261.              */
  262.             this["records"] = (
  263.                 file["to"]("Standard")["records"]
  264.                     .filter( r => r["status"] == "asleep" )
  265.                     .map( (r,n) => ({
  266.                         "start"               : r["start"],
  267.                         "end"                 : r["end"  ],
  268.                         "Start Time"          : r["start"],
  269.                         "End Time"            : r["end"],
  270.                         "Minutes Asleep"      : Math.round( ( r["end"] - r["start"] ) / (60*1000) ),
  271.                         "Minutes Awake"       : 0,
  272.                         "Number of Awakenings": null,
  273.                         "Time in Bed"         : null,
  274.                         "Minutes REM Sleep"   : null,
  275.                         "Minutes Light Sleep" : null,
  276.                         "Minutes Deep Sleep"  : null,
  277.                     }))
  278.             );
  280.             break;
  282.         }
  284.     }
  286.     ["to"](to_format) {
  288.         switch ( to_format ) {
  290.         case "output":
  292.             return this.serialise({
  293.                 "file_format": () => "string",
  294.                 "contents": [
  295.                     "Sleep",
  296.                     "Start Time,End Time,Minutes Asleep,Minutes Awake,Number of Awakenings,Time in Bed,Minutes REM Sleep,Minutes Light Sleep,Minutes Deep Sleep",
  297.                 ].concat(
  298.                     this["records"].map(
  299.                         r => [
  300.                             "Start Time",
  301.                             "End Time",
  302.                         ].map(
  303.                             date => {
  304.                                 date = new Date(r[date]);
  305.                                 const hours = date["getHours"]();
  306.                                 return (
  307.                                     '"' +
  308.                                     date["getFullYear"]() +
  309.                                     '-' +
  310.                                     DiaryBase.zero_pad( date["getMonth"]()+1 ) +
  311.                                     '-' +
  312.                                     DiaryBase.zero_pad( date["getDate" ] () ) +
  313.                                     ' ' +
  314.                                     ( ( hours % 12 ) || 12 ) +
  315.                                     ':' +
  316.                                     DiaryBase.zero_pad( date["getMinutes"]() ) +
  317.                                     ( ( hours >= 12 ) ? 'PM' : 'AM' ) +
  318.                                     '"'
  319.                                 );
  320.                             }
  321.                         ).concat([
  322.                             "Minutes Asleep",
  323.                             "Minutes Awake",
  324.                             "Number of Awakenings",
  325.                             "Time in Bed",
  326.                             "Minutes REM Sleep",
  327.                             "Minutes Light Sleep",
  328.                             "Minutes Deep Sleep"
  329.                         ].map(
  330.                             key => (
  331.                                 ( r[key] === null )
  332.                                 ? '"N/A"'
  333.                                 // based on https://stackoverflow.com/a/2901298
  334.                                 : '"' + r[key].toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",") + '"'
  335.                             )
  336.                         )).join(',')
  337.                     ),
  338.                     "\n" // Fitbit format includes a trailing newline
  339.                 ).join("\n")
  340.             });
  342.         case "Standard":
  344.             return new DiaryStandard({
  345.                 "records": this["records"].map(
  346.                     r => ({
  347.                         "status"  : "asleep",
  348.                         "start"   : r["start"],
  349.                         "end"     : r["end"  ],
  350.                         "duration": r["end"] - r["start"],
  351.                     })
  352.                 ),
  353.             }, this.serialiser);
  355.         default:
  357.             return super["to"](to_format);
  359.         }
  361.     }
  363.     ["merge"](other) {
  365.         other = other["to"](this["file_format"]());
  367.         this["records"] = this["records"].concat(
  368.             DiaryBase.unique(
  369.                 this["records"],
  370.                 other["records"],
  371.                 ["start","end"]
  372.             )
  373.         )
  374.         // Fitbit records are always in reverse chronological order:
  375.             .sort( (a,b) => b["start"] - a["start"] )
  376.         ;
  378.         return this;
  380.     }
  382.     ["file_format"]() { return "Fitbit"; }
  383.     ["format_info"]() {
  384.         return {
  385.             "name": "Fitbit",
  386.             "title": "fitbit",
  387.             "url": "/src/Fitbit",
  388.             "statuses": [ "asleep" ],
  389.             "extension": ".csv",
  390.             "logo": "https://community.fitbit.com/html/assets/fitbit_logo_1200.png",
  391.             "timezone": "tzdata",
  392.         }
  393.     }
  395. }
  397. DiaryBase.register(DiaryFitbit);