Deutsch
English
Menu
Software / API Bindings / LabVIEW / API Reference and Examples / Bricklets / DC Bricklet 2.0

LabVIEW - DC Bricklet 2.0

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

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

API

Generally, every function of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletDCV2(uid, ipcon) → dcV2
Input:
  • uid – Type: String
  • ipcon – Type: .NET Refnum (IPConnection)
Output:
  • dcV2 – Type: .NET Refnum (BrickletDCV2)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletDCV2.SetEnabled(enabled)
Input:
  • enabled – Type: Boolean

Enables/Disables the driver chip. The driver parameters can be configured (velocity, acceleration, etc) before it is enabled.

BrickletDCV2.GetEnabled() → enabled
Output:
  • enabled – Type: Boolean, Default: F

Returns true if the driver chip is enabled, false otherwise.

BrickletDCV2.SetVelocity(velocity)
Input:
  • velocity – Type: Int16, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0

Sets the velocity of the motor. Whereas -32767 is full speed backward, 0 is stop and 32767 is full speed forward. Depending on the acceleration (see SetMotion()), the motor is not immediately brought to the velocity but smoothly accelerated.

The velocity describes the duty cycle of the PWM with which the motor is controlled, e.g. a velocity of 3277 sets a PWM with a 10% duty cycle. You can not only control the duty cycle of the PWM but also the frequency, see SetPWMFrequency().

BrickletDCV2.GetVelocity() → velocity
Output:
  • velocity – Type: Int16, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0

Returns the velocity as set by SetVelocity().

BrickletDCV2.GetCurrentVelocity() → velocity
Output:
  • velocity – Type: Int16, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1], Default: 0

Returns the current velocity of the motor. This value is different from GetVelocity() whenever the motor is currently accelerating to a goal set by SetVelocity().

BrickletDCV2.SetMotion(acceleration, deceleration)
Input:
  • acceleration – Type: Int32, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000
  • deceleration – Type: Int32, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000

Sets the acceleration and deceleration of the motor. It is given in velocity/s. An acceleration of 10000 means, that every second the velocity is increased by 10000 (or about 30% duty cycle).

For example: If the current velocity is 0 and you want to accelerate to a velocity of 16000 (about 50% duty cycle) in 10 seconds, you should set an acceleration of 1600.

If acceleration and deceleration is set to 0, there is no speed ramping, i.e. a new velocity is immediately given to the motor.

BrickletDCV2.GetMotion() → acceleration, deceleration
Output:
  • acceleration – Type: Int32, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000
  • deceleration – Type: Int32, Unit: 100/32767 %/s, Range: [0 to 216 - 1], Default: 10000

Returns the acceleration/deceleration as set by SetMotion().

BrickletDCV2.FullBrake()

Executes an active full brake.

Warning

This function is for emergency purposes, where an immediate brake is necessary. Depending on the current velocity and the strength of the motor, a full brake can be quite violent.

Call SetVelocity() with 0 if you just want to stop the motor.

BrickletDCV2.GetPWMFrequency() → frequency
Output:
  • frequency – Type: Int32, Unit: 1 Hz, Range: [1 to 20000], Default: 15000

Returns the PWM frequency as set by SetPWMFrequency().

BrickletDCV2.GetPowerStatistics() → voltage, current
Output:
  • voltage – Type: Int32, Unit: 1 mV, Range: [0 to 216 - 1]
  • current – Type: Int32, Unit: 1 mA, Range: [0 to 216 - 1]

Returns input voltage and current usage of the driver.

Advanced Functions

BrickletDCV2.SetDriveMode(mode)
Input:
  • mode – Type: Byte, Range: See constants, Default: 0

Sets the drive mode. Possible modes are:

  • 0 = Drive/Brake
  • 1 = Drive/Coast

These modes are different kinds of motor controls.

In Drive/Brake mode, the motor is always either driving or braking. There is no freewheeling. Advantages are: A more linear correlation between PWM and velocity, more exact accelerations and the possibility to drive with slower velocities.

In Drive/Coast mode, the motor is always either driving or freewheeling. Advantages are: Less current consumption and less demands on the motor and driver chip.

The following constants are available for this function:

For mode:

  • BrickletDCV2.DRIVE_MODE_DRIVE_BRAKE = 0
  • BrickletDCV2.DRIVE_MODE_DRIVE_COAST = 1
BrickletDCV2.GetDriveMode() → mode
Output:
  • mode – Type: Byte, Range: See constants, Default: 0

