terra.models.v2.sleep

  1#  Copyright 2022 Terra Enabling Developers Limited
  2#
  3#  Licensed under the Apache License, Version 2.0 (the "License");
  4#  you may not use this file except in compliance with the License.
  5#  You may obtain a copy of the License at
  6#
  7#      http://www.apache.org/licenses/LICENSE-2.0
  8#
  9#  Unless required by applicable law or agreed to in writing, software
 10#  distributed under the License is distributed on an "AS IS" BASIS,
 11#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12#  See the License for the specific language governing permissions and
 13#  limitations under the License.
 14import dataclasses
 15import typing
 16
 17from terra.models import base_model
 18from terra.models.v2 import samples as samples_
 19from terra.models.v2.activity import DeviceData
 20
 21__all__ = [
 22    "Sleep",
 23    "Metadata",
 24    "ReadinessData",
 25    "TemperatureData",
 26    "HeartRateDataSummary",
 27    "HeartRateDataDetailed",
 28    "HeartRateData",
 29    "SleepDurationsAwakeData",
 30    "SleepDurationsAsleepData",
 31    "SleepDurationsOtherData",
 32    "SleepDurationsData",
 33    "OxygenSaturationData",
 34    "BreathsData",
 35    "SnoringData",
 36    "RespirationData",
 37]
 38
 39
 40@dataclasses.dataclass
 41class Metadata(base_model.TerraDataModel):
 42    start_time: typing.Optional[str] = dataclasses.field(default=None)
 43    end_time: typing.Optional[str] = dataclasses.field(default=None)
 44    upload_type: typing.Optional[int] = dataclasses.field(default=None)
 45    is_nap: bool = dataclasses.field(default=False)
 46
 47
 48@dataclasses.dataclass
 49class ReadinessData(base_model.TerraDataModel):
 50    readiness: typing.Optional[float] = dataclasses.field(default=None)
 51    recovery_level: typing.Optional[int] = dataclasses.field(default=None)
 52
 53
 54@dataclasses.dataclass
 55class TemperatureData(base_model.TerraDataModel):
 56    delta: typing.Optional[float] = dataclasses.field(default=None)
 57
 58
 59@dataclasses.dataclass
 60class HeartRateDataSummary(base_model.TerraDataModel):
 61    avg_hr_bpm: typing.Optional[int] = dataclasses.field(default=None)
 62    max_hr_bpm: typing.Optional[int] = dataclasses.field(default=None)
 63    min_hr_bpm: typing.Optional[int] = dataclasses.field(default=None)
 64    avg_hrv_rmssd: typing.Optional[int] = dataclasses.field(default=None)
 65    avg_hrv_sdnn: typing.Optional[int] = dataclasses.field(default=None)
 66    user_max_hr_bpm: typing.Optional[int] = dataclasses.field(default=None)
 67    resting_hr_bpm: typing.Optional[float] = dataclasses.field(default=None)
 68
 69
 70@dataclasses.dataclass
 71class HeartRateDataDetailed(base_model.TerraDataModel):
 72    hr_samples: typing.List[samples_.HeartRateDataSample] = dataclasses.field(default_factory=list)
 73    hrv_samples_rmssd: typing.List[samples_.HeartRateVariabilityDataSampleRMSSD] = dataclasses.field(
 74        default_factory=list
 75    )
 76    hrv_samples_sdnn: typing.List[samples_.HeartRateVariabilityDataSampleSDNN] = dataclasses.field(default_factory=list)
 77
 78
 79@dataclasses.dataclass
 80class HeartRateData(base_model.TerraDataModel):
 81    summary: HeartRateDataSummary = dataclasses.field(default_factory=HeartRateDataSummary)
 82    detailed: HeartRateDataDetailed = dataclasses.field(default_factory=HeartRateDataDetailed)
 83
 84
 85@dataclasses.dataclass
 86class SleepDurationsAwakeData(base_model.TerraDataModel):
 87    sleep_latency_seconds: typing.Optional[float] = dataclasses.field(default=None)
 88    wake_up_latency_seconds: typing.Optional[float] = dataclasses.field(default=None)
 89    duration_awake_state_seconds: typing.Optional[float] = dataclasses.field(default=None)
 90    duration_short_interruption_seconds: typing.Optional[float] = dataclasses.field(default=None)
 91    duration_long_interruption_seconds: typing.Optional[float] = dataclasses.field(default=None)
 92    num_out_of_bed_events: typing.Optional[int] = dataclasses.field(default=None)
 93    num_wakeup_events: typing.Optional[int] = dataclasses.field(default=None)
 94
 95
 96@dataclasses.dataclass
 97class SleepDurationsAsleepData(base_model.TerraDataModel):
 98    duration_asleep_state_seconds: typing.Optional[float] = dataclasses.field(default=None)
 99    duration_deep_sleep_state_seconds: typing.Optional[float] = dataclasses.field(default=None)
