Merge pull request #355 from RADAR-base/release-0.8.5

Release 0.8.5

commons/connector/oura/oura_activity_class.avsc

@@ -0,0 +1,14 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraActivityClass",
+  "type": "record",
+  "doc": "Oura Activity class in 5-minute intervals as defined in https://cloud.ouraring.com/v2/docs#operation/Single_daily_activity_Document_v2_usercollection_daily_activity__document_id__get.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the activity in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura activity record the activity class data is taken from.", "default": null},
+    {"name": "type", "type":
+      {"name": "OuraActivityClassType", "type": "enum", "symbols": ["NON_WEAR", "REST", "INACTIVE", "LOW_ACTIVITY", "MEDIUM_ACTIVITY", "HIGH_ACTIVITY", "UNKNOWN"], "doc": "Activity class type as computed by Oura."},
+      "doc": "Activity classification at a 5-minute interval. UNKNOWN when this data is not provided.", "default": "UNKNOWN" }
+  ]
+}

commons/connector/oura/oura_daily_activity.avsc

@@ -0,0 +1,38 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraDailyActivity",
+  "type": "record",
+  "doc": "The Daily Activity scope includes daily activity summary values and detailed activity levels. Activity levels are expressed in metabolic equivalent of task minutes (MET mins). Oura tracks activity based on the movement.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the activity in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the activity from Oura.", "default": null},    
+    {"name": "score", "type": ["null", "int"], "doc": "Activity score in range [1, 100]. Null if unknown.", "default": null},
+    {"name": "activeCalories", "type": ["null", "int"], "doc": "Active calories expended (in kilocalories). Null if unknown.", "default": null},
+    {"name": "averageMetMinutes", "type": ["null", "float"], "doc": "Average metabolic equivalent (MET) in minutes. Null if unknown.", "default": null},
+    {"name": "contributorMeetDailyTargets", "type": ["null", "int"], "doc": "Contribution of meeting previous 7-day daily activity targets in range [1, 100] to the activity score. Null if unknown.", "default": null},    
+    {"name": "contributorMoveEveryHour", "type": ["null", "int"], "doc": "Contribution of previous 24-hour inactivity alerts in range [1, 100] to the activity score. Null if unknown.", "default": null},
+    {"name": "contributorRecoveryTime", "type": ["null", "int"], "doc": "Contribution of previous 7-day recovery time in range [1, 100] to the activity score. Null if unknown.", "default": null},
+    {"name": "contributorStayActive", "type": ["null", "int"], "doc": "Contribution of previous 24-hour activity in range [1, 100] to the activity score. Null if unknown.", "default": null},
+    {"name": "contributorTrainingFrequency", "type": ["null", "int"], "doc": "Contribution of previous 7-day exercise frequency in range [1, 100] to the activity score. Null if unknown.", "default": null},
+    {"name": "contributorTrainingVolume", "type": ["null", "int"], "doc": "Contribution of previous 7-day exercise volume in range [1, 100] to the activity score. Null if unknown.", "default": null},
+    {"name": "equivalentWalkingDistance", "type": ["null", "int"], "doc": "Equivalent walking distance (in meters) of energy expenditure. Null if unknown.", "default": null},
+    {"name": "highActivityMetMinutes", "type": ["null", "int"], "doc": "High activity metabolic equivalent (MET) in minutes. Null if unknown.", "default": null},
+    {"name": "highActivityTime", "type": ["null", "int"], "doc": "High activity metabolic equivalent (MET) in seconds. Null if unknown.", "default": null},
+    {"name": "inactivityAlerts", "type": ["null", "int"], "doc": "Number of inactivity alerts received. Null if unknown.", "default": null},
+    {"name": "lowActivityMetMinutes", "type": ["null", "int"], "doc": "Low activity metabolic equivalent (MET) in minutes. Null if unknown.", "default": null},
+    {"name": "lowActivityTime", "type": ["null", "int"], "doc": "Low activity metabolic equivalent (MET) in seconds. Null if unknown.", "default": null},
+    {"name": "mediumActivityMetMinutes", "type": ["null", "int"], "doc": "Medium activity metabolic equivalent (MET) in minutes. Null if unknown.", "default": null},
+    {"name": "mediumActivityTime", "type": ["null", "int"], "doc": "Medium activity metabolic equivalent (MET) in seconds. Null if unknown.", "default": null},    
+    {"name": "metersToTarget", "type": ["null", "int"], "doc": "Remaining meters to target. Null if unknown.", "default": null},
+    {"name": "nonWearTime", "type": ["null", "int"], "doc": "The time (in seconds) in which the ring was not worn. Null if unknown.", "default": null},
+    {"name": "restingTime", "type": ["null", "int"], "doc": "Resting time (in seconds). Null if unknown.", "default": null},
+    {"name": "sedentaryMetMinutes", "type": ["null", "int"], "doc": "Sedentary metabolic equivalent (MET) in minutes. Null if unknown.", "default": null},
+    {"name": "sedentaryTime", "type": ["null", "int"], "doc": "Sedentary metabolic equivalent (MET) in seconds. Null if unknown.", "default": null},
+    {"name": "steps", "type": ["null", "int"], "doc": "Total number of steps taken. Null if unknown.", "default": null},
+    {"name": "targetCalories", "type": ["null", "int"], "doc": "Daily activity target (in kilocalories). Null if unknown.", "default": null},
+    {"name": "targetMeters", "type": ["null", "int"], "doc": "Daily activity target (in meters). Null if unknown.", "default": null},
+    {"name": "totalCalories", "type": ["null", "int"], "doc": "Total calories expended (in kilocalories). Null if unknown.", "default": null},
+    {"name": "day", "type": ["null", "string"], "doc": "The YYYY-MM-DD formatted local date indicating when the daily activity occurred. Null if unknown.", "default": null}
+  ]
+}

