/ 
Tinkerforge-2.1.24
River stage zero No dependents
/ Tinkerforge::BrickletAccelerometerV2

NAME

Tinkerforge::BrickletAccelerometerV2 - Measures acceleration in three axis

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Accelerometer Bricklet 2.0.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a Accelerometer Bricklet 2.0.

CALLBACK_ACCELERATION

This constant is used with the register_callback() subroutine to specify the CALLBACK_ACCELERATION callback.

CALLBACK_CONTINUOUS_ACCELERATION_16_BIT

This constant is used with the register_callback() subroutine to specify the CALLBACK_CONTINUOUS_ACCELERATION_16_BIT callback.

CALLBACK_CONTINUOUS_ACCELERATION_8_BIT

This constant is used with the register_callback() subroutine to specify the CALLBACK_CONTINUOUS_ACCELERATION_8_BIT callback.

FUNCTION_GET_ACCELERATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ACCELERATION_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_INFO_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_INFO_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CONTINUOUS_ACCELERATION_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_FILTER_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_FILTER_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SPITFP_ERROR_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_WRITE_FIRMWARE_POINTER

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_FIRMWARE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHIP_TEMPERATURE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_RESET

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_READ_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

get_acceleration()

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 :cb:`Acceleration` callback and set the period with :func:`Set Acceleration Callback Configuration`.

set_configuration()

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.

get_configuration()

Returns the configuration as set by :func:`Set Configuration`.

set_acceleration_callback_configuration()

The period in ms is the period with which the :cb:`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 :cb:`Continuous Acceleration 16 Bit` callback and :cb:`Continuous Acceleration 8 Bit` callback will automatically be disabled.

The default value is (0, false).

get_acceleration_callback_configuration()

Returns the callback configuration as set by :func:`Set Acceleration Callback Configuration`.

set_info_led_config()

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

get_info_led_config()

Returns the LED configuration as set by :func:`Set Info LED Config`

set_continuous_acceleration_configuration()

For high throughput of acceleration data (> 1000Hz) you have to use the :cb:`Continuous Acceleration 16 Bit` or :cb:`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 :cb:`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 :cb:`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 :func:`Set Configuration`) to calculate the data in g/10000 (same unit that is returned by :func:`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 :cb:`Acceleration` callback is disabled.

The maximum throughput depends on the exact configuration:

.. csv-table:: :header: "Number of axis enabled", "Throughput 8 bit", "Throughout 16 bit" :widths: 20, 20, 20

"1", "25600Hz", "25600Hz"
"2", "25600Hz", "15000Hz"
"3", "20000Hz", "10000Hz"
get_continuous_acceleration_configuration()

Returns the continuous acceleration configuration as set by :func:`Set Continuous Acceleration Configuration`.

set_filter_configuration()

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.

.. image:: /Images/Bricklets/bricklet_accelerometer_v2_filter.png :scale: 100 % :alt: Accelerometer filter :align: center :target: ../../_images/Bricklets/bricklet_accelerometer_v2_filter.png

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_filter_configuration()

Returns the configuration as set by :func:`Set Filter Configuration`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_spitfp_error_count()

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.

set_bootloader_mode()

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.

get_bootloader_mode()

Returns the current bootloader mode, see :func:`Set Bootloader Mode`.

set_write_firmware_pointer()

Sets the firmware pointer for :func:`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.

write_firmware()

Writes 64 Bytes of firmware at the position as written by :func:`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.

set_status_led_config()

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.

get_status_led_config()

Returns the configuration as set by :func:`Set Status LED Config`

get_chip_temperature()

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.

reset()

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!

write_uid()

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.

read_uid()

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

get_identity()

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 :ref:`here <device_identifier>`. |device_identifier_constant|