From ca8c815446a96b8455e5d665062023a0958a791c Mon Sep 17 00:00:00 2001 From: Meng Li <34143965+Meng6@users.noreply.github.com> Date: Thu, 19 Nov 2020 12:30:16 -0500 Subject: [PATCH] Update Fitbit docs: HR & Steps --- docs/features/fitbit-heartrate-intraday.md | 70 +++++++++++++++++++ docs/features/fitbit-heartrate-summary.md | 78 +++++++++++++++++++++ docs/features/fitbit-steps-intraday.md | 80 ++++++++++++++++++++++ docs/features/fitbit-steps-summary.md | 65 ++++++++++++++++++ docs/setup/configuration.md | 2 + mkdocs.yml | 5 ++ 6 files changed, 300 insertions(+) create mode 100644 docs/features/fitbit-heartrate-intraday.md create mode 100644 docs/features/fitbit-heartrate-summary.md create mode 100644 docs/features/fitbit-steps-intraday.md create mode 100644 docs/features/fitbit-steps-summary.md diff --git a/docs/features/fitbit-heartrate-intraday.md b/docs/features/fitbit-heartrate-intraday.md new file mode 100644 index 00000000..42d783bf --- /dev/null +++ b/docs/features/fitbit-heartrate-intraday.md @@ -0,0 +1,70 @@ +# Fitbit Heart Rate Intraday + +Sensor parameters description for `[FITBIT_HEARTRATE_INTRADAY]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[TABLE]`| Database table name or file path where the heart rate intraday data is stored. Source data type and column format are defined in [Device Data Source Configuration](../../setup/configuration/#device-data-source-configuration). + +Column format could be `JSON` or `PLAIN_TEXT`. Data with `JSON` column format is obtained from Fitbit API directly. Summary data and intraday data come together in `JSON` format. Each row doesn't have to contain the data for a single day as it depends on the way Fitbit API is queried. Examples of the source data with two formats are as follows. Data with `JSON` format is chunked. + +??? example "Example of the structure of source data" + + === "JSON" + + |device_id |fitbit_data | + |---------------------------------------- |--------------------------------------------------------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-07","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1200.6102,"max":88,"min":31,"minutes":1058,"name":"Out of Range"},{"caloriesOut":760.3020,"max":120,"min":86,"minutes":366,"name":"Fat Burn"},{"caloriesOut":15.2048,"max":146,"min":120,"minutes":2,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":72}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":68},{"time":"00:01:00","value":67},{"time":"00:02:00","value":67},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-08","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1100.1120,"max":89,"min":30,"minutes":921,"name":"Out of Range"},{"caloriesOut":660.0012,"max":118,"min":82,"minutes":361,"name":"Fat Burn"},{"caloriesOut":23.7088,"max":142,"min":108,"minutes":3,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":70}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":77},{"time":"00:01:00","value":75},{"time":"00:02:00","value":73},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-09","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":750.3615,"max":77,"min":30,"minutes":851,"name":"Out of Range"},{"caloriesOut":734.1516,"max":107,"min":77,"minutes":550,"name":"Fat Burn"},{"caloriesOut":131.8579,"max":130,"min":107,"minutes":29,"name":"Cardio"},{"caloriesOut":0,"max":220,"min":130,"minutes":0,"name":"Peak"}],"restingHeartRate":69}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":90},{"time":"00:01:00","value":89},{"time":"00:02:00","value":88},...],"datasetInterval":1,"datasetType":"minute"}} + + === "PLAIN_TEXT" + + |device_id |local_date_time |heartrate |heartrate_zone | + |-------------------------------------- |---------------------- |--------- |--------------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:00:00 |68 |outofrange | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:01:00 |67 |outofrange | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:02:00 |67 |outofrange | + + +## RAPIDS provider + +!!! info "Available day segments" + - Available for all day segments + +!!! info "File Sequence" + ```bash + - data/raw/{pid}/fitbit_heartrate_intraday_raw.csv + - data/raw/{pid}/fitbit_heartrate_intraday_parsed.csv + - data/raw/{pid}/fitbit_heartrate_intraday_parsed_with_datetime.csv + - data/interim/{pid}/fitbit_heartrate_intraday_features/fitbit_heartrate_intraday_{language}_{provider_key}.csv + - data/processed/features/{pid}/fitbit_heartrate_intraday.csv + ``` + + +Parameters description for `[FITBIT_HEARTRATE_INTRADAY][PROVIDERS][RAPIDS]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[COMPUTE]` | Set to `True` to extract `FITBIT_HEARTRATE_INTRADAY` features from the `RAPIDS` provider| +|`[FEATURES]` | Features to be computed from heart rate intraday data, see table below | + + +Features description for `[FITBIT_HEARTRATE_INTRADAY][PROVIDERS][RAPIDS]`: + +|Feature |Units |Description| +|-------------------------- |-------------- |---------------------------| +|maxhr |beats/mins |The maximum heart rate during a day segment. +|minhr |beats/mins |The minimum heart rate during a day segment. +|avghr |beats/mins |The average heart rate during a day segment. +|medianhr |beats/mins |The median of heart rate during a day segment. +|modehr |beats/mins |The mode of heart rate during a day segment. +|stdhr |beats/mins |The standard deviation of heart rate during a day segment. +|diffmaxmodehr |beats/mins |The difference between the maximum and mode heart rate during a day segment. +|diffminmodehr |beats/mins |The difference between the mode and minimum heart rate during a day segment. +|entropyhr |nats |Shannon’s entropy measurement based on heart rate during a day segment. +|minutesonZONE |minutes |Number of minutes the user’s heart rate fell within each `heartrate_zone` during a day segment. + +!!! note "Assumptions/Observations" + + 1. There are four heart rate zones (ZONE): ``outofrange``, ``fatburn``, ``cardio``, and ``peak``. Please refer to [Fitbit documentation](https://help.fitbit.com/articles/en_US/Help_article/1565.htm) for more information about the way they are computed. diff --git a/docs/features/fitbit-heartrate-summary.md b/docs/features/fitbit-heartrate-summary.md new file mode 100644 index 00000000..9c64f9b4 --- /dev/null +++ b/docs/features/fitbit-heartrate-summary.md @@ -0,0 +1,78 @@ +# Fitbit Heart Rate Summary + +Sensor parameters description for `[FITBIT_HEARTRATE_SUMMARY]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[TABLE]`| Database table name or file path where the heart rate summary data is stored. Source data type and column format are defined in [Device Data Source Configuration](../../setup/configuration/#device-data-source-configuration). + +Column format could be `JSON` or `PLAIN_TEXT`. Data with `JSON` column format is obtained from Fitbit API directly. Summary data and intraday data come together in `JSON` format. Each row doesn't have to contain the data for a single day as it depends on the way Fitbit API is queried. Examples of the source data with two formats are as follows. Data with `JSON` format is chunked. + +??? example "Example of the structure of source data" + + === "JSON" + + |device_id |fitbit_data | + |---------------------------------------- |--------------------------------------------------------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-07","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1200.6102,"max":88,"min":31,"minutes":1058,"name":"Out of Range"},{"caloriesOut":760.3020,"max":120,"min":86,"minutes":366,"name":"Fat Burn"},{"caloriesOut":15.2048,"max":146,"min":120,"minutes":2,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":72}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":68},{"time":"00:01:00","value":67},{"time":"00:02:00","value":67},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-08","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":1100.1120,"max":89,"min":30,"minutes":921,"name":"Out of Range"},{"caloriesOut":660.0012,"max":118,"min":82,"minutes":361,"name":"Fat Burn"},{"caloriesOut":23.7088,"max":142,"min":108,"minutes":3,"name":"Cardio"},{"caloriesOut":0,"max":221,"min":148,"minutes":0,"name":"Peak"}],"restingHeartRate":70}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":77},{"time":"00:01:00","value":75},{"time":"00:02:00","value":73},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |{"activities-heart":[{"dateTime":"2020-10-09","value":{"customHeartRateZones":[],"heartRateZones":[{"caloriesOut":750.3615,"max":77,"min":30,"minutes":851,"name":"Out of Range"},{"caloriesOut":734.1516,"max":107,"min":77,"minutes":550,"name":"Fat Burn"},{"caloriesOut":131.8579,"max":130,"min":107,"minutes":29,"name":"Cardio"},{"caloriesOut":0,"max":220,"min":130,"minutes":0,"name":"Peak"}],"restingHeartRate":69}}],"activities-heart-intraday":{"dataset":[{"time":"00:00:00","value":90},{"time":"00:01:00","value":89},{"time":"00:02:00","value":88},...],"datasetInterval":1,"datasetType":"minute"}} + + === "PLAIN_TEXT" + + |device_id |local_date_time |heartrate_daily_restinghr |heartrate_daily_caloriesoutofrange |heartrate_daily_caloriesfatburn |heartrate_daily_caloriescardio |heartrate_daily_caloriespeak | + |-------------------------------------- |----------------- |------- |-------------- |------------- |------------ |-------| + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 |72 |1200.6102 |760.3020 |15.2048 |0 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-08 |70 |1100.1120 |660.0012 |23.7088 |0 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-09 |69 |750.3615 |734.1516 |131.8579 |0 | + + +## RAPIDS provider + +!!! info "Available day segments" + - Only available for segments that span 1 or more complete days (e.g. Jan 1st 00:00 to Jan 3rd 23:59) + +!!! info "File Sequence" + ```bash + - data/raw/{pid}/fitbit_heartrate_summary_raw.csv + - data/raw/{pid}/fitbit_heartrate_summary_parsed.csv + - data/raw/{pid}/fitbit_heartrate_summary_parsed_with_datetime.csv + - data/interim/{pid}/fitbit_heartrate_summary_features/fitbit_heartrate_summary_{language}_{provider_key}.csv + - data/processed/features/{pid}/fitbit_heartrate_summary.csv + ``` + + +Parameters description for `[FITBIT_HEARTRATE_SUMMARY][PROVIDERS][RAPIDS]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[COMPUTE]` | Set to `True` to extract `FITBIT_HEARTRATE_SUMMARY` features from the `RAPIDS` provider| +|`[FEATURES]` | Features to be computed from heart rate summary data, see table below | + + +Features description for `[FITBIT_HEARTRATE_SUMMARY][PROVIDERS][RAPIDS]`: + +|Feature |Units |Description| +|-------------------------- |---------- |---------------------------| +|maxrestinghr |beats/mins |The maximum daily resting heart rate during a day segment. +|minrestinghr |beats/mins |The minimum daily resting heart rate during a day segment. +|avgrestinghr |beats/mins |The average daily resting heart rate during a day segment. +|medianrestinghr |beats/mins |The median of daily resting heart rate during a day segment. +|moderestinghr |beats/mins |The mode of daily resting heart rate during a day segment. +|stdrestinghr |beats/mins |The standard deviation of daily resting heart rate during a day segment. +|diffmaxmoderestinghr |beats/mins |The difference between the maximum and mode daily resting heart rate during a day segment. +|diffminmoderestinghr |beats/mins |The difference between the mode and minimum daily resting heart rate during a day segment. +|entropyrestinghr |nats |Shannon’s entropy measurement based on daily resting heart rate during a day segment. +|sumcaloriesZONE |cals |The total daily calories burned within `heartrate_zone` during a day segment. +|maxcaloriesZONE |cals |The maximum daily calories burned within `heartrate_zone` during a day segment. +|mincaloriesZONE |cals |The minimum daily calories burned within `heartrate_zone` during a day segment. +|avgcaloriesZONE |cals |The average daily calories burned within `heartrate_zone` during a day segment. +|mediancaloriesZONE |cals |The median of daily calories burned within `heartrate_zone` during a day segment. +|stdcaloriesZONE |cals |The standard deviation of daily calories burned within `heartrate_zone` during a day segment. +|entropycaloriesZONE |nats |Shannon’s entropy measurement based on daily calories burned within `heartrate_zone` during a day segment. + +!!! note "Assumptions/Observations" + + 1. There are four heart rate zones (ZONE): ``outofrange``, ``fatburn``, ``cardio``, and ``peak``. Please refer to [Fitbit documentation](https://help.fitbit.com/articles/en_US/Help_article/1565.htm) for more information about the way they are computed. + + 2. Calories' accuracy depends on the users’ Fitbit profile (weight, height, etc.). diff --git a/docs/features/fitbit-steps-intraday.md b/docs/features/fitbit-steps-intraday.md new file mode 100644 index 00000000..17270bf7 --- /dev/null +++ b/docs/features/fitbit-steps-intraday.md @@ -0,0 +1,80 @@ +# Fitbit Steps Intraday + +Sensor parameters description for `[FITBIT_STEPS_INTRADAY]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[TABLE]`| Database table name or file path where the steps intraday data is stored. Source data type and column format are defined in [Device Data Source Configuration](../../setup/configuration/#device-data-source-configuration). + +Column format could be `JSON` or `PLAIN_TEXT`. Data with `JSON` column format is obtained from Fitbit API directly. Summary data and intraday data come together in `JSON` format. Each row doesn't have to contain the data for a single day as it depends on the way Fitbit API is queried. Examples of the source data with two formats are as follows. Data with `JSON` format is chunked. + +??? example "Example of the structure of source data" + + === "JSON" + + |device_id |fitbit_data | + |---------------------------------------- |--------------------------------------------------------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-07","value":"1775"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":5},{"time":"00:01:00","value":3},{"time":"00:02:00","value":0},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-08","value":"3201"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":14},{"time":"00:01:00","value":11},{"time":"00:02:00","value":10},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-09","value":"998"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":0},{"time":"00:01:00","value":0},{"time":"00:02:00","value":0},...],"datasetInterval":1,"datasetType":"minute"}} + + === "PLAIN_TEXT" + + |device_id |local_date_time |steps | + |-------------------------------------- |---------------------- |--------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:00:00 |5 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:01:00 |3 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 00:02:00 |0 | + + +## RAPIDS provider + +!!! info "Available day segments" + - Available for all day segments + +!!! info "File Sequence" + ```bash + - data/raw/{pid}/fitbit_steps_intraday_raw.csv + - data/raw/{pid}/fitbit_steps_intraday_parsed.csv + - data/raw/{pid}/fitbit_steps_intraday_parsed_with_datetime.csv + - data/interim/{pid}/fitbit_steps_intraday_features/fitbit_steps_intraday_{language}_{provider_key}.csv + - data/processed/features/{pid}/fitbit_steps_intraday.csv + ``` + + +Parameters description for `[FITBIT_STEPS_INTRADAY][PROVIDERS][RAPIDS]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[COMPUTE]` | Set to `True` to extract `FITBIT_STEPS_INTRADAY` features from the `RAPIDS` provider| +|`[FEATURES]` | Features to be computed from steps intraday data, see table below | +|`[THRESHOLD_ACTIVE_BOUT]` | Every minute with Fitbit steps data wil be labelled as `sedentary` if its step count is below this threshold, otherwise, `active`. | +|`[INCLUDE_ZERO_STEP_ROWS]` | Whether or not to include day segments with a 0 step count during the whole day. | + + +Features description for `[FITBIT_STEPS_INTRADAY][PROVIDERS][RAPIDS]`: + +|Feature |Units |Description | +|-------------------------- |-------------- |-------------------------------------------------------------| +|sumsteps |steps |The total step count during a day segment. +|maxsteps |steps |The maximum step count during a day segment. +|minsteps |steps |The minimum step count during a day segment. +|avgsteps |steps |The average step count during a day segment. +|stdsteps |steps |The standard deviation of step count during a day segment. +|countepisodesedentarybout |bouts |Number of sedentary bouts during a day segment. +|sumdurationsedentarybout |minutes |Total duration of all sedentary bouts during a day segment. +|maxdurationsedentarybout |minutes |The maximum duration of any sedentary bout during a day segment. +|mindurationsedentarybout |minutes |The minimum duration of any sedentary bout during a day segment. +|avgdurationsedentarybout |minutes |The average duration of sedentary bouts during a day segment. +|stddurationsedentarybout |minutes |The standard deviation of the duration of sedentary bouts during a day segment. +|countepisodeactivebout |bouts |Number of active bouts during a day segment. +|sumdurationactivebout |minutes |Total duration of all active bouts during a day segment. +|maxdurationactivebout |minutes |The maximum duration of any active bout during a day segment. +|mindurationactivebout |minutes |The minimum duration of any active bout during a day segment. +|avgdurationactivebout |minutes |The average duration of active bouts during a day segment. +|stddurationactivebout |minutes |The standard deviation of the duration of active bouts during a day segment. + +!!! note "Assumptions/Observations" + + 1. _Active and sedentary bouts_. If the step count per minute is smaller than `THRESHOLD_ACTIVE_BOUT` (default value is 10), that minute is labelled as sedentary, otherwise, is labelled as active. Active and sedentary bouts are periods of consecutive minutes labelled as `active` or `sedentary`. + diff --git a/docs/features/fitbit-steps-summary.md b/docs/features/fitbit-steps-summary.md new file mode 100644 index 00000000..b239c2c3 --- /dev/null +++ b/docs/features/fitbit-steps-summary.md @@ -0,0 +1,65 @@ +# Fitbit Steps Summary + +Sensor parameters description for `[FITBIT_STEPS_SUMMARY]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[TABLE]`| Database table name or file path where the steps summary data is stored. Source data type and column format are defined in [Device Data Source Configuration](../../setup/configuration/#device-data-source-configuration). + +Column format could be `JSON` or `PLAIN_TEXT`. Data with `JSON` column format is obtained from Fitbit API directly. Summary data and intraday data come together in `JSON` format. Each row doesn't have to contain the data for a single day as it depends on the way Fitbit API is queried. Examples of the source data with two formats are as follows. Data with `JSON` format is chunked. + +??? example "Example of the structure of source data" + + === "JSON" + + |device_id |fitbit_data | + |---------------------------------------- |--------------------------------------------------------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-07","value":"1775"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":5},{"time":"00:01:00","value":3},{"time":"00:02:00","value":0},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-08","value":"3201"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":14},{"time":"00:01:00","value":11},{"time":"00:02:00","value":10},...],"datasetInterval":1,"datasetType":"minute"}} + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |"activities-steps":[{"dateTime":"2020-10-09","value":"998"}],"activities-steps-intraday":{"dataset":[{"time":"00:00:00","value":0},{"time":"00:01:00","value":0},{"time":"00:02:00","value":0},...],"datasetInterval":1,"datasetType":"minute"}} + + === "PLAIN_TEXT" + + |device_id |local_date_time |steps | + |-------------------------------------- |---------------------- |--------- | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-07 |1775 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-08 |3201 | + |a748ee1a-1d0b-4ae9-9074-279a2b6ba524 |2020-10-09 |998 | + + +## RAPIDS provider + +!!! info "Available day segments" + - Only available for segments that span 1 or more complete days (e.g. Jan 1st 00:00 to Jan 3rd 23:59) + +!!! info "File Sequence" + ```bash + - data/raw/{pid}/fitbit_steps_summary_raw.csv + - data/raw/{pid}/fitbit_steps_summary_parsed.csv + - data/raw/{pid}/fitbit_steps_summary_parsed_with_datetime.csv + - data/interim/{pid}/fitbit_steps_summary_features/fitbit_steps_summary_{language}_{provider_key}.csv + - data/processed/features/{pid}/fitbit_steps_summary.csv + ``` + + +Parameters description for `[FITBIT_STEPS_SUMMARY][PROVIDERS][RAPIDS]`: + +|Key                              | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------- +|`[COMPUTE]` | Set to `True` to extract `FITBIT_STEPS_SUMMARY` features from the `RAPIDS` provider| +|`[FEATURES]` | Features to be computed from steps summary data, see table below | + + +Features description for `[FITBIT_STEPS_SUMMARY][PROVIDERS][RAPIDS]`: + +|Feature |Units |Description | +|-------------------------- |---------- |-------------------------------------------- | +|maxsumsteps |steps |The maximum daily step count during a day segment. +|minsumsteps |steps |The minimum daily step count during a day segment. +|avgsumsteps |steps |The average daily step count during a day segment. +|mediansumsteps |steps |The median of daily step count during a day segment. +|stdsumsteps |steps |The standard deviation of daily step count during a day segment. + +!!! note "Assumptions/Observations" + + NA diff --git a/docs/setup/configuration.md b/docs/setup/configuration.md index 7f5dcca9..afbbf249 100644 --- a/docs/setup/configuration.md +++ b/docs/setup/configuration.md @@ -337,6 +337,7 @@ DEVICE_DATA: FITBIT: SOURCE: TYPE: DATABASE # DATABASE or FILES (set each FITBIT_SENSOR TABLE attribute accordingly with a table name or a file path) + COLUMN_FORMAT: JSON # JSON or PLAIN_TEXT DATABASE_GROUP: *database_group DEVICE_ID_COLUMN: fitbit_id # column name TIMEZONE: @@ -360,6 +361,7 @@ DEVICE_DATA: | Key | Description | |------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `[SOURCE]` `[TYPE]` | `DATABASE` or `FILES` (set each `[FITBIT_SENSOR]` `[TABLE]` attribute accordingly with a table name or a file path) | +| `[SOURCE]` `[COLUMN_FORMAT]` | `JSON` or `PLAIN_TEXT`. Column format of the source data. | | `[SOURCE]` `[DATABASE_GROUP]` | `*database_group` points to the value defined before in [Database credentials](#database-credentials). Only used if `[TYPE]` is `DATABASE` . | | `[SOURCE]` `[DEVICE_ID_COLUMN]` | The column that has strings that uniquely identify Fitbit devices. | | `[TIMEZONE]` `[TYPE]` | Only `SINGLE` is supported (Fitbit devices always store data in local time). | diff --git a/mkdocs.yml b/mkdocs.yml index 25cb8782..157e3a3b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -93,6 +93,11 @@ nav: - Phone Screen: features/phone-screen.md - Phone WiFI Connected: features/phone-wifi-connected.md - Phone WiFI Visible: features/phone-wifi-visible.md + - Fitbit: + - Fitbit Heart Rate Summary: features/fitbit-heartrate-summary.md + - Fitbit Heart Rate Intraday: features/fitbit-heartrate-intraday.md + - Fitbit Steps Summary: features/fitbit-steps-summary.md + - Fitbit Steps Intraday: features/fitbit-steps-intraday.md - Add New Features: features/add-new-features.md - Developers: - Remote Support: developers/remote-support.md