Skip to content
CARP Documentation

sampling_packages

The built-in CAMS sampling packages, which collect data from the phone itself.

  • DeviceSamplingPackage - information about the phone and the app. Measure types: dk.cachet.carp.deviceinformation, dk.cachet.carp.applicationinformation, dk.cachet.carp.freememory, dk.cachet.carp.batterystate, dk.cachet.carp.screenevent (Android only), dk.cachet.carp.applifecycleevent, dk.cachet.carp.timezone, and dk.cachet.carp.heartbeat.
  • SensorSamplingPackage - the basic phone sensors. Measure types: dk.cachet.carp.acceleration, dk.cachet.carp.nongravitationalacceleration, dk.cachet.carp.accelerationfeatures, dk.cachet.carp.rotation, dk.cachet.carp.magneticfield, dk.cachet.carp.ambientlight (Android only), dk.cachet.carp.stepevent, and dk.cachet.carp.stepcount.

Both run on Android and iOS (except where noted) and need no extra device: they use the Smartphone. The monitoring package (MonitoringSamplingPackage) is part of the domain library.

Classes

  • AccelerationFeatures — A set of acceleration (non-gravitational) features collected over a specific sampling period.
  • AccelerometerFeaturesProbe — Collects user accelerometer data over a sampling period and calculates a set of features from it, as an AccelerationFeatures data point.
  • AccelerometerProbe — Collects raw Acceleration (including gravity) from the accelerometer.
  • AmbientLight — Statistics of ambient light intensity, in lux, over a sampling period.
  • AppLifecycleEvent — A change in the app's AppLifecycleState.
  • AppLifecycleProbe — Collects an AppLifecycleEvent each time the app lifecycle state changes.
  • ApplicationInformation — Name, version and install information about the app collecting the data.
  • ApplicationProbe — Collects ApplicationInformation about this app once.
  • BatteryProbe — Collects battery information (charging state and battery level) on a regular basis as specified by the IntervalSamplingConfiguration.interval.
  • BatteryState — Battery level and charging status of the phone.
  • DeviceInformation — Hardware and operating system information about the phone.
  • DeviceProbe — Collects DeviceInformation about this phone once, using DeviceInfoService.
  • DeviceSamplingPackage — The built-in sampling package for collecting information about the phone and the app.
  • FreeMemory — Free physical and virtual memory on the phone.
  • GyroscopeProbe — Collects raw Rotation data from the gyroscope.
  • Heartbeat — A heartbeat sent at a fixed interval from a device.
  • HeartbeatProbe — Collects a Heartbeat from the phone at the interval given by IntervalSamplingConfiguration.interval.
  • LightProbe — Collects ambient light from the phone's light sensor, typically located near the front camera.
  • MagnetometerProbe — Collects raw MagneticField data from the magnetometer.
  • MemoryProbe — Collects free physical and virtual memory as FreeMemory on a regular basis as specified by the IntervalSamplingConfiguration.interval.
  • PedometerProbe — Collects StepEvents from the hardware step counter sensor.
  • ScreenEvent — A screen on, off or unlock event from the phone.
  • ScreenProbe — Collects screen events:
  • SensorProbe — Base class for the raw sensor probes, providing their samplingPeriod.
  • SensorSamplingPackage — The built-in sampling package for collecting data from the phone's sensors.
  • StepCountProbe — A pedometer probe reporting the total step count since last system boot, as StepCount data.
  • StepEvent — A step event as sensed by the phone's built-in pedometer.
  • Timezone — The time zone of the phone.
  • TimezoneProbe — Collects the phone's current Timezone once.
  • UserAccelerometerProbe — Collects raw Acceleration excluding gravity from the user accelerometer.