Software / API Bindings / Ruby / API Reference and Examples / Bricklets / Accelerometer Bricklet 2.0

Ruby - Accelerometer Bricklet 2.0¶

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

An installation guide for the Ruby API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (example_simple.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_accelerometer_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Accelerometer Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometerV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current acceleration as [x, y, z]
acceleration = a.get_acceleration

puts "Acceleration [X]: #{acceleration[0]/10000.0} g"
puts "Acceleration [Y]: #{acceleration[1]/10000.0} g"
puts "Acceleration [Z]: #{acceleration[2]/10000.0} g"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_accelerometer_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Accelerometer Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
a = BrickletAccelerometerV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register acceleration callback
a.register_callback(BrickletAccelerometerV2::CALLBACK_ACCELERATION) do |x, y, z|
  puts "Acceleration [X]: #{x/10000.0} g"
  puts "Acceleration [Y]: #{y/10000.0} g"
  puts "Acceleration [Z]: #{z/10000.0} g"
  puts ''
end

# Set period for acceleration callback to 1s (1000ms)
a.set_acceleration_callback_configuration 1000, false

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickletAccelerometerV2::new(uid, ipcon) → accelerometer_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	accelerometer_v2 – Type: BrickletAccelerometerV2

Creates an object with the unique device ID uid:

accelerometer_v2 = BrickletAccelerometerV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletAccelerometerV2#get_acceleration → [int, int, int]¶

Return Array:	0: x – Type: int, Unit: 1/10000 gₙ, Range: ? 1: y – Type: int, Unit: 1/10000 gₙ, Range: ? 2: z – Type: int, Unit: 1/10000 gₙ, Range: ?

Returns the acceleration in x, y and z direction. The values are given in gₙ/10000 (1gₙ = 9.80665m/s²). The range is configured with #set_configuration.

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(data_rate, full_scale) → nil¶

Parameters:	data_rate – Type: int, Range: See constants, Default: 7 full_scale – Type: int, Range: See constants, Default: 0

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

Data rate of 0.781Hz to 25600Hz.
Full scale range of ±2g up to ±8g.

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

The following constants are available for this function:

For data_rate:

BrickletAccelerometerV2::DATA_RATE_0_781HZ = 0
BrickletAccelerometerV2::DATA_RATE_1_563HZ = 1
BrickletAccelerometerV2::DATA_RATE_3_125HZ = 2
BrickletAccelerometerV2::DATA_RATE_6_2512HZ = 3
BrickletAccelerometerV2::DATA_RATE_12_5HZ = 4
BrickletAccelerometerV2::DATA_RATE_25HZ = 5
BrickletAccelerometerV2::DATA_RATE_50HZ = 6
BrickletAccelerometerV2::DATA_RATE_100HZ = 7
BrickletAccelerometerV2::DATA_RATE_200HZ = 8
BrickletAccelerometerV2::DATA_RATE_400HZ = 9
BrickletAccelerometerV2::DATA_RATE_800HZ = 10
BrickletAccelerometerV2::DATA_RATE_1600HZ = 11
BrickletAccelerometerV2::DATA_RATE_3200HZ = 12
BrickletAccelerometerV2::DATA_RATE_6400HZ = 13
BrickletAccelerometerV2::DATA_RATE_12800HZ = 14
BrickletAccelerometerV2::DATA_RATE_25600HZ = 15

For full_scale:

BrickletAccelerometerV2::FULL_SCALE_2G = 0
BrickletAccelerometerV2::FULL_SCALE_4G = 1
BrickletAccelerometerV2::FULL_SCALE_8G = 2

BrickletAccelerometerV2#get_configuration → [int, int]¶

Return Array:	0: data_rate – Type: int, Range: See constants, Default: 7 1: full_scale – Type: int, Range: See constants, Default: 0

Returns the configuration as set by #set_configuration.

The following constants are available for this function:

For data_rate:

BrickletAccelerometerV2::DATA_RATE_0_781HZ = 0
BrickletAccelerometerV2::DATA_RATE_1_563HZ = 1
BrickletAccelerometerV2::DATA_RATE_3_125HZ = 2
BrickletAccelerometerV2::DATA_RATE_6_2512HZ = 3
BrickletAccelerometerV2::DATA_RATE_12_5HZ = 4
BrickletAccelerometerV2::DATA_RATE_25HZ = 5
BrickletAccelerometerV2::DATA_RATE_50HZ = 6
BrickletAccelerometerV2::DATA_RATE_100HZ = 7
BrickletAccelerometerV2::DATA_RATE_200HZ = 8
BrickletAccelerometerV2::DATA_RATE_400HZ = 9
BrickletAccelerometerV2::DATA_RATE_800HZ = 10
BrickletAccelerometerV2::DATA_RATE_1600HZ = 11
BrickletAccelerometerV2::DATA_RATE_3200HZ = 12
BrickletAccelerometerV2::DATA_RATE_6400HZ = 13
BrickletAccelerometerV2::DATA_RATE_12800HZ = 14
BrickletAccelerometerV2::DATA_RATE_25600HZ = 15

For full_scale:

BrickletAccelerometerV2::FULL_SCALE_2G = 0
BrickletAccelerometerV2::FULL_SCALE_4G = 1
BrickletAccelerometerV2::FULL_SCALE_8G = 2

BrickletAccelerometerV2#set_info_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 0

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

The following constants are available for this function:

For config:

BrickletAccelerometerV2::INFO_LED_CONFIG_OFF = 0
BrickletAccelerometerV2::INFO_LED_CONFIG_ON = 1
BrickletAccelerometerV2::INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

BrickletAccelerometerV2#get_info_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 0

Returns the LED configuration as set by #set_info_led_config

The following constants are available for this function:

For config:

BrickletAccelerometerV2::INFO_LED_CONFIG_OFF = 0
BrickletAccelerometerV2::INFO_LED_CONFIG_ON = 1
BrickletAccelerometerV2::INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

Advanced Functions¶

BrickletAccelerometerV2#set_filter_configuration(iir_bypass, low_pass_filter) → nil¶

Parameters:	iir_bypass – Type: int, Range: See constants, Default: 0 low_pass_filter – Type: int, Range: See constants, Default: 0

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.

The following constants are available for this function:

For iir_bypass:

BrickletAccelerometerV2::IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2::IIR_BYPASS_BYPASSED = 1

For low_pass_filter:

BrickletAccelerometerV2::LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2::LOW_PASS_FILTER_HALF = 1

New in version 2.0.2 (Plugin).

BrickletAccelerometerV2#get_filter_configuration → [int, int]¶

Return Array:	0: iir_bypass – Type: int, Range: See constants, Default: 0 1: low_pass_filter – Type: int, Range: See constants, Default: 0

Returns the configuration as set by #set_filter_configuration.

The following constants are available for this function:

For iir_bypass:

BrickletAccelerometerV2::IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2::IIR_BYPASS_BYPASSED = 1

For low_pass_filter:

BrickletAccelerometerV2::LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2::LOW_PASS_FILTER_HALF = 1

New in version 2.0.2 (Plugin).

BrickletAccelerometerV2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] 2: error_count_frame – Type: int, Range: [0 to 2³² - 1] 3: error_count_overflow – Type: int, Range: [0 to 2³² - 1]

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_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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 constants are available for this function:

