Software / API Bindings / Visual Basic .NET / API Reference and Examples / Bricklets / Accelerometer Bricklet 2.0

Visual Basic .NET - Accelerometer Bricklet 2.0¶

This is the description of the Visual Basic .NET 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 Visual Basic .NET API bindings is part of their general description.

Examples¶

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

Simple¶

Download (ExampleSimple.vb)

Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Accelerometer Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim a As New BrickletAccelerometerV2(UID, ipcon) ' Create device object

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

        ' Get current acceleration
        Dim x, y, z As Integer

        a.GetAcceleration(x, y, z)

        Console.WriteLine("Acceleration [X]: " + (x/10000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Y]: " + (y/10000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Z]: " + (z/10000.0).ToString() + " g")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback¶

Download (ExampleCallback.vb)

Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Accelerometer Bricklet 2.0

    ' Callback subroutine for acceleration callback
    Sub AccelerationCB(ByVal sender As BrickletAccelerometerV2, ByVal x As Integer, _
                       ByVal y As Integer, ByVal z As Integer)
        Console.WriteLine("Acceleration [X]: " + (x/10000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Y]: " + (y/10000.0).ToString() + " g")
        Console.WriteLine("Acceleration [Z]: " + (z/10000.0).ToString() + " g")
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim a As New BrickletAccelerometerV2(UID, ipcon) ' Create device object

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

        ' Register acceleration callback to subroutine AccelerationCB
        AddHandler a.AccelerationCallback, AddressOf AccelerationCB

        ' Set period for acceleration callback to 1s (1000ms)
        a.SetAccelerationCallbackConfiguration(1000, False)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API¶

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions¶

Class BrickletAccelerometerV2(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim accelerometerV2 As New BrickletAccelerometerV2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletAccelerometerV2.GetAcceleration(ByRef x As Integer, ByRef y As Integer, ByRef z As Integer)¶

Output Parameters:	x – Type: Integer, Unit: 1/10000 gₙ, Range: ? y – Type: Integer, Unit: 1/10000 gₙ, Range: ? z – Type: Integer, 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 SetConfiguration().

If you want to get the acceleration periodically, it is recommended to use the AccelerationCallback callback and set the period with SetAccelerationCallbackConfiguration().

Sub BrickletAccelerometerV2.SetConfiguration(ByVal dataRate As Byte, ByVal fullScale As Byte)¶

Parameters:	dataRate – Type: Byte, Range: See constants, Default: 7 fullScale – Type: Byte, 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 dataRate:

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 fullScale:

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

Sub BrickletAccelerometerV2.GetConfiguration(ByRef dataRate As Byte, ByRef fullScale As Byte)¶

Output Parameters:	dataRate – Type: Byte, Range: See constants, Default: 7 fullScale – Type: Byte, Range: See constants, Default: 0

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

For dataRate:

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 fullScale:

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

Sub BrickletAccelerometerV2.SetInfoLEDConfig(ByVal config As Byte)¶

Parameters:	config – Type: Byte, 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

Function BrickletAccelerometerV2.GetInfoLEDConfig() As Byte¶

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

Returns the LED configuration as set by SetInfoLEDConfig()

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¶

Sub BrickletAccelerometerV2.SetFilterConfiguration(ByVal iirBypass As Byte, ByVal lowPassFilter As Byte)¶

Parameters:	iirBypass – Type: Byte, Range: See constants, Default: 0 lowPassFilter – Type: Byte, 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 iirBypass:

BrickletAccelerometerV2.IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2.IIR_BYPASS_BYPASSED = 1

For lowPassFilter:

BrickletAccelerometerV2.LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2.LOW_PASS_FILTER_HALF = 1

New in version 2.0.2 (Plugin).

Sub BrickletAccelerometerV2.GetFilterConfiguration(ByRef iirBypass As Byte, ByRef lowPassFilter As Byte)¶

Output Parameters:	iirBypass – Type: Byte, Range: See constants, Default: 0 lowPassFilter – Type: Byte, Range: See constants, Default: 0

Returns the configuration as set by SetFilterConfiguration().

The following constants are available for this function:

For iirBypass:

BrickletAccelerometerV2.IIR_BYPASS_APPLIED = 0
BrickletAccelerometerV2.IIR_BYPASS_BYPASSED = 1

For lowPassFilter:

BrickletAccelerometerV2.LOW_PASS_FILTER_NINTH = 0
BrickletAccelerometerV2.LOW_PASS_FILTER_HALF = 1

New in version 2.0.2 (Plugin).

Sub BrickletAccelerometerV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Output Parameters:	errorCountAckChecksum – Type: Long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 2³² - 1] errorCountFrame – Type: Long, Range: [0 to 2³² - 1] errorCountOverflow – Type: Long, 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.

Sub BrickletAccelerometerV2.SetStatusLEDConfig(ByVal config As Byte)¶

Parameters:	config – Type: Byte, 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

Function BrickletAccelerometerV2.GetStatusLEDConfig() As Byte¶

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

Returns the configuration as set by SetStatusLEDConfig()

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

Function BrickletAccelerometerV2.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, 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.

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

Sub BrickletAccelerometerV2.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["a"C to "h"C, "z"C]
hardwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Integer, 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¶

Sub BrickletAccelerometerV2.SetAccelerationCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

The period is the period with which the AccelerationCallback 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 ContinuousAcceleration16BitCallback callback and ContinuousAcceleration8BitCallback callback will automatically be disabled.

Sub BrickletAccelerometerV2.GetAccelerationCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false

Returns the callback configuration as set by SetAccelerationCallbackConfiguration().

Sub BrickletAccelerometerV2.SetContinuousAccelerationConfiguration(ByVal enableX As Boolean, ByVal enableY As Boolean, ByVal enableZ As Boolean, ByVal resolution As Byte)¶

Parameters:	enableX – Type: Boolean, Default: false enableY – Type: Boolean, Default: false enableZ – Type: Boolean, Default: false resolution – Type: Byte, Range: See constants, Default: 0

For high throughput of acceleration data (> 1000Hz) you have to use the ContinuousAcceleration16BitCallback or ContinuousAcceleration8BitCallback 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 ContinuousAcceleration8BitCallback callback is activated. If at least one of the axis is enabled and the resolution is set to 16 bit, the ContinuousAcceleration16BitCallback 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 SetConfiguration()) to calculate the data in gₙ/10000 (same unit that is returned by GetAcceleration()):

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 AccelerationCallback 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

