Visual Basic .NET - Analog Out Bricklet 3.0¶

Simple¶

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

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 Analog Out Bricklet 3.0

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

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

        ' Set output voltage to 3.3V
        ao.SetOutputVoltage(3300)

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

Basic Functions¶

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

Creates an object with the unique device ID uid:

Dim analogOutV3 As New BrickletAnalogOutV3("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletAnalogOutV3.SetOutputVoltage(ByVal voltage As Integer)¶

Parameters:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 12000], Default: 0

Sets the voltage.

Function BrickletAnalogOutV3.GetOutputVoltage() As Integer¶

Returns:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 12000], Default: 0

Returns the voltage as set by SetOutputVoltage().

Advanced Functions¶

Function BrickletAnalogOutV3.GetInputVoltage() As Integer¶

Returns:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 15000]

Returns the input voltage.

Sub BrickletAnalogOutV3.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 232 - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 232 - 1] errorCountFrame – Type: Long, Range: [0 to 232 - 1] errorCountOverflow – Type: Long, 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.

Sub BrickletAnalogOutV3.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:

• BrickletAnalogOutV3.STATUS_LED_CONFIG_OFF = 0
• BrickletAnalogOutV3.STATUS_LED_CONFIG_ON = 1
• BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletAnalogOutV3.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:

• BrickletAnalogOutV3.STATUS_LED_CONFIG_OFF = 0
• BrickletAnalogOutV3.STATUS_LED_CONFIG_ON = 1
• BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletAnalogOutV3.GetChipTemperature() As Short¶

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

Sub BrickletAnalogOutV3.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 BrickletAnalogOutV3.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:

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

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 BrickletAnalogOutV3.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 BrickletAnalogOutV3.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:

• BrickletAnalogOutV3.FUNCTION_SET_OUTPUT_VOLTAGE = 1
• BrickletAnalogOutV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletAnalogOutV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletAnalogOutV3.FUNCTION_RESET = 243
• BrickletAnalogOutV3.FUNCTION_WRITE_UID = 248

Sub BrickletAnalogOutV3.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.

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:

• BrickletAnalogOutV3.FUNCTION_SET_OUTPUT_VOLTAGE = 1
• BrickletAnalogOutV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletAnalogOutV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletAnalogOutV3.FUNCTION_RESET = 243
• BrickletAnalogOutV3.FUNCTION_WRITE_UID = 248

Sub BrickletAnalogOutV3.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 BrickletAnalogOutV3.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:

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

For status:

• BrickletAnalogOutV3.BOOTLOADER_STATUS_OK = 0
• BrickletAnalogOutV3.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletAnalogOutV3.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletAnalogOutV3.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletAnalogOutV3.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletAnalogOutV3.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletAnalogOutV3.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:

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

Sub BrickletAnalogOutV3.SetWriteFirmwarePointer(ByVal pointer As Long)¶

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

Function BrickletAnalogOutV3.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 BrickletAnalogOutV3.WriteUID(ByVal uid As Long)¶

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

Function BrickletAnalogOutV3.ReadUID() As Long¶

Returns:	uid – Type: Long, Range: [0 to 232 - 1]

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

Constants¶

Const BrickletAnalogOutV3.DEVICE_IDENTIFIER¶

This constant is used to identify a Analog Out Bricklet 3.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 BrickletAnalogOutV3.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Analog Out Bricklet 3.0.