MQTT - Tilt Bricklet¶

Simple¶

Download (example-simple.txt)

1# Change XYZ to the UID of your Tilt Bricklet
2
3setup:
4    # Get current tilt state
5    subscribe to tinkerforge/response/tilt_bricklet/XYZ/get_tilt_state
6    publish '' to tinkerforge/request/tilt_bricklet/XYZ/get_tilt_state

Callback¶

Download (example-callback.txt)

1# Change XYZ to the UID of your Tilt Bricklet
2
3setup:
4    # Enable tilt state callback
5    publish '' to tinkerforge/request/tilt_bricklet/XYZ/enable_tilt_state_callback
6
7    # Handle incoming tilt state callbacks
8    subscribe to tinkerforge/callback/tilt_bricklet/XYZ/tilt_state
9    publish '{"register": true}' to tinkerforge/register/tilt_bricklet/XYZ/tilt_state # Register tilt_state callback

Basic Functions¶

request/tilt_bricklet/<UID>/get_tilt_state¶

Request:	empty payload
Response:	state – Type: int, Range: See symbols

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

The following symbols are available for this function:

For state:

• "closed" = 0

• "open" = 1

• "closed_vibrating" = 2

Advanced Functions¶

request/tilt_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Tilt's name in a human readable form.

Callback Configuration Functions¶

request/tilt_bricklet/<UID>/enable_tilt_state_callback¶

Request:	empty payload
Response:	no response

Enables the register/tilt_bricklet/<UID>/tilt_state() callback.

request/tilt_bricklet/<UID>/disable_tilt_state_callback¶

Request:	empty payload
Response:	no response

Disables the register/tilt_bricklet/<UID>/tilt_state() callback.

request/tilt_bricklet/<UID>/is_tilt_state_callback_enabled¶

Request:	empty payload
Response:	enabled – Type: bool, Default: false

Returns true if the register/tilt_bricklet/<UID>/tilt_state() callback is enabled.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/tilt_bricklet/<UID>/tilt_state¶

Register Request:	register – Type: bool
Callback Response:	state – Type: int, Range: See symbols

A callback can be registered for this event by publishing to the .../register/tilt_bricklet/<UID>/tilt_state[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/tilt_bricklet/<UID>/tilt_state[/<SUFFIX>] topic for each registered suffix.

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

See request/tilt_bricklet/<UID>/get_tilt_state() for a description of the states.

The following symbols are available for this function:

For state:

• "closed" = 0

• "open" = 1

• "closed_vibrating" = 2