carp_mobile_sensing 0.6.2
CARP Mobile Sensing Framework in Flutter #
This library contains the software architecture for the CARP sensing framework implemented in Flutter. Supports cross-platform (iOS and Android) sensing.
For Flutter plugins for other CARP products, see CARP Mobile Sensing in Flutter.
Usage #
To use this plugin, add carp_mobile_sensing
as a dependency in your pubspec.yaml file.
Android Integration #
Add the following to your app's manifest.xml
file located in android/app/src/main
:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="<your_package_name"
xmlns:tools="http://schemas.android.com/tools">
...
<!-- The following permissions are used for CARP Mobile Sensing -->
<uses-permission android:name="android.permission.PACKAGE_USAGE_STATS" tools:ignore="ProtectedPermissions"/>
</manifest>
NOTE: Version 0.5.0 is migrated to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library. See Flutter AndroidX compatibility
iOS Integration #
Add this permission in the Info.plist
file located in ios/Runner
:
<key>UIBackgroundModes</key>
<array>
<string>bluetooth-central</string>
<string>bluetooth-peripheral</string>
<string>external-accessory</string>
<string>fetch</string>
</array>
Documentation #
The Dart API doc describes the different libraries and classes.
The wiki contains detailed documentation on the CARP Mobile Sensing Framework, including the domain model, its built-in probes, and how to extend it.
Below is a few simple / minimum examples (a better description is available on the wiki).
Examples #
In the following example, a study is created "by hand", i.e. you specify each task and measure in the study.
// Import package
import 'package:carp_mobile_sensing/carp_mobile_sensing.dart';
some_method() async {
// Create a study using a File Backend
Study study = Study("1234", "user@dtu.dk",
name: "An example study",
dataEndPoint: FileDataEndPoint()
..bufferSize = 500 * 1000
..zip = true
..encrypt = false);
// add sensor collection from accelerometer and gyroscope
// careful - these sensors generate a lot of data!
study.addTriggerTask(
DelayedTrigger(1000), // delay sampling for one second
Task('Sensor Task')
..addMeasure(PeriodicMeasure(MeasureType(NameSpace.CARP, SensorSamplingPackage.ACCELEROMETER),
frequency: 10 * 1000, // sample every 10 secs
duration: 2 // for 2 ms
))
..addMeasure(PeriodicMeasure(MeasureType(NameSpace.CARP, SensorSamplingPackage.GYROSCOPE),
frequency: 20 * 1000, // sample every 20 secs
duration: 2 // for 2 ms
)));
study.addTriggerTask(
PeriodicTrigger(24 * 60 * 60 * 1000), // trigger sampling once pr. day
Task('Task collecting a list of all installed apps')
..addMeasure(Measure(MeasureType(NameSpace.CARP, AppsSamplingPackage.APPS))));
// creating measure variable to be used later
PeriodicMeasure lightMeasure = PeriodicMeasure(MeasureType(NameSpace.CARP, SensorSamplingPackage.LIGHT),
name: "Ambient Light", frequency: 11 * 1000, duration: 700);
study.addTriggerTask(ImmediateTrigger(), Task('Light')..addMeasure(lightMeasure));
// Create a Study Controller that can manage this study, initialize it, and start it.
StudyController controller = StudyController(study);
// await initialization before starting
await controller.initialize();
controller.start();
// listening on all data events from the study
controller.events.forEach(print);
// listen on only CARP events
controller.events.where((datum) => datum.format.namepace == NameSpace.CARP).forEach(print);
// listen on LIGHT events only
controller.events.where((datum) => datum.format.name == SensorSamplingPackage.LIGHT).forEach(print);
// map events to JSON and then print
controller.events.map((datum) => datum.toJson()).forEach(print);
// listening on a specific probe registered in the ProbeRegistry
// this is equivalent to the statement above
ProbeRegistry.probes[SensorSamplingPackage.LIGHT].events.forEach(print);
// subscribe to events
StreamSubscription<Datum> subscription = controller.events.listen((Datum datum) {
// do something w. the datum, e.g. print the json
print(JsonEncoder.withIndent(' ').convert(datum));
});
// sampling can be paused and resumed
controller.pause();
controller.resume();
// pause / resume specific probe(s)
ProbeRegistry.lookup(SensorSamplingPackage.ACCELEROMETER).pause();
ProbeRegistry.lookup(SensorSamplingPackage.ACCELEROMETER).resume();
// adapt measures on the go - calling hasChanged() force a restart of the probe, which will load the new measure
lightMeasure
..frequency = 12 * 1000
..duration = 500
..hasChanged();
// disabling a measure will pause the probe
lightMeasure
..enabled = false
..hasChanged();
// once the sampling has to stop, e.g. in a Flutter dispose() methods, call stop.
// note that once a sampling has stopped, it cannot be restarted.
controller.stop();
}
However, you can se up a study quite simple, by using sampling schemas. Below is an example of this:
StudyController controller = StudyController(
study,
samplingSchema: SamplingSchema.common(),
);
await controller.initialize();
controller.start();
// listening on all data events from the study
controller.events.forEach(print);
There is a very simple example app app which shows how a study can be created with different tasks and measures. This app just prints the sensing data to a console screen on the phone.
However, the CARP Mobile Sensing App provides a MUCH better example of how to use the package in a Flutter BLoC architecture, including good documentation of how to do this.
Features and bugs #
Please read about existing issues and file new feature requests and bug reports at the issue tracker.
License #
This software is copyright (c) 2018 Copenhagen Center for Health Technology (CACHET) at the Technical University of Denmark (DTU). This software is made available 'as-is' in a MIT license.
0.6.2 #
- intensive test of data upload to CARP and Firebase on both Android and iOS
- support for retry in upload of data to CARP
- handling that a study id can only be an integer in the CARP web services
0.6.1 #
- Thorough testing on iOS.
- Better handling of probes not available on iOS via the
initialize
method. - Centralized concept for handling permissions.
0.6.0 - Trigger
Model & Data Manager events
- Extension of
Study
domain model to include support forTrigger
, which manages the temporal triggering of data sampling. See the documentation on how to defined a study with triggers.
-
Adjustment of runtime environment to reflect the new study model
- Addition of a
TriggerExecutor
- Update to
Executors
, i.e.StudyExecutor
,TaskExecutor
andProbe
- Addition of a
-
The data manager model has been updated
- A
DataManager
now expose a stream of stateevents
as defined inDataManagerEventTypes
- A
DataManager
now has atype
which is a string as defined inDataEndPointTypes
- These changes are also implemented for the file and CARP data managers.
- A
-
Minor refactoring
- Apps and AppUsage are no longer periodic measure, but one-off measures. Hence, use the new trigger model to sample installed apps and their usage e.g. on a daily basis.
- The
BluetoothDatum
now lists all devices found in a scan. - The pedometer now works as a simple step stream which sense and report each step taken.
datastore
library have been renamed todata_managers
.
0.5.1 #
- Update of readme file.
0.5.0 - AndroidX Compatibility #
- Breaking change. This version has been migrated from the deprecated Android Support Library to AndroidX.
This should not result in any functional changes, but it requires any Android app using this plugin to also
migrate if they're using the original support library.
- See Flutter AndroidX compatibility
- Fixed error in
PedometerProbe
0.4.0 - Data Transformers and Privacy Support #
- support for data transformers
- OMH Geolocation
- OMH PhysicalActivity
- support for privacy schema
- added support for hashing bluetooth names in the bluetooth package
- upgrade to json_serializable v.2
0.3.10 #
- minor change to the
StreamProbe
API - now non-static streams can be used by implementing theget stream
method. - update of the relevant sampling packages using
StreamProbe
0.3.8+9 #
- update and rename of
CARPDataPoint
toDataPoint
to reflect new CARP API. - moved CARP web service specific data model to
CARPDataPoint
to thecarp_webservices
package.
0.3.5+6+7 #
- rename of
packages
folder tosampling_packages
(seems like Dart Pub don't like folders calledpackages
) - rename of
core
folder todomain
0.3.3 #
- update to new versions of CACHET Flutter Plugins
- rename of
probes
folder topackages
- upgrade and test on Flutter v. 1.3.4 Dart v. 2.2.1
0.3.2 - Sampling Packages #
- support for dividing probes into separate sampling packages
- included in
carp_mobile_sensing
aredevice
(device, screen, memory, battery)sensors
(sensors, light, pedometer)connectivity
(connectivity, bluetooth)apps
(installed apps, app usage)
- implementation of the following external probe packages:
communication
(sms & call log)context
(location, activity, weather)audio
(noise, audio recording)movisens
(Movisens Move/ECG devices)
0.3.1 #
- small updates to the data format incl. documentation on the wiki.
- fixed error in the
stop
method.
0.3.0 - Domain Model update #
- major updates to the domain model as a
core
libraryMeasure
now have aconfiguration
- simplification to probe implementations
- all probes now uses the Dart
Stream
API and supports a reactive programming model - all probes adjusted to a stream model
- implementation of
SamplingSchema
architecture - support for power-aware sampling using different sampling schemas
0.2.6 #
- fixed small bug in
weater
probe.
0.2.5 #
- small bug fixes in connectivity datum model (to work w. `carp_firebase_backend).
weather
probe added.
0.2.4 #
- error in
light
probe fixed. noise
probe added.- using the
carp_core
domain model
0.2.3 #
- fixed error in
readme
file.
0.2.2 #
phone_log
probe addedaudio
probe addedactivity
probe added- improvement to
readme
file onmanifest.xml
andInfo.plist
.
0.2.1 #
- re-organization of github location and outline
- improvements to
FileDataManager
to avoid race conditions - improved API documentation
0.2.0 #
- refactor of organization of classes into libraries
- complete API documentation
0.1.1 #
- small improvements incl. documentation
0.1.0 #
- removal of all remote backend code to separate packages
0.0.1 #
- Initial version by Jakob E. Bardram
- Transferring the old implementation to this carp.sensing-flutter framework
- General refactor and clean-up
CARP Mobile Sensing Example #
Demonstrates how to use the carp_mobile_sensing plugin.
Getting Started #
For help getting started with Flutter, view our online documentation.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies:
carp_mobile_sensing: ^0.6.2
2. Install it
You can install packages from the command line:
with Flutter:
$ flutter pub get
Alternatively, your editor might support flutter pub get
.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
import 'package:carp_mobile_sensing/carp_mobile_sensing.dart';
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
55
|
Health:
Code health derived from static analysis.
[more]
|
97
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
90
|
Overall:
Weighted score of the above.
[more]
|
75
|
We analyzed this package on Dec 8, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.6.1
- pana: 0.12.21
- Flutter: 1.9.1+hotfix.6
Platforms
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
Health suggestions
Fix lib/sampling_packages/connectivity/connectivity_privacy.dart
. (-1 points)
Analysis of lib/sampling_packages/connectivity/connectivity_privacy.dart
reported 2 hints:
line 6 col 7: Name non-constant identifiers using lowerCamelCase.
line 19 col 7: Name non-constant identifiers using lowerCamelCase.
Fix lib/domain/serialization.dart
. (-0.50 points)
Analysis of lib/domain/serialization.dart
reported 1 hint:
line 16 col 10: Name non-constant identifiers using lowerCamelCase.
Fix lib/domain/transformers.dart
. (-0.50 points)
Analysis of lib/domain/transformers.dart
reported 1 hint:
line 19 col 28: Name non-constant identifiers using lowerCamelCase.
Fix additional 29 files with analysis or formatting issues. (-1.50 points)
Additional issues in the following files:
lib/runtime/probes.dart
(1 hint)lib/runtime/runtime.dart
(1 hint)lib/runtime/sampling_package.dart
(1 hint)lib/data_managers/local/file_data_manager.dart
(Runflutter format
to formatlib/data_managers/local/file_data_manager.dart
.)lib/domain/datapoint.dart
(Runflutter format
to formatlib/domain/datapoint.dart
.)lib/domain/datum.dart
(Runflutter format
to formatlib/domain/datum.dart
.)lib/domain/device_info.dart
(Runflutter format
to formatlib/domain/device_info.dart
.)lib/domain/measures.dart
(Runflutter format
to formatlib/domain/measures.dart
.)lib/domain/sampling_schema.dart
(Runflutter format
to formatlib/domain/sampling_schema.dart
.)lib/domain/study.dart
(Runflutter format
to formatlib/domain/study.dart
.)lib/domain/tasks.dart
(Runflutter format
to formatlib/domain/tasks.dart
.)lib/domain/triggers.dart
(Runflutter format
to formatlib/domain/triggers.dart
.)lib/runtime/data_manager.dart
(Runflutter format
to formatlib/runtime/data_manager.dart
.)lib/runtime/executors.dart
(Runflutter format
to formatlib/runtime/executors.dart
.)lib/runtime/study_controller.dart
(Runflutter format
to formatlib/runtime/study_controller.dart
.)lib/sampling_packages/apps/app_probes.dart
(Runflutter format
to formatlib/sampling_packages/apps/app_probes.dart
.)lib/sampling_packages/apps/apps.dart
(Runflutter format
to formatlib/sampling_packages/apps/apps.dart
.)lib/sampling_packages/apps/apps_datum.dart
(Runflutter format
to formatlib/sampling_packages/apps/apps_datum.dart
.)lib/sampling_packages/connectivity/connectivity_datum.dart
(Runflutter format
to formatlib/sampling_packages/connectivity/connectivity_datum.dart
.)lib/sampling_packages/connectivity/connectivity_package.dart
(Runflutter format
to formatlib/sampling_packages/connectivity/connectivity_package.dart
.)lib/sampling_packages/connectivity/connectivity_probes.dart
(Runflutter format
to formatlib/sampling_packages/connectivity/connectivity_probes.dart
.)lib/sampling_packages/device/device_datum.dart
(Runflutter format
to formatlib/sampling_packages/device/device_datum.dart
.)lib/sampling_packages/device/device_package.dart
(Runflutter format
to formatlib/sampling_packages/device/device_package.dart
.)lib/sampling_packages/device/device_probes.dart
(Runflutter format
to formatlib/sampling_packages/device/device_probes.dart
.)lib/sampling_packages/sensors/light_probe.dart
(Runflutter format
to formatlib/sampling_packages/sensors/light_probe.dart
.)lib/sampling_packages/sensors/pedometer_probe.dart
(Runflutter format
to formatlib/sampling_packages/sensors/pedometer_probe.dart
.)lib/sampling_packages/sensors/sensor_datum.dart
(Runflutter format
to formatlib/sampling_packages/sensors/sensor_datum.dart
.)lib/sampling_packages/sensors/sensor_package.dart
(Runflutter format
to formatlib/sampling_packages/sensors/sensor_package.dart
.)lib/sampling_packages/sensors/sensor_probes.dart
(Runflutter format
to formatlib/sampling_packages/sensors/sensor_probes.dart
.)
Maintenance issues and suggestions
Support latest dependencies. (-10 points)
The version constraint in pubspec.yaml
does not support the latest published versions for 1 dependency (flutter_blue
).
Dependencies
Package | Constraint | Resolved | Available |
---|---|---|---|
Direct dependencies | |||
Dart SDK | >=2.3.0 <3.0.0 | ||
app_usage | ^0.1.0 | 0.1.0 | |
archive | ^2.0.4 | 2.0.11 | |
async | ^2.0.8 | 2.4.0 | |
battery | ^0.3.0 | 0.3.1+5 | |
connectivity | ^0.4.0 | 0.4.6 | |
device_apps | ^1.0.8 | 1.0.8 | |
device_info | ^0.4.0 | 0.4.1+3 | |
flutter | 0.0.0 | ||
flutter_blue | 0.6.2 | 0.6.2 | 0.6.3+1 |
json_annotation | ^3.0.0 | 3.0.0 | |
light | ^0.1.0 | 0.1.1 | |
path_provider | ^1.2.0 | 1.5.0 | |
pedometer | ^1.0.0 | 1.0.0 | |
permission_handler | ^4.0.0 | 4.0.0 | |
screen_state | ^0.1.0 | 0.1.1 | |
sensors | ^0.4.0 | 0.4.1+3 | |
stats | ^0.2.0 | 0.2.0+3 | |
system_info | ^0.1.0 | 0.1.1 | |
uuid | ^2.0.0 | 2.0.4 | |
Transitive dependencies | |||
args | 1.5.2 | ||
charcode | 1.1.2 | ||
collection | 1.14.11 | 1.14.12 | |
convert | 2.1.1 | ||
crypto | 2.1.4 | ||
file_utils | 0.1.3 | ||
fixnum | 0.10.11 | ||
globbing | 0.3.0 | ||
meta | 1.1.7 | 1.1.8 | |
path | 1.6.4 | ||
platform | 2.2.1 | ||
protobuf | 0.14.4 | 1.0.1 | |
rxdart | 0.22.6 | 0.23.0-dev.2 | |
sky_engine | 0.0.99 | ||
typed_data | 1.1.6 | ||
vector_math | 2.0.8 | ||
Dev dependencies | |||
build_runner | any | ||
flutter_test | |||
json_serializable | ^3.0.0 | ||
test | any |