commons/connector/oura/oura_daily_readiness.avsc

@@ -0,0 +1,23 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraDailyReadiness",
+  "type": "record",
+  "doc": "This includes the daily readiness summary values. Readiness tells how ready you are for the day.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Time the daily readiness record belongs to in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the readiness data from Oura.", "default": null},    
+    {"name": "contributorActivityBalance", "type": ["null", "int"], "doc": "Contribution of cumulative activity balance in range [1, 100] to the readiness score. Null if unknown.", "default": null},    
+    {"name": "contributorBodyTemperature", "type": ["null", "int"], "doc": "Contribution of body temperature in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorHrvBalance", "type": ["null", "int"], "doc": "Contribution of heart rate variability balance in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorPreviousDayActivity", "type": ["null", "int"], "doc": "Contribution of previous day's activity in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorPreviousNight", "type": ["null", "int"], "doc": "Contribution of previous night's sleep in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorRecoveryIndex", "type": ["null", "int"], "doc": "Contribution of previous 7-day exercise volume in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorRestingHeartRate", "type": ["null", "int"], "doc": "Contribution of resting heart rate in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "contributorSleepBalance", "type": ["null", "int"], "doc": "Contribution of sleep balance in range [1, 100] to the readiness score. Null if unknown.", "default": null},
+    {"name": "day", "type": ["null", "string"], "doc": "Day that the daily readiness belongs to. Null if unknown.", "default": null},
+    {"name": "score", "type": ["null", "int"], "doc": "Daily readiness score in range [1, 100]. Null if unknown.", "default": null},
+    {"name": "temperatureDeviation", "type": ["null", "float"], "doc": "Temperature deviation in degrees Celsius. Null if unknown.", "default": null},
+    {"name": "temperatureTrendDeviation", "type": ["null", "float"], "doc": "Temperature trend deviation in degrees Celsius. Null if unknown.", "default": null}
+  ]
+}

commons/connector/oura/oura_daily_sleep.avsc