Returns the drive mode, as set by SetDriveMode().

The following constants are available for this function:

For mode:

  • BrickletDCV2.DRIVE_MODE_DRIVE_BRAKE = 0
  • BrickletDCV2.DRIVE_MODE_DRIVE_COAST = 1
BrickletDCV2.SetPWMFrequency(frequency)
Input:
  • frequency – Type: Int32, Unit: 1 Hz, Range: [1 to 20000], Default: 15000

Sets the frequency of the PWM with which the motor is driven. Often a high frequency is less noisy and the motor runs smoother. However, with a low frequency there are less switches and therefore fewer switching losses. Also with most motors lower frequencies enable higher torque.

If you have no idea what all this means, just ignore this function and use the default frequency, it will very likely work fine.

BrickletDCV2.SetErrorLEDConfig(config)
Input:
  • config – Type: Byte, Range: See constants, Default: 3

Configures the error LED to be either turned off, turned on, blink in heartbeat mode or show an error.

If the LED is configured to show errors it has three different states:

  • Off: No error present.
  • 1s interval blinking: Input voltage too low (below 6V).
  • 250ms interval blinking: Overtemperature or overcurrent.

The following constants are available for this function:

For config:

  • BrickletDCV2.ERROR_LED_CONFIG_OFF = 0
  • BrickletDCV2.ERROR_LED_CONFIG_ON = 1
  • BrickletDCV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDCV2.ERROR_LED_CONFIG_SHOW_ERROR = 3
BrickletDCV2.GetErrorLEDConfig() → config
Output:
  • config – Type: Byte, Range: See constants, Default: 3

Returns the LED configuration as set by SetErrorLEDConfig()

The following constants are available for this function:

For config:

  • BrickletDCV2.ERROR_LED_CONFIG_OFF = 0
  • BrickletDCV2.ERROR_LED_CONFIG_ON = 1
  • BrickletDCV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDCV2.ERROR_LED_CONFIG_SHOW_ERROR = 3