Sub BrickletAccelerometerV2.GetContinuousAccelerationConfiguration(ByRef enableX As Boolean, ByRef enableY As Boolean, ByRef enableZ As Boolean, ByRef resolution As Byte)¶

Output Parameters:	enableX – Type: Boolean, Default: false enableY – Type: Boolean, Default: false enableZ – Type: Boolean, Default: false resolution – Type: Byte, Range: See constants, Default: 0

Returns the continuous acceleration configuration as set by SetContinuousAccelerationConfiguration().

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 by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletAccelerometerV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler accelerometerV2.ExampleCallback, AddressOf MyCallback

The available callback property and their 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.

Event BrickletAccelerometerV2.AccelerationCallback(ByVal sender As BrickletAccelerometerV2, ByVal x As Integer, ByVal y As Integer, ByVal z As Integer)¶

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

This callback is triggered periodically according to the configuration set by SetAccelerationCallbackConfiguration().

The parameters are the same as GetAcceleration().

Event BrickletAccelerometerV2.ContinuousAcceleration16BitCallback(ByVal sender As BrickletAccelerometerV2, ByVal acceleration() As Short)¶

Callback Parameters:	sender – Type: BrickletAccelerometerV2 acceleration – Type: Short Array, Length: 30, Unit: ? gₙ, Range: ?

Returns 30 acceleration values with 16 bit resolution. The data rate can be configured with SetConfiguration() and this callback can be enabled with SetContinuousAccelerationConfiguration().

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

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

Event BrickletAccelerometerV2.ContinuousAcceleration8BitCallback(ByVal sender As BrickletAccelerometerV2, ByVal acceleration() As Short)¶

Callback Parameters:	sender – Type: BrickletAccelerometerV2 acceleration – Type: Short Array, Length: 60, Unit: ? gₙ, Range: ?

Returns 60 acceleration values with 8 bit resolution. The data rate can be configured with SetConfiguration() and this callback can be enabled with SetContinuousAccelerationConfiguration().

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.

Function BrickletAccelerometerV2.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, 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.

Function BrickletAccelerometerV2.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	responseExpected – Type: Boolean

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 SetResponseExpected(). 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 functionId:

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

Sub BrickletAccelerometerV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameters:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

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 functionId:

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

Sub BrickletAccelerometerV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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.

Function BrickletAccelerometerV2.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameters:	mode – Type: Byte, Range: See constants
Returns:	status – Type: Byte, 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

Function BrickletAccelerometerV2.GetBootloaderMode() As Byte¶

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

Returns the current bootloader mode, see SetBootloaderMode().

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

Sub BrickletAccelerometerV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

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

Sets the firmware pointer for WriteFirmware(). 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.

Function BrickletAccelerometerV2.WriteFirmware(ByVal data() As Byte) As Byte¶

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

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() 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.

Sub BrickletAccelerometerV2.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, 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.

Function BrickletAccelerometerV2.ReadUID() As Long¶

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

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

Constants¶

Const BrickletAccelerometerV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Accelerometer Bricklet 2.0.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

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