Visual Basic .NET - Tilt Bricklet

This is the description of the Visual Basic .NET API bindings for the Tilt Bricklet. General information and technical specifications for the Tilt 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
25
26
27
28
29
30
31
Imports System
Imports Tinkerforge

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

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

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

        ' Get current tilt state
        Dim state As Byte = t.GetTiltState()

        If state = BrickletTilt.TILT_STATE_CLOSED Then
            Console.WriteLine("Tilt State: Closed")
        Else If state = BrickletTilt.TILT_STATE_OPEN Then
            Console.WriteLine("Tilt State: Open")
        Else If state = BrickletTilt.TILT_STATE_CLOSED_VIBRATING Then
            Console.WriteLine("Tilt State: Closed Vibrating")
        End If

        Console.WriteLine("Press key to exit")
        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
33
34
35
36
37
Imports System
Imports Tinkerforge

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

    ' Callback subroutine for tilt state callback
    Sub TiltStateCB(ByVal sender As BrickletTilt, ByVal state As Byte)
        If state = BrickletTilt.TILT_STATE_CLOSED Then
            Console.WriteLine("Tilt State: Closed")
        Else If state = BrickletTilt.TILT_STATE_OPEN Then
            Console.WriteLine("Tilt State: Open")
        Else If state = BrickletTilt.TILT_STATE_CLOSED_VIBRATING Then
            Console.WriteLine("Tilt State: Closed Vibrating")
        End If
    End Sub

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

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

        ' Enable tilt state callback
        t.EnableTiltStateCallback()

        ' Register tilt state callback to subroutine TiltStateCB
        AddHandler t.TiltStateCallback, AddressOf TiltStateCB

        Console.WriteLine("Press key to exit")
        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 BrickletTilt(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim tilt As New BrickletTilt("YOUR_DEVICE_UID", ipcon)

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

Function BrickletTilt.GetTiltState() As Byte

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

The following constants are available for this function:

  • BrickletTilt.TILT_STATE_CLOSED = 0
  • BrickletTilt.TILT_STATE_OPEN = 1
  • BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

Advanced Functions

Function BrickletTilt.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 BrickletTilt.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 BrickletTilt.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.

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:

  • BrickletTilt.FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
  • BrickletTilt.FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3
Sub BrickletTilt.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletTilt.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 BrickletTilt.EnableTiltStateCallback()

Enables the TiltStateCallback callback.

Sub BrickletTilt.DisableTiltStateCallback()

Disables the TiltStateCallback callback.

Function BrickletTilt.IsTiltStateCallbackEnabled() As Boolean

Returns true if the TiltStateCallback callback is enabled.

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 MyCallback(ByVal sender As BrickletTilt, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler tilt.ExampleCallback, AddressOf MyCallback

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 BrickletTilt.TiltStateCallback(ByVal sender As BrickletTilt, ByVal state As Byte)

This callback provides the current tilt state. It is called every time the state changes.

See GetTiltState() for a description of the states.

The following constants are available for this function:

  • BrickletTilt.TILT_STATE_CLOSED = 0
  • BrickletTilt.TILT_STATE_OPEN = 1
  • BrickletTilt.TILT_STATE_CLOSED_VIBRATING = 2

Constants

Const BrickletTilt.DEVICE_IDENTIFIER

This constant is used to identify a Tilt 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.

Const BrickletTilt.DEVICE_DISPLAY_NAME

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