DeviceConfiguration<TRegistration extends DeviceRegistration> class

Describes any type of electronic device, such as a sensor, video camera, desktop computer, or smartphone that collects data which can be incorporated into the platform after it has been processed by a primary device (potentially itself). Optionally, a device can present output and receive user input.

Inheritance

• Object
• Serializable
• DeviceConfiguration

Implementers

• AltBeacon
• BLEHeartRateDevice
• DefaultDeviceConfiguration
• PrimaryDeviceConfiguration

Annotations

• @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

DeviceConfiguration({required String roleName, bool? isOptional})

DeviceConfiguration.fromJson(Map<String, dynamic> json)

factory

Properties

$type ↔ String?

The runtime class name (type) of this object. Used for deserialization from JSON objects.

getter/setter pair, inherited

dataTypeSamplingSchemes → DataTypeSamplingSchemeMap?

Sampling schemes for all the sensors available on this device.

no setter

defaultSamplingConfiguration ↔ Map<String, SamplingConfiguration>?

Sampling configurations which override the default configurations for data types available on this device.

getter/setter pair

fromJsonFunction → Function

The function which can convert a JSON string to an object of this type.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

isOptional ↔ bool?

Determines whether device registration for this device is optional prior to starting a study, i.e., whether the study can run without this device or not.

getter/setter pair

jsonType → String

Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.

no setter, override

roleName ↔ String

A name which describes how the device participates within the study protocol; it's 'role'. For example, 'Parent's phone' or 'Child phone'.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

supportedDataTypes → Set<String>?

The set of data types which can be collected on this device.

no setter

type → String

The device type identifier

no setter

Methods

createRegistration({String? deviceId, String? deviceDisplayName}) → TRegistration

Create a DeviceRegistration which can be used to configure this device for deployment.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Return a JSON encoding of this object.

override

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

DEVICE_NAMESPACE → const String