Visual Basic .NET - Motion Detector Bricklet

This is the description of the Visual Basic .NET API bindings for the Motion Detector Bricklet. General information and technical specifications for the Motion Detector 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).

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
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 Motion Detector Bricklet

    ' Callback subroutine for motion detected callback
    Sub MotionDetectedCB(ByVal sender As BrickletMotionDetector)
        Console.WriteLine("Motion Detected")
    End Sub

    ' Callback subroutine for detection cycle ended callback
    Sub DetectionCycleEndedCB(ByVal sender As BrickletMotionDetector)
        Console.WriteLine("Detection Cycle Ended (next detection possible in ~3 seconds)")
    End Sub

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

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

        ' Register motion detected callback to subroutine MotionDetectedCB
        AddHandler md.MotionDetectedCallback, AddressOf MotionDetectedCB

        ' Register detection cycle ended callback to subroutine DetectionCycleEndedCB
        AddHandler md.DetectionCycleEndedCallback, AddressOf DetectionCycleEndedCB

        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 BrickletMotionDetector(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim motionDetector As New BrickletMotionDetector("YOUR_DEVICE_UID", ipcon)

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

Function BrickletMotionDetector.GetMotionDetected() As Byte

Returns 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see here.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the "motion detected" state.

The following constants are available for this function:

  • BrickletMotionDetector.MOTION_NOT_DETECTED = 0
  • BrickletMotionDetector.MOTION_DETECTED = 1

Advanced Functions

Sub BrickletMotionDetector.SetStatusLEDConfig(ByVal config As Byte)

Sets the status led configuration.

By default the status LED turns on if a motion is detected and off is no motion is detected.

You can also turn the LED permanently on/off.

The following constants are available for this function:

  • BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

Function BrickletMotionDetector.GetStatusLEDConfig() As Byte

Returns the configuration as set by SetStatusLEDConfig().

The following constants are available for this function:

  • BrickletMotionDetector.STATUS_LED_CONFIG_OFF = 0
  • BrickletMotionDetector.STATUS_LED_CONFIG_ON = 1
  • BrickletMotionDetector.STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

Function BrickletMotionDetector.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 BrickletMotionDetector.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 BrickletMotionDetector.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:

  • BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4
Sub BrickletMotionDetector.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletMotionDetector.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.

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

AddHandler motionDetector.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 BrickletMotionDetector.MotionDetectedCallback(ByVal sender As BrickletMotionDetector)

This callback is called after a motion was detected.

Event BrickletMotionDetector.DetectionCycleEndedCallback(ByVal sender As BrickletMotionDetector)

This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.

Constants

Const BrickletMotionDetector.DEVICE_IDENTIFIER

This constant is used to identify a Motion Detector 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 BrickletMotionDetector.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Motion Detector Bricklet.