@@ -0,0 +1,20 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraDailySleep",
+  "type": "record",
+  "doc": "This includes the daily sleep summary values. Sleep period is a nearly continuous, longish period of time spent lying down in bed.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the sleep in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the sleep data from Oura.", "default": null},    
+    {"name": "contributorDeepSleep", "type": ["null", "int"], "doc": "Contribution of deep sleep in range [1, 100] to the sleep score. Null if unknown.", "default": null},    
+    {"name": "contributorEfficiency", "type": ["null", "int"], "doc": "Contribution of sleep efficiency in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "contributorLatency", "type": ["null", "int"], "doc": "Contribution of sleep latency in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "contributorRemSleep", "type": ["null", "int"], "doc": "Contribution of REM sleep in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "contributorRestfulness", "type": ["null", "int"], "doc": "Contribution of sleep restfulness in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "contributorTiming", "type": ["null", "int"], "doc": "Contribution of sleep timing in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "contributorTotalSleep", "type": ["null", "int"], "doc": "Contribution of total sleep in range [1, 100] to the sleep score. Null if unknown.", "default": null},
+    {"name": "day", "type": ["null", "string"], "doc": "Day that the daily sleep belongs to. Null if unknown.", "default": null},
+    {"name": "score", "type": ["null", "int"], "doc": "Daily sleep score in range [1, 100]. Null if unknown.", "default": null}
+  ]
+}

commons/connector/oura/oura_daily_spo2.avsc

@@ -0,0 +1,13 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraDailySpo2",
+  "type": "record",
+  "doc": "This includes the daily blood oxygen saturation (spO2) average. Data only available for Gen 3 rings.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the sleep in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the spO2 data from Oura.", "default": null},
+    {"name": "spo2AveragePercentage", "type": ["null", "float"], "doc": "The average oxygen saturation percentage value over a single day.", "default": null},    
+    {"name": "day", "type": ["null", "string"], "doc": "Day that the daily oxygen saturation data belongs to. Null if unknown.", "default": null}
+  ]
+}

commons/connector/oura/oura_heart_rate.avsc

@@ -0,0 +1,15 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraHeartRate",
+  "type": "record",
+  "doc": "The Heart Rate data scope includes time-series heart rate data throughout the day and night. Heart rate is provided at 5-minute increments.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Timestamp of the heart rate in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura session or sleep record the heart rate data is taken from.", "default": null},
+    {"name": "bpm", "type": ["null", "int"], "doc": "Heart rate in beats per minute.", "default": null},    
+    {"name": "source", "type":
+      {"name": "OuraHeartRateSource", "type": "enum", "symbols": ["AWAKE", "REST", "SLEEP", "SESSION", "LIVE", "WORKOUT", "UNKNOWN"], "doc": "Heart rate source type as computed by Oura."},
+      "doc": "Heart rate source type as computed by Oura. UNKNOWN when this data is not provided (e.g. samples from sleep API).", "default": "UNKNOWN" }
+  ]
+}

commons/connector/oura/oura_heart_rate_variability.avsc

@@ -0,0 +1,12 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraHeartRateVariability",
+  "type": "record",
+  "doc": "This describes the heart rate variability provided by the Oura Ring.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the hrv in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura session or sleep record the hrv data is taken from.", "default": null},
+    {"name": "hrv", "type": ["null", "float"], "doc": "The HRV value in milliseconds.", "default": null}   
+  ]
+}

commons/connector/oura/oura_met.avsc

@@ -0,0 +1,12 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraMet",
+  "type": "record",
+  "doc": "This describes the metabolic equivalent data (MET) during an activity. MET is a common measure used to express the energy expenditure and intensity of different physical activities.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the activity in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura activity record the met data is taken from.", "default": null},
+    {"name": "met", "type": ["null", "float"], "doc": "Activity metabolic equivalent (MET) in seconds.", "default": null}  
+  ]
+}

commons/connector/oura/oura_motion_count.avsc

@@ -0,0 +1,12 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraMotionCount",
+  "type": "record",
+  "doc": "This describes motion count during a session.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the session in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura session the motion count data is taken from.", "default": null},
+    {"name": "motionCount", "type": ["null", "int"], "doc": "Motion count during a session.", "default": null}   
+  ]
+}

