LabVIEW - Heart Rate Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# LabVIEW - Heart Rate Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the LabVIEW API bindings for the Heart Rate Bricklet. General information and technical specifications for the Heart Rate Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

## Examples

The example code below is Public Domain (CC0 1.0).

## API

Generally, every method of the LabVIEW bindings that outputs a value can report a `Tinkerforge.TimeoutException`. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is `Tinkerforge.*`.

### Basic Functions

`BrickletHeartRate`(uid, ipcon) → heartRate

  Input:

  - uid -- String
  - ipcon -- .NET Refnum (IPConnection)

  Output:

  - heartRate -- .NET Refnum (BrickletHeartRate)

  Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection is connected (see examples above).

`BrickletHeartRate.``GetHeartRate`() → heartRate

  Output:

  - heartRate -- Int32

  Returns the current heart rate measured.

  If you want to get the heart rate periodically, it is recommended to use the callback `HeartRate` and set the period with `SetHeartRateCallbackPeriod()`.

### Advanced Functions

`BrickletHeartRate.``GetAPIVersion`() → apiVersion

  Output:

  - apiVersion -- Byte[3]

  Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

`BrickletHeartRate.``GetResponseExpected`(functionId) → responseExpected

  Input:

  - functionId -- Byte

  Output:

  - responseExpected -- Boolean

  Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

  For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by `SetResponseExpected()`. For setter functions it is disabled by default and can be enabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected()` for the list of function ID constants available for this function.

`BrickletHeartRate.``SetResponseExpected`(functionId, responseExpected)

  Input:

  - functionId -- Byte
  - responseExpected -- Boolean

  Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled and callbacks it is always disabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - BrickletHeartRate.FUNCTION_SET_HEART_RATE_CALLBACK_PERIOD = 2
  - BrickletHeartRate.FUNCTION_SET_HEART_RATE_CALLBACK_THRESHOLD = 4
  - BrickletHeartRate.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  - BrickletHeartRate.FUNCTION_ENABLE_BEAT_STATE_CHANGED_CALLBACK = 11
  - BrickletHeartRate.FUNCTION_DISABLE_BEAT_STATE_CHANGED_CALLBACK = 12

`BrickletHeartRate.``SetResponseExpectedAll`(responseExpected)

  Input:

  - responseExpected -- Boolean

  Changes the response expected flag for all setter and callback configuration functions of this device at once.

`BrickletHeartRate.``GetIdentity`() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier

  Output:

  - uid -- String
  - connectedUid -- String
  - position -- Char
  - hardwareVersion -- Byte[3]
  - firmwareVersion -- Byte[3]
  - deviceIdentifier -- Int32

  Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

  The position can be 'a', 'b', 'c' or 'd'.

  The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

### Callback Configuration Functions

`BrickletHeartRate.``SetHeartRateCallbackPeriod`(period)

  Input:

  - period -- Int64

  Sets the period in ms with which the `HeartRate` callback is triggered periodically. A value of 0 turns the callback off.

  `HeartRate` is only triggered if the heart rate has changed since the last triggering.

  The default value is 0.

`BrickletHeartRate.``GetHeartRateCallbackPeriod`() → period

  Output:

  - period -- Int64

  Returns the period as set by `SetHeartRateCallbackPeriod()`.

`BrickletHeartRate.``SetHeartRateCallbackThreshold`(option, min, max)

  Input:

  - option -- Char
  - min -- Int32
  - max -- Int32

  Sets the thresholds for the `HeartRateReached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the heart rate is outside the min and max values
  'i' | Callback is triggered when the heart rate is inside the min and max values
  '<' | Callback is triggered when the heart rate is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the heart rate is greater than the min value (max is ignored)

  The default value is ('x', 0, 0).

  The following constants are available for this function:

  - BrickletHeartRate.THRESHOLD_OPTION_OFF = 'x'
  - BrickletHeartRate.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletHeartRate.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletHeartRate.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletHeartRate.THRESHOLD_OPTION_GREATER = '>'

`BrickletHeartRate.``GetHeartRateCallbackThreshold`() → option, min, max

  Output:

  - option -- Char
  - min -- Int32
  - max -- Int32

  Returns the threshold as set by `SetHeartRateCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletHeartRate.THRESHOLD_OPTION_OFF = 'x'
  - BrickletHeartRate.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletHeartRate.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletHeartRate.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletHeartRate.THRESHOLD_OPTION_GREATER = '>'

`BrickletHeartRate.``SetDebouncePeriod`(debounce)

  Input:

  - debounce -- Int64

  Sets the period in ms with which the threshold callback

  - `HeartRateReached`

  is triggered, if the threshold

  - `SetHeartRateCallbackThreshold()`

  keeps being reached.

  The default value is 100.

`BrickletHeartRate.``GetDebouncePeriod`() → debounce

  Output:

  - debounce -- Int64

  Returns the debounce period as set by `SetDebouncePeriod()`.

`BrickletHeartRate.``EnableBeatStateChangedCallback`()

  Enables the `BeatStateChanged` callback.

`BrickletHeartRate.``DisableBeatStateChangedCallback`()

  Disables the `BeatStateChanged` callback.

`BrickletHeartRate.``IsBeatStateChangedCallbackEnabled`() → enabled

  Output:

  - enabled -- Boolean

  Returns true if the `BeatStateChanged` callback is enabled.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event `BrickletHeartRate.``HeartRate`(sender, heartRate)

  Input:

  - sender -- .NET Refnum (BrickletHeartRate)
  - heartRate -- Int32

  This callback is triggered periodically with the period that is set by `SetHeartRateCallbackPeriod()`. The parameter is the heart rate of the sensor.

  `HeartRate` is only triggered if the heart rate has changed since the last triggering.

event `BrickletHeartRate.``HeartRateReached`(sender, heartRate)

  Input:

  - sender -- .NET Refnum (BrickletHeartRate)
  - heartRate -- Int32

  This callback is triggered when the threshold as set by `SetHeartRateCallbackThreshold()` is reached. The parameter is the heart rate of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod()`.

event `BrickletHeartRate.``BeatStateChanged`(sender, state)

  Input:

  - sender -- .NET Refnum (BrickletHeartRate)
  - state -- Byte

  This callback provides the current heart beat state.It is called every time a heart beat is detected. The state can either be

  - 0 = Falling: The falling edge of a detected heart beat.
  - 1 = Rising: The rising edge of a detected heart beat.

  The following constants are available for this function:

  - BrickletHeartRate.BEAT_STATE_FALLING = 0
  - BrickletHeartRate.BEAT_STATE_RISING = 1

### Constants

`BrickletHeartRate.``DEVICE_IDENTIFIER`

  This constant is used to identify a Heart Rate Bricklet.

  The `GetIdentity()` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.