Quickstart

import 'dart:convert';

import 'package:flutter/material.dart' hide TimeOfDay;
import 'package:carp_core/carp_core.dart' hide Smartphone;
import 'package:carp_mobile_sensing/carp_mobile_sensing.dart';
import 'package:carp_survey_package/survey.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  CarpMobileSensing.ensureInitialized();

  // 1. Register the sampling package
  SamplingPackageRegistry().register(SurveySamplingPackage());

  // 2. Create a protocol with the phone as the primary device
  final protocol = SmartphoneStudyProtocol(
    ownerId: 'owner@example.com',
    name: 'Daily well-being',
    dataEndPoint: SQLiteDataEndPoint(),
  );
  final phone = Smartphone();
  protocol.addPrimaryDevice(phone);

  // 3. Add the WHO-5 survey every day at 13:00
  protocol.addTaskControl(
    RecurrentScheduledTrigger(
      type: RecurrentType.daily,
      time: const TimeOfDay(hour: 13),
    ),
    RPAppTask( 
      type: AppTask.SURVEY_TYPE,
      name: 'WHO-5 Survey',
      title: 'Well-being survey',
      description: 'Five questions about how you have been feeling',
      notification: true,
      rpTask: who5Task,
    ),
    phone,
  );

  // 4. Deploy the protocol on the first run
  final client = SmartPhoneClientManager();
  await client.configure();
  if (client.studies.isEmpty) {
    final study = await client.addStudyFromProtocol(protocol);
    await client.tryDeployment(study.studyDeploymentId, study.deviceRoleName);
  }

  // 5. Print each measurement as JSON
  client.measurements.listen((measurement) => print(jsonEncode(measurement)));

  // 6. Start sampling once CAMS has set up the study on the phone
  await startSampling(client);

  runApp(const MaterialApp(home: TaskListPage()));
}

// Resume sampling once CAMS has connected the phone, its last setup step
Future<void> startSampling(SmartPhoneClientManager client) async {
  final phoneManager = client.deviceController.getDeviceManager(
    Smartphone.DEVICE_TYPE,
  )!;
  if (!phoneManager.isConnected) {
    await phoneManager.statusEvents.firstWhere(
      (status) => status == DeviceStatus.connected,
    );
  }
  // Queue the tasks that connecting the phone scheduled, so resume() does not schedule them again
  await AppTaskController().enqueueBufferedTasks();
  client.resume();
}

// 7. List the due tasks and open a survey when the participant taps it
class TaskListPage extends StatefulWidget {
  const TaskListPage({super.key});

  @override
  State<TaskListPage> createState() => _TaskListPageState();
}

class _TaskListPageState extends State<TaskListPage> {
  late final AppLifecycleListener _lifecycle;

  @override
  void initState() {
    super.initState();
    // A scheduled task becomes due without an event, so rebuild on resume
    _lifecycle = AppLifecycleListener(onResume: () => setState(() {}));
  }

  @override
  void dispose() {
    _lifecycle.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) => Scaffold(
    appBar: AppBar(title: const Text('Tasks')),
    body: StreamBuilder<UserTask>(
      stream: AppTaskController().userTaskEvents,
      builder: (context, _) {
        final tasks = AppTaskController().userTaskQueue
            .where((task) => task.availableForUser)
            .toList();
        return ListView(
          children: [
            for (final task in tasks)
              ListTile(
                title: Text(task.title),
                subtitle: Text(task.description),
                onTap: () => _open(task),
              ),
          ],
        );
      },
    ),
  );

  void _open(UserTask task) {
    task.onStart();
    if (task.hasWidget) {
      Navigator.of(context)
          .push(MaterialPageRoute<void>(builder: (context) => task.widget!));
    }
  }
}

{
  "sensorStartTime": 1793016161231945,
  "data": {
    "__type": "dk.cachet.carp.survey",
    "status": "submitted",
    "result": {
      "__type": "RPTaskResult",
      "identifier": "who5_task",
      "startDate": "2026-10-26T13:02:05.412907",
      "endDate": "2026-10-26T13:02:41.230518",
      "results": {
        "who5_question_1": {
          "__type": "RPStepResult",
          "identifier": "who5_question_1",
          "startDate": "2026-10-26T13:02:05.498120",
          "endDate": "2026-10-26T13:02:09.871244",
          "questionTitle": "I have felt cheerful and in good spirits",
          "results": {
            "answer": [
              {
                "__type": "RPChoice",
                "text": "Most of the time",
                "value": 4,
                "isFreeText": false
              }
            ]
          },
          "answerFormat": {
            "__type": "RPChoiceAnswerFormat",
            "questionType": "SingleChoice",
            "choices": [
              { "__type": "RPChoice", "text": "All of the time", "value": 5, "isFreeText": false },
              { "__type": "RPChoice", "text": "Most of the time", "value": 4, "isFreeText": false },
              { "__type": "RPChoice", "text": "More than half of the time", "value": 3, "isFreeText": false },
              { "__type": "RPChoice", "text": "Less than half of the time", "value": 2, "isFreeText": false },
              { "__type": "RPChoice", "text": "Some of the time", "value": 1, "isFreeText": false },
              { "__type": "RPChoice", "text": "At no time", "value": 0, "isFreeText": false }
            ],
            "answerStyle": "SingleChoice"
          }
        }
      }
    }
  }
}