Delphi/Lazarus - Motion Detector Bricklet¶

Callback¶

Download (ExampleCallback.pas)

 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletMotionDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    md: TBrickletMotionDetector;
  public
    procedure MotionDetectedCB(sender: TBrickletMotionDetector);
    procedure DetectionCycleEndedCB(sender: TBrickletMotionDetector);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Motion Detector Bricklet }

var
  e: TExample;

{ Callback procedure for motion detected callback }
procedure TExample.MotionDetectedCB(sender: TBrickletMotionDetector);
begin
  WriteLn('Motion Detected');
end;

{ Callback procedure for detection cycle ended callback }
procedure TExample.DetectionCycleEndedCB(sender: TBrickletMotionDetector);
begin
  WriteLn('Detection Cycle Ended (next detection possible in ~3 seconds)');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  md := TBrickletMotionDetector.Create(UID, ipcon);

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

  { Register motion detected callback to procedure MotionDetectedCB }
  md.OnMotionDetected := {$ifdef FPC}@{$endif}MotionDetectedCB;

  { Register detection cycle ended callback to procedure DetectionCycleEndedCB }
  md.OnDetectionCycleEnded := {$ifdef FPC}@{$endif}DetectionCycleEndedCB;

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Basic Functions¶

constructor TBrickletMotionDetector.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	motionDetector – Type: TBrickletMotionDetector

Creates an object with the unique device ID uid:

motionDetector := TBrickletMotionDetector.Create('YOUR_DEVICE_UID', ipcon);

This object can then be used after the IP Connection is connected.

function TBrickletMotionDetector.GetMotionDetected: byte¶

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:

• BRICKLET_MOTION_DETECTOR_MOTION_NOT_DETECTED = 0
• BRICKLET_MOTION_DETECTOR_MOTION_DETECTED = 1

Advanced Functions¶

procedure TBrickletMotionDetector.SetStatusLEDConfig(const config: byte)¶

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:

• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_ON = 1
• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

function TBrickletMotionDetector.GetStatusLEDConfig: byte¶

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:

• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_ON = 1
• BRICKLET_MOTION_DETECTOR_STATUS_LED_CONFIG_SHOW_STATUS = 2

New in version 2.0.1 (Plugin).

procedure TBrickletMotionDetector.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: array [0..2] of byte 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: array [0..2] of byte 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: word, 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). A Bricklet connected to an Isolator Bricklet is always at 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 assigning a procedure to an callback property of the device object:

procedure TExample.MyCallback(sender: TBrickletMotionDetector; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

motionDetector.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback properties and their parameter types are described below.

property TBrickletMotionDetector.OnMotionDetected¶

procedure(sender: TBrickletMotionDetector) of object;

Callback Parameters:	sender – Type: TBrickletMotionDetector

This callback is called after a motion was detected.

property TBrickletMotionDetector.OnDetectionCycleEnded¶

procedure(sender: TBrickletMotionDetector) of object;

Callback Parameters:	sender – Type: TBrickletMotionDetector

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.

function TBrickletMotionDetector.GetAPIVersion: array [0..2] of byte¶

Output Parameters:	apiVersion – Type: array [0..2] of byte 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.

function TBrickletMotionDetector.GetResponseExpected(const functionId: byte): boolean¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BRICKLET_MOTION_DETECTOR_FUNCTION_SET_STATUS_LED_CONFIG = 4

procedure TBrickletMotionDetector.SetResponseExpected(const functionId: byte; const responseExpected: boolean)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BRICKLET_MOTION_DETECTOR_FUNCTION_SET_STATUS_LED_CONFIG = 4

procedure TBrickletMotionDetector.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

const BRICKLET_MOTION_DETECTOR_DEVICE_IDENTIFIER¶

This constant is used to identify a Motion Detector Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_MOTION_DETECTOR_DEVICE_DISPLAY_NAME¶

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