LabVIEW - PTC Bricklet¶

Simple¶

Download (Example Simple.vi)

Callback¶

Download (Example Callback.vi), Download (Example Callback - Temperature Callback.vi)

Threshold¶

Download (Example Threshold.vi), Download (Example Threshold - TemperatureReached Callback.vi)

Graph¶

Download (Example Graph.vi), Download (Example Graph - Temperature Callback.vi)

Basic Functions¶

BrickletPTC(uid, ipcon) → ptc¶

Input:	uid – Type: String ipcon – Type: .NET Refnum (IPConnection)
Output:	ptc – Type: .NET Refnum (BrickletPTC)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletPTC.GetTemperature() → temperature¶

Output:	temperature – Type: Int32, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of connected sensor.

If you want to get the temperature periodically, it is recommended to use the TemperatureCallback callback and set the period with SetTemperatureCallbackPeriod().

BrickletPTC.IsSensorConnected() → connected¶

Output:	connected – Type: Boolean

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.

BrickletPTC.SetWireMode(mode)¶

Input:	mode – Type: Byte, Range: See constants, Default: 2

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 following constants are available for this function:

For mode:

• BrickletPTC.WIRE_MODE_2 = 2
• BrickletPTC.WIRE_MODE_3 = 3
• BrickletPTC.WIRE_MODE_4 = 4

BrickletPTC.GetWireMode() → mode¶

Output:	mode – Type: Byte, Range: See constants, Default: 2

Returns the wire mode as set by SetWireMode()

The following constants are available for this function:

For mode:

• BrickletPTC.WIRE_MODE_2 = 2
• BrickletPTC.WIRE_MODE_3 = 3
• BrickletPTC.WIRE_MODE_4 = 4

Advanced Functions¶

BrickletPTC.GetResistance() → resistance¶

Output:	resistance – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

• Pt100: resistance = (value * 390) / 32768
• Pt1000: resistance = (value * 3900) / 32768

If you want to get the resistance periodically, it is recommended to use the ResistanceCallback callback and set the period with SetResistanceCallbackPeriod().

BrickletPTC.SetNoiseRejectionFilter(filter)¶

Input:	filter – Type: Byte, Range: See constants, Default: 0

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.

The following constants are available for this function:

For filter:

• BrickletPTC.FILTER_OPTION_50HZ = 0
• BrickletPTC.FILTER_OPTION_60HZ = 1

BrickletPTC.GetNoiseRejectionFilter() → filter¶

Output:	filter – Type: Byte, Range: See constants, Default: 0

Returns the noise rejection filter option as set by SetNoiseRejectionFilter()

The following constants are available for this function:

For filter:

• BrickletPTC.FILTER_OPTION_50HZ = 0
• BrickletPTC.FILTER_OPTION_60HZ = 1

BrickletPTC.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Output:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a" to "h", "z"] hardwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

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.

Callback Configuration Functions¶

BrickletPTC.SetTemperatureCallbackPeriod(period)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The TemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

BrickletPTC.GetTemperatureCallbackPeriod() → period¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetTemperatureCallbackPeriod().

BrickletPTC.SetResistanceCallbackPeriod(period)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

BrickletPTC.GetResistanceCallbackPeriod() → period¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetResistanceCallbackPeriod().

BrickletPTC.SetTemperatureCallbackThreshold(option, min, max)¶

Input:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0 max – Type: Int32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the TemperatureReachedCallback 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 following constants are available for this function:

For option:

• BrickletPTC.THRESHOLD_OPTION_OFF = "x"
• BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
• BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
• BrickletPTC.THRESHOLD_OPTION_GREATER = ">"

BrickletPTC.GetTemperatureCallbackThreshold() → option, min, max¶

Output:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0 max – Type: Int32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by SetTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletPTC.THRESHOLD_OPTION_OFF = "x"
• BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
• BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
• BrickletPTC.THRESHOLD_OPTION_GREATER = ">"

BrickletPTC.SetResistanceCallbackThreshold(option, min, max)¶

Input:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0 max – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the ResistanceReachedCallback 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 following constants are available for this function:

For option:

• BrickletPTC.THRESHOLD_OPTION_OFF = "x"
• BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
• BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
• BrickletPTC.THRESHOLD_OPTION_GREATER = ">"

BrickletPTC.GetResistanceCallbackThreshold() → option, min, max¶

Output:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0 max – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by SetResistanceCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletPTC.THRESHOLD_OPTION_OFF = "x"
• BrickletPTC.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletPTC.THRESHOLD_OPTION_INSIDE = "i"
• BrickletPTC.THRESHOLD_OPTION_SMALLER = "<"
• BrickletPTC.THRESHOLD_OPTION_GREATER = ">"

BrickletPTC.SetDebouncePeriod(debounce)¶

Input:	debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

• TemperatureReachedCallback,
• ResistanceReachedCallback

is triggered, if the threshold

• SetTemperatureCallbackThreshold(),
• SetResistanceCallbackThreshold()

keeps being reached.

BrickletPTC.GetDebouncePeriod() → debounce¶

Output:	debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

BrickletPTC.SetSensorConnectedCallbackConfiguration(enabled)¶

Input:	enabled – Type: Boolean, Default: F

If you enable this callback, the SensorConnectedCallback callback is triggered every time a Pt sensor is connected/disconnected.

New in version 2.0.2 (Plugin).

BrickletPTC.GetSensorConnectedCallbackConfiguration() → enabled¶

Output:	enabled – Type: Boolean, Default: F

Returns the configuration as set by SetSensorConnectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

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.

event BrickletPTC.TemperatureCallback → sender, temperature¶

Callback Output:	sender – Type: .NET Refnum (BrickletPTC) temperature – Type: Int32, Unit: 1/100 °C, Range: [-24600 to 84900]

This callback is triggered periodically with the period that is set by SetTemperatureCallbackPeriod(). The parameter is the temperature of the connected sensor.

The TemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

event BrickletPTC.TemperatureReachedCallback → sender, temperature¶

Callback Output:	sender – Type: .NET Refnum (BrickletPTC) temperature – Type: Int32, Unit: 1/100 °C, Range: [-24600 to 84900]

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().

event BrickletPTC.ResistanceCallback → sender, resistance¶

Callback Output:	sender – Type: .NET Refnum (BrickletPTC) resistance – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by SetResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

event BrickletPTC.ResistanceReachedCallback → sender, resistance¶

Callback Output:	sender – Type: .NET Refnum (BrickletPTC) resistance – Type: Int32, Unit: ? Ω, Range: [-231 to 231 - 1]

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().

event BrickletPTC.SensorConnectedCallback → sender, connected¶

Callback Output:	sender – Type: .NET Refnum (BrickletPTC) connected – Type: Boolean

This callback is triggered periodically according to the configuration set by SetSensorConnectedCallbackConfiguration().

The parameter is the same as IsSensorConnected().

New in version 2.0.2 (Plugin).

Virtual Functions¶

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.

BrickletPTC.GetAPIVersion() → apiVersion¶

Output:	apiVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

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.

BrickletPTC.GetResponseExpected(functionId) → responseExpected¶

Input:	functionId – Type: Byte, Range: See constants
Output:	responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
• BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
• BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
• BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
• BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
• BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
• BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

BrickletPTC.SetResponseExpected(functionId, responseExpected)¶

Input:	functionId – Type: Byte, Range: See constants responseExpected – Type: 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.

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 functionId:

• BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
• BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
• BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
• BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
• BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
• BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
• BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

BrickletPTC.SetResponseExpectedAll(responseExpected)¶

Input:	responseExpected – Type: Boolean

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

Constants¶

BrickletPTC.DEVICE_IDENTIFIER¶

This constant is used to identify a PTC Bricklet.

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

BrickletPTC.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a PTC Bricklet.