Visual Basic .NET - Industrial Dual Analog In 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
  - 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 - Industrial Dual Analog In Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

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

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

The Bricklet has two input channel. Functions that are related directly to a channel have a `channel` parameter to specify one of the two channels. Valid values for the `channel` parameter are 0 and 1.

### Basic Functions

Class `BrickletIndustrialDualAnalogIn`(ByVal uid As String, ByVal ipcon As IPConnection)

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

      Dim industrialDualAnalogIn As New BrickletIndustrialDualAnalogIn("YOUR_DEVICE_UID", ipcon)

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

Function `BrickletIndustrialDualAnalogIn.``GetVoltage`(ByVal channel As Byte) As Integer

  Returns the voltage for the given channel in mV.

  If you want to get the voltage periodically, it is recommended to use the callback `Voltage` and set the period with `SetVoltageCallbackPeriod()`.

### Advanced Functions

Sub `BrickletIndustrialDualAnalogIn.``SetSampleRate`(ByVal rate As Byte)

  Sets the sample rate. The sample rate can be between 1 sample per second and 976 samples per second. Decreasing the sample rate will also decrease the noise on the data.

  The following constants are available for this function:

  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7

Function `BrickletIndustrialDualAnalogIn.``GetSampleRate`() As Byte

  Returns the sample rate as set by `SetSampleRate()`.

  The following constants are available for this function:

  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_976_SPS = 0
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_488_SPS = 1
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_244_SPS = 2
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_122_SPS = 3
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_61_SPS = 4
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_4_SPS = 5
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_2_SPS = 6
  - BrickletIndustrialDualAnalogIn.SAMPLE_RATE_1_SPS = 7

Sub `BrickletIndustrialDualAnalogIn.``SetCalibration`(ByVal offset() As Integer, ByVal gain() As Integer)

  Sets offset and gain of MCP3911 internal calibration registers.

  See MCP3911 datasheet 7.7 and 7.8. The Industrial Dual Analog In Bricklet is already factory calibrated by Tinkerforge. It should not be necessary for you to use this function

Sub `BrickletIndustrialDualAnalogIn.``GetCalibration`(ByRef offset() As Integer, ByRef gain() As Integer)

  Returns the calibration as set by `SetCalibration()`.

Function `BrickletIndustrialDualAnalogIn.``GetADCValues`() As Integer()

  Returns the ADC values as given by the MCP3911 IC. This function is needed for proper calibration, see `SetCalibration()`.

Function `BrickletIndustrialDualAnalogIn.``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 `BrickletIndustrialDualAnalogIn.``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 `BrickletIndustrialDualAnalogIn.``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:

  - BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 2
  - BrickletIndustrialDualAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 4
  - BrickletIndustrialDualAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  - BrickletIndustrialDualAnalogIn.FUNCTION_SET_SAMPLE_RATE = 8
  - BrickletIndustrialDualAnalogIn.FUNCTION_SET_CALIBRATION = 10

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

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

Sub `BrickletIndustrialDualAnalogIn.``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 `BrickletIndustrialDualAnalogIn.``SetVoltageCallbackPeriod`(ByVal channel As Byte, ByVal period As Long)

  Sets the period in ms with which the `Voltage` callback is triggered periodically for the given channel. A value of 0 turns the callback off.

  `Voltage` is only triggered if the voltage has changed since the last triggering.

  The default value is 0.

Function `BrickletIndustrialDualAnalogIn.``GetVoltageCallbackPeriod`(ByVal channel As Byte) As Long

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

Sub `BrickletIndustrialDualAnalogIn.``SetVoltageCallbackThreshold`(ByVal channel As Byte, ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

  Sets the thresholds for the `VoltageReached` callback for the given channel.

  The following options are possible:

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

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

  The following constants are available for this function:

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

Sub `BrickletIndustrialDualAnalogIn.``GetVoltageCallbackThreshold`(ByVal channel As Byte, ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

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

  The following constants are available for this function:

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

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

  Sets the period in ms with which the threshold callback

  - `VoltageReached`

  is triggered, if the threshold

  - `SetVoltageCallbackThreshold()`

  keeps being reached.

  The default value is 100.

Function `BrickletIndustrialDualAnalogIn.``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 BrickletIndustrialDualAnalogIn, ByVal value As Short)
>         Console.WriteLine("Value: {0}", value)
>     End Sub

>     AddHandler industrialDualAnalogIn.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 `BrickletIndustrialDualAnalogIn.``Voltage`(ByVal sender As BrickletIndustrialDualAnalogIn, ByVal channel As Byte, ByVal voltage As Integer)

  This callback is triggered periodically with the period that is set by `SetVoltageCallbackPeriod()`. The parameter is the voltage of the channel.

  `Voltage` is only triggered if the voltage has changed since the last triggering.

Event `BrickletIndustrialDualAnalogIn.``VoltageReached`(ByVal sender As BrickletIndustrialDualAnalogIn, ByVal channel As Byte, ByVal voltage As Integer)

  This callback is triggered when the threshold as set by `SetVoltageCallbackThreshold()` is reached. The parameter is the voltage of the channel.

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

### Constants

Const `BrickletIndustrialDualAnalogIn.``DEVICE_IDENTIFIER`

  This constant is used to identify a Industrial Dual Analog In 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.