C# - Motion Detector Bricklet

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

Examples

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

Callback

Download (ExampleCallback.cs)

 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
38
39
40
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Motion Detector Bricklet

    // Callback function for motion detected callback
    static void MotionDetectedCB(BrickletMotionDetector sender)
    {
        Console.WriteLine("Motion Detected");
    }

    // Callback function for detection cycle ended callback
    static void DetectionCycleEndedCB(BrickletMotionDetector sender)
    {
        Console.WriteLine("Detection Cycle Ended (next detection possible in ~3 seconds)");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletMotionDetector md = 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 function MotionDetectedCB
        md.MotionDetectedCallback += MotionDetectedCB;

        // Register detection cycle ended callback to function DetectionCycleEndedCB
        md.DetectionCycleEndedCallback += DetectionCycleEndedCB;

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown 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.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

All methods listed below are thread-safe.

Basic Functions

class BrickletMotionDetector(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • motionDetector – Type: BrickletMotionDetector

Creates an object with the unique device ID uid:

BrickletMotionDetector motionDetector = new BrickletMotionDetector("YOUR_DEVICE_UID", ipcon);

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

byte BrickletMotionDetector.GetMotionDetected()
Returns:
  • motion – Type: byte, Range: See constants

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:

For motion:

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

Advanced Functions

void BrickletMotionDetector.SetStatusLEDConfig(byte config)
Parameters:
  • config – Type: byte, Range: See constants, Default: 2

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:

For config:

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

byte BrickletMotionDetector.GetStatusLEDConfig()
Returns:
  • config – Type: byte, Range: See constants, Default: 2

Returns the configuration as set by SetStatusLEDConfig().

The following constants are available for this function:

For config:

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

void BrickletMotionDetector.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: byte[], Length: 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[], Length: 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: int, 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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 appending your callback handler to the corresponding event:

void MyCallback(BrickletMotionDetector sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

motionDetector.ExampleCallback += MyCallback;

The available events 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(BrickletMotionDetector sender)
Callback Parameters:
  • sender – Type: BrickletMotionDetector

This callback is called after a motion was detected.

event BrickletMotionDetector.DetectionCycleEndedCallback(BrickletMotionDetector sender)
Callback Parameters:
  • sender – Type: 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.

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.

byte[] BrickletMotionDetector.GetAPIVersion()
Output Parameters:
  • apiVersion – Type: byte[], Length: 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.

bool BrickletMotionDetector.GetResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: bool

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.

The following constants are available for this function:

For functionId:

  • BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4
void BrickletMotionDetector.SetResponseExpected(byte functionId, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: bool

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

For functionId:

  • BrickletMotionDetector.FUNCTION_SET_STATUS_LED_CONFIG = 4
void BrickletMotionDetector.SetResponseExpectedAll(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

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

Constants

int BrickletMotionDetector.DEVICE_IDENTIFIER

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

string BrickletMotionDetector.DEVICE_DISPLAY_NAME

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