This is the description of the Python API bindings for the Analog Out Bricklet. General information and technical specifications for the Analog Out 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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Analog Out Bricklet
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_analog_out import BrickletAnalogOut
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
ao = BrickletAnalogOut(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Set output voltage to 3.3V
ao.set_voltage(3300)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Generally, every function 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 functions listed below are thread-safe.
BrickletAnalogOut
(uid, ipcon)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
:
analog_out = BrickletAnalogOut("YOUR_DEVICE_UID", ipcon)
This object can then be used after the IP Connection is connected.
BrickletAnalogOut.
set_voltage
(voltage)¶Parameters: |
|
---|---|
Returns: |
|
Sets the voltage. Calling this function will set
the mode to 0 (see set_mode()
).
BrickletAnalogOut.
get_voltage
()¶Returns: |
|
---|
Returns the voltage as set by set_voltage()
.
BrickletAnalogOut.
set_mode
(mode)¶Parameters: |
|
---|---|
Returns: |
|
Sets the mode of the analog value. Possible modes:
set_voltage()
is applied)Setting the mode to 0 will result in an output voltage of 0 V. You can jump
to a higher output voltage directly by calling set_voltage()
.
The following constants are available for this function:
For mode:
BrickletAnalogOut.
get_mode
()¶Returns: |
|
---|
Returns the mode as set by set_mode()
.
The following constants are available for this function:
For mode:
BrickletAnalogOut.
get_identity
()¶Return Object: |
|
---|
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.
BrickletAnalogOut.
get_api_version
()¶Return Object: |
|
---|
Returns the version of the API definition 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.
BrickletAnalogOut.
get_response_expected
(function_id)¶Parameters: |
|
---|---|
Returns: |
|
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
BrickletAnalogOut.
set_response_expected
(function_id, response_expected)¶Parameters: |
|
---|---|
Returns: |
|
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.
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 sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For function_id:
BrickletAnalogOut.
set_response_expected_all
(response_expected)¶Parameters: |
|
---|---|
Returns: |
|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
BrickletAnalogOut.
DEVICE_IDENTIFIER
¶This constant is used to identify a Analog Out Bricklet.
The get_identity()
function and the
IPConnection.CALLBACK_ENUMERATE
callback of the IP Connection have a device_identifier
parameter to specify
the Brick's or Bricklet's type.
BrickletAnalogOut.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Analog Out Bricklet.