Xiaomi

By integrating the ROOK SDK, you can access available Xiaomi data through of Apple Health and Health Connect to retrieve body, physical, and sleep information from your linked users. Our SDK collects raw data from Apple Health and Health Connect, transforms it into structured data, and delivers it in JSON format through the ROOK SDK.

Xiaomi Data Available Through Apple Health

This is the data available from Apple Health that ROOK extracts:

Body Health

{
    "body_summary": [
      "hr_avg_bpm_int", 
      "hr_granular_data_array", 
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "height_cm_float"
    ]
  }

Physical Health

{
    "physical_summary": [
      "walked_distance_meters_float",
      "floors_climbed_float",
      "traveled_distance_meters_float", 
      "traveled_distance_granular_data_array", 
      "active_steps_init", 
      "active_steps_granular_data_array", 
      "calories_expenditure_kcal_float", 
      "calories_net_active_kcal_float", 
      "calories_basal_metabolic_rate_kcal_float",       
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "hr_avg_bpm_int", 
      "hr_granular_data_array"
    ],
    "physical_calories_event": [
      "basal_float",
      "active_float"
    ],
    "physical_steps_event": [
      "accumulated_steps_int"
    ],
    "physical_activity_event": [
      "activity_start_datetime_string",
      "activity_end_datetime_string",
      "activity_duration_seconds_int",
      "activity_type_name_string",
      "activite_seconds_int",
      "calories_expenditure_kcal_float",
      "calories_net_active_kcal_float"
    ]    
}

Sleep Health

{
    "sleep_summary": [
      "sleep_start_datetime_string", 
      "sleep_end_datetime_string", 
      "sleep_date_string", 
      "sleep_duration_seconds_int", 
      "time_in_bed_seconds_int",
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "hr_avg_bpm_int", 
      "hr_granular_data_array"
    ]
}

Xiaomi Data Available Through Health Connect

This is the data available from Health Connect that ROOK extracts:

Body Health

{
    "body_summary": [
      "hr_avg_bpm_int", 
      "hr_granular_data_array", 
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "hr_resting_bpm_float", 
      "saturation_avg_percentage_int", 
      "saturation_granular_data_array" 
    ],
    "body_heart_rate_event": [
      "hr_avg_bpm_int", 
      "hr_granular_data_array", 
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int"
    ],
    "body_oxygenation_event": [
      "saturation_avg_percentage_int", 
      "saturation_granular_data_array"
    ]
}

Physical Health

{
    "physical_summary": [
      "steps_int", 
      "steps_granular_data_array", 
      "traveled_distance_meters_float", 
      "traveled_distance_granular_data_array", 
      "saturation_avg_percentage_int", 
      "saturation_granular_data_array", 
      "calories_expenditure_kcal_float", 
      "calories_net_active_kcal_float", 
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "hr_avg_bpm_int", 
      "hr_granular_data_array"
    ],
    "physical_calories_event": [
      "active_float"
    ],
    "physical_steps_event": [
      "accumulated_steps_int"
    ],
     "physical_heart_rate_event": [
      "hr_maximum_bpm_int",
      "hr_minimum_bpm_int",
      "hr_avg_bpm_int",
      "hr_granular_data_array"
    ],
    "physical_activity_event": [
      "activity_start_datetime_string",
      "activity_end_datetime_string",
      "activity_duration_seconds_int",
      "activity_type_name_string",
      "activity_energy_kilojoules_float",
      "calories_net_active_kcal_float",
      "steps_init",
      "steps_granular_data_array",
      "traveled_distance_meter_float",
      "traveled_distance_granular_data_array",
      "hr_maximum_bpm_int",
      "hr_minimum_bpm_int",
      "hr_avg_bpm_init",
      "hr_granular_data_array",
      "cadence_avg_rpm_float",      
      "cadence_maximum_rpm_float",
      "cadence_granular_data_array"
    ]
}

Sleep Health

{
    "sleep_summary": [
      "sleep_start_datetime_string", 
      "sleep_end_datetime_string", 
      "sleep_date_string", 
      "sleep_duration_seconds_int", 
      "time_in_bed_seconds_int", 
      "hr_maximum_bpm_int", 
      "hr_minimum_bpm_int", 
      "hr_avg_bpm_int", 
      "hr_granular_data_array", 
      "light_sleep_duration_seconds_int",                           
      "rem_sleep_duration_seconds_int",                           
      "deep_sleep_duration_seconds_int",                           
      "saturation_avg_percentage_int", 
      "saturation_minimum_percentage_int", 
      "saturation_maximum_percentage_int", 
      "saturation_granular_data_array"
    ]
}

note

The data you receive depends on the permissions granted by the user when linking their data source.

Data Delivery:

Our Xiaomi integration delivers notifications within minutes after a user completes an event and syncs their app. ROOK retrieves, processes, and delivers the data through our SDK, providing you with user insights efficiently.

Start Extracting Xiaomi Data

To begin extracting health data from Xiaomi through the Health Connect and Apple Health SDKs, follow these steps:

Step 1: Integrate Our SDK

ROOK offers SDK compatible with Health Connect and Apple Health SDKs, allowing precise integration into your solution.

iOS	Android	Flutter	Capacitor	React Native

Step 2: Set Up Your Connections Page

Enable the Xiaomi data through the Health Connect and Apple Health SDKs source on the connections page to allow your users to connect.

Step 3: Receive Your Users' Data

Once users connect to the data source, you will start receiving their data. Utilize this data to its full potential.

{
  "version":[],
  "data_structure": "",
  "client_uuid": "",
  "user_id": "",
  "body_health": {},
  "physical_health": {},
  "Sleep_health": {}
}

Xiaomi Brand Guide

To ensure the correct use of Xiaomi’s brand and assets, follow their official guidelines. You can find more details in their brand guide here: Xiaomi Brand Guide.