This is the description of the LabVIEW API bindings for the PTC Bricklet. General information and technical specifications for the PTC Bricklet are summarized in its hardware description.
An installation guide for the LabVIEW API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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.*.
Input: |
|
---|---|
Output: |
|
Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).
Output: |
|
---|
Returns the temperature of connected sensor. The value has a range of -246 to 849 °C and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
If you want to get the temperature periodically, it is recommended to use the callback Temperature and set the period with SetTemperatureCallbackPeriod().
Output: |
|
---|
Returns true if the sensor is connected correctly.
If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.
Input: |
|
---|
Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.
The default value is 2 = 2-wire.
The following constants are available for this function:
Output: |
|
---|
Returns the wire mode as set by SetWireMode()
The following constants are available for this function:
Output: |
|
---|
Returns the value as measured by the MAX31865 precision delta-sigma ADC.
The value can be converted with the following formulas:
If you want to get the resistance periodically, it is recommended to use the callback Resistance and set the period with SetResistanceCallbackPeriod().
Input: |
|
---|
Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.
Default value is 0 = 50Hz.
The following constants are available for this function:
Output: |
|
---|
Returns the noise rejection filter option as set by SetNoiseRejectionFilter()
The following constants are available for this function:
Output: |
|
---|
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.
Input: |
|
---|---|
Output: |
|
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.
Input: |
|
---|
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:
Input: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Output: |
|
---|
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.
Input: |
|
---|
Sets the period in ms with which the Temperature callback is triggered periodically. A value of 0 turns the callback off.
Temperature is only triggered if the temperature has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by SetTemperatureCallbackPeriod().
Input: |
|
---|
Sets the period in ms with which the Resistance callback is triggered periodically. A value of 0 turns the callback off.
Resistance is only triggered if the resistance has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by SetResistanceCallbackPeriod().
Input: |
|
---|
Sets the thresholds for the TemperatureReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the temperature is outside the min and max values |
'i' | Callback is triggered when the temperature is inside the min and max values |
'<' | Callback is triggered when the temperature is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the temperature is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Output: |
|
---|
Returns the threshold as set by SetTemperatureCallbackThreshold().
The following constants are available for this function:
Input: |
|
---|
Sets the thresholds for the ResistanceReached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the temperature is outside the min and max values |
'i' | Callback is triggered when the temperature is inside the min and max values |
'<' | Callback is triggered when the temperature is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the temperature is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Output: |
|
---|
Returns the threshold as set by SetResistanceCallbackThreshold().
The following constants are available for this function:
Input: |
|
---|
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by SetDebouncePeriod().
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.
Input: |
|
---|
This callback is triggered periodically with the period that is set by SetTemperatureCallbackPeriod(). The parameter is the temperature of the connected sensor.
Temperature is only triggered if the temperature has changed since the last triggering.
Input: |
|
---|
This callback is triggered when the threshold as set by SetTemperatureCallbackThreshold() is reached. The parameter is the temperature of the connected sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().
Input: |
|
---|
This callback is triggered periodically with the period that is set by SetResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.
Resistance is only triggered if the resistance has changed since the last triggering.
Input: |
|
---|
This callback is triggered when the threshold as set by SetResistanceCallbackThreshold() is reached. The parameter is the resistance of the connected sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().
This constant is used to identify a PTC 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.