Skip to content
CARP Documentation

connectivity

A sampling package that collects network connectivity, wifi, Bluetooth and beacon data.

Register ConnectivitySamplingPackage in the SamplingPackageRegistry to use these measure types in a protocol:

  • dk.cachet.carp.connectivity - connectivity status changes (Connectivity).
  • dk.cachet.carp.wifi - the connected wifi network (Wifi).
  • dk.cachet.carp.bluetooth - nearby Bluetooth devices (Bluetooth).
  • dk.cachet.carp.beacon - nearby iBeacons in given regions (BeaconData).

Works on Android and iOS, using the Smartphone primary device. Wifi and Bluetooth names are hashed by the default PrivacySchema.

Classes

  • BeaconData — The nearby beacons found in a monitored beacon region.
  • BeaconDevice — A beacon found by ranging, as listed in BeaconData.
  • BeaconProbe — Monitors iBeacon regions and collects a BeaconData measurement listing each nearby BeaconDevice while the phone is inside a region.
  • BeaconRangingPeriodicSamplingConfiguration — A sampling configuration specifying how to scan for iBeacon devices.
  • BeaconRegion — A beacon region to monitor, as listed in BeaconRangingPeriodicSamplingConfiguration.beaconRegions.
  • Bluetooth — The nearby Bluetooth devices found in one scan.
  • BluetoothDevice — A Bluetooth device found in a scan, as listed in Bluetooth.
  • BluetoothProbe — Scans for nearby, visible Bluetooth devices and collects a Bluetooth measurement that lists each device found during the scan.
  • BluetoothScanPeriodicSamplingConfiguration — A sampling configuration specifying how to scan for Bluetooth devices on a regular basis for a specific period.
  • Connectivity — The connectivity status of the phone.
  • ConnectivityProbe — Collects a Connectivity measurement every time the phone's connectivity status changes.
  • ConnectivitySamplingPackage — The sampling package for collecting connectivity, wifi, Bluetooth and beacon data.
  • Wifi — The wifi network the phone is connected to (SSID, BSSID and IP).
  • WifiProbe — Collects the phone's wifi connection (SSID, BSSID and IP) as Wifi data.

Enums

Functions

bluetoothNameAnonymizer

Data bluetoothNameAnonymizer(
  1. Data data
)

Anonymizes a Bluetooth scan by hashing (SHA-1) the device and advertisement names of each device found.

Bluetooth device names may contain participants' real names because people use their names to name their computers and phones. Registered in the default PrivacySchema for the ConnectivitySamplingPackage.BLUETOOTH measure.

wifiNameAnonymizer

Data wifiNameAnonymizer(
  1. Data data
)

Anonymizes Wifi data by hashing (SHA-1) the network name (SSID).

Wifi network names may contain participants' or households' real names. Registered in the default PrivacySchema for the ConnectivitySamplingPackage.WIFI measure.