100    duration_light_sleep_state_seconds: typing.Optional[float] = dataclasses.field(default=None)
101    duration_REM_sleep_state_seconds: typing.Optional[float] = dataclasses.field(default=None)
102    num_REM_events: typing.Optional[int] = dataclasses.field(default=None)
103
104
105@dataclasses.dataclass
106class SleepDurationsOtherData(base_model.TerraDataModel):
107    duration_unmeasurable_sleep_seconds: typing.Optional[float] = dataclasses.field(default=None)
108    duration_in_bed_seconds: typing.Optional[float] = dataclasses.field(default=None)
109
110
111@dataclasses.dataclass
112class SleepDurationsData(base_model.TerraDataModel):
113    sleep_efficiency: typing.Optional[float] = dataclasses.field(default=None)
114    awake: SleepDurationsAwakeData = dataclasses.field(default_factory=SleepDurationsAwakeData)
115    asleep: SleepDurationsAsleepData = dataclasses.field(default_factory=SleepDurationsAsleepData)
116    other: SleepDurationsOtherData = dataclasses.field(default_factory=SleepDurationsOtherData)
117    hypnogram_samples: typing.List[samples_.SleepHypnogramSample] = dataclasses.field(default_factory=list)
118
119
120@dataclasses.dataclass
121class OxygenSaturationData(base_model.TerraDataModel):
122    start_time: typing.Optional[str] = dataclasses.field(default=None)
123    end_time: typing.Optional[str] = dataclasses.field(default=None)
124    avg_saturation_percentage: typing.Optional[float] = dataclasses.field(default=None)
125    samples: typing.List[samples_.OxygenSaturationSample] = dataclasses.field(default_factory=list)
126
127
128@dataclasses.dataclass
129class BreathsData(base_model.TerraDataModel):
130    start_time: typing.Optional[str] = dataclasses.field(default=None)
131    end_time: typing.Optional[str] = dataclasses.field(default=None)
132    on_demand_reading: typing.Optional[bool] = dataclasses.field(default=None)
133    avg_breaths_per_min: typing.Optional[float] = dataclasses.field(default=None)
134    max_breaths_per_min: typing.Optional[float] = dataclasses.field(default=None)
135    min_breaths_per_min: typing.Optional[float] = dataclasses.field(default=None)
136    samples: typing.List[samples_.BreathSample] = dataclasses.field(default_factory=list)
137
138
139@dataclasses.dataclass
140class SnoringData(base_model.TerraDataModel):
141    start_time: typing.Optional[str] = dataclasses.field(default=None)
142    end_time: typing.Optional[str] = dataclasses.field(default=None)
143    total_snoring_duration_seconds: typing.Optional[float] = dataclasses.field(default=None)
144    num_snoring_events: typing.Optional[int] = dataclasses.field(default=None)
145    samples: typing.List[samples_.SnoringSample] = dataclasses.field(default_factory=list)
146
147
148@dataclasses.dataclass
149class RespirationData(base_model.TerraDataModel):
150    oxygen_saturation_data: OxygenSaturationData = dataclasses.field(default_factory=OxygenSaturationData)
151    breaths_data: BreathsData = dataclasses.field(default_factory=BreathsData)
152    snoring_data: SnoringData = dataclasses.field(default_factory=SnoringData)
153
154
155@dataclasses.dataclass
156class Sleep(base_model.TerraDataModel):
157    metadata: Metadata = dataclasses.field(default_factory=Metadata)
158    temperature_data: TemperatureData = dataclasses.field(default_factory=TemperatureData)
159    readiness_data: ReadinessData = dataclasses.field(default_factory=ReadinessData)
160    heart_rate_data: HeartRateData = dataclasses.field(default_factory=HeartRateData)
161    sleep_durations_data: SleepDurationsData = dataclasses.field(default_factory=SleepDurationsData)
162    respiration_data: RespirationData = dataclasses.field(default_factory=RespirationData)
163    device_data: DeviceData = dataclasses.field(default_factory=DeviceData)