TCP/IP - Accelerometer Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# TCP/IP - Accelerometer Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the TCP/IP protocol for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer Bricklet are summarized in its hardware description.

## API

A general description of the TCP/IP protocol structure can be found here.

### Basic Functions

`BrickletAccelerometer.``get_acceleration`

  Function ID: | 1
  Request: | empty payload

  Response:

  - x -- int16
  - y -- int16
  - z -- int16

  Returns the acceleration in x, y and z direction. The values are given in mG (1/1000 G).

  If you want to get the acceleration periodically, it is recommended to use the callback `CALLBACK_ACCELERATION` and set the period with `set_acceleration_callback_period`.

`BrickletAccelerometer.``get_temperature`

  Function ID: | 8
  Request: | empty payload

  Response:

  - temperature -- int16

  Returns the temperature of the accelerometer in °C.

`BrickletAccelerometer.``led_on`

  Function ID: | 11
  Request: | empty payload
  Response: | no response

  Enables the LED on the Bricklet.

`BrickletAccelerometer.``led_off`

  Function ID: | 12
  Request: | empty payload
  Response: | no response

  Disables the LED on the Bricklet.

`BrickletAccelerometer.``is_led_on`

  Function ID: | 13
  Request: | empty payload

  Response:

  - value -- uint8

  Returns true if the LED is enabled, false otherwise.

### Advanced Functions

`BrickletAccelerometer.``set_configuration`

  Function ID: | 9

  Request:

  - data_rate -- uint8
  - full_scale -- uint8
  - filter_bandwidth -- uint8

  Response: | no response

  Configures the data rate, full scale range and filter bandwidth. Possible values are:

  - Data rate of 0Hz to 1600Hz.
  - Full scale range of -2G to +2G up to -16G to +16G.
  - Filter bandwidth between 50Hz and 800Hz.

  Decreasing data rate or full scale range will also decrease the noise on the data.

  The default values are 100Hz data rate, -4G to +4G range and 200Hz filter bandwidth.

`BrickletAccelerometer.``get_configuration`

  Function ID: | 10
  Request: | empty payload

  Response:

  - data_rate -- uint8
  - full_scale -- uint8
  - filter_bandwidth -- uint8

  Returns the configuration as set by `set_configuration`.

`BrickletAccelerometer.``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

`BrickletAccelerometer.``set_acceleration_callback_period`

  Function ID: | 2

  Request:

  - period -- uint32

  Response: | no response

  Sets the period in ms with which the `CALLBACK_ACCELERATION` callback is triggered periodically. A value of 0 turns the callback off.

  `CALLBACK_ACCELERATION` is only triggered if the acceleration has changed since the last triggering.

  The default value is 0.

`BrickletAccelerometer.``get_acceleration_callback_period`

  Function ID: | 3
  Request: | empty payload

  Response:

  - period -- uint32

  Returns the period as set by `set_acceleration_callback_period`.

`BrickletAccelerometer.``set_acceleration_callback_threshold`

  Function ID: | 4

  Request:

  - option -- char
  - min_x -- int16
  - max_x -- int16
  - min_y -- int16
  - max_y -- int16
  - min_z -- int16
  - max_z -- int16

  Response: | no response

  Sets the thresholds for the `CALLBACK_ACCELERATION_REACHED` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the temperature is outside the min and max values
  'i' | Callback is triggered when the temperature is inside the min and max values
  '<' | Callback is triggered when the temperature is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the temperature is greater than the min value (max is ignored)

  The default value is ('x', 0, 0, 0, 0, 0, 0).

`BrickletAccelerometer.``get_acceleration_callback_threshold`

  Function ID: | 5
  Request: | empty payload

  Response:

  - option -- char
  - min_x -- int16
  - max_x -- int16
  - min_y -- int16
  - max_y -- int16
  - min_z -- int16
  - max_z -- int16

  Returns the threshold as set by `set_acceleration_callback_threshold`.

`BrickletAccelerometer.``set_debounce_period`

  Function ID: | 6

  Request:

  - debounce -- uint32

  Response: | no response

  Sets the period in ms with which the threshold callback

  - `CALLBACK_ACCELERATION_REACHED`

  is triggered, if the threshold

  - `set_acceleration_callback_threshold`

  keeps being reached.

  The default value is 100.

`BrickletAccelerometer.``get_debounce_period`

  Function ID: | 7
  Request: | empty payload

  Response:

  - debounce -- uint32

  Returns the debounce period as set by `set_debounce_period`.

### Callbacks

`BrickletAccelerometer.``CALLBACK_ACCELERATION`

  Function ID: | 14

  Response:

  - x -- int16
  - y -- int16
  - z -- int16

  This callback is triggered periodically with the period that is set by `set_acceleration_callback_period`. The response values are the X, Y and Z acceleration.

  `CALLBACK_ACCELERATION` is only triggered if the acceleration has changed since the last triggering.

`BrickletAccelerometer.``CALLBACK_ACCELERATION_REACHED`

  Function ID: | 15

  Response:

  - x -- int16
  - y -- int16
  - z -- int16

  This callback is triggered when the threshold as set by `set_acceleration_callback_threshold` is reached. The response values are the X, Y and Z acceleration.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `set_debounce_period`.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.