carp_mobile_sensing 1.13.1

carp_mobile_sensing: ^1.13.1 copied to clipboard

• Fix of #491
• Fix of #492
• Fix of #493
• Fix of #494
• Fix of #498

• deprecating the ONE_TIME_SENSING_TYPE - now there is only one type of sensing user task (#488)

• upgrade of Android APK
• bumped minimum Flutter SDK requirement to 3.3
• upgrade of plugins to latest versions
• Fix of #470
• upgrade to latest Flutter plugins
• Fix of #481
• Fix of #482

• Support for the NoUserTaskTrigger (issue #453)

• Fix of issue with restarting data collection on device reconnect (issue #442)
• Added timestamps to user tasks when completed (issue #441)

• Extended the SmartphoneStudy and SmartphoneDeployment to hold info on participant ID and participant role for a study running on the phone. This helps upload participant data (like informed consent) without the need to specify this every time.
• Fix of #429
• Fix of #430
• Fix of #431
• Fix of #437

• Upgrade to carp_core v. 1.8 & carp_serialization v. 2.0
• Type safe fromJson() methods & nested json serialization
• Upgrade of example app to use new Flutter Android Gradle build setup

• Support for handling permission on a Measure level #407.

• Fix of #408

• Added support for extension of triggers, #403. See the section on Adding new Trigger on the CAMS wiki.
• Refactor of the software architecture to align better with a domain-driven design architecture.
• Improvements to executor state machine (can only restart an executor/probe that is already started)

• Fix of #390

• Refactor task and notification enqueueing process:
  • Move from sequential scheduling for each TaskControl to buffering tasks in AppTaskController.
  • Buffered tasks are sorted by time and scheduled in batches based on platform limits (iOS and Android notification limits).
• Enhance consistency in task scheduling:
  • Ensured all necessary tasks in the foreseeable future are queued.
  • Prevent task and notification drops due to notification slot limitations.
• Resolve issue with duplicate tasks being scheduled:
  • Ensure tasks are stored in the database after being scheduled the first time.

• Improvement to removing studies (linked to issue #283 in the CARP Studies App)
  • adding a new "disposed" sensing state
  • removing study deployment runtime
  • better handling of restarting sampling on device reconnection
• Upgrade of carp_serialization and carp_core
• Getting rid of uuid package dependency
• Fix of #394

• Automatically stopping a background task if all of its underlying probes have stopped (fix of 384)
• Upgrade to carp_core v. 1.5.0 (getting rid of IsoDuration)

• Improvements to the Notification Controller
  • support app-specific methods to create, schedule, and cancel app-specific notifications
  • asks for permission on Android (Issue #375)
  • tapping a notification takes the user to the right task in the app (Issue #376)
• Fix of #379

• Improvements to handling connected BLE devices
• Improvement to triggers and probes using BLE devices
• Improvements to restarting sampling on device reconnect
• Upgrade of packages

• Upgrade of plugins (battery_plus, sensor_plus, cron)
• Support for specifying ("overriding") sampling frequency in sensor measures (accelerometer, gyroscope, magnetometer) by using a IntervalSamplingConfiguration
• Improvement to executor state machine
• Improvement to restarting sampling on device (re)connection, including now also online service like the location service
• Improvements to device manager

• Upgrade to Dart 3.2
• Update to README

• Upgrade of uuid and permission_handler plugins
• Addition of a ACCELERATION_FEATURES that samples accelerometer readings over a sampling period and calculates a set of statistical features (Issue 336 & 347)
• Removal of support for awesome_notifications which does not compile on iOS
• Improvements to API docs
• Removal of toString() methods on data points - if you want to print data, print the json generated from the toJson() method.
• Rename of TransformerSchemaRegistry to DataTransformerSchemaRegistry

• Battery stream on device controller and device managers
• Support for creating, scheduling, and cancelling generic text-based notifications in the notification controller
• A device manager can now specify and handle its required permissions

• Added support for restoring a SmartPhoneClientManager on app restart
• A privacySchemaName is moved to be part of the SmartphoneStudyProtocol configuration.
• Simplification of API so that a simple local study can be configured, initialized, and started in one statement (without the need for understanding the whole deployment architecture).

Note: This release has breaking changes.

• The first stable release of CARP Mobile Sensing which follows the carp.core-kotlin v. 1.1.0 domain model, which again is implemented in the carp_core v. 1.1.0 Dart Domain model.

• This entails a set of breaking changes to the domain model:

  • CARP cores now comes with a range of pre-defined Measure Types (e.g., geolocation, stepcount, etc.). These CARP Core measures has replaced the previous CAMS versions of these. However, most of the "old" measures are kept, so there should be backward compatibility.
  • Important new measure types are the TriggeredTask, CompletedTask, which now automatically collected data on when and how a trigger and task are done.
  • A Heartbeat measurement has been added, which sends a measure every 5 minutes for each device (incl. the phone), if connected. This can be used to retrospectively check if sampling has been running (typically used in our so-called Coverage tests).
  • In the protocol, triggering is now controlled by the Control class, which basically states if sampling should be started or stopped. So, instead of adding a TriggeredTask to a protocol you now add a TaskControl instead.
  • As part of this, the states of sampling has changed from "resumed" and "paused" to "started" and "stopped" (to reflect the Control state of a TaskControl).
  • Configuration of sampling is done using the SamplingConfiguration which can be part of a DataTypeSamplingScheme which again can be part of a DataTypeSamplingSchemeMap. A description of how this works is on the CARP Core description of Sampling Schemes and Configuration section. Note that sampling configurations can be associated both with a Measure, with a DeviceConfiguration for a device, and with a SamplingPackage.

• The new data sub-system has been implemented in CAMS. This entails:

  • Sampled data is now stored as Data objects which again are stored as part of a Measurement (this replaces the old DataPoint data model).
  • Measurements are streamed using the measurements stream which is accessible from the SmartphoneDeploymentController.
  • Measurements can be stored or managed by a DataManager. CAMS comes with two build-in data managers: the FileDataManager and the SQLiteDataManager.

• The UserTask is no longer responsible for showing the user interface of the task. Now, instead of showing the user interface, the onStart methods now returns a Widget to be shown. In this model, the app (and not CAMS) is responsible for deciding when and how to show the user interface. This entails that the the life cycle methods of onStart, onCancel, onExpired, and onDone no longer takes the Flutter BuildContext as a parameter. Read more on the AppTask and UserTask model on the CAMS wiki.

• Other smaller changes include:

  • Use the CarpMobileSensing.ensureInitialized() static method in your main method to ensure that CAMS is initialized before use.
  • Update of AppDelegate.swift in example app to handle notifications in the background.
  • Adding info, warning, and debug information to the system log (instead of the console) using colors for better reading.

• Added support for timezone data type (issue #301).
• fix of JsonKey annotations

• Better support for removing a study deployment from a client manager
  • Refactor of DataManager interfaces; file, sqlite, etc. to support multiple deployments on the same client.
  • NotificationController now cancels notifications for a study which is removed.
  • Removal of tasks from the AppTaskController.
• Support for local caching of files while keeping sampled data
• fix of JsonKey annotations

• Fix of issue #305.

• Adding dispose, pause, and remove life cycle methods to the DeploymentController
• Support for deleting cached runtime information (deployment and task list)
• Fix of bug in getTaskExecutor method

• Fix of BufferingUserAccelerometerProbe error.

• Addition of USER_ACCELEROMETER measure (issue #283).
• Added the FunctionTask task type which can executed a Dart function when resumed (issue #284).
• Support for application-specific data / configuration in the SmartphoneStudyProtocol (issue #285).

• Fix of issue #280.

• Added convenience method addStudyProtocol to SmartPhoneClientManager and updated examples accordingly.

• Added the UserTaskTrigger trigger.
• Added the magnetometer measure type.
• Upgrade of device_info_plus v. ^8.0.0
• Upgrade to carp_core v. 0.40.3

• Upgrade to carp_core v. 0.40.2
• Fix of issue #269.

• One purpose of this release is to make CAMS more stable across app re-restart (since the OSs (Android / iOS) increasingly are killing apps). This has lead to the following changes:
  • MarkedMeasure is no longer a separate measure type. The state of all measure are now saved across app restart.
  • A OneTimeTrigger no longer needs an id (this is now handled behind-the-scene).
  • All AppTask are now scheduled persistently using the notification system. When an app task is due, a notification is made on the phone, and when the user taps this notification, the app is (re)started.
  • As part of this, CAMS now asks for permissions to use notifications on the phone (if the SmartphoneDeploymentControlleris configured to use notifications).
• Another purpose is to change the configuration of the measures in the study protocol to resemble the newly released version 1.0.0 of the CARP Core Framework (Note, however, that CAMS is not yet updated to version 1.0.0 of CARP Core - this will happen in the next release). This entails:
  • Measure no longer contains sampling configurations but only specifies the type of data to collect (e.g., dk.cachet.carp.memory)
  • instead, sampling configuration is now done in the SamplingConfiguration and SamplingScheme classes (which can be part of a StudyProtocol).
  • default sampling configuration are now part of a SamplingSchema provided by the SamplingPackage. For example, periodic sampling in e.g. the MemoryProbe is configured using a PeriodicSamplingConfiguration in the DeviceSamplingPackage.
  • improved support for supporting 'connected devices' such as a wearable ECG monitor or an online weather service. This is configured using specialized DeviceDescriptor classes.
• Added support for storing data in a SQLite database using a SQLiteDataEndPoint data endpoint.
• Upgrade to Android compileSdkVersion 33. Make sure to update the android/app/build.gradle file and set the compileSdkVersion to 33.
• Upgraded to Dart 2.17 and Flutter 3.0
• Refactoring to comply to official Dart recommended lint rules
• Additional refactoring include:
  • DeploymentDelayedTrigger has been removed. Use ElapsedTimeTrigger.
  • RecurrentScheduledTrigger no longer supports the remember feature. Persistent sampling for app tasks is now supported by the persistent sampling configuration across app re-start as described above.
  • AutomaticTask is replaced by the BackgroundTask from carp_core.

• upgrade to carp_core v. 0.33.0
• support of new device model, incl. configuration of devices with device descriptors
• BREAKING - the SmartphoneDeploymentController no longer automatically deploys the study when calling addStudy().
  • make sure to call the tryDeployment() method when you want the deployment to happen.
• the factory method for getting default sampling schemes (common, debug, etc.) are now instance members (rather than functions) on the singleton SamplingPackageRegistry.
• upgrade to permission_handler: ^9.2.0

• added OneTimeTrigger as a new trigger type.
• timestamp is now enforced (not null) on all Datum objects.

• notifications are no longer (re-)send when the app task queue is restored across app restart.

• upgrade to permission_handler: ^8.3.0
• NOTE
  • see the permission_handler README on how to set up your app - for example:
  • on Android, in build.graddle set compileSdkVersion 31
  • on iOS, add permission to your Info.plist file and update the Podfile

• support for a ConditionalPeriodicTrigger which preiodically checks resume/pause conditions (originates from #230).
• PeriodicTrigger now required a sampling duration.
• upgrade of pubspec libaries (flutter_local_notifications, cron, and json).
• re-generation of json serialization
• still cannot upgrade permission_handler since 8.2.0 gives a graddle compile error?????

• bug fix of #221.

• A CAMS-specific StudyProtocol named SmartphoneStudyProtocol has been reintroduced (c.f., v. 0.30.0). It turned out that there are several things which needs to be configured as part of a study protocol, which the generic StudyProtocol from carp_core doesn't support. The new SmartphoneStudyProtocol supports specifying:
  • The StudyDescription describing the study including the researcher responsible for the study.
  • The DataEndPoint specifying where and how to upload data.
• The SmartphoneDeploymentService is updated to handle the new SmartphoneStudyProtocol.
• StudyDescription now also supports specifying the URL of a study description and the privacy policy.

• separate method for asking permissions in SmartphoneDeploymentController
• bug fix of #215 - notifications can now be enabled/disabled in the configure method of the SmartphoneDeploymentController.

• all deployment information is now stored in a folder named <local_application_path>/carp/deployments/<study_deployment_id> where local_application_path is the folder where an application can place files that are private to the application.
  • On iOS, this is the NSDocumentsDirectory and this can be accessed like accessing files on iOS via the Finder.
  • On Android, Flutter files are stored in the AppData directory, which is located in the data/data/<package_name>/app_flutter folder. Files can be accessed via AndroidStudio.

• added support for the DeploymentDelayedTrigger
• Settings now have support for storing deployment information across app restart
• added local notifications to an AppTask

• small updates to Settings
• fixed a bug in path to json files in FileDataManager
• improvement to saving task list across app re-start
• CAMSMasterDeviceDeployment renamed to SmartphoneDeployment (to allign with the other naming using Smartphone)
• StudyProtocolDescription and StudyProtocolReponsible renamed to StudyDescription and StudyReponsible
• fix of bug in storing app tasks in AppTaskController
• updates to example apps

• DebugLevel is now an enum
• support for persistenly storing AppTasks on the AppTaskController queue across app re-start

• upgrade to null-safety, carp_core v. 0.30.0
• CAMSStudyProtocol is no longer used and is replaced by StudyProtocol in carp_core
• fix of bug in RandomRecurrentTriggerExecutor (Issue #202)

• bug fix of #199

• rename of ProtocolOwner to StudyProtocolReponsible (in order not to confuse it with ownerId in StudyProtocol)

• small bug fixes
• upgrade to carp_core 0.21.4

• NOTE - DataEndPoint is no longer specified as part of a StudyProtocol.
  • Specifying where and how to store or upload data is really not part of specifying a study protocol, but rather a deployment issues. Therefore, the DataEndPoint is now part of a MasterDeviceDeployment.
  • The SmartphoneDeploymentService will use the FileDataEndpoint per default if not specified in the deployment. Hence, data is saved as files on the phone.
  • The StudyDeploymentController.configure() method now takes an optional DataEndPoint parameter to specify the data endpoint, if it should be different to what is specified in the deployment.
  • The StudyDeploymentController.configure() method also takes a askForPermissions parameter - if false, then CAMS will not ask for permissions, but hands this over to the app, which can show appropiate information to the user.
• settings are now a singleton accessed using Settings() (similar to other singletons in the framework)
• better support for handling json functions

• update to carp_core v. 0.21.2

• update to carp_core v. 0.21.0

• update to carp_core v. 0.21.0 client domain model
• support for using a SmartPhoneClientManager for executing multiple studies
• adjusted examples and example app to use the carp_core_client domain model

• Added a RandomRecurrentTrigger as a new trigger type (Issue #170)

• removed localization support again - this has to be handled on an application level, not as part of sensing.
• removed the ConsentSection also - again, this is separate to sensing.

• update to carp_core v. 0.20.3 (json serialization)

• BREAKING: Now using the carp_core domain models in order to align with the overall domain-driven design of CARP.
• This has an impact on the naming used in the API. The most important changes are:
  • Study is now called StudyProtocol and a CAMS-specific protocol called CAMSStudyProtocol is available
  • PrincipalInvestigator is now called ProtocolOwner
  • Task is now called TaskDescriptor
  • Device is now called DeviceDescriptor
  • ManualTrigger is now called PassiveTrigger
  • ScheduledTrigger is now called DateTimeTrigger
  • Measure is now called CAMSMeasure (but Measure is part of carp_core)
• A StudyProtocol now uses the concept of a TriggeredTask which is slightly different to the previous Study model. See the example.
• A CAMSStudyProtocol now supports localization. A StudyProtocolDescription and a list of ConsentSection can be added to a protocol for each locale (i.e., language code).
• Similarly, measures now also supports localization. For each CAMSMeasure there is the option to specify its MeasureDescription for each locale.
• All json serialization of a protocol now use camelCase instead of snake_case to be consistent with carp_core in Kotlin.
  • Note, however, that DataPoint objects are still serialized as snake_case json.
• All the events streams are now called data and streams DataPoint data objects (instead of just the Datum data objects).
• The DataPoint comply to version 1.2 definition (Issue #162)

• extension of Study to include purpose, title and PrincipalInvestigator

• support for canceling UserTask

• small refactor for Device model.

• feature: support for handling devices as part of a study configuration.
• refactor: rename of Device to DeviceInfo

• feature: support for storing and retrieving study json protocols on the local file system.
• refactor: the deploymentId has been removed from Study since this is CARP specific info.

• refactor: improved (de)serialization in the Serialization class.
• refactor: named constructors in the Study and Measure classes.
• feature: support for handling local settings on the phone in the Settings.
• feature: added description property to Measure.
• feature: added support for an AppTask can expire, i.e. be removed from the queue.
• fix: issue #139
• fix: issue #140

• fix: issue #123
• based on issue #134 the following measures has changed
  • periodic_accelerometer and periodic_gyroscope has been added
  • the "old" accelerometer and gyroscope measures are made to run continously
  • This implies that they need to be started and stopped using a Trigger instead.
  • This, however, open up for triggering the collection of accelerometer data as part of an AppTask. For example, sampling accelerometer data while a Parkinson's patient fill in a survey.

• BREAKING: a new AppTask model is implemented
  • see documentation on the CAMS wiki.
  • see the Pulmonary app for an example on how to use this new model.
• fix: issue #98
• fix: issue #114

• fix: issue #113

• feature: added the validNextState() method to the Probe class, which checks if a probe can be move to a next state.
• fix : issue #112
  • this means that the initialize() method is no longer a Future (and hence cannot be awaited)

• fix: issue #106.
• fix: fix of race condition in FileDataManager
• fix: small error in monthly recurrence in RecurrentScheduledTrigger
• refactor: Device() is now a singleton.

• refactor: all singleton adhering to the Dart Singleton Pattern.
  • SamplingPackageRegistry
  • ProbeRegistry
  • TransformerSchemaRegistry
  • DataManagerRegistry
• fix: fixed issue #100
• feature: support for the CronScheduledTrigger that takes a cron expression for scheduling

• fix: error in screen probe
• refactor: small pedantic formatting issues
• refactor: TransformerSchemaRegistry and SamplingPackageRegistry are now accessed using an instance singleton

• refactor: using pedantic

• refactor: new polymorphic JSON serialization using $type for class type identifier.
• docs: update of documentation and examples (#92)

• feature: support for saving ("remembering") RecurrentScheduledTrigger across app shutdown (#80)

• feature: support for monthly recurrences in RecurrentScheduledTrigger (#78)

• update: updated to the new pedometer API

• refactor: removed the Apps package and moved this to an external package

• refactor: converted from a plugin to a package by overhauling the project

• feature: support for Deployment ID in Study.
• update: upgrade to screen_state v. 1.x
• update: upgrade to Android Embedding v2.

• using the Dart Duration class in many places where duration previously was specified using miliseconds.
• added the MarkedMeasure class for creating measures that collect all measures since last time data was collected. Useful for collecting things like log entries and health data.
• added the settings global variable providing access to:
  • SharedPreferences
  • PackageInfo, and
  • a method for getting a unique, persistent user id

• added support for better logging using the DebugLevel settings

• Added trigger_id to the Trigger class.
• Made Task abstract rather than deprecated.
• Fixed issue #61.

• BREAKING: this release break some parts of the previous API.
• Extended Task model -- introduction of a AutomaticTask and AppTask.
• Added support for "manually" adding data points (Datum) and errors to the data stream (events). This is part of the StudyExecutor API.
• The start() method on all executors (probes, and study, trigger & task executors) has been removed. Now an executor is 'started' by resuming it (calling resume()).
• Fixed a bug in BufferingPeriodicStreamProbe.
• Added the FileDatum data type which can hold a reference to a file. For example, an audio file (see the carp_audio_package).

• upgrade to persmission_handler v. 5.x

• Support 1.0.0 version of stable dependencies. (dart_lsc)

• moved the connectivity sampling package to an external carp_connectivity_package due to issue#46.

• 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

• Thorough testing on iOS.
• Better handling of probes not available on iOS via the initialize method.
• Centralized concept for handling permissions.

• Extension of Study domain model to include support for Trigger, 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 and Probe
• The data manager model has been updated
  • A DataManager now expose a stream of state events as defined in DataManagerEventTypes
  • A DataManager now has a type which is a string as defined in DataEndPointTypes
  • These changes are also implemented for the file and CARP data managers.
• 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 to data_managers.

• Update of readme file.

• BREAKING 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

• 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

• minor change to the StreamProbe API - now non-static streams can be used by implementing the get stream method.
• update of the relevant sampling packages using StreamProbe

• update and rename of CARPDataPoint to DataPoint to reflect new CARP API.
• moved CARP web service specific data model to CARPDataPoint to the carp_webservices package.

• rename of packages folder to sampling_packages (seems like Dart Pub don't like folders called packages)
• rename of core folder to domain

• update to new versions of CACHET Flutter Plugins
• rename of probes folder to packages
• upgrade and test on Flutter v. 1.3.4 Dart v. 2.2.1

• support for dividing probes into separate sampling packages
• included in carp_mobile_sensing are
  • device (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)

• small updates to the data format incl. documentation on the wiki.
• fixed error in the stop method.

• major updates to the domain model as a core library
  • Measure now have a configuration
• 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

• fixed small bug in weater probe.

• small bug fixes in connectivity datum model (to work w. `carp_firebase_backend).
• weather probe added.

• error in light probe fixed.
• noise probe added.
• using the carp_core domain model

• fixed error in readme file.

• phone_log probe added
• audio probe added
• activity probe added
• improvement to readme file on manifest.xml and Info.plist.

• re-organization of github location and outline
• improvements to FileDataManager to avoid race conditions
• improved API documentation

• refactor of organization of classes into libraries
• complete API documentation

• small improvements incl. documentation

• removal of all remote backend code to separate packages

• Initial version by Jakob E. Bardram
• Transferring the old implementation to this carp.sensing-flutter framework
• General refactor and clean-up