Modbus - Accelerometer Bricklet 2.0

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

API

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

Basic Functions

BrickletAccelerometerV2.get_acceleration
Function ID:

1

Request:

empty payload

Response:
  • x -- int32
  • y -- int32
  • z -- int32

Returns the acceleration in x, y and z direction. The values are given in g/10000 (1g = 9.80665m/s²), not to be confused with grams.

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

BrickletAccelerometerV2.set_configuration
Function ID:

2

Request:
  • data_rate -- uint8
  • full_scale -- uint8
Response:

no response

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

  • Data rate of 0.781Hz to 25600Hz.
  • Full scale range of -2g to +2g up to -8g to +8g.

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

The default values are 100Hz data rate and -2g to +2g range.

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

  • 0: 0 781hz, for data_rate
  • 1: 1 563hz, for data_rate
  • 2: 3 125hz, for data_rate
  • 3: 6 2512hz, for data_rate
  • 4: 12 5hz, for data_rate
  • 5: 25hz, for data_rate
  • 6: 50hz, for data_rate
  • 7: 100hz, for data_rate
  • 8: 200hz, for data_rate
  • 9: 400hz, for data_rate
  • 10: 800hz, for data_rate
  • 11: 1600hz, for data_rate
  • 12: 3200hz, for data_rate
  • 13: 6400hz, for data_rate
  • 14: 12800hz, for data_rate
  • 15: 25600hz, for data_rate
  • 0: 2g, for full_scale
  • 1: 4g, for full_scale
  • 2: 8g, for full_scale
BrickletAccelerometerV2.get_configuration
Function ID:

3

Request:

empty payload

Response:
  • data_rate -- uint8
  • full_scale -- uint8

Returns the configuration as set by set_configuration.

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

  • 0: 0 781hz, for data_rate
  • 1: 1 563hz, for data_rate
  • 2: 3 125hz, for data_rate
  • 3: 6 2512hz, for data_rate
  • 4: 12 5hz, for data_rate
  • 5: 25hz, for data_rate
  • 6: 50hz, for data_rate
  • 7: 100hz, for data_rate
  • 8: 200hz, for data_rate
  • 9: 400hz, for data_rate
  • 10: 800hz, for data_rate
  • 11: 1600hz, for data_rate
  • 12: 3200hz, for data_rate
  • 13: 6400hz, for data_rate
  • 14: 12800hz, for data_rate
  • 15: 25600hz, for data_rate
  • 0: 2g, for full_scale
  • 1: 4g, for full_scale
  • 2: 8g, for full_scale
BrickletAccelerometerV2.set_info_led_config
Function ID:

6

Request:
  • config -- uint8
Response:

no response

Configures the info LED (marked as "Force" on the Bricklet) to be either turned off, turned on, or blink in heartbeat mode.

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
BrickletAccelerometerV2.get_info_led_config
Function ID:

7

Request:

empty payload

Response:
  • config -- uint8

Returns the LED configuration as set by set_info_led_config

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
BrickletAccelerometerV2.set_continuous_acceleration_configuration
Function ID:

9

Request:
  • enable_x -- bool
  • enable_y -- bool
  • enable_z -- bool
  • resolution -- uint8
Response:

no response

For high throughput of acceleration data (> 1000Hz) you have to use the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT or CALLBACK_CONTINUOUS_ACCELERATION_8_BIT callbacks.

You can enable the callback for each axis (x, y, z) individually and choose a resolution of 8 bit or 16 bit.

If at least one of the axis is enabled and the resolution is set to 8 bit, the CALLBACK_CONTINUOUS_ACCELERATION_8_BIT callback is activated. If at least one of the axis is enabled and the resolution is set to 16 bit, the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT callback is activated.

The returned values are raw ADC data. If you want to put this data into a FFT to determine the occurrences of specific frequencies we recommend that you use the data as is. It has all of the ADC noise in it. This noise looks like pure noise at first glance, but it might still have some frequnecy information in it that can be utilized by the FFT.

Otherwise you have to use the following formulas that depend on the configured resolution (8/16 bit) and the full scale range (see set_configuration) to calculate the data in g/10000 (same unit that is returned by get_acceleration):

  • 16 bit, full scale 2G: acceleration = value*625/1024
  • 16 bit, full scale 4G: acceleration = value*1250/1024
  • 16 bit, full scale 8G: acceleration = value*2500/1024

If a resolution of 8 bit is used, only the 8 most significant bits will be transferred, so you can use the following formulas:

  • 8 bit, full scale 2G: acceleration = value*256*625/1024
  • 8 bit, full scale 4G: acceleration = value*256*1250/1024
  • 8 bit, full scale 8G: acceleration = value*256*2500/1024

If no axis is enabled, both callbacks are disabled. If one of the continuous callbacks is enabled, the CALLBACK_ACCELERATION callback is disabled.

The maximum throughput depends on the exact configuration:

Number of axis enabled Throughput 8 bit Throughout 16 bit
1 25600Hz 25600Hz
2 25600Hz 15000Hz
3 20000Hz 10000Hz

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

  • 0: 8bit, for resolution
  • 1: 16bit, for resolution