commons/connector/oura/oura_personal_info.avsc

@@ -0,0 +1,16 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraPersonalInfo",
+  "type": "record",
+  "doc": "This describes personal information (e.g. age, email, weight, and height) about the user. You can access the id on the personal_info route with any access token (no scopes are required).",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Timestamp of the record."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "ID of the record.", "default": null},
+    {"name": "age", "type": ["null", "int"], "doc": "Age of the user.", "default": null},    
+    {"name": "weight", "type": ["null", "float"], "doc": "Weight of the user.", "default": null},    
+    {"name": "height", "type": ["null", "float"], "doc": "Height of the user.", "default": null},         
+    {"name": "biologicalSex", "type": ["null", "string"], "doc": "Biological sex of the user.", "default": null},      
+    {"name": "email", "type": ["null", "string"], "doc": "Email of the user.", "default": null}    
+  ]
+}

commons/connector/oura/oura_recommended_sleep_time.avsc

@@ -0,0 +1,21 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraRecommendedSleepTime",
+  "type": "record",
+  "doc": "Oura recommendations for the optimal bedtime window that is calculated based on sleep data.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the recomended sleep time period in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the Oura sleep time recommendation.", "default": null},
+    {"name": "day", "type": ["null", "string"], "doc": "Day that the sleep recommendation record belongs to. Null if unknown.", "default": null},
+    {"name": "optimalBedtimeStartOffset", "type": ["null", "int"], "doc": "Recommended optimal bedtime start offset from midnight. Null if unknown.", "default": null},
+    {"name": "optimalBedtimeEndOffset", "type": ["null", "int"], "doc": "Recommended optimal bedtime end offset from midnight. Null if unknown.", "default": null},
+    {"name": "optimalBedtimeTimezoneOffset", "type": ["null", "int"], "doc": "Timezone offset in second from GMT of the day. Null if unknown.", "default": null},
+    {"name": "recommendation", "type":
+      {"name": "OuraSleepRecommendation", "type": "enum", "symbols": ["IMPROVE_EFFICIENCY", "EARLIER_BEDTIME", "LATER_BEDTIME", "EARLIER_WAKE_UP_TIME", "LATER_WAKE_UP_TIME", "FOLLOW_OPTIMAL_BEDTIME", "UNKNOWN"], "doc": "Sleep phase type as computed by Oura."},
+      "doc": "Oura recommendation action type for bedtime.", "default": "UNKNOWN" },
+    {"name": "status", "type":
+      {"name": "OuraSleepStatus", "type": "enum", "symbols": ["NOT_ENOUGH_NIGHTS", "NOT_ENOUGH_RECENT_NIGHTS", "BAD_SLEEP_QUALITY", "ONLY_RECOMMENDED_FOUND", "OPTIMAL_FOUND", "UNKNOWN"], "doc": "Sleep phase type as computed by Oura."},
+      "doc": "Oura sleep time status type. This is used to inform sleep time recommendation.", "default": "UNKNOWN" }
+  ]
+}

commons/connector/oura/oura_rest_mode_period.avsc

@@ -0,0 +1,14 @@
+{
+  "namespace": "org.radarcns.connector.oura",
+  "name": "OuraRestModePeriod",
+  "type": "record",
+  "doc": "The Rest Mode scope includes information about rest mode periods.",
+  "fields": [
+    {"name": "time", "type": "double", "doc": "Start time of the rest mode period in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "endTime", "type": "double", "doc": "End time of the rest mode period in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)."},
+    {"name": "timeReceived", "type": "double", "doc": "Time that this record was collected by a service in seconds since the Unix Epoch (s)."},
+    {"name": "id", "type": ["null", "string"], "doc": "Unique identifier of the rest mode period from Oura.", "default": null},
+    {"name": "startDay", "type": ["null", "string"], "doc": "Start date of the rest mode period. Null if unknown.", "default": null},
+    {"name": "endDay", "type": ["null", "string"], "doc": "End date of the rest mode period. Null if unknown.", "default": null}
+  ]
+}