Python - 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 Python 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 Python API bindings is part of their general description.

Examples

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

Simple

Download (example_simple.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#!/usr/bin/env python
# -*- coding: utf-8 -*-  

HOST = "localhost"
PORT = 4223
UID = "abc" # Change to your UID

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_heart_rate import HeartRate

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    hr = HeartRate(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get current heart rate (unit is beats per minute)
    hrate = hr.get_heart_rate()

    print('Heart Rate: ' + str(hrate) + ' bpm')

    raw_input('Press key to exit\n') # Use input() in Python 3
    ipcon.disconnect()

Callback

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#!/usr/bin/env python
# -*- coding: utf-8 -*-  

HOST = "localhost"
PORT = 4223
UID = "abc" # Change to your UID

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_heart_rate import HeartRate

# Callback function for heart rate callback (unit is beats per minute)
def cb_heart_rate(hrate):
    print('Heart Rate: ' + str(hrate) + ' bpm')

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    hr = HeartRate(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected
    # Set Period for heart rate callback to 1s (1000ms)
    # Note: The callback is only called every second if the 
    #       heart rate has changed since the last call!
    hr.set_heart_rate_callback_period(1000)

    # Register heart rate callback to function cb_heart_rate
    hr.register_callback(hr.CALLBACK_HEART_RATE, cb_heart_rate)
    
    raw_input('Press key to exit\n') # Use input() in Python 3
    ipcon.disconnect()

Threshold

Download (example_threshold.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
#!/usr/bin/env python
# -*- coding: utf-8 -*-  

HOST = "localhost"
PORT = 4223
UID = "abc" # Change to your UID

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_heart_rate import HeartRate

# Callback function for heart rate reached callback (unit is beats per minute)
def cb_reached(hrate):
    print('Heart rate reached...')
    print('Heart Rate(bpm): ' + str(hrate))
    print('')

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    hr = HeartRate(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    hr.set_debounce_period(10000)

    # Register threshold reached callback to function cb_reached
    hr.register_callback(hr.CALLBACK_HEART_RATE_REACHED, cb_reached)

    # Configure threshold "greater than 90 bpm"
    hr.set_heart_rate_callback_threshold('>', 90, 0)
    
    raw_input('Press key to exit\n') # Use input() in Python 3
    ipcon.disconnect()

API

Generally, every method of the Python bindings can throw an tinkerforge.ip_connection.Error exception that has a value and a description property. value can have different values:

  • Error.TIMEOUT = -1
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11

All methods listed below are thread-safe.

Basic Functions

HeartRate(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

heart_rate = HeartRate("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

HeartRate.get_heart_rate()
Return type:int

Returns the current heart rate measured.

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

Advanced Functions

HeartRate.get_api_version()
Return type:[int, int, int]

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.

HeartRate.get_response_expected(function_id)
Parameters:function_id -- int
Return type:bool

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 set_response_expected(). 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 set_response_expected() for the list of function ID constants available for this function.

HeartRate.set_response_expected(function_id, response_expected)
Parameters:
  • function_id -- int
  • response_expected -- bool
Return type:

None

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:

  • HeartRate.FUNCTION_SET_HEART_RATE_CALLBACK_PERIOD = 2
  • HeartRate.FUNCTION_SET_HEART_RATE_CALLBACK_THRESHOLD = 4
  • HeartRate.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • HeartRate.FUNCTION_ENABLE_BEAT_STATE_CHANGED_CALLBACK = 11
  • HeartRate.FUNCTION_DISABLE_BEAT_STATE_CHANGED_CALLBACK = 12
HeartRate.set_response_expected_all(response_expected)
Parameters:response_expected -- bool
Return type:None

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

HeartRate.get_identity()
Return type:(str, str, chr, [int, int, int], [int, int, int], int)

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.

The returned namedtuple has the variables uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

HeartRate.register_callback(id, callback)
Parameters:
  • id -- int
  • callback -- callable
Return type:

None

Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

HeartRate.set_heart_rate_callback_period(period)
Parameters:period -- int
Return type:None

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

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

The default value is 0.

HeartRate.get_heart_rate_callback_period()
Return type:int

Returns the period as set by set_heart_rate_callback_period().

HeartRate.set_heart_rate_callback_threshold(option, min, max)
Parameters:
  • option -- chr
  • min -- int
  • max -- int
Return type:

None

Sets the thresholds for the CALLBACK_HEART_RATE_REACHED 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:

  • HeartRate.THRESHOLD_OPTION_OFF = 'x'
  • HeartRate.THRESHOLD_OPTION_OUTSIDE = 'o'
  • HeartRate.THRESHOLD_OPTION_INSIDE = 'i'
  • HeartRate.THRESHOLD_OPTION_SMALLER = '<'
  • HeartRate.THRESHOLD_OPTION_GREATER = '>'
HeartRate.get_heart_rate_callback_threshold()
Return type:(chr, int, int)

Returns the threshold as set by set_heart_rate_callback_threshold().

The following constants are available for this function:

  • HeartRate.THRESHOLD_OPTION_OFF = 'x'
  • HeartRate.THRESHOLD_OPTION_OUTSIDE = 'o'
  • HeartRate.THRESHOLD_OPTION_INSIDE = 'i'
  • HeartRate.THRESHOLD_OPTION_SMALLER = '<'
  • HeartRate.THRESHOLD_OPTION_GREATER = '>'

The returned namedtuple has the variables option, min and max.

HeartRate.set_debounce_period(debounce)
Parameters:debounce -- int
Return type:None

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

HeartRate.get_debounce_period()
Return type:int

Returns the debounce period as set by set_debounce_period().

HeartRate.enable_beat_state_changed_callback()
Return type:None

Enables the CALLBACK_BEAT_STATE_CHANGED callback.

HeartRate.disable_beat_state_changed_callback()
Return type:None

Disables the CALLBACK_BEAT_STATE_CHANGED callback.

HeartRate.is_beat_state_changed_callback_enabled()
Return type:bool

Returns true if the CALLBACK_BEAT_STATE_CHANGED callback is enabled.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

def my_callback(param):
    print(param)

heart_rate.register_callback(HeartRate.CALLBACK_EXAMPLE, my_callback)

The available constants with inherent number and 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.

HeartRate.CALLBACK_HEART_RATE
Parameters:heart_rate -- int

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

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

HeartRate.CALLBACK_HEART_RATE_REACHED
Parameters:heart_rate -- int

This callback is triggered when the threshold as set by set_heart_rate_callback_threshold() 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 set_debounce_period().

HeartRate.CALLBACK_BEAT_STATE_CHANGED
Parameters:state -- int

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:

  • HeartRate.BEAT_STATE_FALLING = 0
  • HeartRate.BEAT_STATE_RISING = 1

Constants

HeartRate.DEVICE_IDENTIFIER

This constant is used to identify a Heart Rate Bricklet.

The get_identity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

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