Modbus - Tilt Bricklet

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

API

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

Basic Functions

BrickletTilt.get_tilt_state
Function ID:

1

Request:

empty payload

Response:
  • state -- uint8

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

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

  • 0: closed, for state
  • 1: open, for state
  • 2: closed vibrating, for state

Advanced Functions

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

Callback Configuration Functions

BrickletTilt.enable_tilt_state_callback
Function ID:2
Request:empty payload
Response:no response

Enables the CALLBACK_TILT_STATE callback.

BrickletTilt.disable_tilt_state_callback
Function ID:3
Request:empty payload
Response:no response

Disables the CALLBACK_TILT_STATE callback.

BrickletTilt.is_tilt_state_callback_enabled
Function ID:

4

Request:

empty payload

Response:
  • enabled -- bool

Returns true if the CALLBACK_TILT_STATE callback is enabled.

Callbacks

BrickletTilt.CALLBACK_TILT_STATE
Function ID:

5

Response:
  • state -- uint8

This callback provides the current tilt state. It is called every time the state changes.

See get_tilt_state for a description of the states.

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

  • 0: closed, for state
  • 1: open, for state
  • 2: closed vibrating, for state