BrickletDCV2.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Output:
  • errorCountAckChecksum – Type: Int64, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Int64, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Int64, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Int64, Range: [0 to 232 - 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.

BrickletDCV2.SetStatusLEDConfig(config)
Input:
  • 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:

  • BrickletDCV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDCV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletDCV2.GetStatusLEDConfig() → config
Output:
  • 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:

  • BrickletDCV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDCV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDCV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDCV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletDCV2.GetChipTemperature() → temperature
Output:
  • temperature – Type: Int16, Unit: 1 °C, Range: [-215 to 215 - 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.

BrickletDCV2.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!

BrickletDCV2.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char, Range: ["a" to "h", "z"]
  • hardwareVersion – Type: Byte[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[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: Int32, Range: [0 to 216 - 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

BrickletDCV2.SetEmergencyShutdownCallbackConfiguration(enabled)
Input:
  • enabled – Type: Boolean, Default: F

Enable/Disable EmergencyShutdownCallback callback.

BrickletDCV2.GetEmergencyShutdownCallbackConfiguration() → enabled
Output:
  • enabled – Type: Boolean, Default: T

Returns the callback configuration as set by SetEmergencyShutdownCallbackConfiguration().

BrickletDCV2.SetVelocityReachedCallbackConfiguration(enabled)
Input:
  • enabled – Type: Boolean, Default: F

Enable/Disable VelocityReachedCallback callback.

BrickletDCV2.GetVelocityReachedCallbackConfiguration() → enabled
Output:
  • enabled – Type: Boolean, Default: F

Returns the callback configuration as set by SetVelocityReachedCallbackConfiguration().

BrickletDCV2.SetCurrentVelocityCallbackConfiguration(period, valueHasToChange)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F

The period is the period with which the CurrentVelocityCallback 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.

BrickletDCV2.GetCurrentVelocityCallbackConfiguration() → period, valueHasToChange
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: Boolean, Default: F

Returns the callback configuration as set by SetCurrentVelocityCallbackConfiguration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. 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 BrickletDCV2.EmergencyShutdownCallback → sender
Callback Output:
  • sender – Type: .NET Refnum (BrickletDCV2)

This callback is triggered if either the current consumption is too high (above 5A) or the temperature of the driver chip is too high (above 175°C). These two possibilities are essentially the same, since the temperature will reach this threshold immediately if the motor consumes too much current. In case of a voltage below 3.3V (external or stack) this callback is triggered as well.

If this callback is triggered, the driver chip gets disabled at the same time. That means, SetEnabled() has to be called to drive the motor again.

Note

This callback only works in Drive/Brake mode (see SetDriveMode()). In Drive/Coast mode it is unfortunately impossible to reliably read the overcurrent/overtemperature signal from the driver chip.

event BrickletDCV2.VelocityReachedCallback → sender, velocity
Callback Output:
  • sender – Type: .NET Refnum (BrickletDCV2)
  • velocity – Type: Int16, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1]

This callback is triggered whenever a set velocity is reached. For example: If a velocity of 0 is present, acceleration is set to 5000 and velocity to 10000, the VelocityReachedCallback callback will be triggered after about 2 seconds, when the set velocity is actually reached.

Note

Since we can't get any feedback from the DC motor, this only works if the acceleration (see SetMotion()) is set smaller or equal to the maximum acceleration of the motor. Otherwise the motor will lag behind the control value and the callback will be triggered too early.

event BrickletDCV2.CurrentVelocityCallback → sender, velocity
Callback Output:
  • sender – Type: .NET Refnum (BrickletDCV2)
  • velocity – Type: Int16, Unit: 100/32767 %, Range: [-215 + 1 to 215 - 1]

This callback is triggered with the period that is set by SetCurrentVelocityCallbackConfiguration(). The parameter is the current velocity used by the motor.

The CurrentVelocityCallback callback is only triggered after the set period if there is a change in the velocity.

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.

BrickletDCV2.GetAPIVersion() → apiVersion
Output:
  • apiVersion – Type: Byte[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.

BrickletDCV2.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId – Type: Byte, Range: See constants
Output:
  • 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:

  • BrickletDCV2.FUNCTION_SET_ENABLED = 1
  • BrickletDCV2.FUNCTION_SET_VELOCITY = 3
  • BrickletDCV2.FUNCTION_SET_MOTION = 6
  • BrickletDCV2.FUNCTION_FULL_BRAKE = 8
  • BrickletDCV2.FUNCTION_SET_DRIVE_MODE = 9
  • BrickletDCV2.FUNCTION_SET_PWM_FREQUENCY = 11
  • BrickletDCV2.FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BrickletDCV2.FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
  • BrickletDCV2.FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
  • BrickletDCV2.FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
  • BrickletDCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDCV2.FUNCTION_RESET = 243
  • BrickletDCV2.FUNCTION_WRITE_UID = 248
BrickletDCV2.SetResponseExpected(functionId, responseExpected)
Input:
  • 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.

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:

  • BrickletDCV2.FUNCTION_SET_ENABLED = 1
  • BrickletDCV2.FUNCTION_SET_VELOCITY = 3
  • BrickletDCV2.FUNCTION_SET_MOTION = 6
  • BrickletDCV2.FUNCTION_FULL_BRAKE = 8
  • BrickletDCV2.FUNCTION_SET_DRIVE_MODE = 9
  • BrickletDCV2.FUNCTION_SET_PWM_FREQUENCY = 11
  • BrickletDCV2.FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BrickletDCV2.FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 16
  • BrickletDCV2.FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 18
  • BrickletDCV2.FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 20
  • BrickletDCV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDCV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDCV2.FUNCTION_RESET = 243
  • BrickletDCV2.FUNCTION_WRITE_UID = 248
BrickletDCV2.SetResponseExpectedAll(responseExpected)
Input:
  • 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.

BrickletDCV2.SetBootloaderMode(mode) → status
Input:
  • mode – Type: Byte, Range: See constants
Output:
  • 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:

  • BrickletDCV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDCV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BrickletDCV2.BOOTLOADER_STATUS_OK = 0
  • BrickletDCV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDCV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDCV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDCV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDCV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletDCV2.GetBootloaderMode() → mode
Output:
  • mode – Type: Byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletDCV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDCV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDCV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletDCV2.SetWriteFirmwarePointer(pointer)
Input:
  • pointer – Type: Int64, Unit: 1 B, Range: [0 to 232 - 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.

BrickletDCV2.WriteFirmware(data) → status
Input:
  • data – Type: Byte[64], Range: [0 to 255]
Output:
  • 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.

BrickletDCV2.WriteUID(uid)
Input:
  • uid – Type: Int64, Range: [0 to 232 - 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.

BrickletDCV2.ReadUID() → uid
Output:
  • uid – Type: Int64, Range: [0 to 232 - 1]

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

Constants

BrickletDCV2.DEVICE_IDENTIFIER

This constant is used to identify a DC 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.

BrickletDCV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a DC Bricklet 2.0.