Modbus - Tilt Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
    - Protocol
    - API
      - Bricks
      - Bricklets
        - Ambient Light Bricklet
        - Analog In Bricklet
        - Analog Out Bricklet
        - Barometer Bricklet
        - Color Bricklet
        - Current12 Bricklet
        - Current25 Bricklet
        - Distance IR Bricklet
        - Distance US Bricklet
        - Dual Button Bricklet
        - Dual Relay Bricklet
        - GPS Bricklet
        - Hall Effect Bricklet
        - Humidity Bricklet
        - Industrial Digital In 4 Bricklet
        - Industrial Digital Out 4 Bricklet
        - Industrial Dual 0-20mA Bricklet
        - Industrial Quad Relay Bricklet
        - IO-16 Bricklet
        - IO-4 Bricklet
        - Joystick Bricklet
        - LCD 16x2 Bricklet
        - LCD 20x4 Bricklet
        - LED Strip Bricklet
        - Line Bricklet
        - Linear Poti Bricklet
        - Moisture Bricklet
        - Motion Detector Bricklet
        - Multi Touch Bricklet
        - NFC/RFID Bricklet
        - Piezo Buzzer Bricklet
        - Piezo Speaker Bricklet
        - PTC Bricklet
        - Remote Switch Bricklet
        - Rotary Encoder Bricklet
        - Rotary Poti Bricklet
        - Segment Display 4x7 Bricklet
        - Solid State Relay Bricklet
        - Sound Intensity Bricklet
        - Temperature Bricklet
        - Temperature IR Bricklet
        - Tilt Bricklet
          - API
            - Basic Functions
            - Advanced Functions
            - Callback Configuration Functions
            - Callbacks
        - Voltage Bricklet
        - Voltage/Current Bricklet
  - Wireshark Dissector

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

### 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 content of this page is licensed under Creative Commons Attribution 3.0 Unported License.