BrickletAccelerometerV2.get_continuous_acceleration_configuration
Function ID:

10

Request:

empty payload

Response:
  • enable_x -- bool
  • enable_y -- bool
  • enable_z -- bool
  • resolution -- uint8

Returns the continuous acceleration configuration as set by set_continuous_acceleration_configuration.

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

  • 0: 8bit, for resolution
  • 1: 16bit, for resolution

Advanced Functions

BrickletAccelerometerV2.set_filter_configuration
Function ID:

13

Request:
  • iir_bypass -- uint8
  • low_pass_filter -- uint8
Response:

no response

Configures IIR Bypass filter mode and low pass filter roll off corner frequency.

The filter can be applied or bypassed and the corner frequency can be half or a ninth of the output data rate.

Accelerometer filter

By default filtering is applied and the filter corner frequency is a ninth of the output data rate.

New in version 2.0.2 (Plugin).

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

  • 0: applied, for iir_bypass
  • 1: bypassed, for iir_bypass
  • 0: ninth, for low_pass_filter
  • 1: half, for low_pass_filter
BrickletAccelerometerV2.get_filter_configuration
Function ID:

14

Request:

empty payload

Response:
  • iir_bypass -- uint8
  • low_pass_filter -- uint8

Returns the configuration as set by set_filter_configuration.

New in version 2.0.2 (Plugin).

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

  • 0: applied, for iir_bypass
  • 1: bypassed, for iir_bypass
  • 0: ninth, for low_pass_filter
  • 1: half, for low_pass_filter
BrickletAccelerometerV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletAccelerometerV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletAccelerometerV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

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

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletAccelerometerV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

Sets the firmware pointer for write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletAccelerometerV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletAccelerometerV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

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

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

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletAccelerometerV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletAccelerometerV2.reset
Function ID:243
Request:empty payload
Response:no response

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletAccelerometerV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletAccelerometerV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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

BrickletAccelerometerV2.set_acceleration_callback_configuration
Function ID:

4

Request:
  • period -- uint32
  • value_has_to_change -- bool
Response:

no response

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

If this callback is enabled, the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT callback and CALLBACK_CONTINUOUS_ACCELERATION_8_BIT callback will automatically be disabled.

The default value is (0, false).

BrickletAccelerometerV2.get_acceleration_callback_configuration
Function ID:

5

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool

Returns the callback configuration as set by set_acceleration_callback_configuration.

Callbacks

BrickletAccelerometerV2.CALLBACK_ACCELERATION
Function ID:

8

Response:
  • x -- int32
  • y -- int32
  • z -- int32

This callback is triggered periodically according to the configuration set by set_acceleration_callback_configuration.

The response values are the same as get_acceleration.

BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_16_BIT
Function ID:

11

Response:
  • acceleration -- int16[30]

Returns 30 acceleration values with 16 bit resolution. The data rate can be configured with set_configuration and this callback can be enabled with set_continuous_acceleration_configuration.

The returned values are raw ADC data. If you want to put this data into a FFT to determine the occurrences of specific frequencies we recommend that you use the data as is. It has all of the ADC noise in it. This noise looks like pure noise at first glance, but it might still have some frequnecy information in it that can be utilized by the FFT.

Otherwise you have to use the following formulas that depend on the full scale range (see set_configuration) to calculate the data in g/10000 (same unit that is returned by get_acceleration):

  • Full scale 2G: acceleration = value*625/1024
  • Full scale 4G: acceleration = value*1250/1024
  • Full scale 8G: acceleration = value*2500/1024

The data is formated in the sequence "x, y, z, x, y, z, ..." depending on the enabled axis. Examples:

  • x, y, z enabled: "x, y, z, ... 10x ..., x, y, z"
  • x, z enabled: "x, z, ... 15x ..., x, z"
  • y enabled: "y, ... 30x ..., y"
BrickletAccelerometerV2.CALLBACK_CONTINUOUS_ACCELERATION_8_BIT
Function ID:

12

Response:
  • acceleration -- int8[60]

Returns 30 acceleration values with 8 bit resolution. The data rate can be configured with set_configuration and this callback can be enabled with set_continuous_acceleration_configuration.

The returned values are raw ADC data. If you want to put this data into a FFT to determine the occurrences of specific frequencies we recommend that you use the data as is. It has all of the ADC noise in it. This noise looks like pure noise at first glance, but it might still have some frequnecy information in it that can be utilized by the FFT.

Otherwise you have to use the following formulas that depend on the full scale range (see set_configuration) to calculate the data in g/10000 (same unit that is returned by get_acceleration):

  • Full scale 2G: acceleration = value*256*625/1024
  • Full scale 4G: acceleration = value*256*1250/1024
  • Full scale 8G: acceleration = value*256*2500/1024

The data is formated in the sequence "x, y, z, x, y, z, ..." depending on the enabled axis. Examples:

  • x, y, z enabled: "x, y, z, ... 20x ..., x, y, z"
  • x, z enabled: "x, z, ... 30x ..., x, z"
  • y enabled: "y, ... 60x ..., y"