For config:

BrickletAccelerometerV2::STATUS_LED_CONFIG_OFF = 0
BrickletAccelerometerV2::STATUS_LED_CONFIG_ON = 1
BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletAccelerometerV2#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

BrickletAccelerometerV2::STATUS_LED_CONFIG_OFF = 0
BrickletAccelerometerV2::STATUS_LED_CONFIG_ON = 1
BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletAccelerometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletAccelerometerV2#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature 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 → nil¶

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#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

Return Array:	0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: 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] 4: 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] 5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

0: uid – Type: str, Length: up to 8
1: connected_uid – Type: str, Length: up to 8
2: position – Type: chr, Range: ['a' to 'h', 'z']
3: 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]

4: 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]

5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletAccelerometerV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletAccelerometerV2#set_acceleration_callback_configuration(period, value_has_to_change) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

The period 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.

BrickletAccelerometerV2#get_acceleration_callback_configuration → [int, bool]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by #set_acceleration_callback_configuration.

BrickletAccelerometerV2#set_continuous_acceleration_configuration(enable_x, enable_y, enable_z, resolution) → nil¶

Parameters:	enable_x – Type: bool, Default: false enable_y – Type: bool, Default: false enable_z – Type: bool, Default: false resolution – Type: int, Range: See constants, Default: 0

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 constants are available for this function:

For resolution:

BrickletAccelerometerV2::RESOLUTION_8BIT = 0
BrickletAccelerometerV2::RESOLUTION_16BIT = 1

BrickletAccelerometerV2#get_continuous_acceleration_configuration → [bool, bool, bool, int]¶

Return Array:	0: enable_x – Type: bool, Default: false 1: enable_y – Type: bool, Default: false 2: enable_z – Type: bool, Default: false 3: resolution – Type: int, Range: See constants, Default: 0

Returns the continuous acceleration configuration as set by #set_continuous_acceleration_configuration.

The following constants are available for this function:

For resolution:

BrickletAccelerometerV2::RESOLUTION_8BIT = 0
BrickletAccelerometerV2::RESOLUTION_16BIT = 1

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

accelerometer_v2.register_callback BrickletAccelerometerV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletAccelerometerV2::CALLBACK_ACCELERATION¶

Callback Parameters:	x – Type: int, Unit: 1/10000 gₙ, Range: ? y – Type: int, Unit: 1/10000 gₙ, Range: ? z – Type: int, Unit: 1/10000 gₙ, Range: ?

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

The parameters are the same as #get_acceleration.

BrickletAccelerometerV2::CALLBACK_CONTINUOUS_ACCELERATION_16_BIT¶

Callback Parameters:	acceleration – Type: [int, ...], Length: 30, Unit: ? gₙ, Range: ?

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.

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 repeated
x, z enabled: "x, z, ..." 15x repeated
y enabled: "y, ..." 30x repeated

BrickletAccelerometerV2::CALLBACK_CONTINUOUS_ACCELERATION_8_BIT¶

Callback Parameters:	acceleration – Type: [int, ...], Length: 60, Unit: ? gₙ, Range: ?

Returns 60 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.

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 repeated
x, z enabled: "x, z, ..." 30x repeated
y enabled: "y, ..." 60x repeated

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletAccelerometerV2#get_api_version → [int, ...]¶

Return Array:	0: api_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]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletAccelerometerV2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

BrickletAccelerometerV2::FUNCTION_SET_CONFIGURATION = 2
BrickletAccelerometerV2::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
BrickletAccelerometerV2::FUNCTION_SET_INFO_LED_CONFIG = 6
BrickletAccelerometerV2::FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
BrickletAccelerometerV2::FUNCTION_SET_FILTER_CONFIGURATION = 13
BrickletAccelerometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAccelerometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAccelerometerV2::FUNCTION_RESET = 243
BrickletAccelerometerV2::FUNCTION_WRITE_UID = 248

BrickletAccelerometerV2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For function_id:

BrickletAccelerometerV2::FUNCTION_SET_CONFIGURATION = 2
BrickletAccelerometerV2::FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
BrickletAccelerometerV2::FUNCTION_SET_INFO_LED_CONFIG = 6
BrickletAccelerometerV2::FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
BrickletAccelerometerV2::FUNCTION_SET_FILTER_CONFIGURATION = 13
BrickletAccelerometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAccelerometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAccelerometerV2::FUNCTION_RESET = 243
BrickletAccelerometerV2::FUNCTION_WRITE_UID = 248

BrickletAccelerometerV2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletAccelerometerV2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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 constants are available for this function:

For mode:

BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletAccelerometerV2::BOOTLOADER_STATUS_OK = 0
BrickletAccelerometerV2::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletAccelerometerV2::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletAccelerometerV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletAccelerometerV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletAccelerometerV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletAccelerometerV2#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletAccelerometerV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletAccelerometerV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletAccelerometerV2#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]

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(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]

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 → int¶

Returns:	uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

BrickletAccelerometerV2::DEVICE_IDENTIFIER¶

This constant is used to identify a Accelerometer Bricklet 2.0.

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

BrickletAccelerometerV2::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Accelerometer Bricklet 2.0.