CARP Data Backend

This package supports uploading of data from the CARP Mobile Sensing Framework to the CARP web service backend.

For Flutter plugins for other CARP products, see CARP Mobile Sensing in Flutter.

Upload of sensing data to the CARP web service can be done in four different ways:

as CARP data points
as a CARP object in a collection
as a file to the CARP file store
batch upload

Using the Plugin

Add carp_backend as a dependency in your pubspec.yaml file and import the library along with the carp_core library.

import 'package:carp_core/carp_core.dart';
import 'package:carp_backend/carp_backend.dart';

Using the library takes three steps.

1. Register the Data Manager

First you should register the data manager in the DataManagerRegistry.

DataManagerRegistry.register(DataEndPointType.CARP, new CarpDataManager());

2. Create a CARP Data Endpoint

Create a CarpDataEndPoint that specify which method to use for upload of data, and the details. Upload methods are defined in the CarpUploadMethod class.

For example, a CarpDataEndPoint that upload data points directly looks like this:

CarpDataEndPoint cdep = CarpDataEndPoint(CarpUploadMethod.DATA_POINT,
      name: 'CARP Staging Server',
      uri: uri,
      clientId: clientID,
      clientSecret: clientSecret,
      email: username,
      password: password);

A CarpDataEndPoint that uploads data as zipped files and keeps the file on the phone, looks like this:

  CarpDataEndPoint cdep = CarpDataEndPoint(CarpUploadMethod.FILE,
      name: 'CARP Staging Server',
      uri: uri,
      clientId: clientID,
      clientSecret: clientSecret,
      email: username,
      password: password,
      bufferSize: 500 * 1000,
      zip: true
      deleteWhenUploaded: false);

And a CarpDataEndPoint that batch uploads data points in a json file (which is deleted when uploaded) looks like this:

  CarpDataEndPoint cdep = CarpDataEndPoint(CarpUploadMethod.BATCH_DATA_POINT,
      name: 'CARP Staging Server',
      uri: uri,
      clientId: clientID,
      clientSecret: clientSecret,
      email: username,
      password: password,
      bufferSize: 500 * 1000
      deleteWhenUploaded: true);

3. Assign the CARP Data Endpoint to your Study

To use the CARP Data Endpoint in you study, assign it to the study. And then start the study.

  Study study = new Study(testStudyId, username, name: "Test study #$testStudyId");
  study.dataEndPoint = cdep;
  
  // create a new executor, initialize it, and start it
  executor = new StudyExecutor(study);
  executor.initialize();
  executor.start();

Features and bugs

Please file feature requests and bug reports at the issue tracker.

carp_backend package