Visual Basic .NET - Current25 Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Visual Basic .NET - Current25 Bricklet

This is the description of the Visual Basic .NET API bindings for the Current25 Bricklet. General information and technical specifications for the Current25 Bricklet 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)

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

    Imports Tinkerforge

    Module ExampleSimple
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "9yW" ' Change to your UID

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

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

            ' Get current current (unit is mA)
            Dim current As Short = c25.GetCurrent()

            System.Console.WriteLine("Current: " + (current/1000.0).ToString() + " A")

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

### Callback

Download (ExampleCallback.vb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32

    Imports Tinkerforge

    Module ExampleCallback
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "ABC" ' Change to your UID

        ' Callback function for current callback (parameter has unit mA)
        Sub CurrentCB(ByVal sender As BrickletCurrent25, ByVal current As Short)
            System.Console.WriteLine("Current: " + (current/1000.0).ToString() + " A")
        End Sub

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

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

            ' Set Period for current callback to 1s (1000ms)
            ' Note: The current callback is only called every second if the
            '       current has changed since the last call!
            c25.SetCurrentCallbackPeriod(1000)

            ' Register current callback to function CurrentCB
            AddHandler c25.Current, AddressOf CurrentCB

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

### Threshold

Download (ExampleThreshold.vb)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33

    Imports Tinkerforge

    Module ExampleThreshold
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "9yW" ' Change to your UID

        ' Callback for current greater than 5A
        Sub ReachedCB(ByVal sender As BrickletCurrent25, ByVal current As Short)
            System.Console.WriteLine("Current is greater than 5A: " + (current/1000.0).ToString() + "A")
        End Sub

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

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

            ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            c25.SetDebouncePeriod(10000)

            ' Register threshold reached callback to function ReachedCB
            AddHandler c25.CurrentReached, AddressOf ReachedCB

            ' Configure threshold for "greater than 5A" (unit is mA)
            c25.SetCurrentCallbackThreshold(">"C, 5*1000, 0)

            System.Console.WriteLine("Press key to exit")
            System.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 `BrickletCurrent25`(ByVal uid As String, ByVal ipcon As IPConnection)

  Creates an object with the unique device ID `uid`:

      Dim current25 As New BrickletCurrent25("YOUR_DEVICE_UID", ipcon)

  This object can then be used after the IP Connection is connected (see examples above).

Function `BrickletCurrent25.``GetCurrent`() As Short

  Returns the current of the sensor. The value is in mA and between -25000mA and 25000mA.

  If you want to get the current periodically, it is recommended to use the callback `Current` and set the period with `SetCurrentCallbackPeriod()`.

### Advanced Functions

Sub `BrickletCurrent25.``Calibrate`()

  Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

  The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

  The resulting calibration will be saved on the EEPROM of the Current Bricklet.

Function `BrickletCurrent25.``IsOverCurrent`() As Boolean

  Returns true if more than 25A were measured.

  Note

  To reset this value you have to power cycle the Bricklet.

Function `BrickletCurrent25.``GetAnalogValue`() As Integer

  Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

  Note

  The value returned by `GetCurrent()` is averaged over several samples to yield less noise, while `GetAnalogValue()` gives back raw unfiltered analog values. The only reason to use `GetAnalogValue()` is, if you need the full resolution of the analog-to-digital converter.

  If you want the analog value periodically, it is recommended to use the callback `AnalogValue` and set the period with `SetAnalogValueCallbackPeriod()`.

Function `BrickletCurrent25.``GetAPIVersion`() As Byte()

  Returns the version of the API definition (major, minor, revision) 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 `BrickletCurrent25.``GetResponseExpected`(ByVal functionId As Byte) As 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 send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected()` for the list of function ID constants available for this function.

Sub `BrickletCurrent25.``SetResponseExpected`(ByVal functionId As Byte, ByVal responseExpected As 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 and callbacks it is always disabled.

  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 send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - BrickletCurrent25.FUNCTION_CALIBRATE = 2
  - BrickletCurrent25.FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 5
  - BrickletCurrent25.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  - BrickletCurrent25.FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 9
  - BrickletCurrent25.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  - BrickletCurrent25.FUNCTION_SET_DEBOUNCE_PERIOD = 13

Sub `BrickletCurrent25.``SetResponseExpectedAll`(ByVal responseExpected As Boolean)

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

Sub `BrickletCurrent25.``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)

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

### Callback Configuration Functions

Sub `BrickletCurrent25.``SetCurrentCallbackPeriod`(ByVal period As Long)

  Sets the period in ms with which the `Current` callback is triggered periodically. A value of 0 turns the callback off.

  `Current` is only triggered if the current has changed since the last triggering.

  The default value is 0.

Function `BrickletCurrent25.``GetCurrentCallbackPeriod`() As Long

  Returns the period as set by `SetCurrentCallbackPeriod()`.

Sub `BrickletCurrent25.``SetAnalogValueCallbackPeriod`(ByVal period As Long)

  Sets the period in ms with which the `AnalogValue` callback is triggered periodically. A value of 0 turns the callback off.

  `AnalogValue` is only triggered if the analog value has changed since the last triggering.

  The default value is 0.

