This is the description of the Python API bindings for the Sound Intensity Bricklet. General information and technical specifications for the Sound Intensity Bricklet are summarized in its hardware description.
An installation guide for the Python API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 = "XYZ" # Change to your UID
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_sound_intensity import SoundIntensity
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
si = SoundIntensity(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Get current intensity
intensity = si.get_intensity()
print('Intensity: ' + str(intensity))
raw_input('Press key to exit\n') # Use input() in Python 3
ipcon.disconnect()
|
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 31 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change to your UID
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_sound_intensity import SoundIntensity
# Callback function for intensity
def cb_intensity(intensity):
print('Intensity: ' + str(intensity))
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
si = SoundIntensity(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Set Period for intensity callback to 1s (1000ms)
# Note: The intensity callback is only called every second if the
# intensity has changed since the last call!
si.set_intensity_callback_period(1000)
# Register intensity callback to function cb_intensity
si.register_callback(si.CALLBACK_INTENSITY, cb_intensity)
raw_input('Press key to exit\n') # Use input() in Python 3
ipcon.disconnect()
|
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change to your UID
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_sound_intensity import SoundIntensity
# Callback for intensity greater than 2000
def cb_reached(intensity):
print('Intensity: ' + str(intensity))
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
si = SoundIntensity(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 1 seconds (1000ms)
si.set_debounce_period(1000)
# Register threshold reached callback to function cb_reached
si.register_callback(si.CALLBACK_INTENSITY_REACHED, cb_reached)
# Configure threshold for "greater than 2000"
si.set_intensity_callback_threshold('>', 2000, 0)
raw_input('Press key to exit\n') # Use input() in Python 3
ipcon.disconnect()
|
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:
All methods listed below are thread-safe.
Parameters: |
|
---|
Creates an object with the unique device ID uid:
sound_intensity = SoundIntensity("YOUR_DEVICE_UID", ipcon)
This object can then be used after the IP Connection is connected (see examples above).
Return type: | int |
---|
Returns the current sound intensity. The value has a range of 0 to 4095.
The value corresponds to the upper envelop of the signal of the microphone capsule.
If you want to get the intensity periodically, it is recommended to use the callback CALLBACK_INTENSITY and set the period with set_intensity_callback_period().
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.
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.
Parameters: |
|
---|---|
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:
Parameters: | response_expected -- bool |
---|---|
Return type: | None |
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
Parameters: |
|
---|---|
Return type: | None |
Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.
Parameters: | period -- int |
---|---|
Return type: | None |
Sets the period in ms with which the CALLBACK_INTENSITY callback is triggered periodically. A value of 0 turns the callback off.
CALLBACK_INTENSITY is only triggered if the intensity has changed since the last triggering.
The default value is 0.
Return type: | int |
---|
Returns the period as set by set_intensity_callback_period().
Parameters: |
|
---|---|
Return type: | None |
Sets the thresholds for the CALLBACK_INTENSITY_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the intensity is outside the min and max values |
'i' | Callback is triggered when the intensity is inside the min and max values |
'<' | Callback is triggered when the intensity is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the intensity is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Return type: | (chr, int, int) |
---|
Returns the threshold as set by set_intensity_callback_threshold().
The following constants are available for this function:
The returned namedtuple has the variables option, min and max.
Parameters: | debounce -- int |
---|---|
Return type: | None |
Sets the period in ms with which the threshold callback
is triggered, if the thresholds
keeps being reached.
The default value is 100.
Return type: | int |
---|
Returns the debounce period as set by set_debounce_period().
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)
sound_intensity.register_callback(SoundIntensity.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.
Parameters: | intensity -- int |
---|
This callback is triggered periodically with the period that is set by set_intensity_callback_period(). The parameter is the intensity of the encoder.
CALLBACK_INTENSITY is only triggered if the intensity has changed since the last triggering.
Parameters: | intensity -- int |
---|
This callback is triggered when the threshold as set by set_intensity_callback_threshold() is reached. The parameter is the intensity of the encoder.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period().
This constant is used to identify a Sound Intensity 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.