Modbus - Motion Detector Bricklet

This is the description of the Modbus protocol for the Motion Detector Bricklet. General information and technical specifications for the Motion Detector Bricklet are summarized in its hardware description.

API

A general description of the Modbus protocol structure can be found here.

Basic Functions

BrickletMotionDetector.get_motion_detected
Function ID:

1

Request:

empty payload

Response:
  • motion -- uint8

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 meanings are defined for the parameters of this function:

  • 0: not detected, for motion
  • 1: detected, for motion

Advanced Functions

BrickletMotionDetector.set_status_led_config
Function ID:

4

Request:
  • config -- uint8
Response:

no response

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.

New in version 2.0.1 (Plugin).

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show status, for config
BrickletMotionDetector.get_status_led_config
Function ID:

5

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config.

New in version 2.0.1 (Plugin).

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show status, for config
BrickletMotionDetector.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callbacks

BrickletMotionDetector.CALLBACK_MOTION_DETECTED
Function ID:2
Response:empty payload

This callback is called after a motion was detected.

BrickletMotionDetector.CALLBACK_DETECTION_CYCLE_ENDED
Function ID:3
Response:empty payload

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.