LabVIEW - Motion Detector Bricklet

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

API

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.*.

Basic Functions

BrickletMotionDetector(uid, ipcon) → motionDetector
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • motionDetector -- .NET Refnum (BrickletMotionDetector)

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

BrickletMotionDetector.GetMotionDetected() → motion
Output:
  • motion -- 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

BrickletMotionDetector.SetStatusLEDConfig(config)
Input:
  • config -- 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).

BrickletMotionDetector.GetStatusLEDConfig() → config
Output:
  • config -- 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).

BrickletMotionDetector.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

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.

BrickletMotionDetector.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- 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.

BrickletMotionDetector.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- 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
BrickletMotionDetector.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletMotionDetector.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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

event BrickletMotionDetector.MotionDetectedCallback(sender)
Input:
  • sender -- .NET Refnum (BrickletMotionDetector)

This callback is called after a motion was detected.

event BrickletMotionDetector.DetectionCycleEndedCallback(sender)
Input:
  • sender -- .NET Refnum (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

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.

BrickletMotionDetector.DEVICE_DISPLAY_NAME

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