Function `BrickletCurrent25.``GetAnalogValueCallbackPeriod`() As Long

  Returns the period as set by `SetAnalogValueCallbackPeriod()`.

Sub `BrickletCurrent25.``SetCurrentCallbackThreshold`(ByVal option As Char, ByVal min As Short, ByVal max As Short)

  Sets the thresholds for the `CurrentReached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the current is outside the min and max values
  'i' | Callback is triggered when the current is inside the min and max values
  '<' | Callback is triggered when the current is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the current is greater than the min value (max is ignored)

  The default value is ('x', 0, 0).

  The following constants are available for this function:

  - BrickletCurrent25.THRESHOLD_OPTION_OFF = "x"C
  - BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = "o"C
  - BrickletCurrent25.THRESHOLD_OPTION_INSIDE = "i"C
  - BrickletCurrent25.THRESHOLD_OPTION_SMALLER = "<"C
  - BrickletCurrent25.THRESHOLD_OPTION_GREATER = ">"C

Sub `BrickletCurrent25.``GetCurrentCallbackThreshold`(ByRef option As Char, ByRef min As Short, ByRef max As Short)

  Returns the threshold as set by `SetCurrentCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletCurrent25.THRESHOLD_OPTION_OFF = "x"C
  - BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = "o"C
  - BrickletCurrent25.THRESHOLD_OPTION_INSIDE = "i"C
  - BrickletCurrent25.THRESHOLD_OPTION_SMALLER = "<"C
  - BrickletCurrent25.THRESHOLD_OPTION_GREATER = ">"C

Sub `BrickletCurrent25.``SetAnalogValueCallbackThreshold`(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

  Sets the thresholds for the `AnalogValueReached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the analog value is outside the min and max values
  'i' | Callback is triggered when the analog value is inside the min and max values
  '<' | Callback is triggered when the analog value is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the analog value is greater than the min value (max is ignored)

  The default value is ('x', 0, 0).

  The following constants are available for this function:

  - BrickletCurrent25.THRESHOLD_OPTION_OFF = "x"C
  - BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = "o"C
  - BrickletCurrent25.THRESHOLD_OPTION_INSIDE = "i"C
  - BrickletCurrent25.THRESHOLD_OPTION_SMALLER = "<"C
  - BrickletCurrent25.THRESHOLD_OPTION_GREATER = ">"C

Sub `BrickletCurrent25.``GetAnalogValueCallbackThreshold`(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

  Returns the threshold as set by `SetAnalogValueCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletCurrent25.THRESHOLD_OPTION_OFF = "x"C
  - BrickletCurrent25.THRESHOLD_OPTION_OUTSIDE = "o"C
  - BrickletCurrent25.THRESHOLD_OPTION_INSIDE = "i"C
  - BrickletCurrent25.THRESHOLD_OPTION_SMALLER = "<"C
  - BrickletCurrent25.THRESHOLD_OPTION_GREATER = ">"C

Sub `BrickletCurrent25.``SetDebouncePeriod`(ByVal debounce As Long)

  Sets the period in ms with which the threshold callbacks

  - `CurrentReached`,
  - `AnalogValueReached`

  are triggered, if the thresholds

  - `SetCurrentCallbackThreshold()`,
  - `SetAnalogValueCallbackThreshold()`

  keep being reached.

  The default value is 100.

Function `BrickletCurrent25.``GetDebouncePeriod`() As Long

  Returns the debounce period as set by `SetDebouncePeriod()`.

### 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 Callback(ByVal sender As BrickletCurrent25, ByVal value As Short)
>         Console.WriteLine("Value: {0}", value)
>     End Sub

>     AddHandler current25.Example, AddressOf Callback

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 `BrickletCurrent25.``Current`(ByVal sender As BrickletCurrent25, ByVal current As Short)

  This callback is triggered periodically with the period that is set by `SetCurrentCallbackPeriod()`. The parameter is the current of the sensor.

  `Current` is only triggered if the current has changed since the last triggering.

Event `BrickletCurrent25.``AnalogValue`(ByVal sender As BrickletCurrent25, ByVal value As Integer)

  This callback is triggered periodically with the period that is set by `SetAnalogValueCallbackPeriod()`. The parameter is the analog value of the sensor.

  `AnalogValue` is only triggered if the current has changed since the last triggering.

Event `BrickletCurrent25.``CurrentReached`(ByVal sender As BrickletCurrent25, ByVal current As Short)

  This callback is triggered when the threshold as set by `SetCurrentCallbackThreshold()` is reached. The parameter is the current of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod()`.

Event `BrickletCurrent25.``AnalogValueReached`(ByVal sender As BrickletCurrent25, ByVal value As Integer)

  This callback is triggered when the threshold as set by `SetAnalogValueCallbackThreshold()` is reached. The parameter is the analog value of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `SetDebouncePeriod()`.

Event `BrickletCurrent25.``OverCurrent`(ByVal sender As BrickletCurrent25)

  This callback is triggered when an over current is measured (see `IsOverCurrent()`).

### Constants

Const `BrickletCurrent25.``DEVICE_IDENTIFIER`

  This constant is used to identify a Current25 Bricklet.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.