mCerebrum-Configuration

mCerebrum is a configurable smartphone software platform for mobile and wearable sensors. It provides support for reliable data collection from mobile and wearable sensors, and offers real-time processing of these data.

This repo contains configurations for mCerebrum studies.

You can find more information about MD2K software on our software website or the MD2K organization on our MD2K website.

Scheduler

Name	Default Config	Config	Description
core_id	☑
core_enable	☑	☑

Schedule

Field	required	Description	Example
id	☑	unique id for this scheduler	"id": "wakeup"
observe[]		list of events to observe Events: 1) DataSource 2) DateTime 3) Time	"observe":[ "WAKEUP-----", "00:00:00 ]
startIf		Conditional statement to start scheduling (if it's not running)
stopIf		Conditional statement to stop scheduling defines whether it's possible to schedule
startTime
endTime
recurrence

Trigger When

Field	required	Description	Example
id	☑	unique id for this scheduler	"id": "wakeup"
observe[]		list of events to observe Events: 1) DataSource 2) DateTime 3) Time	"observe":[ "WAKEUP-----", "00:00:00 ]
startIf		Conditional statement to start scheduling (if it's not running)
stopIf		Conditional statement to stop scheduling defines whether it's possible to schedule
startTime
endTime
recurrence

Core

Name	Default Config	Config	Description
core_id	☑
core_enable	☑	☑

Config Info

Name	Default Config	Config	Description
core_config_id	☑
core_config_title	☑
core_config_description	☑
core_config_version	☑
core_config_filename	☑	☑
core_config_from		☑	local, cerebral_cortex
core_config_createTime		☑
core_config_icon - name - type - content	☑

Login

Name	Default Config	Config	Description
core_login_serverAddress	☑	☑	Example: https://odin.md2k.org
core_login_isLoggedIn		☑
core_login_username		☑
core_login_password		☑
core_login_accessToken		☑

privacy

Name	Default Config	Config	Description
core_privacy_durationChoices - id - title - timestamp	☑
core_privacy_dataSourceChoices - id - title - dataSources	☑

upload

Name	Default Config	Config	Description
core_upload_enable		☑
core_upload_rules - id - enable - title - interval - condition - includeDataSources - excludeDataSources	☑

PhoneSensor

Name	Values	Default Value	Description
phonesensor_accelerometer_enable	true/false	false
phonesensor_accelerometer_sampleRate	1-100	16	☑
phonesensor_accelerometer_sampleRateUnit	SECOND	SECOND	☑
phonesensor_accelerometer_writeType	FIXED/AS_RECEIVED/ON_CHANGE	FIXED
phonesensor_accelerometerLinear_enable	☑	☑
phonesensor_accelerometerLinear_sampleRate	☑	☑
phonesensor_accelerometerLinear_sampleRateUnit	☑	☑
phonesensor_accelerometerLinear_writeType	☑	☑
phonesensor_gyroscope_enable	☑	☑
phonesensor_gyroscope_sampleRate	☑	☑
phonesensor_gyroscope_sampleRateUnit	☑	☑
phonesensor_gyroscope_writeType	☑	☑
phonesensor_magnetometer_enable	☑	☑
phonesensor_magnetometer_sampleRate	☑	☑
phonesensor_magnetometer_sampleRateUnit	☑	☑
phonesensor_magnetometer_writeType	☑	☑
phonesensor_gravity_enable	☑	☑
phonesensor_gravity_sampleRate	☑	☑
phonesensor_gravity_sampleRateUnit	☑	☑
phonesensor_gravity_writeType	☑	☑
phonesensor_ambientLight_enable	☑	☑
phonesensor_ambientLight_sampleRate	☑	☑
phonesensor_ambientLight_sampleRateUnit	☑	☑
phonesensor_ambientLight_writeType	☑	☑
phonesensor_airPressure_enable	☑	☑
phonesensor_airPressure_sampleRate	☑	☑
phonesensor_airPressure_sampleRateUnit	☑	☑
phonesensor_airPressure_writeType	☑	☑
phonesensor_ambientTemperature_enable	☑	☑
phonesensor_ambientTemperature_sampleRate	☑	☑
phonesensor_ambientTemperature_sampleRateUnit	☑	☑
phonesensor_ambientTemperature_writeType	☑	☑
phonesensor_proximity_enable	☑	☑
phonesensor_proximity_sampleRate	☑	☑
phonesensor_proximity_sampleRateUnit	☑	☑
phonesensor_proximity_writeType	☑	☑
phonesensor_relativeHumidity_enable	☑	☑
phonesensor_relativeHumidity_sampleRate	☑	☑
phonesensor_relativeHumidity_sampleRateUnit	☑	☑
phonesensor_relativeHumidity_writeType	☑	☑
phonesensor_significantMotion_enable	☑	☑
phonesensor_significantMotion_writeType	☑	☑
phonesensor_chargingStatus_enable	☑	☑
phonesensor_chargingStatus_sampleRate	☑	☑
phonesensor_chargingStatus_sampleRateUnit	☑	☑
phonesensor_chargingStatus_writeType	☑	☑
phonesensor_bluetoothStatus_enable	☑	☑
phonesensor_bluetoothStatus_sampleRate	☑	☑
phonesensor_bluetoothStatus_sampleRateUnit	☑	☑
phonesensor_bluetoothStatus_writeType	☑	☑
phonesensor_gpsStatus_enable	☑	☑
phonesensor_gpsStatus_sampleRate	☑	☑
phonesensor_gpsStatus_sampleRateUnit	☑	☑
phonesensor_gpsStatus_writeType	☑	☑
phonesensor_wifiStatus_enable	☑	☑
phonesensor_wifiStatus_sampleRate	☑	☑
phonesensor_wifiStatus_sampleRateUnit	☑	☑
phonesensor_wifiStatus_writeType	☑	☑
phonesensor_battery_enable	☑	☑
phonesensor_battery_sampleRate	☑	☑
phonesensor_battery_sampleRateUnit	☑	☑
phonesensor_battery_writeType	☑	☑
phonesensor_activityType_enable	☑	☑
phonesensor_activityType_sampleRate	☑	☑
phonesensor_activityType_sampleRateUnit	☑	☑
phonesensor_activityType_writeType	☑	☑
phonesensor_gps_enable	☑	☑
phonesensor_gps_sampleRate	☑	☑
phonesensor_gps_sampleRateUnit	☑	☑
phonesensor_gps_writeType	☑	☑

MotionSense

Varialble	Default Config	Config	Description
motionsense_requiredDevice - RequiredDevice[]	☑
motionsense_runAsForegroundService	☑	☑
motionsense_deviceSettings - DeviceSettings[]	☑	☑
motionsense_devices[Device]	☑	☑

RequiredDevice

Variable	Default Config	Config	Description
motionsense_device_platformType	☑
motionsense_device_platformId	☑	☑
motionsense_device_version	☑
motionsense_device_required	☑

DeviceSettings

Variable	Default Config	Config	Description	Supported devices
motionsense_device_platformType	☑			MotionSense, MotionSenseHRV
motionsense_device_platformId	☑	☑		MotionSense, MotionSenseHRV
motionsense_device_version	☑			MotionSense, MotionSenseHRV
motionsense_device_minimumConnectionInterval	☑	☑
motionsense_accelerometer_enable	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+, MotionSenseHRV+Gen2
motionsense_accelerometer_frequency	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+, MotionSenseHRV+Gen2
motionsense_accelerometer_sensitivity	☑	☑		MotionSenseHRV+Gen2
motionsense_gyroscope_enable	☑	☑		MotionSense, MotionSenseHRV
motionsense_gyroscope_frequency	☑	☑		MotionSense, MotionSenseHRV
motionsense_gyroscope_sensitivity	☑	☑		MotionSenseHRV+Gen2
motionsense_sequenceNumberMotion_enable	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+
motionsense_sequenceNumberMotion_frequency	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+
motionsense_rawMotion_enable	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+
motionsense_rawMotion_frequency	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+
motionsense_battery_enable	☑	☑		MotionSense, MotionSenseHRV, MotionSenseHRV+
motionsense_led_enable	☑	☑		MotionSenseHRV, MotionSenseHRV+
motionsense_led_frequency	☑	☑		MotionSenseHRV, MotionSenseHRV+
motionsense_led_filteredEnable	☑	☑		MotionSenseHRV+Gen2
motionsense_led_red	☑	☑		MotionSenseHRV+Gen2
motionsense_led_green	☑	☑		MotionSenseHRV+Gen2
motionsense_led_infrared	☑	☑		MotionSenseHRV+Gen2
motionsense_rawLed_enable	☑	☑		MotionSenseHRV+Gen2
motionsense_quaternion_enable	☑	☑		MotionSenseHRV+
motionsense_quaternion_frequency	☑	☑		MotionSenseHRV+
motionsense_magnetometer_enable	☑	☑		MotionSenseHRV+
motionsense_magnetometer_frequency	☑	☑		MotionSenseHRV+
motionsense_magnetometerSensitivity_enable	☑	☑		MotionSenseHRV+
motionsense_magnetometerSensitivity_frequency	☑	☑		MotionSenseHRV+
motionsense_rawMagnetometer_enable	☑	☑		MotionSenseHRV+
motionsense_rawMagnetometer_frequency	☑	☑		MotionSenseHRV+
motionsense_sequenceNumberMagnetometer_enable	☑	☑		MotionSenseHRV+
motionsense_sequenceNumberMagnetometer_frequency	☑	☑		MotionSenseHRV+

Device

Variable	Default Config	Config	Description	Device
motionsense_device_id	☑			MotionSense, MotionSenseHRV
motionsense_device_enable	☑			MotionSense, MotionSenseHRV
motionsense_device_platformType	☑			MotionSense, MotionSenseHRV
motionsense_device_platformId	☑	☑		MotionSense, MotionSenseHRV
motionsense_device_version	☑			MotionSense, MotionSenseHRV

Contributing

Please read our Contributing Guidelines for details on the process for submitting pull requests to us.

We use the Google Java Style Guide.

Our Code of Conduct is the Contributor Covenant.

Bug reports can be submitted through JIRA.

Our discussion forum can be found here.

Versioning

We use Semantic Versioning for versioning the software which is based on the following guidelines.

MAJOR.MINOR.PATCH (example: 3.0.12)

1. MAJOR version when incompatible API changes are made,
2. MINOR version when functionality is added in a backwards-compatible manner, and
3. PATCH version when backwards-compatible bug fixes are introduced.

For the versions available, see this repository's tags.

Contributors

Link to the list of contributors who participated in this project.

License

This project is licensed under the BSD 2-Clause - see the license file for details.

Acknowledgments

• National Institutes of Health - Big Data to Knowledge Initiative
  • Grants: R01MD010362, 1UG1DA04030901, 1U54EB020404, 1R01CA190329, 1R01DE02524, R00MD010468, 3UH2DA041713, 10555SC
• National Science Foundation
  • Grants: 1640813, 1722646
• Intelligence Advanced Research Projects Activity
  • Contract: 2017-17042800006