BLEHeartRateDevice class
A BLEDevice that implements the standard GATT Heart Rate service (https://www.bluetooth.com/specifications/gatt/services/).
Supports the heart rate, interbeat interval, and skin contact measures of
CarpDataTypes. If no service UUIDs are specified, the standard Heart Rate
service UUID (0x180D) is used.
- Inheritance
-
- Object
- Serializable
- DeviceConfiguration<
BLEDeviceRegistration> - CamsDevice<
BLEDeviceRegistration> - BLEDevice<
BLEDeviceRegistration> - BLEHeartRateDevice
- Annotations
-
- @JsonSerializable.new(includeIfNull: false, explicitToJson: true)
Constructors
Properties
- $type ↔ String?
-
The type name written to
__typein JSON; set tojsonTypeon creation.getter/setter pairinherited - allowDuplicates ↔ bool
-
Whether to receive repeated scan results for the same device.
Useful for RSSI updates. Default is
true.getter/setter pairinherited - dataTypeSamplingSchemes → DataTypeSamplingSchemeMap?
-
Sampling schemes for all the sensors available on this device.
no setteroverride
-
defaultSamplingConfiguration
↔ Map<
String, SamplingConfiguration> ? -
Sampling configurations which override the default configurations for
data types available on this device, mapped by data type.
getter/setter pairinherited
- fromJsonFunction → Function
-
The generated function that converts a JSON map to an object of this type.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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 pairinherited
- jsonType → String
-
The
__typeused for JSON serialization of this class.no setterinherited - minRssi ↔ int?
-
Minimum RSSI (dBm) to accept, for example: -80.
getter/setter pairinherited
- namePrefix ↔ String?
-
Optional device name filter (substring match, case-insensitive).
Applied AFTER discovery, not at the BLE controller level.
getter/setter pairinherited
- roleName ↔ String
-
A name which describes how the device participates within the study protocol;
its 'role'. For example, 'Parent's phone' or 'Child phone'.
Must be unique within a protocol.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceUuids
↔ List<
String> -
Advertised service UUIDs to filter for. Empty means no filter.
getter/setter pairinherited
-
supportedDataTypes
→ Set<
String> ? -
The set of data types which can be collected on this device.
no setterinherited
- timeout ↔ Duration?
-
Scan timeout. If
null, the scan has no timeout.getter/setter pairinherited - type → String
-
The device type identifier, i.e. its
jsonType.no setterinherited
Methods
-
acceptedRegistration(
DeviceRegistration registration) → DeviceRegistration -
The
registrationin the form the deployment service accepts for this device.inherited -
createRegistration(
{String? deviceId, String? deviceDisplayName}) → BLEDeviceRegistration -
Create a
DeviceRegistrationwhich can be used to configure this device for deployment.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON map of this object, including the
__typeproperty.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited