Visual Basic .NET - PTC Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Visual Basic .NET - PTC Bricklet

This is the description of the Visual Basic .NET 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 Visual Basic .NET API bindings is part of their general description.

## Examples

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

### Simple

Download (ExampleSimple.vb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24

    Imports Tinkerforge

    Module ExampleSimple
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "XYZ" ' Change to your UID

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim ptc As New BrickletPTC(UID, ipcon) ' Create device object

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

            ' Get current temperature (unit is °C/100)
            Dim temperature As Integer = ptc.GetTemperature()

            System.Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

### Callback

Download (ExampleCallback.vb)

     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

    Imports Tinkerforge

    Module ExampleCallback
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "XYZ" ' Change to your UID

        ' Callback function for temperature callback (parameter has unit °C/100)
        Sub TemperatureCB(ByVal sender As BrickletPTC, ByVal temperature As Integer)
            System.Console.WriteLine("Temperature: " + (temperature/100.0).ToString() + " °C")
        End Sub

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim ptc As New BrickletPTC(UID, ipcon) ' Create device object

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

            ' Set Period for temperature callback to 1s (1000ms)
            ' Note: The temperature callback is only called every second if the
            '       temperature has changed since the last call!
            ptc.SetTemperatureCallbackPeriod(1000)

            ' Register temperature callback to function TemperatureCB
            AddHandler ptc.Temperature, AddressOf TemperatureCB

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

### Threshold

Download (ExampleThreshold.vb)

     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

    Imports Tinkerforge

    Module ExampleThreshold
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "XYZ" ' Change to your UID

        ' Callback for temperature greater than 30 °C
        Sub ReachedCB(ByVal sender As BrickletPTC, ByVal temperature As Integer)
            System.Console.WriteLine("We have: " + (temperature/100.0).ToString() + " °C")
            System.Console.WriteLine("It is too hot, we need air conditioning!")
        End Sub

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim ptc As New BrickletPTC(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)
            ptc.SetDebouncePeriod(10000)

            ' Register threshold reached callback to function ReachedCB
            AddHandler ptc.TemperatureReached, AddressOf ReachedCB

            ' Configure threshold for "greater than 30 °C" (unit is °C/100)
            ptc.SetTemperatureCallbackThreshold(">"C, 30*100, 0)

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

## API

Since Visual Basic .NET does not support multiple return values directly, we use the `ByRef` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

### Basic Functions

Class `BrickletPTC`(ByVal uid As String, ByVal ipcon As IPConnection)

  Creates an object with the unique device ID `uid`:

      Dim ptc As New BrickletPTC("YOUR_DEVICE_UID", ipcon)

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

Function `BrickletPTC.``GetTemperature`() As Integer

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

Function `BrickletPTC.``IsSensorConnected`() As 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.

Sub `BrickletPTC.``SetWireMode`(ByVal mode As Byte)

  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:

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

Function `BrickletPTC.``GetWireMode`() As Byte

  Returns the wire mode as set by `SetWireMode()`

  The following constants are available for this function:

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

### Advanced Functions

Function `BrickletPTC.``GetResistance`() As Integer

  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 callback `Resistance` and set the period with `SetResistanceCallbackPeriod()`.

Sub `BrickletPTC.``SetNoiseRejectionFilter`(ByVal filter As Byte)

  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:

  - BrickletPTC.FILTER_OPTION_50HZ = 0
  - BrickletPTC.FILTER_OPTION_60HZ = 1

Function `BrickletPTC.``GetNoiseRejectionFilter`() As Byte

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

  The following constants are available for this function:

  - BrickletPTC.FILTER_OPTION_50HZ = 0
  - BrickletPTC.FILTER_OPTION_60HZ = 1

Function `BrickletPTC.``GetAPIVersion`() As Byte()

  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.

Function `BrickletPTC.``GetResponseExpected`(ByVal functionId As Byte) As 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 send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected()` for the list of function ID constants available for this function.

Sub `BrickletPTC.``SetResponseExpected`(ByVal functionId As Byte, ByVal responseExpected As 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 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:

  - 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

Sub `BrickletPTC.``SetResponseExpectedAll`(ByVal responseExpected As Boolean)

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

Sub `BrickletPTC.``GetIdentity`(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

  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.

### Callback Configuration Functions

Sub `BrickletPTC.``SetTemperatureCallbackPeriod`(ByVal period As Long)

  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.

Function `BrickletPTC.``GetTemperatureCallbackPeriod`() As Long

  Returns the period as set by `SetTemperatureCallbackPeriod()`.

Sub `BrickletPTC.``SetResistanceCallbackPeriod`(ByVal period As Long)

  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.

Function `BrickletPTC.``GetResistanceCallbackPeriod`() As Long

  Returns the period as set by `SetResistanceCallbackPeriod()`.

Sub `BrickletPTC.``SetTemperatureCallbackThreshold`(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

  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:

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

Sub `BrickletPTC.``GetTemperatureCallbackThreshold`(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

  Returns the threshold as set by `SetTemperatureCallbackThreshold()`.

  The following constants are available for this function:

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

Sub `BrickletPTC.``SetResistanceCallbackThreshold`(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

  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:

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

Sub `BrickletPTC.``GetResistanceCallbackThreshold`(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

  Returns the threshold as set by `SetResistanceCallbackThreshold()`.

  The following constants are available for this function:

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

Sub `BrickletPTC.``SetDebouncePeriod`(ByVal debounce As Long)

  Sets the period in ms with which the threshold callback

  - `TemperatureReached`,
  - `ResistanceReached`

  is triggered, if the threshold

  - `SetTemperatureCallbackThreshold()`,
  - `SetResistanceCallbackThreshold()`

  keeps being reached.

  The default value is 100.

Function `BrickletPTC.``GetDebouncePeriod`() As Long

  Returns the debounce period as set by `SetDebouncePeriod()`.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

>     Sub Callback(ByVal sender As BrickletPTC, ByVal value As Short)
>         Console.WriteLine("Value: {0}", value)
>     End Sub

>     AddHandler ptc.Example, AddressOf Callback

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.

Event `BrickletPTC.``Temperature`(ByVal sender As BrickletPTC, ByVal temperature As Integer)

  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.

Event `BrickletPTC.``TemperatureReached`(ByVal sender As BrickletPTC, ByVal temperature As Integer)

  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.``Resistance`(ByVal sender As BrickletPTC, ByVal resistance As Integer)

  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.

Event `BrickletPTC.``ResistanceReached`(ByVal sender As BrickletPTC, ByVal resistance As Integer)

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

### Constants

Const `BrickletPTC.``DEVICE_IDENTIFIER`

  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.

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