aRMT
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/active/aRMT-1.18.0.yml
| Measurement | Value schema | Kafka / stream | Notes |
|---|---|---|---|
| THINC_IT | Questionnaire | notification_thinc_it | Definition: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/thinc_it/thinc_it_armt.json |
| ROMBERG_TEST | Task | task_romberg_test | The value of the task is in milliseconds (ms). Definition: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/romberg_test/romberg_test_armt.json |
| 2MW_TEST | Task | task_2MW_test | The value of the task is in milliseconds (ms). Definition: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/2MW_test/2MW_test_armt.json |
| TANDEM_WALKING_TEST | Task | task_tandem_walking_test | The value of the task is in milliseconds (ms). Definition: https://github.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/blob/master/questionnaires/tandem_walking_test/tandem_walking_test_armt.json |
| PHQ8 | Questionnaire | questionnaire_phq8 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/phq8/phq8_armt.json |
| ESM | Questionnaire | questionnaire_esm | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/esm/esm_armt.json |
| AUDIO | Questionnaire | questionnaire_audio | A speech questionnaire that contain two parts, a scripted text part where users will record themselves reading a text aloud, and an unscripted text part where users will record themselves answering a question. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio/audio_armt.json |
| AUDIO_2 | Questionnaire | questionnaire_audio | A speech questionnaire that contain two parts, a scripted text part where users will record themselves reading a text aloud, and an unscripted text part where users will record themselves answering a question. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_2/audio_2_armt.json |
| AUDIO_3 | Questionnaire | questionnaire_audio | A speech questionnaire that contain two parts, a scripted text part where users will record themselves reading a text aloud, and an unscripted text part where users will record themselves answering a question. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_3/audio_3_armt.json |
| AUDIO_4 | Questionnaire | questionnaire_audio | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_4/audio_4_armt.json |
| RSES | Questionnaire | questionnaire_rses | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/rses/rses_armt.json |
| PERCEIVED_DEFICITS_QUESTIONNAIRE | Questionnaire | questionnaire_perceived_deficits_questionnaire | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/perceived_deficits_questionnaire/perceived_deficits_questionnaire_armt.json |
| PATIENT_DETERMINED_DISEASE_STEP | Questionnaire | questionnaire_patient_determined_disease_step | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/patient_determined_disease_step/patient_determined_disease_step_armt.json |
| ESM28Q | Questionnaire | questionnaire_esm28q | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/esm28q/esm28q_armt.json |
| BIPQ | Questionnaire | questionnaire_bipq | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/bipq/bipq_armt.json |
| ESM_EPI_MOD_1 | Questionnaire | questionnaire_esm_epi_mod_1 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/esm_epi_mod_1/esm_epi_mod_1_armt.json |
| EVENING_ASSESSMENT | Questionnaire | questionnaire_evening_assessment | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/evening_assessment/evening_assessment_armt.json |
| MORNING_ASSESSMENT | Questionnaire | questionnaire_morning_assessment | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/morning_assessment/morning_assessment_armt.json |
| TAM | Questionnaire | questionnaire_tam | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/tam/tam_armt.json |
| BAARS_IV | Questionnaire | questionnaire_baars_iv | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/baars_iv/baars_iv_armt.json |
| ARI_SELF | Questionnaire | questionnaire_ari_self | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/ari_self/ari_self_armt.json |
| GAD7 | Questionnaire | questionnaire_gad7 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/gad7/gad7_armt.json |
| RPQ | Questionnaire | questionnaire_rpq | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/rpq/rpq_armt.json |
| ART_COGNITIVE_TEST | Questionnaire | questionnaire_art_cognitive_test | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/art_cognitive_test/art_cognitive_test_armt.json |
| COVID19_DIAGNOSIS | Questionnaire | questionnaire_covid19_diagnosis | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/covid19_diagnosis/covid19_diagnosis_armt.json |
| COVID19_SYMPTOMS | Questionnaire | questionnaire_covid19_symptoms | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/covid19_symptoms/covid19_symptoms_armt.json |
| CNS_COVID19_BASELINE | Questionnaire | questionnaire_cns_covid19_baseline | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/cns_covid19_baseline/cns_covid19_baseline_armt.json |
| CNS_COVID19_FOLLOWUP | Questionnaire | questionnaire_cns_covid19_followup | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/cns_covid19_followup/cns_covid19_followup_armt.json |
| CNS_COVID19_FOLLOWUP_V2 | Questionnaire | questionnaire_cns_covid19_followup_v2 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/cns_covid19_followup_v2/cns_covid19_followup_v2_armt.json |
| CNS_COVID19_FOLLOWUP_V3 | Questionnaire | questionnaire_cns_covid19_followup_v3 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/cns_covid19_followup_v3/cns_covid19_followup_v3_armt.json |
| ART_COVID19_FOLLOWUP | Questionnaire | questionnaire_art_covid19_followup | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/art_covid19_followup/art_covid19_followup_armt.json |
| ADHD_MEDICATION_USE | Questionnaire | questionnaire_adhd_medication_use | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/adhd_medication_use/adhd_medication_use_armt.json |
| QIDS | Questionnaire | questionnaire_qids | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/qids/qids_armt.json |
| WSAS | Questionnaire | questionnaire_wsas | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/wsas/wsas_armt.json |
| SLEEP_QUESTIONS | Questionnaire | questionnaire_rapid_sleep_questions | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/sleep_questions/sleep_questions_armt.json |
| AUDIO_WITHOUT_UNSCRIPTED | Questionnaire | questionnaire_audio_without_unscripted | A speech questionnaire similar to the AUDIO questionnaire but without the second unscripted task. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_without_unscripted/audio_without_unscripted_armt.json |
| AUDIO_WITHOUT_UNSCRIPTED_2 | Questionnaire | questionnaire_audio_without_unscripted_2 | A speech questionnaire similar to the AUDIO questionnaire but without the second unscripted task. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_without_unscripted_2/audio_without_unscripted_armt.json |
| AUDIO_WITHOUT_UNSCRIPTED_3 | Questionnaire | questionnaire_audio_without_unscripted_3 | A speech questionnaire similar to the AUDIO questionnaire but without the second unscripted task. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_without_unscripted_3/audio_without_unscripted_armt.json |
| CAT | Questionnaire | questionnaire_cat | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/cat/cat_armt.json |
| PSQI | Questionnaire | questionnaire_psqi | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/psqi/psqi_armt.json |
| FSS | Questionnaire | questionnaire_fss | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/fss/fss_armt.json |
| PCFS | Questionnaire | questionnaire_pcfs | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/pcfs/pcfs_armt.json |
| RALPMH_COVID_SYMPTOMS | Questionnaire | questionnaire_ralpmh_covid_symptoms | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/ralpmh_covid_symptoms/ralpmh_covid_symptoms_armt.json |
| LIPF | Questionnaire | questionnaire_lipf | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/lipf/lipf_armt.json |
| ERS | Questionnaire | questionnaire_ers | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/ers/ers_armt.json |
| VAS | Questionnaire | questionnaire_vas | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/vas/vas_armt.json |
| PULSE_OX | Questionnaire | questionnaire_pulse_ox | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/pulse_ox/pulse_ox_armt.json |
| AUDIO_WITHOUT_UNSCRIPTED_4 | Questionnaire | questionnaire_audio_without_unscripted_4 | A speech questionnaire that contains `The North Wind` scripted text where users will record themselves reading a text aloud. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_without_unscripted_4/audio_without_unscripted_4_armt.json |
| AUDIO_COUNT | Questionnaire | questionnaire_audio_count | A speech questionnaire where users will record themselves count from 1 to 20 aloud. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_count/audio_count_armt.json |
| AUDIO_VOCALISATION | Questionnaire | questionnaire_audio_vocalisation | A speech questionnaire where users will record themselves speak the vowels displayed on the screen aloud. Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audio_vocalisation/audio_vocalisation_armt.json |
| EXACERBATION_DIARY | Questionnaire | questionnaire_exacerbation_diary | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/exacerbation_diary/exacerbation_diary_armt.json |
| NUVOAIR_SPIROMETRY | Questionnaire | notification_nuvoair_spirometry | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/nuvoair_spirometry/nuvoair_spirometry_armt.json |
| K_BUILD_PRIVATE | Questionnaire | questionnaire_k_build_private | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions-Private/master/questionnaires/k_build_private/k_build_private_armt.json |
| EPI_SEIZURE_DIARY | Questionnaire | questionnaire_epi_seizure_diary | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/epi_seizure_diary/epi_seizure_diary_armt.json |
| EPI_EVENING_QUESTIONNAIRE | Questionnaire | questionnaire_epi_evening_questionnaire | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/epi_evening_questionnaire/epi_evening_questionnaire_armt.json |
| EPI_WSAS | Questionnaire | questionnaire_epi_wsas | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/epi_wsas/epi_wsas_armt.json |
| BP | Questionnaire | questionnaire_bp | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/bp/bp_armt.json |
| HLH | Questionnaire | questionnaire_hlh | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/hlh/hlh_armt.json |
| TECHNOLOGY_USAGE | Questionnaire | questionnaire_technology_usage | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/technology_usage/technology_usage_armt.json |
| REGULAR_ACTIVITIES | Questionnaire | questionnaire_regular_activities | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/regular_activities/regular_activities_armt.json |
| NONREGULAR_ACTIVITIES | Questionnaire | questionnaire_nonregular_activities | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/nonregular_activities/nonregular_activities_armt.json |
| AUTISM_SYMPTOMS | Questionnaire | questionnaire_autism_symptoms | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/autism_symptoms/autism_symptoms_armt.json |
| SLEEP_QUALITY_INFO | Questionnaire | questionnaire_sleep_quality | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/sleep_quality_info/sleep_quality_info_armt.json |
| SLEEP_QUALITY | Questionnaire | questionnaire_sleep_quality | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/sleep_quality/sleep_quality_armt.json |
| ADHD_SYMPTOMS | Questionnaire | questionnaire_adhd_symptoms | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/adhd_symptoms/adhd_symptoms_armt.json |
| USER_FEEDBACK | Questionnaire | questionnaire_user_feedback | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/user_feedback/user_feedback_armt.json |
| PROGRESS_REPORT_1 | Questionnaire | questionnaire_progress_report | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/progress_report_1/progress_report_1_armt.json |
| PROGRESS_REPORT_2 | Questionnaire | questionnaire_progress_report | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/progress_report_2/progress_report_2_armt.json |
| PROGRESS_REPORT_3 | Questionnaire | questionnaire_progress_report | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/progress_report_3/progress_report_3_armt.json |
| PROGRESS_REPORT_4 | Questionnaire | questionnaire_progress_report | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/progress_report_4/progress_report_4_armt.json |
| ADHD_PHQ8 | Questionnaire | questionnaire_adhd_phq8 | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/adhd_phq8/adhd_phq8_armt.json |
| RPQ_A | Questionnaire | questionnaire_rpq_a | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/rpq_a/rpq_a_armt.json |
| ADHD_MEDICATION_USE_DAILY | Questionnaire | questionnaire_adhd_medication_use_daily | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/adhd_medication_daily/adhd_medication_daily_armt.json |
| ADHD_MEDICATION_SIDE_EFFECTS | Questionnaire | questionnaire_adhd_medication_side_effects | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/adhd_medication_side_effects/adhd_medication_side_effects_armt.json |
| FND | Questionnaire | questionnaire_fnd | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/fnd/fnd_armt.json |
| AUDIT | Questionnaire | questionnaire_audit | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/audit/audit_armt.json |
| LTE | Questionnaire | questionnaire_lte | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/lte/lte_armt.json |
| MEDITERRANEAN_DIET_ADHERENCE | Questionnaire | questionnaire_mediterranean_diet_adherence | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/mediterranean_diet_adherence/mediterranean_diet_adherence_armt.json |
| WEIGHT_AND_WAIST_CIRCUMFERENCE | Questionnaire | questionnaire_weight_and_waist_circumference | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/weight_and_waist_circumference/weight_and_waist_circumference_armt.json |
| BLOOD_PRESSURE_MEASUREMENT | Questionnaire | questionnaire_blood_pressure_measurement | Definition: https://raw.githubusercontent.com/RADAR-base/RADAR-REDCap-aRMT-Definitions/master/questionnaires/blood_pressure_measurement/blood_pressure_measurement_armt.json |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
answers | array<Answer> | Answers list. The answers order must follow the questions order. · Answers list. The answers order must follow the task order. |
name | string | Questionnaire names. · Task names. |
timeCompleted | double | Timestamp in UTC (s) when subject marks the task as complete. · Timestamp in UTC (s) when the questionnaire is completed by the subject. |
timeNotification | null | double | Timestamp in UTC (s) when the notification to complete the questionnaire is sent. |
version | string | It reports the questionnaire version stated in the JSON specification. · It reports the task version stated in the JSON specification. |
Apple Health
Apple Health (HealthKit) samples and topics; value payloads use the shared schema below.
Data from the Apple Health app (HealthKit) is published using a single Avro value type HealthKitTypedData; each row below is a distinct sample category (Kafka topic). Values use the appropriate typed slots in that record (e.g. doubleValue, floatValue, stringValue) depending on the HealthKit quantity or category type.
HealthKit-aligned types covered in this catalog:
- Steps — A quantity sample type that measures the number of steps the user has taken, unit is count.
- Stairs — A quantity sample type that measures the number flights of stairs that the user has climbed, unit is count.
- Distance — A quantity sample type that measures the distance the user has moved by walking, running or cycling, unit is m.
- Exercise Time — A quantity sample type that measures the amount of time the user spent exercising, unit is min.
- Calories — A quantity sample type that measures the amount of active and basal energy the user has burned, unit is kcal.
- Activity — A workout sample that stores information about a single physical activity, unit is activityType.
- Sleep Stage — A category sample type describing the user's sleep stage, unit is sleepType.
- Heart Rate — A quantity sample type that measures the user’s heart rate, unit is count/min.
- Resp Rate — A quantity sample type that measures the user’s respiratory rate, unit is count/min.
- Oxygen Saturation — A quantity sample type that measures the user’s oxygen saturation, unit is %.
- Vo2Max — A quantity sample that measures the maximal oxygen consumption during exercise, unit is ml/(kg * min).
- Temperature — A quantity sample type that measures the user’s body temperature, unit is Celsius.
- Fat Percentage — A quantity sample type that measures the user’s body fat percentage, unit is %.
- Waist Circumference — A quantity sample type that measures the user’s waist circumference, unit is m.
- Blood Glucose — A quantity sample type that measures the user’s blood glucose level, unit is mmol/L.
- Insulin — A quantity sample that measures the amount of insulin delivered, unit is IU.
- Blood Pressure — A correlation sample that combines a systolic sample and a diastolic sample into a single blood pressure reading, unit is mmHg.
- Gender — A characteristic type identifier for the user’s sex.
- Date Of Birth — A characteristic type identifier for the user’s date of birth.
- Mindfulness — A category sample type for recording a mindful session, unit is sec.
- Nutrition — A quantity sample type that shows the user's nutrition data, unit varies across types.
- Uv Exposure — A quantity sample type that measures the user’s exposure to UV radiation, unit is count.
- Height — A quantity sample type that measures the user’s height, unit is m.
- Weight — A quantity sample type that measures the user’s weight, unit is kg.
- Bmi — A quantity sample type that measures the user’s body mass index, unit is count.
Specifications: specifications/active/aRMT-healthkit-1.0.0.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
HealthKitTypedData | active_apple_healthkit_steps | A quantity sample type that measures the number of steps the user has taken, unit is count. |
HealthKitTypedData | active_apple_healthkit_stairs | A quantity sample type that measures the number flights of stairs that the user has climbed, unit is count. |
HealthKitTypedData | active_apple_healthkit_distance | A quantity sample type that measures the distance the user has moved by walking, running or cycling, unit is m. |
HealthKitTypedData | active_apple_healthkit_exercise_time | A quantity sample type that measures the amount of time the user spent exercising, unit is min. |
HealthKitTypedData | active_apple_healthkit_calories | A quantity sample type that measures the amount of active and basal energy the user has burned, unit is kcal. |
HealthKitTypedData | active_apple_healthkit_activity | A workout sample that stores information about a single physical activity, unit is activityType. |
HealthKitTypedData | active_apple_healthkit_sleep_stage | A category sample type describing the user's sleep stage, unit is sleepType. |
HealthKitTypedData | active_apple_healthkit_heart_rate | A quantity sample type that measures the user’s heart rate, unit is count/min. |
HealthKitTypedData | active_apple_healthkit_resp_rate | A quantity sample type that measures the user’s respiratory rate, unit is count/min. |
HealthKitTypedData | active_apple_healthkit_oxygen_saturation | A quantity sample type that measures the user’s oxygen saturation, unit is %. |
HealthKitTypedData | active_apple_healthkit_vo2max | A quantity sample that measures the maximal oxygen consumption during exercise, unit is ml/(kg * min). |
HealthKitTypedData | active_apple_healthkit_temperature | A quantity sample type that measures the user’s body temperature, unit is Celsius. |
HealthKitTypedData | active_apple_healthkit_fat_percentage | A quantity sample type that measures the user’s body fat percentage, unit is %. |
HealthKitTypedData | active_apple_healthkit_waist_circumference | A quantity sample type that measures the user’s waist circumference, unit is m. |
HealthKitTypedData | active_apple_healthkit_blood_glucose | A quantity sample type that measures the user’s blood glucose level, unit is mmol/L. |
HealthKitTypedData | active_apple_healthkit_insulin | A quantity sample that measures the amount of insulin delivered, unit is IU. |
HealthKitTypedData | active_apple_healthkit_blood_pressure | A correlation sample that combines a systolic sample and a diastolic sample into a single blood pressure reading, unit is mmHg. |
HealthKitTypedData | active_apple_healthkit_gender | A characteristic type identifier for the user’s sex. |
HealthKitTypedData | active_apple_healthkit_date_of_birth | A characteristic type identifier for the user’s date of birth. |
HealthKitTypedData | active_apple_healthkit_mindfulness | A category sample type for recording a mindful session, unit is sec. |
HealthKitTypedData | active_apple_healthkit_nutrition | A quantity sample type that shows the user's nutrition data, unit varies across types. |
HealthKitTypedData | active_apple_healthkit_uv_exposure | A quantity sample type that measures the user’s exposure to UV radiation, unit is count. |
HealthKitTypedData | active_apple_healthkit_height | A quantity sample type that measures the user’s height, unit is m. |
HealthKitTypedData | active_apple_healthkit_weight | A quantity sample type that measures the user’s weight, unit is kg. |
HealthKitTypedData | active_apple_healthkit_bmi | A quantity sample type that measures the user’s body mass index, unit is count. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
doubleValue | null | double | Value of the double data retrieved. |
endTime | double | End time of this activity period in UTC (s). |
floatValue | null | float | Value of the float data retrieved. |
intValue | null | int | Value of the int data retrieved. |
key | string | Type of data retrived e.g. weight, height, etc. |
sourceId | string | The identifier of the app that produced the data. |
sourceName | string | The name of the app that produced the data (as it appears to the user). |
stringValue | null | string | Value of the string data retrieved. |
unit | string | The unit of the measurement. |
Android Phone
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/monitor/radar_prmt-v1.yml, specifications/passive/android_phone-1.0.0.yml, specifications/passive/android_phone-v1.yml, specifications/stream/android_phone.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing | Notes |
|---|---|---|---|---|---|---|
| EXTERNAL_TIME | ApplicationExternalTime | application_external_time | every 300 s, user-configurable | SECOND | — | Information sent by the Android pRMT about time synchronisation with a NTS different from the default one. |
| RECORD_COUNTS | ApplicationRecordCounts | application_record_counts | every 300 s, user-configurable | — | — | Monitor used by the Android pRMT to report the number of cached and created records. |
| SERVER_STATUS | ApplicationServerStatus | application_server_status | every 300 s, user-configurable | — | — | Monitor used by the Android pRMT to report the server connection status between the android client and the RADAR-CNS Platform. |
| UPTIME | ApplicationUptime | application_uptime | every 300 s, user-configurable | SECOND | — | Monitor used by the Android pRMT to notify the time duration since last reboot. |
| ACCELEROMETER | PhoneAcceleration | android_phone_acceleration | 5 Hz, user-configurable | G | RAW | — |
| BATTERY | PhoneBatteryLevel | android_phone_battery_level | dynamic rate | PERCENTAGE | RAW | — |
| GYROSCOPE | PhoneGyroscope | android_phone_gyroscope | 5 Hz, user-configurable | RADAIAN_PER_SEC | RAW | — |
| LIGHT | PhoneLight | android_phone_light | 5 Hz, user-configurable | LUX | RAW | — |
| MAGNETIC_FIELD | PhoneMagneticField | android_phone_magnetic_field | 5 Hz, user-configurable | MICRO_TESLA | RAW | — |
| STEP_COUNT | PhoneStepCount | android_phone_step_count | 5 Hz, dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| RELATIVE_LOCATION | PhoneRelativeLocation | android_phone_relative_location | every 600 s, dynamic rate, user-configurable | DEGREE | RAW | — |
| PHONE_CALL | PhoneCall | android_phone_call | every 86400 s, user-configurable | — | RAW | — |
| PHONE_SMS | PhoneSms | android_phone_sms | every 86400 s, user-configurable | NON_DIMENSIONAL | RAW | — |
| PHONE_SMS_UNREAD | PhoneSmsUnread | android_phone_sms_unread | every 86400 s, user-configurable | NON_DIMENSIONAL | RAW | — |
| PHONE_CONTACTS | PhoneContactList | android_phone_contacts | every 86400 s, user-configurable | NON_DIMENSIONAL | RAW | — |
| PHONE_BLUETOOTH_DEVICES | PhoneBluetoothDevices | android_phone_bluetooth_devices | every 3600 s, user-configurable | NON_DIMENSIONAL | RAW | — |
| PHONE_BLUETOOTH_DEVICE_SCANNED | PhoneBluetoothDeviceScanned | android_phone_bluetooth_device_scanned | — | NON_DIMENSIONAL | RAW | — |
| USAGE_EVENT | PhoneUsageEvent | android_phone_usage_event | dynamic rate | — | RAW | — |
| USER_INTERACTION | PhoneUserInteraction | android_phone_user_interaction | dynamic rate | NON_DIMENSIONAL | RAW | — |
| Stream master | PhoneStreamMaster | ANDROID_PHONE | — | — | — | Aggregation of Phone data |
| — | AggregateList | in: android_phone_acceleration · windowed: True | — | — | — | — |
| — | PhoneUsageEvent | in: android_phone_usage_event · windowed: False | — | — | — | — |
| — | PhoneUsageAggregate | android_phone_usage_event_aggregated · in: android_phone_usage_event_output · windowed: False | — | — | — | — |
| — | NumericAggregate | in: android_phone_battery_level · windowed: True | — | — | — | — |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
accuracy | null | float | The estimated horizontal accuracy of this location, radial (m). We define horizontal accuracy as the radius of 68% confidence. In other words, if you draw a circle centered at this location's latitude and longitude, and with a radius equal to the accuracy, then there is a 68% probability that the true location is inside the circle. |
altitude | null | float | Height above the WGS 84 reference ellipsoid (m). |
batteryLevel | float | Battery level from 0 to 1. |
bearing | null | float | The horizontal direction of travel of this device (degrees with range (0, 360]). |
bluetoothEnabled | boolean | Whether Bluetooth is enabled. |
categoryName | null | string | App category as given by the play store, null if a category is not listed or unable to be fetched. |
categoryNameFetchTime | null | double | Timestamp in UTC when the category was attempted to fetch from the play store (s), null if not fetched. |
contacts | int | Current number of contacts in the list of contacts. |
contactsAdded | null | int | Number of new contacts added to the list of contacts since the previous measurement that was sent. The value is null if this is the first measurement or if the previous measurement is unknown to the sender. |
contactsRemoved | null | int | Number of new contacts removed from the list of contacts since the previous measurement that was sent. The value is null if this is the first measurement or if the previous measurement is unknown to the sender. |
count | int | Count the accumulated values. |
delay | null | double | Delay between sending and receiving a message from the host (s). The lower this delay, the more precise the external timestamp is expected to be. |
duration | null | float | Duration of the call (s). |
durationInForeground | double | Total time in milliseconds the app was in the foreground. |
eventType | UsageEventType | Android app usage event types where an event represents a state change for component/app. |
externalTime | double | Timestamp in UTC according to an external source (s). |
fields | array<NumericAggregate> | Aggregates of each of the underlying elements. |
hashSaltReference | null | int | This field has been deprecated. Random identifier associated with the device or installation of the app. If the app gets reinstalled or installed on another device, it's clear during analysis that the mac addresses between iterations are not comparable. |
host | null | string | Hostname or IP address that time was polled from. |
interactionState | PhoneInteractionState | What interaction state the phone has. |
ipAddress | null | string | Hardware identifier of client application. |
isPaired | null | boolean | Whether the bluetooth device is paired. This has been deprecated in favor of pairedState in newer versions. |
isPlugged | boolean | Whether the phone is connected to a power source. |
latitude | null | double | Relative latitude from an initial random reference latitude (degrees with range [-90, 90]). |
length | null | int | Number of characters in the message (null if unknown). |
light | float | Illuminance (lx). |
longitude | null | double | Relative longitude from an initial reference longitude (degrees with range [-180, 180]). |
macAddressHash | null | bytes | Hash of Nearby Bluetooth device MAC address. |
max | double | State the maximum between accumulated values. |
mean | null | double | State the arithmetic mean between accumulated values. |
min | double | State the minimum between accumulated values. |
name | string | Name of the field that has been aggregated over. |
nearbyDevices | null | int | Number of nearby devices. |
offsetReference | null | int | Arbitrary reference to the offset. As long as the offset remains equal, so does this reference. If this reference is 0, no offset is used and the contained latitude and longitude can be considered absolute. If this is null, the location is relative to an offset but the offset is unknown: it may vary between different measurements with null reference. Offset references cannot be compared between users. |
packageName | string | Package name of the app in use. · Package name of the launched app. |
pairedDevices | null | int | Number of paired devices. |
pairedState | null | PairedState | Indicates the current paired status of the remote device. |
protocol | ExternalTimeProtocol | Protocol for external time synchronization. |
provider | LocationProvider | Android provider of the location data. |
quartile | null | array<double> | Quartile of accumulated values. |
recordsCached | null | long | Number of records currently being cached. |
recordsSent | long | Number of records sent since application start. |
recordsUnsent | null | int | Number of unsent records. |
serverStatus | ServerStatus | Application server connection status. |
speed | null | float | Speed over ground (m/s). |
status | BatteryStatus | Android battery states. |
steps | int | Number of steps taken between this and the previous record. |
sum | double | State the sum of accumulated values. |
target | null | bytes | HMAC SHA-256 one-way source/target of the SMS. This hash of a given phone number will be the same unless the app is reinstalled. If the number is unknown or anonymous, this contains null. · HMAC SHA-256 one-way source/target of the call. This hash of a given phone number will be the same unless the app is reinstalled. If the number is unknown or anonymous, this contains null. |
targetIsContact | null | boolean | Call to/from a known contact, null if unknown. · Sms sender is a known contact (null if unknown). |
targetIsNonNumeric | null | boolean | Sms sender ID is replaced by text, e.g. a company name. |
targetLength | null | int | Length of the target phone number, -1 if not collected. |
timesOpen | int | Total amount of times given app was opened in given time-frame. |
type | PhoneCallType | PhoneSmsType | Direction of phone call. · Direction of the SMS. |
unreadSms | int | Number of unread SMS messages currently in the inbox. |
uptime | double | Time since last app start (s). |
x | float | Acceleration in the x-axis (g). · Gyration in the x-axis (rad/s). · Magnetic field in the x-axis (μT). |
y | float | Acceleration in the y-axis (g). · Gyration in the y-axis (rad/s). · Magnetic field in the y-axis (μT). |
z | float | Acceleration in the z-axis (g). · Gyration in the z-axis (rad/s). · Magnetic field in the z-axis (μT). |
Android (Google APIs)
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/android_google-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| SLEEP_SEGMENT_EVENT | GoogleSleepSegmentEvent | android_google_sleep_segment_event | dynamic rate | NON_DIMENSIONAL | RAW |
| SLEEP_CLASSIFY_EVENT | GoogleSleepClassifyEvent | android_google_sleep_classify_event | every 600 s, dynamic rate | NON_DIMENSIONAL | RAW |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
endTime | double | The UNIX epoch time (s) for the moment when the user wakes up. |
light | int | The brightness of the space around the device, based on the device's ambient light sensor readings. Value ranges from 1 to 6, inclusive. Higher values indicate brighter surroundings, while lower values indicate darker surroundings. |
motion | int | The amount of device motion, based on the device's accelerometer readings. Value ranges from 1 to 6, inclusive. Higher values indicate more movement of the device. |
sleepConfidence | float | Sleep confidence value between 0-1. Higher value indicate that the user is more likely sleeping, while lower values indicate that the user is more likely awake. |
status | null | SleepClassificationStatus | Status that indicates whether the system succeeded in detecting sleep. |
Apple SensorKit
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/apple_sensorkit-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit |
|---|---|---|---|---|
| ACCELERATION | SensorKitAcceleration | sensorkit_acceleration | dynamic rate | — |
| GYROSCOPE | SensorKitRotationRate | sensorkit_rotation_rate | dynamic rate | RADAIAN_PER_SEC |
| AMBIENT_LIGHT | SensorKitAmbientLight | sensorkit_ambient_light | dynamic rate | — |
| AMBIENT_PRESSURE | SensorKitAmbientPressure | sensorkit_ambient_pressure | dynamic rate | — |
| KEYBOARD_METRICS | SensorKitKeyboardMetrics | sensorkit_keyboard_metrics | dynamic rate | — |
| MESSAGE_USAGE | SensorKitMessageUsage | sensorkit_message_usage | dynamic rate | — |
| ON_WRIST | SensorKitOnWrist | sensorkit_on_wrist | dynamic rate | — |
| PEDOMETER | SensorKitPedometer | sensorkit_pedometer | dynamic rate | — |
| PHONE_USAGE | SensorKitPhoneUsage | sensorkit_phone_usage | dynamic rate | — |
| VISITS | SensorKitVisits | sensorkit_visits | dynamic rate | — |
| DEVICE_USAGE | SensorKitDeviceUsage | sensorkit_device_usage | dynamic rate | — |
| TELEPHONY_SPEECH_METRICS | SensorKitTelephonySpeechMetrics | sensorkit_telephony_speech_metrics | dynamic rate | — |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
applicationUsageByCategory | string | The usage time of apps per category. |
arrivalDateIntervalDuration | double | The duration of a range of time within which the user arrives at a location of interest (s). |
arrivalDateIntervalEnd | double | The end date of a range of time within which the user arrives at a location of interest timestamp in UTC (s). |
arrivalDateIntervalStart | double | The start date of a range of time within which the user arrives at a location of interest timestamp in UTC (s). |
audioLevelDuration | null | double | The duration of the time range in the audio stream that the level applies to (s). |
audioLevelLoudness | null | double | The measure of the audio level in decibels. |
audioLevelStart | null | double | The start time of the time range in the audio stream that the level applies to, in seconds relative to time (s). |
averageActivePace | double | The average pace of the user, measured in seconds per meter. |
chromaticityX | float | Chromaticity x coordinate of the ambient light in the CIE xy color space (dimensionless). |
chromaticityY | float | Chromaticity y coordinate of the ambient light in the CIE xy color space (dimensionless). |
crownOrientation | CrownOrientation | A value that indicates the direction the Digital Crown faces with respect to the wearer. |
currentCadence | double | The rate at which steps are taken, measured in steps per second. |
currentPace | double | The current pace of the user, measured in seconds per meter. |
departureDateIntervalDuration | double | The duration of a range of time within which the user departs from a location of interest (s). |
departureDateIntervalEnd | double | The end date of a range of time within which the user departs from a location of interest timestamp in UTC (s). |
departureDateIntervalStart | double | The start date of a range of time within which the user departs from a location of interest timestamp in UTC (s). |
device | string | Device model. |
distance | double | The estimated distance (in meters) traveled by the user. |
distanceFromHome | double | The location’s distance from the home-category location. |
duration | double | The duration that the report spans (s). |
endDate | double | The end time for the pedometer data timestamp in UTC (s). |
floorsAscended | int | The approximate number of floors ascended by walking. |
floorsDescended | int | The approximate number of floors descended by walking. |
identifier | string | A value that maps to a unique geographic location. |
locationCategory | LocationCategory | The location’s type. |
lux | float | Illuminance (lx). |
notificationUsageByCategory | string | The frequency of notifications per category. |
numberOfSteps | int | Number of steps taken between this and the previous record. |
offWristDate | double | Off Wrist Date timestamp in UTC (s). |
onWrist | boolean | A value that indicates whether the watch is on the user’s wrist. |
onWristDate | double | On Wrist Date timestamp in UTC (s). |
placement | SensorPlacement | The light’s location relative to the sensor. |
pressure | double | The ambient pressure (Pascal). |
soundClassification | null | string | The confidence value the model has in its prediction. |
soundClassificationDuration | null | double | The duration of the time span that corresponds to the result’s classifications (s). |
soundClassificationStart | null | double | The start time of the time span that corresponds to the result’s classifications, in seconds relative to time (s). |
speechExpressionActivation | null | double | The level of energy or activation of the speaker. |
speechExpressionConfidence | null | double | The level of confidence of the speaker. |
speechExpressionDominance | null | double | The degree of how strong or meek the speaker sounds. |
speechExpressionDuration | null | double | The duration of the time range in the audio stream that the metrics and analytics apply to (s). |
speechExpressionMood | null | double | An indication of how slurry, tired, or exhausted the speaker sounds compared to normal speech. |
speechExpressionStart | null | double | The start time of the time range in the audio stream that the metrics and analytics apply to, in seconds relative to time (s). |
speechExpressionValence | null | double | The degree of positive or negative emotion or sentiment of the speaker. |
startDate | double | The start time for the pedometer data timestamp in UTC (s). |
temperature | double | The temperature (Celsius). |
totalAlteredWords | int | The total number of altered words for the keyboard. |
totalEmojis | int | The total number of emojis for the keyboard. |
totalIncomingCalls | int | The number of calls the user receives. |
totalIncomingMessages | int | The number of messages the user receives. |
totalOutgoingCalls | int | The number of calls the user makes. |
totalOutgoingMessages | int | The number of messages the user sends. |
totalPauses | int | The total number of pauses during the session. |
totalPhoneCallDuration | double | The total duration of all calls (s). |
totalScreenWakes | int | The total number of screen wakes for the device. |
totalTaps | int | The total number of taps for the keyboard. |
totalTypingDuration | double | The total amount of typing time for the keyboard. |
totalTypingEpisodes | int | The total number of continuous typing episodes during the session. |
totalUniqueContacts | int | The user’s number of contacts. |
totalUnlockDuration | double | The duration of time the device is in an unlocked state (s). |
totalUnlocks | int | The total number of unlocks for the device. |
totalWords | int | The total number of typed words for the keyboard. |
version | string | Version of the SensorKit device usage report format. |
webUsageByCategory | string | The amount of time the user accesses domains per category. |
wristLocation | WristLocation | A value that indicates the wrist where the user wears the watch. |
x | float | Acceleration in the x-axis (g). · Gyration in the x-axis (rad/s). |
y | float | Acceleration in the y-axis (g). · Gyration in the y-axis (rad/s). |
z | float | Acceleration in the z-axis (g). · Gyration in the z-axis (rad/s). |
Fitbit
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-fitbit-connector.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
FitbitIntradayHeartRate | connect_fitbit_intraday_heart_rate | The intraday time series for heart rate. |
FitbitIntradaySteps | connect_fitbit_intraday_steps | The intraday time series for Steps. |
FitbitSleepClassic | connect_fitbit_sleep_classic | Sleep data with 60-second granularity. 'Sleep Pattern' levels include asleep, restless, and awake. |
FitbitSleepStage | connect_fitbit_sleep_stages | Sleep data with 30-second granularity. 'Sleep Stages' levels include deep, light, rem, and wake. |
FitbitTimeZone | connect_fitbit_time_zone | User profile timezone. |
FitbitActivityLogRecord | connect_fitbit_activity_log | Aggregate activity log. |
FitbitIntradayCalories | connect_fitbit_intraday_calories | The intraday time series for Calories. Also includes Activity Level and METS. |
FitbitFoodLog | connect_fitbit_food_log | The Food Log for the day. |
FitbitIntradayHeartRateVariability | connect_fitbit_intraday_heart_rate_variability | Intraday heart rate variability |
FitbitBreathingRate | connect_fitbit_breathing_rate | Breathing rate |
FitbitSkinTemperature | connect_fitbit_skin_temperature | Skin temperature |
FitbitIntradaySpo2 | connect_fitbit_intraday_spo2 | Spo2 or Blood oxygen saturation |
FitbitRestingHeartRate | connect_fitbit_resting_heart_rate | Resting heart rate |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
accessLevel | string | The access level of the food. There are three access level types for food log entries that an authorized user can view via API requests. Each food is annotated with an accessLevel field with one of the following values: PUBLIC - Foods that are in Fitbit's public food database and are visible to any Fitbit users. Only Fitbit populates this database to avoid spam and duplicate entries. PRIVATE - Foods created by a user either on the website or via the Create Food endpoint. SHARED - A food created by a user whose foods privacy is set to Friends or Anyone. These can be logged either on the website or via the Create Food endpoint. These foods can be discovered using the Search Foods endpoint. |
amount | int | The amount of the food. Unit can be accessed from From the unitName of the food. |
brand | string | The brand of the food. |
calories | double | float | Calories in this period. · The calories of the food in kilocalories. |
carbs | float | The carbs of the food in grams. |
coverage | float | Data completeness in terms of the number of interbeat intervals (0-1). |
date | string | ISO 8601 formatted local date of device (yyyy-MM-dd). |
dateTime | string | ISO 6801 formatted local date time of device (yyyy-MM-ddTHH:mm:ss). |
deepSleep | float | Average number of breaths taken per minute when the user was in deep sleep. |
distance | null | float | Distance covered during the activity (km). Null if unknown or if the type of activity is not distance-based. |
duration | float | int | Duration at this sleep characteristic in seconds. · Duration of the activity (s). |
durationActive | float | Duration of the part of the activity where the participant was active (s). |
efficiency | null | int | Calculated sleep efficiency score (in percentage). It is a percentage of the amount of time the user was asleep (and not restless) divided by the time they spent in the bed after initially falling asleep. |
energy | null | float | Estimated of energy expended during the activity (kJ). Null if unknown. |
fat | float | The fat of the food in grams. |
fiber | float | The fiber of the food in grams. |
foodId | long | The id of the food. This can be from the Fitbit food database or a private food the authorized user has entered - https://dev.fitbit.com/build/reference/web-api/nutrition/get-food/. |
fullSleep | float | Average number of breaths taken per minute throughout the entire period of sleep which you can compare to the sleep stage-specific measurements. |
heartRate | int | null | FitbitActivityHeartRate | Heart rate aggregate information collected during the activity. Null if unknown. · Heart rate value (bpm). |
highFrequency | float | The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). |
id | long | Activity log ID. |
isFavorite | boolean | Whether the food is the favorite one. |
level | FitbitSleepClassicLevel | FitbitSleepStageLevel | int | Level of activity: 0 - sedentary; 1 - lightly active; 2 - fairly active; 3 - very active. · Level of sleep as computed by Fitbit. |
levels | null | FitbitActivityLevels | Levels of activity. Null if unknown. |
lightSleep | float | Average number of breaths taken per minute when the user was in light sleep. |
locale | string | The locale of the food. Example format - en_US. |
logId | long | The id of the logged food. |
logType | FitbitSkinTemperatureLogType | null | string | The type of skin temperature log created. · Type of log, e.g. manual. Null if unknown. |
lowFrequency | float | The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). |
manualDataEntry | null | FitbitManualDataEntry | Indicates what values of this record are entered manually. Null if unknown. |
mealTypeId | long | The meal type id of the food. The mealTypeId field is always 7 (Anytime). Meals are not associated with particular times. |
mets | double | The metabolic equivalent of task (MET) - https://en.wikipedia.org/wiki/Metabolic_equivalent_of_task. |
name | null | string | string | Activity name. Null if none or unknown. · The name of the food. |
protein | float | The protein of the food in grams. |
relativeTemperature | float | The user's average temperature during a period of sleep. It is displayed to the user as a delta from their baseline temperature in degrees Celsius. |
remSleep | float | Average number of breaths taken per minute when the user was in rem sleep. |
restingHeartRate | int | Resting heart rate value (bpm) for the day. A sleep stage log is required to generate this value. When a classic sleep log is recorded, this value will be missing. |
rmssd | float | The Root Mean Square of Successive Differences (RMSSD) between heart beats. It measures short-term variability in the user’s heart rate in milliseconds (ms). |
sodium | float | The sodium of the food in milligrams. |
source | null | FitbitSource | Source of the data. Null if unknown. |
speed | null | double | Mean speed during the activity (km/h). Null if unknown or if the type of activity is not distance-based. |
spo2 | float | Percentage value of SpO2 in the bloodstream. SpO2 data is collected when the user is in an extended period of sleep (at least 3 hours of quality sleep). Spo2 values are calculated on a 5-minute exponentially-moving average and provided at the end of a period of sleep. |
steps | int | null | int | Number of steps made during the activity. Null if unknown or if the type of activity is not step-based. · Steps taken in this period. |
timeInterval | int | Chronological window size (s). |
timeLastModified | double | Time when the record was last modified, time since the Unix Epoch (s). |
type | null | long | Fitbit-generated ID of the type of activity. Null if unknown. |
unitId | long | The unit id of the food. Typically, an application retrieves the complete list of units once at startup. From then on, the application will receive a food-specific list of unit ids along with the [Favorite](https://dev.fitbit.com/build/reference/web-api/nutrition/get-favorite-foods/), [Recent](https://dev.fitbit.com/build/reference/web-api/nutrition/get-recent-foods/), or [Frequent](https://dev.fitbit.com/build/reference/web-api/nutrition/get-frequent-foods/) food or by making a query to [Search Foods](https://dev.fitbit.com/build/reference/web-api/nutrition/search-foods/) endpoint. These are the IDs of units that apply to the favorite food. The application will refer to the complete list of units retrieved previously to get and display to the user the unit name or plural name for each unit ID on food-specific list. |
unitName | string | The unit name of the food. |
unitPlural | string | The plural unit name of the food. |
Garmin
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/garmin_generic-1.0.0.yml, specifications/push/radar-garmin-push-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing | Notes |
|---|---|---|---|---|---|---|
| STEPS | GarminGenericSteps | android_garmin_generic_steps | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| HEART_RATE_VARIABILITY | GarminGenericHeartRateVariability | android_garmin_generic_heart_rate_variability | dynamic rate | SECOND | VENDOR | — |
| STRESS | GarminGenericStress | android_garmin_generic_stress | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| ASCENT | GarminGenericAscent | android_garmin_generic_ascent | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| SPO2 | GarminGenericSpo2 | android_garmin_generic_spo2 | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| RESPIRATION | GarminGenericRespiration | android_garmin_generic_respiration | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| HEART_RATE | GarminGenericHeartRate | android_garmin_generic_heart_rate | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| INTENSITY | GarminGenericIntensity | android_garmin_generic_intensity | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| CALORIES | GarminGenericCalories | android_garmin_generic_calories | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| ACCELEROMETER | GarminGenericAccelerometer | android_garmin_generic_accelerometer | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| DEVICEINFO | GarminGenericDeviceInfo | android_garmin_generic_device_info | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| — | GarminDailySummary | push_garmin_daily_summary | — | — | — | Daily summaries offer a high-level view of the user’s entire day. |
| — | GarminActivitySummary | push_garmin_activity_summary | — | — | — | Fitness activity summaries represent high-level information from discrete fitness activities, such as running or swimming, that are specifically and intentionally started by the user on their device. |
| — | GarminActivityDetails | push_garmin_activity_detail | — | — | — | Activity details summaries include all data recorded by the device as part of the Fitness Activity, including GPS coordinates and all recorded sensor data. |
| — | GarminEpochSummary | push_garmin_epoch_summary | — | — | — | The Epoch Summary contains wellness data for a specific time range. Epoch summary records contain much of the same data available in Daily summaries, but with 15-minute time-slice granularity. |
| — | GarminSleepSummary | push_garmin_sleep_summary | — | — | — | Sleep summaries are data records representing how long the user slept and the automatically classified sleep levels during that sleep event (e.g. light, deep periods) based on data generated by the user’s device. |
| — | GarminBodyComposition | push_garmin_body_composition | — | — | — | Body Composition summaries contain information about the user’s biometric data, like weight or body mass index. |
| — | GarminStressDetailSummary | push_garmin_stress_detail_summary | — | — | — | Stress Details summaries contain the user’s stress level values for a given day. |
| — | GarminUserMetrics | push_garmin_user_metrics | — | — | — | User Metrics are per-user calculations performed by Garmin based on the underlying data uploaded from the user’s device. |
| — | GarminMoveIQSummary | push_garmin_move_iq_summary | — | — | — | Move IQ Event summaries are a feed of activities which have been automatically detected by the device based on movement patterns, like running or biking. |
| — | GarminPulseOx | push_garmin_pulse_ox | — | — | — | Pulse Ox summaries contain blood oxygen saturation data. |
| — | GarminRespiration | push_garmin_respiration | — | — | — | Respiration is a feature (https://www8.garmin.com/manuals/webhelp/vivoactive4_4S/EN-US/GUID-252F74B6-C24B-495B-8E73-4BD595CA7FE3.html) available on some Garmin devices that tracks breathing rate throughout the day, during sleep, and during activities such as breathwork and yoga. |
| — | GarminActivityDetailsSample | push_garmin_activity_detail_sample | — | — | — | Each activity detail contains an activity summary and an optional list of samples. The samples list will be empty if the activity is manual or details are not supported by the device. Samples may be as frequent as once per second, and values should be considered valid until the next sample. |
| — | GarminBodyBatterySample | push_garmin_body_battery_sample | — | — | — | Body battery value recorded for the time. Usually assocaited with Stress Details Summary using summaryId. Information on and a list of devices that support Body Battery are available here- https://support.garmin.com/ms-MY/?faq=2qczgfbN00AIMJbX33dRq9. |
| — | GarminHeartRateSample | push_garmin_heart_rate_sample | — | — | — | Mapping between time (in seconds) to a heart rate value recorded for the time, in beats per minute. Each entry is a representative sample of the previous 15 seconds from the given time. Lack of entry for a given time should be interpreted as no data available. These are accompanied with the Daily summary data and can be associated using the summaryId. |
| — | GarminSleepLevel | push_garmin_sleep_level | — | — | — | Sleep level time ranges, currently deep, light, rem and awake. Time ranges are represented as unix timestamps in seconds. Usually associated with Sleep Summary data using the summaryId field. |
| — | GarminStressLevelSample | push_garmin_stress_level | — | — | — | Stress levels are provided as 3-minute averages of the real-time stress scores generated on the device with values ranging from 1 to 100. A value of -1 means there was not enough data to detect stress, and -2 means there was too much motion (e.g. the user was walking or running). Scores between 1 and 25 are considered “rest” (i.e. not stressful), 26-50 as “low” stress, 51-75 “medium” stress, and 76- 100 as “high” stress. Usually assocaited with Stress Details Summary using the summaryId. |
| — | GarminBloodPressureSummary | push_garmin_blood_pressure | — | — | — | Blood pressure summaries offer data from blood pressure readings taken using an Index BPM device or from a user’s manually uploaded blood pressure data. This includes systolic, diastolic, and pulse values taken at the time of the blood pressure reading. For more information about the validation of data using the Index BPM, please visit https://www.garmin.com/en-US/bpmvalidation/. |
| — | GarminSleepScoreSample | push_garmin_sleep_score | — | — | — | A map of sleep score string descriptions for each type of sleep as well as restless periods and stress levels during sleep. Each entry in the sleepScores will have a qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR that is used as a qualitative description of the user’s period of sleep. |
| — | GarminHealthSnapshotSummary | push_garmin_health_snapshot_summary | — | — | — | The Garmin Health Snapshot is a collection of key health-related insights recorded during a two-minute session on a compatible device. Heart rate (HR), heart rate variability (HRV), Pulse Ox, respiration, and stress are the metrics included this summary, which collectively provide you a glimpse of your overall cardiovascular status. More information about Health Snapshot can be found at https://support.garmin.com/en-US/?faq=PB1duL5p6V64IQwhNvcRK9. |
| — | GarminHeartRateVariabilitySummary | push_garmin_heart_rate_variability | — | — | — | Heart rate variability (HRV) refers to beat-to-beat variations in heart rate and is data collected during the overnight sleep window for select devices. To gain a deeper understanding of your overall health, recovery and training performance through heart rate variability while you sleep, based on technology developed by our Firstbeat Analytics team, please visit https://discover.garmin.com/en-US/performance-data/running/#heart-rate-variability. |
| — | GarminHeartRateVariabilitySample | push_garmin_heart_rate_variability_sample | — | — | — | Mapping between time (in seconds) to a heart rate variability value recorded for the time, in milliseconds. Lack of entry for a given time should be interpreted as no data available. These are accompanied with the HRV summary data and can be associated using the summaryId. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
activeCalories | int | Active calorie numbers are what is burned throughout the day only while doing physical, non-sedentary, activity such as walking or working out. Garmin devices calculate active calories based on the activity level, type of activity, age, height, weight, gender, and heart rate (if available). |
activeKilocalories | null | int | Active kilocalories (dietary calories) burned during the monitoring period. This includes only the calories burned by the activity and not calories burned as part of the basal metabolic rate (BMR). · Active kilocalories (dietary calories) burned through actual movement and activity during the monitoring period. · Active kilocalories (dietary calories) burned through actual movement and activity during the monitoring period. This includes only the calories burned by the activity and not calories burned as part of the basal metabolic rate (BMR). |
activeTime | null | int | Portion of the monitoring period (in seconds) in which the device wearer was active for this activity type. The sum of active times of all epochs of the same start time (and different activity types) should be equal to the duration. · Portion of the monitoring period (in seconds) in which the device wearer was considered Active. This relies on heuristics internal to each device. |
activityId | null | string | Unique identifier of the activity at Garmin Connect. |
activityStressDuration | null | int | The number of seconds in this monitoring period where the user was engaging in physical activity and so stress measurement was unreliable. All duration in this monitoring period not covered by stress, rest, and activity stress should be considered Uncategorized, either because the device was not worn or because not enough data could be taken to generate a stress score. |
activitySubType | null | string | The activity subtype that has been identified for this timespan. |
activityType | null | string | Text description of the activity type. e.g - SEDENTARY, SLEEP, RUNNING, CYCLING, WALKING, etc. · Text description of the activity type. See Appendix A for a complete list. e.g - SEDENTARY, SLEEP, RUNNING, CYCLING, WALKING, etc. · Text description of the activity type. e.g - SEDENTARY, SLEEP, RUNNING, CYCLING, WALKING, etc. · The activity type that has been identified for this timespan. e.g - SEDENTARY, SLEEP, RUNNING, CYCLING, WALKING, etc. · This field is included in daily summaries for backwards compatibility purposes. It can be ignored and will always default to WALKING. |
airTemperature | null | float | Air Temperature in Celcius. |
averageBikeCadence | null | float | Average Bike Cadence in rounds per minute. |
averageHeartRate | null | int | Average of heart rate values captured during the last 7 days, in beats per minute. The average heart rate value for the monitoring period can be calculated based on the data from timeOffsetHeartRateSamples. |
averagePace | null | float | Average Pace in minutes per kilometer. |
averageRunCadence | null | float | Average Run Cadence in Steps per minute. |
averageSpeed | null | float | Average Speed in meters per second. |
averageStressLevel | null | int | An abstraction of the user’s average stress level in this monitoring period, measured from 1 to 100, or -1 if there is not enough data to calculate average stress. Scores between 1 and 25 are considered “rest” (i.e not stressful), 26-50 as “low” stress, 51-75 “medium” stress, and 76-100 as “high” stress. |
averageSwimCadence | null | float | Average Swim Cadence in strokes per minute. |
awakeCountScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s awake count during the period of sleep. |
awakeDuration | null | int | Time in seconds the user spent awake during the sleep period. |
bikeCadence | null | int | Cycling cadence in revolutions per minute. |
bmrKilocalories | null | int | BMR Kilocalories burned by existing Basal Metabolic Rate (calculated based on user height/weight/age/other demographic data). |
bodyBattery | null | float | Body battery value recorded for the time. |
bodyFat | null | float | Percentage of body fat. (range 0.0 - 100.0). |
bodyMassIndex | null | float | Body mass index, or BMI. |
bodyWater | null | float | Percentage of body water (range 0.0 - 100.0). |
boneMass | null | int | Bone mass in grams. |
clockDuration | null | int | The amount of real-world 'clock time' from the start of an activity to the end. |
connectionState | State | Garmin device connection state. |
consumedCalories | null | int | The number of calories that have been consumed by the user through food for that day (value subtracted from calorie goal). This value is received from MyFitnessPal and is not entered within Connect. |
dailyHighHeartRate | int | Daily high heart rate (bpm). High and low heart rate are simply the highest and lowest individual HR values recorded daily up to a given point, when the RestingHeartRate message is written. Resting heart rate itself is calculated algorithmically based on recordings taken during periods of sustained low motion. 'Daily' values provided by the SDK are always reset at midnight of the local user-day. |
dailyLowHeartRate | int | Daily low heart rate (bpm). High and low heart rate are simply the highest and lowest individual HR values recorded daily up to a given point, when the RestingHeartRate message is written. Resting heart rate itself is calculated algorithmically based on recordings taken during periods of sustained low motion. 'Daily' values provided by the SDK are always reset at midnight of the local user-day. |
dailyModerateMinutes | int | Daily Moderate Minutes. Garmin devices accumulate intensity minutes throughout the day. This is what is available for current total daily minutes. This value indicates intensity minutes accumulated till that point of the day. |
dailyVigorousMinutes | int | Daily Vigorous Minutes. Garmin devices accumulate intensity minutes throughout the day. This is what is available for current total daily minutes. This value indicates intensity minutes accumulated till that point of the day. |
date | null | string | The calendar date this summary would be displayed on in Garmin Connect in the local time zone of the device. The date format is ‘yyyy-mm-dd’. |
deepPercentageScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s deep slep percentage during the period of sleep. |
deepSleepDuration | null | int | Time in seconds the user spent in deep sleep during the sleep period. |
deviceModel | string | Device model. Supported model are listed on Garmin site - https://developer.garmin.com/health-sdk/overview/. |
deviceName | null | string | Only Fitness Activities are associated with a specific Garmin device rather than the user’s overall account. If a user wears two devices at once during the same time and starts a Fitness Activity on each then both will generate separate Activity summaries with two different deviceNames. Always ‘unknown’ for manually created activities. |
diastolic | null | int | The diastolic value of the blood pressure reading. |
distance | null | float | Distance traveled in meters. |
duration | null | int | Length of the monitoring period in seconds. · Length of the monitoring period in seconds. 86400 once a full day is complete, but less if a user syncs mid-day. · The duration of the measurement period in seconds. |
elevation | null | float | Elevation in meters. |
endTime | double | End time of this sleep period in seconds. |
enhanced | null | boolean | When set to true, the Fitness Age provided has been calculated using a new algorithm (taking into account activity intensity, resting heart rate and body fat percentage or BMI). When set to false, the value provided for Fitness Age has been calculated using the older method of estimation. More information on the improved Fitness Age calculation and device compatibility can be found at https://support.garmin.com/en-US/?faq=CM1YJmMrrNAbEpM9PapJ07. |
firmwareVersion | int | Firmware version of Garmin device. |
fitnessAge | null | int | An estimation of the ‘age’ of the user’s fitness level, calculated by comparing internal fitness metrics with the average readings of biometrically average users of the same age and gender. |
floorsClimbed | int | null | int | Number of floors climbed during the monitoring period. · Number of floors climbed since midnight as computed by Garmin. |
floorsClimbedGoal | int | null | int | Floors climbed goal. · The user’s goal for floors climbed in this monitoring period. |
floorsDescended | int | Number of floors descended since midnight as computed by Garmin. |
friendlyName | string | Friendly name of the device. |
heartRate | int | null | float | null | int | Heart rate (bpm). · Heart rate in beats per minute. |
heartRateAverage | null | float | Average value of Heart Rate for this snapshot. |
heartRateMax | null | float | Maximum value of Heart Rate for this snapshot. |
heartRateMin | null | float | Minimum value of Heart Rate for this snapshot. |
heartRateSource | Source | Source from where the heart rate is measured. |
heartRateVariability | int | Heart rate variability received from Garmin device in milliseconds. |
highStressDuration | null | int | The portion of the user’s stress duration where the measured stress score was in the high range (76-100). |
hrvValue | null | float | The HRV value in milliseconds. |
intensity | null | string | Qualitative measure of intensity. Possible values: SEDENTARY(Little to no activity monitored. This could be due to minimal movement, sitting, resting, or sleeping.), ACTIVE(Some activity monitored. A brisk walk could achieve this intensity.), HIGHLY_ACTIVE(High activity monitored. Running or speed walking could achieve this intensity.). |
intensityDurationGoal | null | int | The user’s goal for consecutive seconds of moderate to vigorous intensity activity for this monitoring period. |
isParent | null | boolean | If present and set to true, this activity is the parent activity of one or more child activities that should also be made available in the data feed to the partner. An activity of type MULTI_SPORT is an example of a parent activity. |
lastNight5MinHigh | null | float | The maximum HRV value over any 5 minute interval of the last night of data. |
lastNightAvg | null | float | The average heart rate variability value from the last night of data. |
latitude | null | float | Latitude in decimal degrees (DD). |
lightPercentageScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s light sleep percentage during the period of sleep. |
lightSleepDuration | null | int | Time in seconds the user spent in light sleep during the sleep period. |
longitude | null | float | Longitude in decimal degrees (DD). |
lowStressDuration | null | int | The portion of the user’s stress duration where the measured stress score was in the low range (26-50). |
manual | null | boolean | Indicates that the activity was manually entered directly on the Connect site. This property will only exist for manual activities. |
maxBikeCadence | null | float | Maximum Bike Cadence in rounds per minute. |
maxHeartRate | null | int | Maximum of heart rate values captured during the monitoring period, in beats per minute. |
maxMotionIntensity | null | float | The largest motion intensity score of any minute in this monitoring period. Motion Intensity is a numerical abstraction of low-level accelerometer data, provided for use in further analysis. This data is not exposed directly to the consumer by Garmin but is used in in the creation of other metrics. Motion Intensity is calculated at minute-level granularity as a number between 0 and 7, with 0 being absolutely still and 7 being constant, sharp motion. Unlike steps, distance, or activity type, which take net movement in to account, motion intensity will increase even if the user does not move in space. For instance, if a user were to jump up and down or fidget with a pencil they would not get credit for any distance, but their motion intensity scores for that monitoring period would increase. It is very common to see mid-range max motion intensities even for sedentary epochs as most people do not sit absolutely still. |
maxPace | null | float | Maximum Pace in minutes per kilometer. |
maxRunCadence | null | float | Maximum Run Cadence in Steps per minute. |
maxSpeed | null | float | Maximum Speed in meters per second. |
maxStressLevel | null | int | The highest stress level measurement taken during this monitoring period. |
meanMotionIntensity | null | float | The average of motion intensity scores for all minutes in this monitoring period. Motion Intensity is a numerical abstraction of low-level accelerometer data, provided for use in further analysis. This data is not exposed directly to the consumer by Garmin but is used in in the creation of other metrics. Motion Intensity is calculated at minute-level granularity as a number between 0 and 7, with 0 being absolutely still and 7 being constant, sharp motion. Unlike steps, distance, or activity type, which take net movement in to account, motion intensity will increase even if the user does not move in space. For instance, if a user were to jump up and down or fidget with a pencil they would not get credit for any distance, but their motion intensity scores for that monitoring period would increase. It is very common to see mid-range max motion intensities even for sedentary epochs as most people do not sit absolutely still. |
measurementTimeOffset | null | int | Offset in seconds to add to time to derive the 'local' time of the device that captured the data. |
mediumStressDuration | null | int | The portion of the user’s stress duration where the measured stress score was in the medium range (51-75). |
metabolicEquivalentOfTask | null | float | MET (Metabolic Equivalent of Task) value for the active time for this activity type. Metabolic Equivalent of Task (MET) is an official measure of activity intensity. Garmin’s calculation of MET is an estimation based on the biometric data provided (height, weight, date of birth, gender) and improves in accuracy if heart rate data is also captured. The following linked document hosted by the US Centers for Disease Control and Prevention provides detailed information on MET and physical activity intensity: http://www.cdc.gov/nccdphp/dnpa/physical/pdf/PA_Intensity_table_2_1.pdf. |
metersClimbed | int | Total number of distance climbed in meters since midnight as computed by Garmin. |
metersClimbedGoal | int | Meters climbed goal. |
metersDescended | int | Total number of distance descended in meters since midnight as computed by Garmin. |
minHeartRate | null | int | Minimum of heart rate values captured during the monitoring period, in beats per minute. |
moderateIntensityDuration | null | int | Cumulative duration of activities of moderate intensity, lasting at least 600 seconds at a time. Moderate intensity is defined as activity with MET value range 3-6. |
movingDuration | null | int | The amount of 'timer time' during which the athlete was moving (above a threshold speed). |
muscleMass | null | int | Muscle mass in grams. |
netKilocaloriesGoal | null | int | The user’s goal for net caloric intake (consumed calories minus active calories) for this monitoring period. This field is related to integration with MyFitnessPal and may not be present for many users. |
numberOfActiveLengths | null | int | Number of Active Lengths. |
offset | null | int | Offset in seconds to add to time to derive the 'local' time of the device that captured the data. |
onDemand | null | boolean | A Boolean to show whether this pulse ox summary represents an on- demand reading or an averaged acclimation reading. |
overallSleepScoreQualifier | null | string | The sleep scores will have a qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR that is used as a qualitative description of the user’s period of sleep. |
overallSleepScoreValue | null | int | The quantitative value of the overall sleep score. |
parentSummaryId | null | string | If present, this is the summaryId of the related parent activity. An activity of type CYCLING with a parent activity of type MULTI_SPORT is an example of this type of relationship. |
power | null | float | The amount of power expended in watts. |
pulse | null | int | Pulse rate at the time the blood pressure reading. |
remPercentageScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s REM sleep percentage during the period of sleep. |
remSleepDuration | null | int | Time in seconds the user spent in REM sleep during the sleep period. |
respiration | null | float | Respiration measurement in breaths per minute. |
respirationAverage | null | float | Average value of respiration rate for this snapshot. |
respirationMax | null | float | Maximum value of respiration rate for this snapshot. |
respirationMin | null | float | Minimum value of respiration rate for this snapshot. |
respirationRate | int | Respiration rate in BPM. |
restStressDuration | null | int | The number of seconds in this monitoring period where stress level measurements were in the restful range (1 to 25). |
restingHeartRate | int | null | int | Average heart rate at rest during the monitoring period, in beats per minute. · Resting heart rate (bpm). |
restlessnessScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s restlessness during the period of sleep. |
rmssdHrvAverage | null | float | Average value of RMSSD HRV for this snapshot. RMSSD stands for the root mean square of successive differences between normal heartbeats. |
samplingRate | int | Sampling rate (samples per second). |
sdrrHrvAverage | null | float | Average value of SDRR HRV for this snapshot. SDRR is the standard deviation in time between heartbeats, which is sometimes referred to as the 'RR interval'. |
sleepLevel | string | Sleep levels, currently deep, light, rem and awake. |
source | null | string | The name of the source of the third party data. For example FITBIT. Only present in Third Party summaries. |
sourceType | null | string | This field is used to determine if blood pressure data was entered manually or synced from a Garmin Device. Possible values: MANUAL: The user entered blood pressure information manually through a web form. DEVICE: The user used a Garmin device to perform a blood pressure reading. |
spO2 | int | SpO2 reading as received from Garmin device in %. |
speed | null | float | Speed in Meters Per Second. |
spo2Average | null | float | Average value of pulse ox (spo2) for this snapshot. |
spo2Max | null | float | Maximum value of pulse ox (spo2) for this snapshot. |
spo2Min | null | float | Minimum value of pulse ox (spo2) for this snapshot. |
spo2Value | null | float | The SpO2 measurement taken at the time (1 sample/minute). |
startTime | double | Start time of this sleep period in seconds. |
startTimeOffset | null | int | Offset in seconds to add to time to derive the 'local' time of the device that captured the data. |
startingLatitude | null | float | Starting Latitude in Degree. |
startingLongitude | null | float | Starting Longitude in Degree. |
stepCount | int | Step count since midnight as calculated by Garmin device. 'Daily' values provided by the SDK are always reset at midnight of the local user-day. |
stepGoal | int | Step goal per day. |
steps | null | int | Count of steps recorded during the monitoring period. |
stepsGoal | null | int | The user’s steps goal for this monitoring period. |
stepsPerMinute | null | float | Number of steps per minute. |
stressAverage | null | float | Average value of stress for this snapshot. |
stressDuration | null | int | The number of seconds in this monitoring period where stress level measurements were in the stressful range (26-100). |
stressLevel | null | float | Stress level value recorded for the time.. |
stressMax | null | float | Maximum value of stress for this snapshot. |
stressMin | null | float | Minimum value of stress for this snapshot. |
stressQualifier | null | string | A qualitative label applied based on all stress measurements in this monitoring period. Possible values: unknown, calm, balanced, stressful, very_stressful, calm_awake, balanced_awake, stressful_awake, very_stressful_awake. This matches what the user will see in Garmin Connect. It is recommended that implementations that use the stressQualifier be tolerant of unknown values in case more granular values are added. |
stressScore | int | Stress score as calculated by Garmin device. Value is in between 1 to 100. where 1 is a very low stress state and 100 is a very high stress state. |
stressScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s stress during the period of sleep. |
summaryId | string | Unique identifier for the summary that this record is associated with. · Unique identifier for the summary that this sample is associated with. · Unique identifier for the summary. |
swimCadence | null | int | Swim cadence in strokes per minute. |
systolic | null | int | The systolic value of the blood pressure reading. |
timerDuration | null | int | The amount of 'timer time' in an activity. |
totalCalories | int | Total calories. |
totalDailyMinutes | int | Total Daily Minutes. Garmin devices accumulate intensity minutes throughout the day. This is what is available for current total daily minutes. This value indicates intensity minutes accumulated till that point of the day. |
totalDistance | null | float | Total Distance in Meters. |
totalDurationScoreQualifier | null | string | A qualifierKey value of EXCELLENT, GOOD, FAIR, or POOR used as a qualitative description of the user’s total duration of sleep. |
totalElevationGain | null | float | Total Elevation Gain in meters. |
totalElevationLoss | null | float | Total Elevation Loss in meters. |
totalWeeklyMinutes | int | Total Weekly Minutes. |
unmeasurableSleepDuration | null | int | Time in seconds that the sleep level of the user could not be measured. This may or may not correspond to off-wrist time. |
validation | null | string | String that defines the validation state of the sleep data and its date range. The data could be auto-confirmed, but the sleep window could have been manually adjusted, or the sleep data itself is entirely manually entered. Possible values: MANUAL: The user entered sleep start and stop times manually through a web form. There is no device data backing up the sleep assessment. DEVICE: The user used a device with the sleep feature to manually start and stop sleep. This type still requires manual user intervention to specify sleep start and stop. AUTO_TENTATIVE: The sleep start and stop times were auto-detected by Garmin Connect using accelerometer data. However, refinements to this sleep record may come later. This could be because the user is still asleep or because the user owns multiple devices and might sync another device later for the same time period. AUTO_FINAL: The sleep start and stop times were auto-detected by Garmin Connect, and enough data has been gathered to finalize the window. This status also indicates that the user only has one device so this record can never be updated again – users that own multiple devices will never receive an AUTO_FINAL. AUTO_MANUAL: Sleep data was auto-detected by Garmin Connect, but the user is overriding the start and stop times or the user started with a manual entry and the sleep was auto-detected later. Garmin Connect stores both but will display the manual start and stop times in favor of the auto-detected times. ENHANCED_TENTATIVE: Sleep data was collected from a device capable of running an enhanced sleep analysis to detect REM sleep, but an updated sleep summary record may come later with further refinements or a greater sleep period. ENHANCED_FINAL: Sleep data was collected from a device capable of running an enhanced sleep analysis to detect REM sleep with no further updates. |
vigorousIntensityDuration | null | int | Cumulative duration of activities of vigorous intensity, lasting at least 600 seconds at a time. Vigorous intensity is defined as activity with MET value greater than 6. |
vo2Max | null | float | An estimate of the maximum volume of oxygen (in milliliters) the user can consume per minute per kilogram of body weight at maximum performance. |
weeklyGoal | int | Weekly Goal. |
weight | null | int | Weight in grams. |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
Oura
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-oura-connector.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
OuraDailyActivity | connect_oura_daily_activity | The daily activity summary values and detailed activity levels. |
OuraDailyReadiness | connect_oura_daily_readiness | The daily readiness summary values. |
OuraDailySleep | connect_oura_daily_sleep | The daily sleep summary values. |
OuraHeartRate | connect_oura_heart_rate | Timeseries heart rate data. |
OuraHeartRateVariability | connect_oura_heart_rate_variability | Timeseries heart rate variability data. |
OuraMet | connect_oura_met | Timeseries MET (metabolic equivalent) data. This describes MET data during an activity. |
OuraMotionCount | connect_oura_motion_count | Timeseries motion count data. This describes motion count during a session. |
OuraTag | connect_oura_tag | The tag data scope provides information on the tags the users enter in the mobile app, which includes activities, symptoms, etc. |
OuraSession | connect_oura_session | The Sessions data scope provides information on how users engage with guided and unguided sessions in the Oura app. |
OuraSleep | connect_oura_sleep | The sleep data for the specified Oura user within a given timeframe. A user can have multiple sleep periods per day. |
OuraWorkout | connect_oura_workout | The workout data scope includes information about user workouts. |
OuraPersonalInfo | connect_oura_personal_info | The personal info scope includes personal information (e.g. age, email, weight, and height) about the user. |
OuraSleepPhase | connect_oura_sleep_phase | Sleep data with 5-minute granularity. 'Sleep Phase' levels include deep, light, rem, and awake. |
OuraSleepMovement | connect_oura_sleep_movement | Sleep movement data with 30-second granularity. 'Sleep Movement' levels include no motion, restless, tossing and turning, and active. |
OuraActivityClass | connect_oura_activity_class | Activity data with 5-minute granularity. 'Activity Classes' include non-wear, rest, inactive, high, low, and medium activity. |
OuraDailySpo2 | connect_oura_daily_spo2 | The daily spO2 data of the user. This contains the spO2 average. |
OuraRestModePeriod | connect_oura_rest_mode_period | The Rest Mode scope includes information about rest mode periods. |
OuraRingConfiguration | connect_oura_ring_configuration | The Ring Configuration scope includes information about the user's ring(s). This includes the model, size, color, etc. |
OuraRecommendedSleepTime | connect_oura_recommended_sleep_time | This includes recommendations for the optimal bedtime window that is calculated based on sleep data. |
OuraDailyResilience | connect_oura_daily_resilience | Oura resilience is a measure of how well your body is managing stress and recovering from challenges, based on sleep recovery, daytime recovery, and stress levels. |
OuraDailyCardiovascularAge | connect_oura_daily_cardiovascular_age | The daily cardiovascular age data provides insights into the user's cardiovascular health. |
OuraDailyStress | connect_oura_daily_stress | The daily stress level data provides insights into the user's stress levels throughout the day. |
OuraEnhancedTag | connect_oura_enhanced_tag | This describes the tags with added metadata that are added for any lifestyle choice, habit, mood change, or environmental factor an Oura user wants to monitor the effects of |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
activeCalories | null | int | Active calories expended (in kilocalories). Null if unknown. |
activity | null | string | Type of the workout activity. |
age | null | int | Age of the user. |
averageBreath | null | float | Average breathing rate during sleep as breaths/second. |
averageHeartRate | null | float | Average heart rate during sleep as beats/minute. |
averageHrv | null | int | Average heart rate variability during sleep. |
averageMetMinutes | null | float | Average metabolic equivalent (MET) in minutes. Null if unknown. |
awakeTime | null | int | Duration spent awake in seconds. |
bedtimeEnd | null | string | Bedtime end of the sleep. |
bedtimeStart | null | string | Bedtime start of the sleep. |
biologicalSex | null | string | Biological sex of the user. |
bpm | null | int | Heart rate in beats per minute. |
breathingDisturbanceIndex | null | int | The breathing disturbance index which indicates sleep breathing disturbances. Null if unknown. |
calories | null | float | Energy burned in kilocalories during the workout. Null if unknown. |
color | OuraRingColor | Oura ring color. |
comment | null | string | User comment or note associated with the enhanced tag. Null if no comment provided. |
contributorActivityBalance | null | int | Contribution of cumulative activity balance in range [1, 100] to the readiness score. Null if unknown. |
contributorBodyTemperature | null | int | Contribution of body temperature in range [1, 100] to the readiness score. Null if unknown. |
contributorDaytimeRecovery | null | float | Daytime recovery contribution to resilience score. Null if unknown. |
contributorDeepSleep | null | int | Contribution of deep sleep in range [1, 100] to the sleep score. Null if unknown. |
contributorEfficiency | null | int | Contribution of sleep efficiency in range [1, 100] to the sleep score. Null if unknown. |
contributorHrvBalance | null | int | Contribution of heart rate variability balance in range [1, 100] to the readiness score. Null if unknown. |
contributorLatency | null | int | Contribution of sleep latency in range [1, 100] to the sleep score. Null if unknown. |
contributorMeetDailyTargets | null | int | Contribution of meeting previous 7-day daily activity targets in range [1, 100] to the activity score. Null if unknown. |
contributorMoveEveryHour | null | int | Contribution of previous 24-hour inactivity alerts in range [1, 100] to the activity score. Null if unknown. |
contributorPreviousDayActivity | null | int | Contribution of previous day's activity in range [1, 100] to the readiness score. Null if unknown. |
contributorPreviousNight | null | int | Contribution of previous night's sleep in range [1, 100] to the readiness score. Null if unknown. |
contributorRecoveryIndex | null | int | Contribution of previous 7-day exercise volume in range [1, 100] to the readiness score. Null if unknown. |
contributorRecoveryTime | null | int | Contribution of previous 7-day recovery time in range [1, 100] to the activity score. Null if unknown. |
contributorRemSleep | null | int | Contribution of REM sleep in range [1, 100] to the sleep score. Null if unknown. |
contributorRestfulness | null | int | Contribution of sleep restfulness in range [1, 100] to the sleep score. Null if unknown. |
contributorRestingHeartRate | null | int | Contribution of resting heart rate in range [1, 100] to the readiness score. Null if unknown. |
contributorSleepBalance | null | int | Contribution of sleep balance in range [1, 100] to the readiness score. Null if unknown. |
contributorSleepRecovery | null | float | Sleep recovery contribution to resilience score. Null if unknown. |
contributorStayActive | null | int | Contribution of previous 24-hour activity in range [1, 100] to the activity score. Null if unknown. |
contributorStress | null | float | Stress contribution to resilience score. Null if unknown. |
contributorTiming | null | int | Contribution of sleep timing in range [1, 100] to the sleep score. Null if unknown. |
contributorTotalSleep | null | int | Contribution of total sleep in range [1, 100] to the sleep score. Null if unknown. |
contributorTrainingFrequency | null | int | Contribution of previous 7-day exercise frequency in range [1, 100] to the activity score. Null if unknown. |
contributorTrainingVolume | null | int | Contribution of previous 7-day exercise volume in range [1, 100] to the activity score. Null if unknown. |
customName | null | string | Custom name assigned by the user to the enhanced tag. Null if no custom name provided. |
day | null | string | Day that the cardiovascular age data belongs to in YYYY-MM-DD format. Null if unknown. · Day that the daily oxygen saturation data belongs to. Null if unknown. · Day that the daily readiness belongs to. Null if unknown. · Day that the daily sleep belongs to. Null if unknown. · Day that the daily stress data belongs to in YYYY-MM-DD format. Null if unknown. · Day that the resilience data belongs to in YYYY-MM-DD format. Null if unknown. · Day that the sleep belongs to. · Day that the sleep recommendation record belongs to. Null if unknown. · Day when the workout occurred. Null if unknown. · ID of the note or tag group. · The YYYY-MM-DD formatted local date indicating when the daily activity occurred. Null if unknown. |
daySummary | null | OuraDaySummaryType | Summary of the daily stress levels. Null if unknown. |
deepSleepDuration | null | int | Duration spent in deep sleep in seconds. |
design | OuraRingDesign | Oura ring design. |
distance | null | float | Distance traveled in meters during the workout. Null if unknown. |
efficiency | null | int | Sleep efficiency rating in range [1, 100]. |
email | null | string | Email of the user. |
endDay | null | string | End date of the enhanced tag in YYYY-MM-DD format. Null if the tag doesn't have an end date. · End date of the rest mode period. Null if unknown. |
endTime | double | End time of the rest mode period in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). · End time of the session in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). · End time of the workout in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). |
equivalentWalkingDistance | null | int | Equivalent walking distance (in meters) of energy expenditure. Null if unknown. |
firmwareVersion | null | string | Firmware version of the ring. Null if unknown. |
hardwareType | OuraRingHardwareType | Oura ring hardware types. |
height | null | float | Height of the user. |
highActivityMetMinutes | null | int | High activity metabolic equivalent (MET) in minutes. Null if unknown. |
highActivityTime | null | int | High activity metabolic equivalent (MET) in seconds. Null if unknown. |
hrv | null | float | The HRV value in milliseconds. |
id | null | string | ID of the record. · ID of the sleep record. · Tag id of the record. · Unique identifier of the Oura activity record the activity class data is taken from. · Unique identifier of the Oura activity record the met data is taken from. · Unique identifier of the Oura session or sleep record the heart rate data is taken from. · Unique identifier of the Oura session or sleep record the hrv data is taken from. · Unique identifier of the Oura session the motion count data is taken from. · Unique identifier of the Oura sleep record the sleep movement data is taken from. · Unique identifier of the Oura sleep record the sleep stage data is taken from. · Unique identifier of the Oura sleep time recommendation. · Unique identifier of the activity from Oura. · Unique identifier of the enhanced tag from Oura. · Unique identifier of the readiness data from Oura. · Unique identifier of the resilience data from Oura. · Unique identifier of the rest mode period from Oura. · Unique identifier of the ring configuration from Oura. · Unique identifier of the session from Oura. · Unique identifier of the sleep data from Oura. · Unique identifier of the spO2 data from Oura. · Unique identifier of the stress data from Oura. · Unique identifier of the workout from Oura. |
inactivityAlerts | null | int | Number of inactivity alerts received. Null if unknown. |
intensity | OuraWorkoutIntensity | Workout intensity as computed by Oura. UNKNOWN when this data is not provided by Oura. |
label | null | string | User-defined label for the workout. Null if unknown. |
latency | null | int | Sleep latency in seconds. This is the time it took for the user to fall asleep after going to bed. |
level | OuraResilienceLevel | Overall resilience level for the day. UNKNOWN when this data is not provided. |
lightSleepDuration | null | int | Duration spent in light sleep in seconds. |
lowActivityMetMinutes | null | int | Low activity metabolic equivalent (MET) in minutes. Null if unknown. |
lowActivityTime | null | int | Low activity metabolic equivalent (MET) in seconds. Null if unknown. |
lowBatteryAlert | null | boolean | Flag indicating if a low battery alert occurred. |
lowestHeartRate | null | int | Lowest heart rate during sleep. |
mediumActivityMetMinutes | null | int | Medium activity metabolic equivalent (MET) in minutes. Null if unknown. |
mediumActivityTime | null | int | Medium activity metabolic equivalent (MET) in seconds. Null if unknown. |
met | null | float | Activity metabolic equivalent (MET) in seconds. |
metersToTarget | null | int | Remaining meters to target. Null if unknown. |
mood | OuraMomentMood | Oura Moment mood. UNKNOWN when this data is not provided by Oura. |
motionCount | null | int | Motion count during a session. |
movement | OuraSleepMovementType | Sleep movement at a 30-second interval. UNKNOWN when this data is not provided (e.g. samples from sleep API). |
nonWearTime | null | int | The time (in seconds) in which the ring was not worn. Null if unknown. |
optimalBedtimeEndOffset | null | int | Recommended optimal bedtime end offset from midnight. Null if unknown. |
optimalBedtimeStartOffset | null | int | Recommended optimal bedtime start offset from midnight. Null if unknown. |
optimalBedtimeTimezoneOffset | null | int | Timezone offset in second from GMT of the day. Null if unknown. |
period | null | int | ECore sleep period identifier. |
phase | OuraSleepPhaseType | Sleep phase at a 5-minute interval. UNKNOWN when this data is not provided (e.g. samples from sleep API). |
readinessContributorActivityBalance | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorBodyTemperature | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorHrvBalance | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorPreviousDayActivity | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorPreviousNight | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorRecoveryIndex | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorRestingHeartRate | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessContributorSleepBalance | null | int | Contribution of cumulative activity balance to the readiness score in range [1, 100]. |
readinessScore | null | int | Readiness score for this sleep. |
readinessScoreDelta | null | int | Effect on readiness score caused by this sleep period. |
readinessTemperatureDeviation | null | int | Readiness temperature deviation in degrees Celsius. |
readinessTemperatureTrendDeviation | null | int | Readiness trend deviation in degrees Celsius. |
recommendation | OuraSleepRecommendation | Oura recommendation action type for bedtime. |
recoveryHigh | null | int | The number of minutes the user spends in high recovery each day. Null if unknown. |
remSleepDuration | null | int | Duration spent in REM sleep in seconds. |
restingTime | null | int | Resting time (in seconds). Null if unknown. |
restlessPeriods | null | int | Number of restless periods during sleep. |
score | null | int | Activity score in range [1, 100]. Null if unknown. · Daily readiness score in range [1, 100]. Null if unknown. · Daily sleep score in range [1, 100]. Null if unknown. |
sedentaryMetMinutes | null | int | Sedentary metabolic equivalent (MET) in minutes. Null if unknown. |
sedentaryTime | null | int | Sedentary metabolic equivalent (MET) in seconds. Null if unknown. |
setUpAt | null | double | Timestamp indicating when the ring was set up. Null if unknown. |
size | null | int | US size of the Oura ring. Null if unknown. |
sleepAlgorithmVersion | OuraSleepAlgorithmVersion | Version of the sleep algorithm used to calculate the sleep data. |
sleepScoreDelta | null | int | Effect on sleep score caused by this sleep period. |
source | OuraHeartRateSource | OuraWorkoutSource | Heart rate source type as computed by Oura. UNKNOWN when this data is not provided (e.g. samples from sleep API). · Workout source type as computed by Oura. UNKNOWN when this data is not provided by Oura. |
spo2AveragePercentage | null | float | The average oxygen saturation percentage value over a single day. |
startDay | null | string | Start date of the enhanced tag in YYYY-MM-DD format. Null if unknown. · Start date of the rest mode period. Null if unknown. |
status | OuraSleepStatus | Oura sleep time status type. This is used to inform sleep time recommendation. |
steps | null | int | Total number of steps taken. Null if unknown. |
stressHigh | null | int | The number of minutes the user spends in high stress each day. Null if unknown. |
tag | null | string | Tag part of this tag group/note. |
tagEndTime | null | double | End time of the enhanced tag in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). Null if the tag doesn't have an end time. |
tagStartTime | null | double | Start time of the enhanced tag in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp). Null if the tag doesn't have a start time. |
tagTypeCode | null | string | The tag type code that categorizes the enhanced tag (e.g., 'tag_generic_nocaffeine', 'tag_generic_outdoors', 'tag_generic_relaxed'). |
targetCalories | null | int | Daily activity target (in kilocalories). Null if unknown. |
targetMeters | null | int | Daily activity target (in meters). Null if unknown. |
temperatureDeviation | null | float | Temperature deviation in degrees Celsius. Null if unknown. |
temperatureTrendDeviation | null | float | Temperature trend deviation in degrees Celsius. Null if unknown. |
text | null | string | Textual contents of the note. |
timeInBed | null | int | Duration spent in bed in seconds. |
totalCalories | null | int | Total calories expended (in kilocalories). Null if unknown. |
totalSleepDuration | null | int | Total sleep duration in seconds. |
type | OuraActivityClassType | OuraMomentType | OuraSleepType | Activity classification at a 5-minute interval. UNKNOWN when this data is not provided. · Oura Moment type. UNKNOWN when this data is not provided by Oura. · Possible sleep period types. UNKNOWN when this data is not provided. |
vascularAge | null | int | The estimated cardiovascular/vascular age in years. Null if unknown. |
weight | null | float | Weight of the user. |
Empatica E4
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/empatica_e4-1.0.0.yml, specifications/passive/empatica_e4-1.1.0.yml, specifications/passive/empatica_e4-v1.yml, specifications/stream/empatica_e4.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing | Notes |
|---|---|---|---|---|---|---|
| ACCELEROMETER | EmpaticaE4Acceleration | android_empatica_e4_acceleration | 32 Hz | G | RAW | — |
| BATTERY | EmpaticaE4BatteryLevel | android_empatica_e4_battery_level | dynamic rate | PERCENTAGE | RAW | — |
| BLOOD_VOLUME_PULSE | EmpaticaE4BloodVolumePulse | android_empatica_e4_blood_volume_pulse | 32 Hz | NANO_WATT | RAW | — |
| ELECTRODERMAL_ACTIVITY | EmpaticaE4ElectroDermalActivity | android_empatica_e4_electrodermal_activity | 4 Hz | MICRO_SIEMENS | RAW | — |
| INTER_BEAT_INTERVAL | EmpaticaE4InterBeatInterval | android_empatica_e4_inter_beat_interval | dynamic rate | BEATS_PER_MIN | VENDOR | — |
| THERMOMETER | EmpaticaE4Temperature | android_empatica_e4_temperature | 4 Hz | CELSIUS | RAW | — |
| SENSOR_STATUS | EmpaticaE4SensorStatus | android_empatica_e4_sensor_status | dynamic rate | NON_DIMENSIONAL | VENDOR | — |
| Stream master | EmpaticaE4Master | EMPATICA_E4 | — | — | — | Aggregation and conversion of Empatica E4 data |
| — | AggregateList | in: android_empatica_e4_acceleration · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_empatica_e4_battery_level · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_empatica_e4_blood_volume_pulse · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_empatica_e4_electrodermal_activity · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_empatica_e4_inter_beat_interval · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_empatica_e4_temperature · windowed: True | — | — | — | — |
| HEART_RATE | NumericAggregate | in: android_empatica_e4_inter_beat_interval · windowed: True | — | BEATS_PER_MIN | — | — |
| — | NumericAggregate | in: android_empatica_e4_heartrate · windowed: True | — | — | — | — |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
batteryLevel | float | Battery level from 0 to 1. |
bloodVolumePulse | float | Light absorption (nW). |
count | int | Count the accumulated values. |
electroDermalActivity | float | Electrodermal activity (µS). |
fields | array<NumericAggregate> | Aggregates of each of the underlying elements. |
interBeatInterval | float | The duration (s) of the detected inter-beat interval (i.e., the distance in seconds from the previous beat). |
max | double | State the maximum between accumulated values. |
mean | null | double | State the arithmetic mean between accumulated values. |
min | double | State the minimum between accumulated values. |
name | string | Name of the field that has been aggregated over. |
quartile | null | array<double> | Quartile of accumulated values. |
sensor | string | Sensor name; one of BVP, GSR, ACC, TEMP.. |
status | string | Sensor status; one of NOT_ON_WRIST, ON_WRIST, DEAD. |
sum | double | State the sum of accumulated values. |
temperature | float | Temperature (°C). |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
Polar
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/polar-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| ACCELEROMETER | PolarAcceleration | android_polar_acceleration | 50 Hz | MILLI_G | RAW |
| BATTERY | PolarBatteryLevel | android_polar_battery_level | dynamic rate | PERCENTAGE | RAW |
| ECG | PolarEcg | android_polar_ecg | dynamic rate | VOLT | RAW |
| PPG | PolarPpg | android_polar_ppg | dynamic rate | UNKNOWN | RAW |
| HEART_RATE | PolarHeartRate | android_polar_heart_rate | 1 Hz | BEATS_PER_MIN | VENDOR |
| PULSE_TO_PULSE_INTERVAL | PolarPpInterval | android_polar_pulse_to_pulse_interval | dynamic rate | SECOND | VENDOR |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
ambient | int | Ambient channel representing the background noise caused by other light sources, so it can be used to remove the background noise from ppg channels. |
batteryLevel | float | Battery level from 0 to 1. |
blockerBit | boolean | Data for blockerBit. |
contactStatus | boolean | Data for contactStatus. |
contactStatusSupported | boolean | Data for contactStatusSupported. |
deviceName | string | Polar device name. |
ecgSignal | int | ECG signal (yV). |
errorEstimate | int | Data for errorEstimate. |
heartRate | int | Data for errorEstimate. · Heart rate (bpm). |
ppInterval | int | The duration (s) of the detected inter-beat interval (i.e., the distance in seconds from the previous beat). |
ppg0 | int | PPG0. |
ppg1 | int | PPG1. |
ppg2 | int | PPG2. |
rrAvailable | boolean | Data for rrAvailable. |
rrsMs | array<int> | Data for rrsMs. |
skinContactStatus | boolean | Data for skinContactStatus. |
skinContactSupported | boolean | Data for skinContactSupported. |
x | int | Acceleration in the x-axis (mG). |
y | int | Acceleration in the y-axis (mG). |
z | int | Acceleration in the z-axis (mG). |
Biovotion
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/biovotion_vsm1-1.0.0.yml, specifications/stream/biovotion_vsm1.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing | Notes |
|---|---|---|---|---|---|---|
| ACCELEROMETER | BiovotionVsm1Acceleration | android_biovotion_vsm1_acceleration | 51.2 Hz | G | RAW | — |
| BATTERY | BiovotionVsm1BatteryLevel | android_biovotion_vsm1_battery_level | 1 Hz | PERCENTAGE | RAW | — |
| BLOOD_PULSE_WAVE | BiovotionVsm1BloodPulseWave | android_biovotion_vsm1_blood_volume_pulse | 1 Hz | NON_DIMENSIONAL | VENDOR | — |
| ENERGY | BiovotionVsm1Energy | android_biovotion_vsm1_energy | 1 Hz | CALORIES_PER_SEC | VENDOR | — |
| GALVANIC_SKIN_RESPONSE | BiovotionVsm1GalvanicSkinResponse | android_biovotion_vsm1_galvanic_skin_response | 1 Hz | KILO_OHM | VENDOR | — |
| HEART_RATE | BiovotionVsm1HeartRate | android_biovotion_vsm1_heartrate | 1 Hz | BEATS_PER_MIN | VENDOR | — |
| HEART_RATE_VARIABILITY | BiovotionVsm1HeartRateVariability | android_biovotion_vsm1_heartrate_variability | 1 Hz | RMSSD_IN_MILLI_SEC | VENDOR | — |
| LED | BiovotionVsm1LedCurrent | android_biovotion_vsm1_led_current | 1 Hz | MILLI_AMPERE | VENDOR | — |
| PHOTOPLETHYSMOGRAPHY | BiovotionVsm1PpgRaw | android_biovotion_vsm1_ppg_raw | 51.2 Hz | NON_DIMENSIONAL | RAW | — |
| RESPIRATION_RATE | BiovotionVsm1RespirationRate | android_biovotion_vsm1_respiration_rate | 1 Hz | BEATS_PER_MIN | VENDOR | — |
| OXYGEN_SATURATION | BiovotionVsm1OxygenSaturation | android_biovotion_vsm1_oxygen_saturation | 1 Hz | PERCENTAGE | VENDOR | — |
| THERMOMETER | BiovotionVsm1Temperature | android_biovotion_vsm1_temperature | 1 Hz | CELSIUS | RAW | — |
| Stream master | BiovotionVsm1Master | BIOVOTION_VSM1 | — | — | — | Aggregation of Biovotion data |
| — | AggregateList | in: android_biovotion_vsm1_acceleration · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_battery_level · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_blood_volume_pulse · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_energy · windowed: True | — | — | — | — |
| — | AggregateList | in: android_biovotion_vsm1_galvanic_skin_response · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_heartrate · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_heartrate_variability · windowed: True | — | — | — | — |
| — | AggregateList | in: android_biovotion_vsm1_led_current · windowed: True | — | — | — | — |
| — | AggregateList | in: android_biovotion_vsm1_ppg_raw · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_respiration_rate · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_oxygen_saturation · windowed: True | — | — | — | — |
| — | NumericAggregate | in: android_biovotion_vsm1_temperature · windowed: True | — | — | — | — |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
batteryChargeRate | float | Battery charge rate, level change per hour (0-1). |
batteryLevel | float | Battery level (0-1). |
batteryStatus | float | Battery status; 0:not charging, not on charger; 2:not charging, on charger; 3:charging, on charger. |
batteryVoltage | float | Battery voltage (V). |
bloodPulseWave | float | Blood pulse wave value (nondimensional). |
bloodPulseWaveQuality | float | Blood pulse wave quality (0-1). |
count | int | Count the accumulated values. |
dark | float | Raw dark light ADC response (normalized 0 -16383). |
energyExpenditure | float | Energy expenditure value (cal/s). |
energyExpenditureQuality | float | Energy expenditure quality (0-1). |
fields | array<NumericAggregate> | Aggregates of each of the underlying elements. |
galvanicSkinResponseAmplitude | float | Gsr amplitude (kOhm). |
galvanicSkinResponsePhase | float | Gsr phase. |
green | float | Current for green LED (mA). · Raw green light ADC response (normalized 0 -16383). |
heartRate | float | Heart rate value (bpm). |
heartRateQuality | float | Heart rate quality (0-1). |
heartRateVariability | float | Heart rate variability value. The applied metric is the root mean squared of successive differences (RMSSD) of heart pulses, measured in milliseconds. |
heartRateVariabilityQuality | float | Heart rate variability quality (0-1). |
ir | float | Current for IR LED (mA). · Raw IR light ADC response (normalized 0 -16383). |
max | double | State the maximum between accumulated values. |
mean | null | double | State the arithmetic mean between accumulated values. |
min | double | State the minimum between accumulated values. |
name | string | Name of the field that has been aggregated over. |
offset | float | Current offset (mA). |
quartile | null | array<double> | Quartile of accumulated values. |
red | float | Current for red LED (mA). · Raw red light ADC response (normalized 0 -16383). |
respirationRate | float | Respiration rate value (bpm). |
respirationRateQuality | float | Respiration rate quality (0-1). |
spO2 | float | SpO2 value (0-1). |
spO2Quality | float | SpO2 quality (0-1). |
sum | double | State the sum of accumulated values. |
temperature | float | Skin temperature (°C). |
temperatureBarometer | float | Barometer temperature (°C). |
temperatureLocal | float | Device (board) temperature (°C). |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
TicWatch
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/ticwatch-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing | Notes |
|---|---|---|---|---|---|---|
| ACCELEROMETER | TicwatchAcceleration | android_esl_ticwatch_acceleration | dynamic rate | G | RAW | — |
| GYROSCOPE | TicwatchGyroscope | android_esl_ticwatch_gyroscope | dynamic rate | RADAIAN_PER_SEC | RAW | — |
| BATTERY | TicwatchBatteryLevel | android_esl_ticwatch_battery_level | dynamic rate | PERCENTAGE | RAW | — |
| PPG | TicwatchPpg | android_esl_ticwatch_ppg | dynamic rate | UNKNOWN | RAW | — |
| EXTERNAL_TIME | ApplicationExternalTime | application_external_time | dynamic rate | SECOND | — | Information sent by the Mobovi Ticwatch about time synchronisation with a NTP server. |
| DEVICE_INFO | ApplicationDeviceInfo | application_device_info | dynamic rate | — | — | Device information where the app is installed. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
appVersion | null | string | App version as a readable string. Null if unknown. |
appVersionCode | null | int | Unique app version number. Null if unknown. |
batteryLevel | float | Battery level from 0 to 1. Note that the battery level is a rough estimate. |
delay | null | double | Delay between sending and receiving a message from the host (s). The lower this delay, the more precise the external timestamp is expected to be. |
externalTime | double | Timestamp in UTC according to an external source (s). |
host | null | string | Hostname or IP address that time was polled from. |
iredled | float | Infrared LED. |
manufacturer | null | string | Manufacturer of the device. Null if unknown. |
model | null | string | Model of the device. Null if unknown. |
operatingSystem | OperatingSystem | Operating system that the application is running on. |
operatingSystemVersion | null | string | Operating system version as readable string. Null if unknown. |
operatingSystemVersionCode | null | int | Operating system unique version number. Null if unknown. |
protocol | ExternalTimeProtocol | Protocol for external time synchronization. |
redled | float | Red LED. |
x | float | Acceleration in the x-axis (g). · Angular velocity in the x-axis (rad/s). |
y | float | Acceleration in the y-axis (g). · Angular velocity in the y-axis (rad/s). |
z | float | Acceleration in the z-axis (g). · Angular velocity in the z-axis (rad/s). |
Pebble
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/pebble_2-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| ACCELEROMETER | Pebble2Acceleration | android_pebble_2_acceleration | 10 Hz | G | RAW |
| BATTERY | Pebble2BatteryLevel | android_pebble_2_battery_level | dynamic rate | PERCENTAGE | RAW |
| HEART_RATE | Pebble2HeartRate | android_pebble_2_heartrate | dynamic rate | BEATS_PER_MIN | VENDOR |
| HEART_RATE_FILTERED | Pebble2HeartRateFiltered | android_pebble_2_heartrate_filtered | dynamic rate | BEATS_PER_MIN | VENDOR |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
batteryIsCharging | boolean | Whether the battery is being charged. |
batteryIsPlugged | boolean | Whether the battery charger cable is plugged in. |
batteryLevel | float | Battery level from 0 to 1. |
heartRate | float | Heart rate (bpm). |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
Dreem
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/dreem-1.0.0.yml
| Value schema | Kafka / stream | Unit | Processing | Notes |
|---|---|---|---|---|
DreemSleepStage | dreem_sleep_stage | NON_DIMENSIONAL | VENDOR | This is DREEM hypnogram data captured from Neuroband |
DreemSleepEndpoints | dreem_sleep_endpoints | NON_DIMENSIONAL | VENDOR | This is DREEM metrics data captured from Neuroband |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
epochNumber | int | Interval number (30 seconds) since the measurement was started. It starts at 1. |
latencyPersistentSleep | org.radarcns.passive.dreem.DreemMetric | LPS stands for Latency to Persistent Sleep. Unit is min. Time from 'Lights out' to the first epoch of persistent sleep (persistent sleep defined as the first epoch of 10 min of persistent sleep). |
meanRespiratoryRate | org.radarcns.passive.dreem.DreemMetric | RR stands for Mean Respiratory rate. Unit is BPM. Is is average number of breaths per minute through the recording. |
nonRapidEyeMovement | org.radarcns.passive.dreem.DreemMetric | NREM stands for Total Sleep Non-REM Sleep. Unit is min. It is N1 + N2 + N3. |
nonRapidEyeMovement1Duration | org.radarcns.passive.dreem.DreemMetric | N1 stands for NREM 1 duration. Unit is min. It is minutes of N1 sleep. |
nonRapidEyeMovement2Duration | org.radarcns.passive.dreem.DreemMetric | N2 stands for NREM 2 duration. Unit is min. It is minutes of N2 sleep. |
nonRapidEyeMovement3Duration | org.radarcns.passive.dreem.DreemMetric | N3 stands for NREM 3 duration. Unit is min. It is minutes of N3 sleep. |
offHead | float | Percentage of the total recording time TRT during which the headband was on head. |
rapidEyeMovementLatency | org.radarcns.passive.dreem.DreemMetric | RL stands for REM Latency. Unit is min. It is SO to first epoch of REM sleep. |
recDateTime | double | This refers to the session start time. |
recordingQuality | org.radarcns.passive.dreem.DreemMetric | QUAL stands for recording quality. Unit is %. It is proportion of recording that is unequivocally scorable by a sleep expert. |
respiratoryRateDuringNonRapidEyeMovement1Duration | org.radarcns.passive.dreem.DreemMetric | RRN1 stands for respiratory rate during N1. Unit is BPM. It is average number of breaths per minute in N1 sleep. |
respiratoryRateDuringNonRapidEyeMovement2Duration | org.radarcns.passive.dreem.DreemMetric | RRN2 stands for respiratory rate during N2. Unit is BPM. It is average number of breaths per minute in N2 sleep. |
respiratoryRateDuringNonRapidEyeMovement3Duration | org.radarcns.passive.dreem.DreemMetric | RRN3 stands for respiratory rate during N3. Unit is BPM. It is average number of breaths per minute in N3 sleep. |
sleepEfficiency | org.radarcns.passive.dreem.DreemMetric | SE stands for Sleep Efficiency. Unit is %. It is portion of the TRT spent asleep. |
sleepOnsetLatency | org.radarcns.passive.dreem.DreemMetric | SOL stands for Sleep Onset Latency. Unit is min. Time from 'Lights out' to unequivocal sleep onset (first of three consecutive N1 sleep epochs, or any non-N1 sleep stage). |
sleepStage | SleepStageType | Sleep stage that the user is in at this particular time point. |
totalRapidEyeMovementSleepDuration | org.radarcns.passive.dreem.DreemMetric | REM stands for Total Rapid Eye Movement Sleep duration. Unit is min. It is minutes of REM sleep. |
totalRecordingTime | org.radarcns.passive.dreem.DreemMetric | TRT stands for Total Recording Time. Unit is min. It is amount of time from record start to record stop. |
totalSleepTime | org.radarcns.passive.dreem.DreemMetric | TST stands for Total Sleep Time. Unit is min. It is amount of sleep from record start to record stop. |
totalSleepTimeSpentInNonRapidEyeMovement1Sleep | org.radarcns.passive.dreem.DreemMetric | The p_N1 stands for percentage Stage N1 Sleep. Unit is %. It is percentage of TST spent in N1 sleep. |
totalSleepTimeSpentInNonRapidEyeMovement2Sleep | org.radarcns.passive.dreem.DreemMetric | The p_N2 stands for percentage Stage N2 Sleep. Unit is %. It is percentage of TST spent in N2 sleep. |
totalSleepTimeSpentInNonRapidEyeMovement3Sleep | org.radarcns.passive.dreem.DreemMetric | The p_N3 stands for percentage Stage N3 Sleep. Unit is %. It is percentage of TST spent in N3 sleep. |
totalSleepTimeSpentInNonRapidEyeMovementSleep | org.radarcns.passive.dreem.DreemMetric | The p_NREM stands for Total Sleep NREM Sleep/ Total Sleep Time. Unit is %. It is percentage of TST spent in NREM sleep (N1 + N2 + N3). |
totalSleepTimeSpentInRapidEyeMovementSleep | org.radarcns.passive.dreem.DreemMetric | The p_REM stands for Percentage Stage REM Sleep. Unit is %. It is percentage of TST spent in REM sleep. |
wakeAfterSleepOnset | org.radarcns.passive.dreem.DreemMetric | WASO stands for Wake After Sleep Onset. Unit is min. It is wakefulness between SO and final epoch of sleep. |
Bittium Faros
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/bittium_faros-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| ACCELEROMETER | BittiumFarosAcceleration | android_bittium_faros_acceleration | dynamic rate | G | RAW |
| BATTERY | BittiumFarosBatteryLevel | android_bittium_faros_battery_level | dynamic rate | PERCENTAGE | RAW |
| ECG | BittiumFarosEcg | android_bittium_faros_ecg | dynamic rate | MICRO_VOLT | RAW |
| INTER_BEAT_INTERVAL | BittiumFarosInterBeatInterval | android_bittium_faros_inter_beat_interval | dynamic rate | SECOND | VENDOR |
| THERMOMETER | BittiumFarosTemperature | android_bittium_faros_temperature | dynamic rate | CELSIUS | VENDOR |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
batteryLevel | float | Battery level from 0 to 1. Note that the battery level is a rough estimate. |
ecgChannel1 | float | ECG signal from the first channel (µV). |
ecgChannel2 | null | float | ECG signal from the second channel (µV). Null if the device does not have at least two channels. |
ecgChannel3 | null | float | ECG signal from the first channel (µV). Null if the device does not have at least two three channels. |
exact | boolean | Whether the batteryLevel can be taken as an exact value. True if the battery level is an exact representation, false if it is just an estimate based on the battery status (CRITICAL/LOW/MEDIUM/HIGH). |
interBeatInterval | float | Duration (s) of the detected inter beat interval. |
temperature | float | Skin temperature (°C) converted from analog-to-digital converter (ADC) values. Conversion is reliable between 35 and 45 degrees Celcius. |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
Oxford camera
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-oxford-camera-connector.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
OxfordCameraData | connect_upload_oxford_camera_data | Sensor readings and computed properties when an image was captured. |
OxfordCameraImage | connect_upload_oxford_camera_image | Image file reference. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
acceleration | OxfordCameraAxes | Acceleration of the camera when the image was captured (g). |
colorBalance | OxfordCameraRgb | Relative distribution of gain applied in the captured image (uncertain interpretation). |
colorMean | OxfordCameraRgb | Mean color saturation over all pixels of the image in the sRGB color space (range 0-1). |
exposure | int | Physical exposure of the captured image (unknown unit, unknown range). |
gain | float | Gain applied to raw photo sensor values. Amplification factor of the signal (unknown range). |
infraredProximity | boolean | True if a the infrared sensor detected an warm object (e.g. part of a human body) closeby when the image was captured. |
luminanceMean | float | Mean luminance over all pixels of the image (0 - 1). Calculation unknown but assumed to match sum of RGB values. |
magneticField | OxfordCameraAxes | Magnetic field of the camera when the image was captured (100 µT). |
name | string | Image name. |
orientation | OxfordCameraAxes | Orientation of the camera when the image was captured (unknown unit, unknown interpretation). |
temperature | float | Ambient temperature when the image was recorded (celcius). |
url | string | URL where image is stored. |
Altoida
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-altoida-connector.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
AltoidaSummary | connect_upload_altoida_summary | Summary and analytics from a set of trials and tests |
AltoidaSummaryMetrics | connect_upload_altoida_bit_metrics | Summary and analytics from Back in Time (BIT) trails and tests |
AltoidaSummaryMetrics | connect_upload_altoida_dot_metrics | Summary and analytics from DOT and tests |
AltoidaDomainResult | connect_upload_altoida_domain_result | Results provided based on nine domains analysed by Altoida |
AltoidaAcceleration | connect_upload_altoida_acceleration | Data from 3-axis accelerometer sensor with gravitational constant g as unit. Original file name ends with _ACC.csv |
AltoidaAttitude | connect_upload_altoida_attitude | Data from 3-axis, the attitude sensor provides the orientation of the device (with respect to the north pole) with radians as unit. Original file name ends with _ATT.csv |
AltoidaGravity | connect_upload_altoida_gravity | Data from 3-axis gravity sensor with gravitational constant g as unit. Original file name ends with _GRA.csv |
AltoidaMagneticField | connect_upload_altoida_magnetic_field | Data from 3-axis magnetometer sensor in micro Tesla. Original file name ends with _MAG.csv |
AltoidaTap | connect_upload_altoida_tap | Data of location where the user tapped the touchscreen on an x and y axis. These values are calculated from the center of the screen in centimeters (cm). Original file name ends with _NORMAL.csv |
AltoidaRotation | connect_upload_altoida_rotation | Data from 3-axis rotation sensor with radians as unit. Original file name ends with _ROT.csv |
AltoidaTouch | connect_upload_altoida_touch | Data of location where the user touched the touchscreen on an x and y axis. These values are calculated from the center of the screen in centimeters (cm). Original file name ends with _TOUCH.csv |
AltoidaBlink | connect_upload_altoida_blink | Eye blinking event data of the Aldoida app user. Original file name ends with _BLINK.csv |
AltoidaEyeTracking | connect_upload_altoida_eye_tracking | Eye movement on the screen is detected Aldoida app user. Original file name ends with _EYE.csv |
AltoidaDiagnostics | connect_upload_altoida_diagnostics | Data indicating what object was placed or found. Orginal file name ends with _DIAG.csv |
AltoidaObject | connect_upload_altoida_object | Data from 3-axis indicating the orientation of the placed object. Orginal file name ends with _OBJECTS.csv |
AltoidaPath | connect_upload_altoida_path | Data of 3-axis distance to an object in meters(m). Orginal file name ends with _PATH.csv |
AltoidaAction | connect_upload_altoida_action | Logs of actions taken. Original file name ends with _TAG.csv |
AltoidaMetadata | connect_upload_altoida_metadata | Data that contains one column with the version name as type string. Original file name ends with _VERSION.csv |
AltoidaXmlMetadata | connect_upload_altoida_xml_metadata | Data from the XML summary file |
AltoidaAssessmentsSummary | connect_upload_altoida_assessment | Assessment summary which includes the start time and end time of a single assessment |
AltoidaAssessmentEvent | connect_upload_altoida_test_event | Single event in an assessment. This usually describes the user's interaction with an object in an assessment |
AltoidaARTestQuestionnaire | connect_upload_altoida_ar_assessment | Questionnaire answers in the AR Test |
AltoidaTestScreenElement | connect_upload_altoida_screen_elements | Screen elements during an Altoida test |
AltoidaMotorBubble | connect_upload_altoida_motor_bubble | Motor function for bubble test |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
accelerationVarianceX | float | Variance of acceleration data of x axis. |
accelerationVarianceY | float | Variance of acceleration data of y axis. |
accelerationVarianceZ | float | Variance of acceleration data of z axis. |
accelerometer | double | Acceleration exerted by the finger hitting the screen. |
accuracy | string | Accuracy of measurement magnetometer low, medium, high and uncalibrated. |
action | string | Action taken by the user during test. |
age | null | int | Age of the participant in years. |
applicationVersion | string | Version number. |
assessmentName | null | string | string | Assessment name. |
assessmentTimestamp | double | Timestamp in UTC (s) when the assessment is started. |
audioHighAccuracy | float | Distribution of deviation from speaker button center (cm). |
audioHighReactionTimes | float | Distribution of reaction times to high tone(s). |
audioIgnoredHighTonePercentage | float | Distribution of ratio of high tones ignored. |
audioLowReactions | null | int | Distributions of number of reactions to low tones. |
audioPrematureToneButtonPresses | int | Distribution of number of premature tone button presses. |
classification | null | Classification | Classification based on the analysis 0=healthy, 1=at risk, 2=MCI due to AD. |
cognitiveProcessingSpeed | float | Percentage value of cognitive processing speed. |
colorAlpha | null | float | Circle alpha value in RGBA color space. |
colorBlue | null | float | Circle blue value in RGBA color space. |
colorGreen | null | float | Circle green value in RGBA color space. |
colorRed | null | float | Circle red value in RGBA color space. |
combined | double | An overall value of touch pressure formed from a linear combination of the previous columns. |
complexAttention | float | Percentage value of complex attention. |
countdownFail | float | Number of countdown fails. |
deviceDescription | string | Device description such as model, etc. |
deviceType | DeviceType | Device type used by the participant. |
displayHeightCm | double | Device display height centimeters. |
displayHeightPixels | double | Device display height pixels. |
displayPpi | double | Device display PPI. |
displayWidthCm | double | Device display width centimeters. |
displayWidthPixels | double | Device display width pixels. |
dominantHand | DominantHandType | Dominant hand of the participant. |
endTime | double | Timestamp in UTC (s) when the assessment is finished. |
eventType | null | string | Event type. |
extraInfo | string | Extra information about action taken. |
eye | string | Which of the eyes blinked. LEFT, RIGHT, BOTH, DETECTED. |
eyeMovement | null | float | Percentage value of eye movement. |
findBetterPlaceCount | float | Number of times the user had to find a better place. |
findFailCount | float | Number of times the user failed to find an object. |
findSkipDurations | float | Mean time the user tried before skipping an object in seconds. |
firstObjectPlaced | string | First object placed. Name of the object: star, heart or teddy. |
firstObjectPlacedCorrect | string | First object placed correct answer. Name of the object: star, heart or teddy. |
firstObjectSearched | string | First object searched. Name of the object: star, heart or teddy. |
firstObjectSearchedCorrect | string | First object searched correct answer. Name of the object: star, heart or teddy. |
flexibility | float | Percentage value of flexibility. |
gender | GenderType | Gender of the participant. |
height | null | double | Element height in cm. |
hit | boolean | Whether the touch hit a button or not, 1 if the touch served a purpose basically, 0 otherwise. |
id | null | int | Circle id. |
inhibition | float | Percentage value of inhibition. |
introReadTime1 | float | Time the user required to read the first intro page (s). |
introReadTime2 | float | Time the user required to read the second intro page (s). |
introReadTimes | float | Mean time the user required to read an intro page (s). |
label | string | Label name of session as entered in the app. |
location | null | LocationValue | Tapping location. |
metadata | null | string | Assessment metadata, if provided. |
name | null | string | Element name. |
nmi | double | NMI value of the test,a value in 0-100, where 0-33.3 is class 2, 33.3-66.6 is class 1, 66.6-100 is class 0. |
normalisationCircle | AltoidaWalkingTestAggregate | Deviation from optimal path in circle normalisation test (cm). |
normalisationRandomTapping | AltoidaTappingTestAggregate | Deviation from center points in random tapping normalisation test (cm). |
normalisationSerpentine | AltoidaWalkingTestAggregate | Deviation from optimal path in serpentine normalisation test (cm). |
normalisationSpeedCircle | AltoidaWalkingTestAggregate | Deviation from optimal path in speed circle normalisation test (cm). |
normalisationSquare | AltoidaWalkingTestAggregate | Deviation from optimal path in square normalisation test (cm). |
normalisationTapping | AltoidaTappingTestAggregate | Deviation from center points in tapping normalisation test (cm). |
notWalkingTimeF | float | Time the user did not walk during finding objects (s). |
notWalkingTimeP | float | Time the user did not walk during placing objects (s). |
object | string | Name of object: star, heart or teddy. |
objectAction | string | Indicates whether the object is placed or found. |
objectName | null | string | Object name related to the event. |
objectType | string | Name of the object: star, heart or teddy. |
osType | OSType | OS type of the device used by the participant. |
osVersion | string | Device OS version. |
perceptualMotorCoordination | float | Percentage value of perceptual motor coordination. |
pitch | float | Rotation of the x-axis (radians). |
placeDelays | float | Mean delay from possible placement to actual placement (s). |
planning | float | Percentage value of planning. |
prospectiveMemory | float | Percentage value of prospective memory. |
radius | null | double | Circle radius. |
randomScreenPressesDuringPlacement | int | Distribution of number of random screen presses during the placement phase. |
randomScreenPressesDuringSearch | int | Distribution of number of random screen presses during placement. |
roll | float | Rotation of the y-axis (radians). |
shockCount | float | Number of shocks that were recorded during the test. |
skipButtonCount | float | Number of times the user pressed the skip button. |
spatialMemory | float | Percentage value of spatial memory. |
speech | null | float | Percentage value of speech. |
spotAlreadyTakenCount | int | Number of times the user tried to use the same spot twice. |
startTime | double | Timestamp in UTC (s) when the assessment is started. |
stepCountRatio | float | Distribution of the ratio between the steps needed for finding the objects over the steps needed for placing them. |
stepDelayF | float | Mean delay between steps when finding objects (s). |
stepDelayP | float | Mean delay between steps when placing objects (s). |
stepVarianceF | float | Variance of delays between steps when finding objects. |
stepVarianceP | float | Variance of delays between steps when placing objects. |
strongHand | float | Dominant hand of user. |
surface | double | Diameter of the touch area in cm. |
tooMuchMovementCount | int | Distribution of number of times placement was impossible due to too much movement. |
trialMeans | AltoidaTrial | Mean values of each of the trials. |
trials | array<AltoidaTrial> | Per-trials details and analyses. |
version | string | Version number. |
visualPerception | float | Percentage value of visual perception. |
width | null | double | Element width in cm. |
x | double | float | null | float | Acceleration in the x-axis (g). · Distance from the center of the screen in (cm)s on x-axis. · Distance to fixed point along the x axis (m). · Earths magnetic field along the x-axis in µT. · Force of gravity along the x-axis (g). · Location where the touchscreen was touched along the x axis (cm). · Rotation of the x-axis (radians). · Rotation of the x-axis in radians. · X coordinate of the eye position. |
xCenterOffset | null | double | Circle location x center offset in cm. |
y | double | float | null | float | Acceleration in the y-axis (g). · Distance from the center of the screen in (cm)s on y-axis. · Distance to fixed point along the y axis (m). · Earths magnetic field along the y-axis in µT. · Force of gravity along the y-axis (g). · Location where the touchscreen was touched along the y axis (cm). · Rotation of the y-axis (radians). · Rotation of the y-axis in radians. · Y coordinate of the eye position. |
yCenterOffset | null | double | Circle location y center offset in cm. |
yaw | float | Rotation of the z-axis (radians). |
yearsOfEducation | null | int | Years of education in years. |
z | float | Acceleration in the z-axis (g). · Distance to fixed point along the z axis (m). · Earths magnetic field along the z-axis in µT. · Force of gravity along the z-axis (g). · Rotation of the z-axis (radians). · Rotation of the z-axis in radians. |
Axivity
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-axivity-connector.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
AxivityAcceleration | connect_upload_axivity_acceleration | Data from 3-axis accelerometer sensor with gravitational constant g as unit. Data extracted from CWA binary file. |
AxivityBatteryLevel | connect_upload_axivity_battery_level | Battery level information of axivity device extracted from CWA Block. |
AxivityLight | connect_upload_axivity_light | Ambient light data extracted from a CWA Block. |
AxivityLight | connect_upload_axivity_temperature | Temperature data extracted from CWA Block. |
AxivityEvent | connect_upload_axivity_event | Event data extracted from from a CWA Block. |
AxivityMetadata | connect_upload_axivity_metadata | Data that contains additional meta-data of the recording. Data extracted from the header of CWA binary file. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
annotationData | string | Value available for this annotation in the cwa metadata. |
annotationName | string | Name of the annotation from cwa metadata. |
batteryLevel | float | Battery level of the Axivity device . |
event | AxivityEventType | Event of the block. |
light | float | Light. |
x | float | Acceleration in the x-axis (g). |
y | float | Acceleration in the y-axis (g). |
z | float | Acceleration in the z-axis (g). |
Physilog
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/connector/radar-physilog-connector-1.0.0.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
PhysilogBinaryDataReference | connect_upload_physilog_binary_data_reference | Binary file reference. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
name | string | File name. |
url | string | URI where image is stored. |
Carl / cloud
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/carl-cloud-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Unit | Notes |
|---|---|---|---|---|
| FIBAROSECTION | FibaroSection | certh_carl_cloud_fibaro_section | NON_DIMENSIONAL | A section of a building that can include one or multiple different rooms. |
| FIBAROROOM | FibaroRoom | certh_carl_cloud_fibaro_room | NON_DIMENSIONAL | A building Room that has Fibaro Devices assigned to it. |
| FIBARODEVICE | FibaroDevice | certh_carl_cloud_fibaro_device | NON_DIMENSIONAL | A Fibaro Device, capturing multiple variables for a specific Fibaro device. More information can be found https://www.fibaro.com/. |
| FIBAROCONSUMPTION | FibaroConsumption | certh_carl_cloud_fibaro_consumption | NON_DIMENSIONAL | Record of wattage that a home device consumed at a point in time. |
| FIBAROEVENT | FibaroEvent | certh_carl_cloud_fibaro_event | NON_DIMENSIONAL | An event that was registered with a Fibaro Device that captures the previous value of the last event that was registered with the same device - old and the new value - new. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
battery | double | The level of Device's Battery. |
categories | string | Show the categories in which the Device belongs to. |
configured | boolean | True if the device is configured. |
created | double | Time since the Unix Epoch (seconds), represents the time of the Fibaro Device's first sync. |
current | double | The current value that was registered with the Device. |
dead | boolean | True if the device is not found on the network. |
deadReason | null | string | The reason that 'dead' field was set as True. |
deviceId | int | Unique ID of the device that corresponding to this record. · Unique ID of the device that registered the Event. |
deviceType | DeviceType | Type of the device (Presense, Door, Flood, Panic, Wall Plug). |
enabled | boolean | True if the Fibaro Device is enabled, False if it is not. |
hclId | int | Unique ID for a Event. As registered in Home Center Lite's API. · Unique ID for a Fibaro Device. As registered in Home Center Lite's API. · Unique ID for a Room. As registered in Home Center Lite's API. · Unique ID for a Section. As registered in Home Center Lite's API. |
id | double | int | A unique ID for a Fibaro Device. As registered in Carl Cloud. · A unique ID of a consumption record. · Unique ID for a Room. As registered in Carl Cloud. · Unique ID for a Section. As registered in Carl Cloud. · Unique ID for an Event. As registered in Carl Cloud. |
lastSyncTime | double | Time since the Unix Epoch (seconds), represent the time of the Fibaro Device's last sync with CARL Cloud. |
mac | null | string | The MAC Addresss of the Fibaro Device. |
make | null | string | The name of a Device's Manufacturer. |
model | string | The model name of the Fibaro Device. |
modified | double | Time since the Unix Epoch (seconds), represents the time of the Fibaro Device's last modification. |
name | null | string | string | Name of the Fibaro Device. · Room's Name. · Section's name. |
parentId | int | Unique ID of the Fibaro Device where this Fibaro Instance belongs to. |
previous | double | The previous value of a similar Event that was registered on with the same Device. |
roomId | int | Unique ID of the Room that the Fibaro Device is registered to. |
sectionId | null | int | Section's unique ID where the Room belongs to. |
serial | string | A serial number for a Fibaro Device. |
type | string | The type of the Event. |
userId | int | Unique ID for the user who registered the Fibaro Device. · Unique ID for the user who registered the Room. · Unique ID for the user who registered the Section. |
watt | double | Wattage recorded at this point in time. |
CANedge
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/canedge-1.0.0.yml
| Value schema | Kafka / stream | Unit | Processing | Notes |
|---|---|---|---|---|
CanEdgeObd2 | canedge_obd2 | NON_DIMENSIONAL | VENDOR | This is vehicle CAN bus OBD2 data captured from CANedge1 device |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
absBaroPres | null | float | Absolute barometric pressure. The OBD2 name is S1_PID_33_AbsBaroPres. Min value is 0. Max value is 255. The unit is kPa. |
absEvapSysVapPres | null | float | Absolute evap system vapor pressure. The OBD2 name is S1_PID_53_AbsEvapSysVapPres. Min value is 0. Max value is 328. The unit is kPa. |
absLoadValue | null | float | Absolute load value. The OBD2 name is S1_PID_43_AbsLoadValue. Min value is 0. Max value is 25700. The unit is %. |
absThrottlePosB | null | float | Absolute throttle position B. The OBD2 name is S1_PID_47_AbsThrottlePosB. Min value is 0. Max value is 100. The unit is %. |
absThrottlePosC | null | float | Absolute throttle position C. The OBD2 name is S1_PID_48_AbsThrottlePosC. Min value is 0. Max value is 100. The unit is %. |
absThrottlePosCd | null | float | Absolute throttle position D. The OBD2 name is S1_PID_49_AbsThrottlePosD. Min value is 0. Max value is 100. The unit is %. |
absThrottlePosE | null | float | Absolute throttle position E. The OBD2 name is S1_PID_4A_AbsThrottlePosE. Min value is 0. Max value is 100. The unit is %. |
absThrottlePosF | null | float | Absolute throttle position F. The OBD2 name is S1_PID_4B_AbsThrottlePosF. Min value is 0. Max value is 100. The unit is %. |
actualEngTorqPct | null | float | Actual engine percent torque. The OBD2 name is S1_PID_62_ActualEngTorqPct. Min value is -125. Max value is 130. The unit is %. |
ambientAirTemp | null | float | Ambient air temperature. The OBD2 name is S1_PID_46_AmbientAirTemp. Min value is -40. Max value is 215. The unit is degC. |
auxInputOutput | null | float | Auxiliary input/output supported. The OBD2 name is S1_PID_65_AuxInputOutput. Min value is 0. Max value is 255. The unit is Encoded. |
calcEngineLoad | null | float | Calculated engine load. The OBD2 name is S1_PID_04_CalcEngineLoad. Min value is 0. Max value is 100. The unit is %. |
catTempBank1Sens1 | null | float | Catalyst temperature (bank 1, sensor 1). The OBD2 name is S1_PID_3C_CatTempBank1Sens1. Min value is -40. Max value is 6514. The unit is degC. |
catTempBank1Sens2 | null | float | Catalyst temperature (bank 1, sensor 2). The OBD2 name is S1_PID_3E_CatTempBank1Sens2. Min value is -40. Max value is 6514. The unit is degC. |
catTempBank2Sens1 | null | float | Catalyst temperature (bank 2, sensor 1). The OBD2 name is S1_PID_3D_CatTempBank2Sens1. Min value is -40. Max value is 6514. The unit is degC. |
catTempBank2Sens2 | null | float | Catalyst temperature (bank 2, sensor 2). The OBD2 name is S1_PID_3F_CatTempBank2Sens2. Min value is -40. Max value is 6514. The unit is degC. |
cmdEgr | null | float | Commanded EGR. The OBD2 name is S1_PID_2C_CmdEGR. Min value is 0. Max value is 100. The unit is %. |
cmdEvapPurge | null | float | Commanded evaporative purge. The OBD2 name is S1_PID_2E_CmdEvapPurge. Min value is 0. Max value is 100. The unit is %. |
cmdSecAirStatus | null | float | Commanded secondary air status. The OBD2 name is S1_PID_12_CmdSecAirStatus. Min value is 0. Max value is 255. The unit is Encoded. |
cmdThrottleAct | null | float | Commanded throttle actuator. The OBD2 name is S1_PID_4C_CmdThrottleAct. Min value is 0. Max value is 100. The unit is %. |
controlModuleVolt | null | float | Control module voltage. The OBD2 name is S1_PID_42_ControlModuleVolt. Min value is 0. Max value is 66. The unit is V. |
demandEngTorqPct | null | float | Demanded engine percent torque. The OBD2 name is S1_PID_61_DemandEngTorqPct. Min value is -125. Max value is 130. The unit is %. |
distanceMilOn | null | float | Distance traveled with MIL on. The OBD2 name is S1_PID_21_DistanceMILOn. Min value is 0. Max value is 65535. The unit is km. |
distanceSinceCodeClear | null | float | Distance traveled since DTCs cleared. The OBD2 name is S1_PID_31_DistanceSinceCodeClear. Min value is 0. Max value is 65535. The unit is km. |
egrError | null | float | EGR Error. The OBD2 name is S1_PID_2D_EGRError. Min value is -100. Max value is 99. The unit is %. |
emissionReq | null | float | Emission requirements. The OBD2 name is S1_PID_5F_EmissionReq. Min value is 0. Max value is 255. The unit is Encoded. |
engPctTorqEp1 | null | float | Engine pct. torque (engine point 1). The OBD2 name is S1_PID_64_EngPctTorq_EP1. Min value is -125. Max value is 130. The unit is %. |
engPctTorqEp2 | null | float | Engine pct. torque (engine point 2). The OBD2 name is S1_PID_64_EngPctTorq_EP2. Min value is -125. Max value is 130. The unit is %. |
engPctTorqEp3 | null | float | Engine pct. torque (engine point 3). The OBD2 name is S1_PID_64_EngPctTorq_EP3. Min value is -125. Max value is 130. The unit is %. |
engPctTorqEp4 | null | float | Engine pct. torque (engine point 4). The OBD2 name is S1_PID_64_EngPctTorq_EP4. Min value is -125. Max value is 130. The unit is %. |
engPctTorqIdle | null | float | Engine pct. torque (idle). The OBD2 name is S1_PID_64_EngPctTorq_Idle. Min value is -125. Max value is 130. The unit is %. |
engRefTorq | null | float | Engine reference torque. The OBD2 name is S1_PID_63_EngRefTorq. Min value is 0. Max value is 65535. The unit is Nm. |
engineCoolantTemp | null | float | Engine coolant temperature. The OBD2 name is S1_PID_05_EngineCoolantTemp. Min value is -40. Max value is 215. The unit is degC. |
engineCoolantTemp67 | null | float | Engine coolant temperature. The OBD2 name is S1_PID_67_EngineCoolantTemp. Min value is -40. Max value is 215. The unit is degC. |
engineFrictionPercentTorque | null | float | Engine friction percent torque. The OBD2 name is S1_PID_8E_EngFrictionPctTorq. Min value is -125. Max value is 130. The unit is %. |
engineFuelRate | null | float | Engine fuel rate. The OBD2 name is S1_PID_5E_EngineFuelRate. Min value is 0. Max value is 3277. The unit is L/h. |
engineOilTemp | null | float | Engine oil temperature. The OBD2 name is S1_PID_5C_EngineOilTemp. Min value is -40. Max value is 215. The unit is degC. |
engineRpm | null | float | Engine speed. The OBD2 name is S1_PID_0C_EngineRPM. Min value is 0. Max value is 16384. The unit is rpm. |
ethanolFuelPct | null | float | Ethanol fuel percentage. The OBD2 name is S1_PID_52_EthanolFuelPct. Min value is 0. Max value is 100. The unit is %. |
evapSysVapPres | null | float | Evap system vapor pressure. The OBD2 name is S1_PID_54_EvapSysVapPres. Min value is -32767. Max value is 32768. The unit is Pa. |
evapSysVaporPres | null | float | Evap. system vapor pressure. The OBD2 name is S1_PID_32_EvapSysVaporPres. Min value is -8192. Max value is 8192. The unit is Pa. |
fuelAirCmdEquiv | null | float | Commanded air-fuel equiv. ratio. The OBD2 name is S1_PID_44_FuelAirCmdEquiv. Min value is 0. Max value is 2. The unit is ratio. |
fuelInjectionTiming | null | float | Fuel injection timing. The OBD2 name is S1_PID_5D_FuelInjectionTiming. Min value is -210. Max value is 302. The unit is deg. |
fuelPressure | null | float | Fuel pressure (gauge pressure). The OBD2 name is S1_PID_0A_FuelPressure. Min value is 0. Max value is 765. The unit is kPa. |
fuelRailAbsPres | null | float | Fuel rail absolute pressure. The OBD2 name is S1_PID_59_FuelRailAbsPres. Min value is 0. Max value is 655350. The unit is kPa. |
fuelRailGaug | null | float | Fuel rail gauge pres. (diesel, gas inject). The OBD2 name is S1_PID_23_FuelRailGaug. Min value is 0. Max value is 655350. The unit is kPa. |
fuelRailPres | null | float | Fuel rail pres. (rel. to manifold vacuum). The OBD2 name is S1_PID_22_FuelRailPres. Min value is 0. Max value is 5177. The unit is kPa. |
fuelSystemStatus | null | float | Fuel system status. The OBD2 name is S1_PID_03_FuelSystemStatus. Min value is 0. Max value is 65535. The unit is Encoded. |
fuelTankLevel | null | float | Fuel tank level input. The OBD2 name is S1_PID_2F_FuelTankLevel. Min value is 0. Max value is 100. The unit is %. |
fuelType | null | float | Fuel type. The OBD2 name is S1_PID_51_FuelType. Min value is 0. Max value is 255. The unit is Encoded. |
hybrBatPackRemLife | null | float | Hybrid battery pack remaining life. The OBD2 name is S1_PID_5B_HybrBatPackRemLife. Min value is 0. Max value is 100. The unit is %. |
intakeAirTempSens | null | float | Intake air temperature. The OBD2 name is S1_PID_68_IntakeAirTempSens. Min value is -40. Max value is 215. The unit is degC. |
intakeAirTemperature | null | float | Intake air temperature. The OBD2 name is S1_PID_0F_IntakeAirTemperature. Min value is -40. Max value is 215. The unit is degC. |
intakeManiAbsPress | null | float | Intake manifold absolute pressure. The OBD2 name is S1_PID_0B_IntakeManiAbsPress. Min value is 0. Max value is 255. The unit is kPa. |
longFuelTrimBank1 | null | float | Long term fuel trim (bank 1). The OBD2 name is S1_PID_07_LongFuelTrimBank1. Min value is -100. Max value is 99. The unit is %. |
longFuelTrimBank2 | null | float | Long term fuel trim (bank 2). The OBD2 name is S1_PID_09_LongFuelTrimBank2. Min value is -100. Max value is 99. The unit is %. |
longSecOxyTrimBank1 | null | float | Long term sec. oxygen trim (bank 1). The OBD2 name is S1_PID_56_LongSecOxyTrimBank1. Min value is -100. Max value is 99. The unit is %. |
longSecOxyTrimBank2 | null | float | Long term sec. oxygen trim (bank 2). The OBD2 name is S1_PID_58_LongSecOxyTrimBank2. Min value is -100. Max value is 99. The unit is %. |
longSecOxyTrimBank3 | null | float | Long term sec. oxygen trim (bank 3). The OBD2 name is S1_PID_56_LongSecOxyTrimBank3. Min value is -100. Max value is 99. The unit is %. |
longSecOxyTrimBank4 | null | float | Long term sec. oxygen trim (bank 4). The OBD2 name is S1_PID_58_LongSecOxyTrimBank4. Min value is -100. Max value is 99. The unit is %. |
mafAirFlowRate | null | float | Mass air flow sensor air flow rate. The OBD2 name is S1_PID_10_MAFAirFlowRate. Min value is 0. Max value is 655. The unit is grams/sec. |
mafSensor | null | float | Mass air flow sensor. The OBD2 name is S1_PID_66_MAFSensor. Min value is 0. Max value is 2048. The unit is grams/sec. |
maxAirFlowMaf | null | float | Max air flow rate from MAF sensor. The OBD2 name is S1_PID_50_Max_AirFlowMAF. Min value is 0. Max value is 2550. The unit is g/s. |
maxFaer | null | float | Max fuel-air equiv. ratio. The OBD2 name is S1_PID_4F_Max_FAER. Min value is 0. Max value is 255. The unit is ratio. |
maxIntManiAbsPres | null | float | Max intake manifold absolute pressure. The OBD2 name is S1_PID_4F_Max_IntManiAbsPres. Min value is 0. Max value is 2550. The unit is kPa. |
maxOxySensCrnt | null | float | Max oxygen sensor current. The OBD2 name is S1_PID_4F_Max_OxySensCrnt. Min value is 0. Max value is 255. The unit is mA. |
maxOxySensVol | null | float | Max oxygen sensor voltage. The OBD2 name is S1_PID_4F_Max_OxySensVol. Min value is 0. Max value is 255. The unit is V. |
monStatusDriveCycle | null | float | Monitor status this drive cycle. The OBD2 name is S1_PID_41_MonStatusDriveCycle. Min value is 0. Max value is 4294967295. The unit is Encoded. |
oxySensor1Crnt | null | float | Oxygen sensor 1 (current). The OBD2 name is S1_PID_34_OxySensor1_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor1Faer24 | null | float | Oxygen sensor 1 (air-fuel equiv. ratio). The OBD2 name is S1_PID_24_OxySensor1_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor1Faer34 | null | float | Oxygen sensor 1 (air-fuel equiv. ratio). The OBD2 name is S1_PID_34_OxySensor1_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor1Stft | null | float | Oxygen sensor 1 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor1_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor1Volt14 | null | float | Oxygen sensor 1 (voltage). The OBD2 name is S1_PID_14_OxySensor1_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor1Volt24 | null | float | Oxygen sensor 1 (voltage). The OBD2 name is S1_PID_24_OxySensor1_Volt. Min value is 0. Max value is 2. The unit is volts. |
oxySensor2Crnt | null | float | Oxygen sensor 2 (current). The OBD2 name is S1_PID_35_OxySensor2_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor2Faer25 | null | float | Oxygen sensor 2 (air-fuel equiv. ratio). The OBD2 name is S1_PID_25_OxySensor2_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor2Faer35 | null | float | Oxygen sensor 2 (air-fuel equiv. ratio). The OBD2 name is S1_PID_35_OxySensor2_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor2Stft | null | float | Oxygen sensor 2 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor2_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor2Volt14 | null | float | Oxygen sensor 2 (voltage). The OBD2 name is S1_PID_14_OxySensor2_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor2Volt25 | null | float | Oxygen sensor 2 (voltage). The OBD2 name is S1_PID_25_OxySensor2_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor3Crnt | null | float | Oxygen sensor 3 (current). The OBD2 name is S1_PID_36_OxySensor3_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor3Faer26 | null | float | Oxygen sensor 3 (air-fuel equiv. ratio). The OBD2 name is S1_PID_26_OxySensor3_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor3Faer36 | null | float | Oxygen sensor 3 (air-fuel equiv. ratio). The OBD2 name is S1_PID_36_OxySensor3_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor3Stft | null | float | Oxygen sensor 3 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor3_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor3Volt14 | null | float | Oxygen sensor 3 (voltage). The OBD2 name is S1_PID_14_OxySensor3_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor3Volt26 | null | float | Oxygen sensor 3 (voltage). The OBD2 name is S1_PID_26_OxySensor3_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor4Crnt | null | float | Oxygen sensor 4 (current). The OBD2 name is S1_PID_37_OxySensor4_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor4Faer27 | null | float | Oxygen sensor 4 (air-fuel equiv. ratio). The OBD2 name is S1_PID_27_OxySensor4_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor4Faer37 | null | float | Oxygen sensor 4 (air-fuel equiv. ratio). The OBD2 name is S1_PID_37_OxySensor4_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor4Stft | null | float | Oxygen sensor 4 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor4_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor4Volt14 | null | float | Oxygen sensor 4 (voltage). The OBD2 name is S1_PID_14_OxySensor4_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor4Volt27 | null | float | Oxygen sensor 4 (voltage). The OBD2 name is S1_PID_27_OxySensor4_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor5Crnt | null | float | Oxygen sensor 5 (current). The OBD2 name is S1_PID_38_OxySensor5_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor5Faer28 | null | float | Oxygen sensor 5 (air-fuel equiv. ratio). The OBD2 name is S1_PID_28_OxySensor5_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor5Faer38 | null | float | Oxygen sensor 5 (air-fuel equiv. ratio). The OBD2 name is S1_PID_38_OxySensor5_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor5Stft | null | float | Oxygen sensor 5 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor5_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor5Volt14 | null | float | Oxygen sensor 5 (voltage). The OBD2 name is S1_PID_14_OxySensor5_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor5Volt28 | null | float | Oxygen sensor 5 (voltage). The OBD2 name is S1_PID_28_OxySensor5_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor6Crnt | null | float | Oxygen sensor 6 (current). The OBD2 name is S1_PID_39_OxySensor6_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor6Faer29 | null | float | Oxygen sensor 6 (air-fuel equiv. ratio). The OBD2 name is S1_PID_29_OxySensor6_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor6Faer39 | null | float | Oxygen sensor 6 (air-fuel equiv. ratio). The OBD2 name is S1_PID_39_OxySensor6_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor6Stft | null | float | Oxygen sensor 6 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor6_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor6Volt14 | null | float | Oxygen sensor 6 (voltage). The OBD2 name is S1_PID_14_OxySensor6_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor6Volt29 | null | float | Oxygen sensor 6 (voltage). The OBD2 name is S1_PID_29_OxySensor6_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor7Crnt | null | float | Oxygen sensor 7 (current). The OBD2 name is S1_PID_3A_OxySensor7_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor7Faer2A | null | float | Oxygen sensor 7 (air-fuel equiv. ratio). The OBD2 name is S1_PID_2A_OxySensor7_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor7Faer3A | null | float | Oxygen sensor 7 (air-fuel equiv. ratio). The OBD2 name is S1_PID_3A_OxySensor7_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor7Stft | null | float | Oxygen sensor 7 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor7_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor7Volt14 | null | float | Oxygen sensor 7 (voltage). The OBD2 name is S1_PID_14_OxySensor7_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor7Volt2A | null | float | Oxygen sensor 7 (voltage). The OBD2 name is S1_PID_2A_OxySensor7_Volt. Min value is 0. Max value is 8. The unit is volts. |
oxySensor8Crnt | null | float | Oxygen sensor 8 (current). The OBD2 name is S1_PID_3B_OxySensor8_Crnt. Min value is -128. Max value is 128. The unit is mA. |
oxySensor8Faer2B | null | float | Oxygen sensor 8 (air-fuel equiv. ratio). The OBD2 name is S1_PID_2B_OxySensor8_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor8Faer3B | null | float | Oxygen sensor 8 (air-fuel equiv. ratio). The OBD2 name is S1_PID_3B_OxySensor8_FAER. Min value is 0. Max value is 2. The unit is ratio. |
oxySensor8Stft | null | float | Oxygen sensor 8 (short term fuel trim). The OBD2 name is S1_PID_14_OxySensor8_STFT. Min value is -100. Max value is 99. The unit is %. |
oxySensor8Volt14 | null | float | Oxygen sensor 8 (voltage). The OBD2 name is S1_PID_14_OxySensor8_Volt. Min value is 0. Max value is 1. The unit is volts. |
oxySensor8Volt2B | null | float | Oxygen sensor 8 (voltage). The OBD2 name is S1_PID_2B_OxySensor8_Volt. Min value is 0. Max value is 8. The unit is volts. |
relAccelPedalPos | null | float | Relative accelerator pedal position. The OBD2 name is S1_PID_5A_RelAccelPedalPos. Min value is 0. Max value is 100. The unit is %. |
relThrottlePos | null | float | Relative throttle position. The OBD2 name is S1_PID_45_RelThrottlePos. Min value is 0. Max value is 100. The unit is %. |
shortFuelTrimBank1 | null | float | Short term fuel trim (bank 1). The OBD2 name is S1_PID_06_ShortFuelTrimBank1. Min value is -100. Max value is 99. The unit is %. |
shortFuelTrimBank2 | null | float | Short term fuel trim (bank 2). The OBD2 name is S1_PID_08_ShortFuelTrimBank2. Min value is -100. Max value is 99. The unit is %. |
shortSecOxyTrimBank1 | null | float | Short term sec. oxygen trim (bank 1). The OBD2 name is S1_PID_55_ShortSecOxyTrimBank1. Min value is -100. Max value is 99. The unit is %. |
shortSecOxyTrimBank2 | null | float | Short term sec. oxygen trim (bank 2). The OBD2 name is S1_PID_57_ShortSecOxyTrimBank2. Min value is -100. Max value is 99. The unit is %. |
shortSecOxyTrimBank3 | null | float | Short term sec. oxygen trim (bank 3). The OBD2 name is S1_PID_55_ShortSecOxyTrimBank3. Min value is -100. Max value is 99. The unit is %. |
shortSecOxyTrimBank4 | null | float | Short term sec. oxygen trim (bank 4). The OBD2 name is S1_PID_57_ShortSecOxyTrimBank4. Min value is -100. Max value is 99. The unit is %. |
throttlePosition | null | float | Throttle position. The OBD2 name is S1_PID_11_ThrottlePosition. Min value is 0. Max value is 100. The unit is %. |
timeRunMilOn | null | float | Time run with MIL on. The OBD2 name is S1_PID_4D_TimeRunMILOn. Min value is 0. Max value is 65535. The unit is minutes. |
timeSinceCodeClear | null | float | Time since DTCs cleared. The OBD2 name is S1_PID_4E_TimeSinceCodeClear. Min value is 0. Max value is 65535. The unit is minutes. |
timeSinceEngStart | null | float | Run time since engine start. The OBD2 name is S1_PID_1F_TimeSinceEngStart. Min value is 0. Max value is 65535. The unit is seconds. |
timingAdvance | null | float | Timing Advance. The OBD2 name is S1_PID_0E_TimingAdvance. Min value is -64. Max value is 64. The unit is deg. |
vehicleSpeed | null | float | Vehicle Speed. The OBD2 name is S1_PID_0D_VehicleSpeed. Min value is 0. Max value is 255. The unit is km/h. |
warmUpsSinceCodeClear | null | float | Warmups since DTCs cleared. The OBD2 name is S1_PID_30_WarmUpsSinceCodeClear. Min value is 0. Max value is 255. The unit is count. |
OpenWeatherMap
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/openweathermap_api-0.1.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| WEATHER | LocalWeather | android_local_weather | every 10800 s, user-configurable | NON_DIMENSIONAL | RAW |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
cloudiness | null | float | Current cloudiness (%). |
condition | WeatherCondition | Current weather condition. |
humidity | null | float | Current humidity (%). |
locationSource | LocationType | The source of the location used to get the weather details. |
precipitation | null | float | Rain or snow volume over last hours reported in 'percipitationPeriod' (mm). |
precipitationPeriod | null | int | Period over which the precipitation was determined (h). |
pressure | null | float | Current atmospheric pressure on sea level (hPa). |
source | string | From which source/API the weather data was retrieved. |
sunrise | null | int | Sunrise time of day in minutes after midnight. The difference with sunset is the minutes of daylight. |
sunset | null | int | Sunset time of day in minutes after midnight. The difference with sunrise is the minutes of daylight. |
temperature | null | float | Current ambient temperature (C). |
RateAF PPG
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/rateaf_ppg-0.1.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Processing |
|---|---|---|---|---|
| PPG | PhoneCameraPpg | android_phone_ppg | dynamic rate | RADAR |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
blue | float | Blue component detected in a sample of the camera preview. The range is 0 (no saturation) to 1 (full saturation). |
green | float | Green component detected in a sample of the camera preview. The range is 0 (no saturation) to 1 (full saturation). |
red | float | Red component detected in a sample of the camera preview. The range is 0 (no saturation) to 1 (full saturation). |
sampleSize | int | Number of pixels that were evaluated to get the current value. |
OpenSMILE audio
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/opensmile_audio-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling |
|---|---|---|---|
| AUDIO | OpenSmile2PhoneAudio | android_processed_audio | every 3600 s, user-configurable |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
config | string | OpenSMILE configuration file. |
data | string | Audio features computed by openSMILE recorded in Base64 format. |
Android Phone (audio)
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/android_phone_audio-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Processing |
|---|---|---|---|---|
| PHONE_AUDIO_INPUT | PhoneAudioInput | android_phone_audio_input | dynamic rate | RADAR |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
audioFileExtension | string | Extension of the audio file. |
audioFileSize | long | Size of the audio file (in bytes). |
audioLength | long | Length of the audio recording (in milliseconds). |
configuredEncoding | string | Encoding for audio recording configured by firebase remote configs in application. |
configuredSampleRate | int | Sample rate for audio recording configured by firebase remote configs in application. |
deviceChannelCounts | string | Supported channel counts of the input audio device. |
deviceEncodings | string | Supported encodings of the input audio device. |
deviceId | string | Identifier associated with the input device used for audio recording. |
deviceName | string | Name of the input audio device used for routing during this recording. |
deviceSampleRates | string | Supported sample rates of the input audio device. |
deviceType | string | Type of the input audio device used for recording. |
fileName | string | Name of the audio file after it is saved to S3. |
filePath | string | Path of the audio file retrieved after uploading to S3 storage. |
hadPlayback | boolean | Whether the recorded audio file was played before uploading to s3 storage. |
pRMT (monitoring)
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/monitor/radar_prmt-1.1.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Notes |
|---|---|---|---|---|---|
| EXTERNAL_TIME | ApplicationExternalTime | application_external_time | every 300 s, user-configurable | SECOND | Information sent by the Android pRMT about time synchronisation with a NTS different from the default one. |
| RECORD_COUNTS | ApplicationRecordCounts | application_record_counts | every 300 s, user-configurable | — | Monitor used by the Android pRMT to report the number of cached and created records. |
| SERVER_STATUS | ApplicationServerStatus | application_server_status | every 300 s, user-configurable | — | Monitor used by the Android pRMT to report the server connection status between the android client and the RADAR-CNS Platform. |
| UPTIME | ApplicationUptime | application_uptime | every 300 s, user-configurable | SECOND | Monitor used by the Android pRMT to notify the time duration since last reboot. |
| TIMEZONE | ApplicationTimeZone | application_time_zone | every 86400 s, user-configurable | SECOND | Local time zone that the device is running in. |
| DEVICE_INFO | ApplicationDeviceInfo | application_device_info | every 300 s, user-configurable | — | Device information where the app is installed |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
appVersion | null | string | App version as a readable string. Null if unknown. |
appVersionCode | null | int | Unique app version number. Null if unknown. |
delay | null | double | Delay between sending and receiving a message from the host (s). The lower this delay, the more precise the external timestamp is expected to be. |
externalTime | double | Timestamp in UTC according to an external source (s). |
host | null | string | Hostname or IP address that time was polled from. |
ipAddress | null | string | Hardware identifier of client application. |
manufacturer | null | string | Manufacturer of the device. Null if unknown. |
model | null | string | Model of the device. Null if unknown. |
offset | int | Offset from UTC (s). |
operatingSystem | OperatingSystem | Operating system that the application is running on. |
operatingSystemVersion | null | string | Operating system version as readable string. Null if unknown. |
operatingSystemVersionCode | null | int | Operating system unique version number. Null if unknown. |
protocol | ExternalTimeProtocol | Protocol for external time synchronization. |
recordsCached | null | long | Number of records currently being cached. |
recordsSent | long | Number of records sent since application start. |
recordsUnsent | null | int | Number of unsent records. |
serverStatus | ServerStatus | Application server connection status. |
uptime | double | Time since last app start (s). |
Stream statistics
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/stream/statistics.yml
| Value schema | Kafka / stream | Notes |
|---|---|---|
SourceStatistics | source_statistics_empatica_e4 · in: android_empatica_e4_blood_volume_pulse_1min | Statistics about E4 devices. |
SourceStatistics | source_statistics_android_phone · in: android_phone_acceleration_1min, android_phone_bluetooth_devices, android_phone_sms, android_phone_call, android_phone_contacts, android_phone_usage_event, android_phone_relative_location | Statistics about Android devices. |
SourceStatistics | source_statistics_biovotion_vsm1 · in: android_biovotion_vsm1_acceleration_1min | Statistics about Biovotion devices. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
timeEnd | double | Last time (seconds since the UNIX Epoch) that a source streamed any data. |
timeStart | double | First time (seconds since the UNIX Epoch) that a source streamed any data. |
Banking app
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/active/banking-app-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Notes |
|---|---|---|---|
| APP_EVENT | BankingEvent | certh_banking_app_event | A Banking App Event, which is either a correct or wrong submission of a PIN number, an amount to withdraw, a cancelled or confirmed transaction. Notably, this allows us to distinguish between a wrong confirmed transaction or a correct cancelled transaction etc. |
| TRANSACTION | BankingTransaction | certh_banking_app_transaction | Transaction in Banking App. This captures a full transaction inputting a PIN number, then an amount and then a confirmation or cancellation. |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
duration | double | Duration of the event (seconds), duration is essentially timeCompleted - time. · Duration of the transaction (seconds), duration is essentially timeCompleted - time. |
eventType | EventType | The type of submitted input: PIN or Amount. |
isComplete | null | boolean | True if the result is CORRECT_CONFIRMED, WRONG_CONFIRMED, CORRECT_CANCELLED or WRONG_CANCELLED. False if TIME_OUT or EXIT. |
isCorrect | null | boolean | Describes if the input Pin or Amount is correct. Null if this event is a confirmation or cancellation. |
timeCompleted | double | Time since the Unix Epoch (seconds), time stores the time an event has been completed. · Time stores the time a transaction has been completed. |
transactionId | string | The uid of Transaction record that the event is related to. · Unique ID for an Transaction. |
transactionResult | TransactionResult | Shows the result of the Transaction which can be Correct Cancelled, Correct Cancelled, Wrong Confirmed, Wrong Cancelled, Timed Out, Ended. |
Google activity
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/google_activity-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| ACTIVITY_TRANSITION_EVENT | GoogleActivityTransitionEvent | android_google_activity_transition_event | dynamic rate | NON_DIMENSIONAL | RAW |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
activity | null | ActivityType | Gets the type of the activity of the transition. |
transition | TransitionType | Represents the transition associated with an activity listed in ActivityType. |
Google places
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/passive/google_places-1.0.0.yml
| Measurement | Value schema | Kafka / stream | Sampling | Unit | Processing |
|---|---|---|---|---|---|
| GOOGLE_PLACES | GooglePlacesInfo | android_google_places_info | every 600 s, dynamic rate, user-configurable | NON_DIMENSIONAL | RAW |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
city | null | string | The city returned corresponds to the current location of the user's device. |
country | null | string | The country returned corresponds to the current location of the user's device. |
fromBroadcast | boolean | Whether the data was generated as a result of a change in device location (true) or as part of a fixed scheduled intervals (false). |
likelihood | double | The likelihood provides a relative probability of the place being the best match within the list of returned places for a single request. A higher value means a greater probability that the place is the best match. It's value ranges between 0.0 and 1.0. |
placeId | null | string | A unique identifier assigned to each place in the Google Places database. It serves as a specific reference or key to a particular place entry and is used to retrieve detailed information about that place. By default, it is not retrieved to respect the user's privacy. To retrieve place IDs, Firebase parameters need to be explicitly set. |
placeType1 | null | string | Categorizing places based on their characteristics or attributes, this field represents the first type, if any, among the retrieved place categories. |
placeType2 | null | string | Categorizing places based on their characteristics or attributes, this field represents the second type, if any, among the retrieved place categories. |
placeType3 | null | string | Categorizing places based on their characteristics or attributes, this field represents the third type, if any, among the retrieved place categories. |
placeType4 | null | string | Categorizing places based on their characteristics or attributes, this field represents the fourth type, if any, among the retrieved place categories. |
state | null | string | The state returned corresponds to the current location of the user's device. |
type1 | null | PlacesType | Categorizing places based on their characteristics or attributes, This field is deprecated, as the Google Place.Type enum is deprecated. Instead, use the placeType field of string type. |
type2 | null | org.radarcns.passive.google.PlacesType | Categorizing places based on their characteristics or attributes, This field is deprecated, as the Google Place.Type enum is deprecated. Instead, use the placeType field of string type. |
type3 | null | org.radarcns.passive.google.PlacesType | Categorizing places based on their characteristics or attributes, This field is deprecated, as the Google Place.Type enum is deprecated. Instead, use the placeType field of string type. |
type4 | null | org.radarcns.passive.google.PlacesType | Categorizing places based on their characteristics or attributes, This field is deprecated, as the Google Place.Type enum is deprecated. Instead, use the placeType field of string type. |
THINC-IT
Data types and sampling as declared in RADAR-base specifications for this source.
Specifications: specifications/active/thincit-1.0.0.yml, specifications/active/thincit-v1.yml
| Measurement | Value schema | Kafka / stream |
|---|---|---|
| THINCIT_CODE_BREAKER | ThincItCodeBreaker | thincit_code_breaker |
| THINCIT_SPOTTER | ThincItSpotter | thincit_spotter |
| THINCIT_SYMBOL_CHECK | ThincItSymbolCheck | thincit_symbol_check |
| THINCIT_TRAILS | ThincItTrails | thincit_trails |
| THINCIT_PDQ5 | ThincItPdq | thincit_pdq5 |
Payload fields (merged)
Unique field names across all value schemas for this source. Omitted: time, timeReceived, timeZone, timeZoneOffset, timestamp.
| Field | Avro type | Description |
|---|---|---|
anticipations | int | The number of responses within 100ms of stimulus presentation. |
appVersion | int | App version. |
completed | int | The number of completed trials. |
correct | int | The number of correct responses. |
duration | int | Total time taken to complete the assessment in milliseconds. |
incorrect | int | The number of incorrect responses. |
inputType | ThincItInputType | Dominant input type used by the subject to answer. |
intervalEight | int | Trial completion time in milliseconds. |
intervalEleven | int | Trial completion time in milliseconds. |
intervalFifteen | int | Trial completion time in milliseconds. |
intervalFive | int | Trial completion time in milliseconds. |
intervalFour | int | Trial completion time in milliseconds. |
intervalFourteen | int | Trial completion time in milliseconds. |
intervalNine | int | Trial completion time in milliseconds. |
intervalOne | int | Trial completion time in milliseconds. |
intervalSeven | int | Trial completion time in milliseconds. |
intervalSeventeen | int | Trial completion time in milliseconds. |
intervalSix | int | Trial completion time in milliseconds. |
intervalSixteen | int | Trial completion time in milliseconds. |
intervalTen | int | Trial completion time in milliseconds. |
intervalThirteen | int | Trial completion time in milliseconds. |
intervalThree | int | Trial completion time in milliseconds. |
intervalTwelve | int | Trial completion time in milliseconds. |
intervalTwo | int | Trial completion time in milliseconds. |
iqrCompletion | int | Mean of trial completion times within interquartile range. |
layoutVersion | int | Each play randomly select one of 40 pre-designed layouts. |
longestTrial | int | Longest trial completion time expressed in milliseconds. |
lostContact | int | The number of times that the mouse button has been released before transitioning successfully to next circle. |
meanLatency | int | Mean latency of correct responses expressed in milliseconds. |
quarterSummaryFour | ThincItCodeBreakerQuarterSummary | ThincItSpotterQuarterSummary | ThincItSymbolCheckQuarterSummary | Trial summary for CodeBreaker assessment Quarter 4. · Trial summary for SymbolCheck assessment Quarter 4. |
quarterSummaryOne | ThincItCodeBreakerQuarterSummary | ThincItSpotterQuarterSummary | ThincItSymbolCheckQuarterSummary | Trial summary for CodeBreaker assessment Quarter 1. · Trial summary for SymbolCheck assessment Quarter 1. |
quarterSummaryThree | ThincItCodeBreakerQuarterSummary | ThincItSpotterQuarterSummary | ThincItSymbolCheckQuarterSummary | Trial summary for CodeBreaker assessment Quarter 3. · Trial summary for SymbolCheck assessment Quarter 3. |
quarterSummaryTwo | ThincItCodeBreakerQuarterSummary | ThincItSpotterQuarterSummary | ThincItSymbolCheckQuarterSummary | Trial summary for CodeBreaker assessment Quarter 2. · Trial summary for SymbolCheck assessment Quarter 2. |
questionFive | ThincItPdqQuestion | PDQ5 Question 5. |
questionFour | ThincItPdqQuestion | PDQ5 Question 4. |
questionOne | ThincItPdqQuestion | PDQ5 Question 1. |
questionThree | ThincItPdqQuestion | PDQ5 Question 3. |
questionTwo | ThincItPdqQuestion | PDQ5 Question 2. |
score | int | THINC-it index score - 0 to 4000. |
timeCompleted | double | Timestamp in UTC (s) when the subject completes the test. |
timeouts | int | The number of times that a subject failed to input a response within the time limit. |
wrongNode | int | The number of times that the subject transitioned to an incorrect next circle before successful transition to correct next circle. |
Other Avro definitions
These records exist under commons/ but are not used as a value schema in the specifications shown above (nested types, keys, or legacy).
org.radarcns.active.notification.Notificationorg.radarcns.active.opensmile.OpenSmile2AudioAnalysisorg.radarcns.active.opensmile.OpenSmile2AudioRecordingorg.radarcns.active.thincit.ThincItInputTypeorg.radarcns.catalogue.ProcessingStateorg.radarcns.catalogue.TimeWindoworg.radarcns.catalogue.Unitorg.radarcns.connector.fitbit.FitbitActivityHeartRateorg.radarcns.connector.fitbit.FitbitActivityLevelsorg.radarcns.connector.fitbit.FitbitManualDataEntryorg.radarcns.connector.fitbit.FitbitSourceorg.radarcns.connector.oura.OuraVO2Maxorg.radarcns.connector.upload.altoida.AltoidaTappingTestAggregateorg.radarcns.connector.upload.altoida.AltoidaTrialorg.radarcns.connector.upload.altoida.AltoidaWalkingTestAggregateorg.radarcns.connector.upload.axivity.AxivityTemperatureorg.radarcns.connector.upload.oxford.OxfordCameraAxesorg.radarcns.connector.upload.oxford.OxfordCameraRgborg.radarcns.kafka.AggregateKeyorg.radarcns.kafka.ObservationKeyorg.radarcns.kafka.RecordSetorg.radarcns.monitor.questionnaire.QuestionnaireApplicationInteractionEventorg.radarcns.monitor.questionnaire.QuestionnaireCompletionLogorg.radarcns.passive.apple.ios.IosMagneticFieldorg.radarcns.passive.dreem.DreemMetricorg.radarcns.passive.empatica.EmpaticaE4Tag