Go - Industrial Dual Analog In Bricklet

This is the description of the Go 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 Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

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

Simple

Download (example_simple.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/industrial_dual_analog_in_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idai, _ := industrial_dual_analog_in_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current voltage from channel 1.
    voltage, _ := idai.GetVoltage(1)
    fmt.Printf("Voltage (Channel 1): %f V\n", float64(voltage)/1000.0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 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
34
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/industrial_dual_analog_in_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idai, _ := industrial_dual_analog_in_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    idai.RegisterVoltageCallback(func(channel uint8, voltage int32) {
        fmt.Printf("Channel: %d\n", channel)
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
        fmt.Println()
    })

    // Set period for voltage (channel 1) receiver to 1s (1000ms).
    // Note: The voltage (channel 1) callback is only called every second
    //       if the voltage (channel 1) has changed since the last call!
    idai.SetVoltageCallbackPeriod(1, 1000)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Threshold

Download (example_threshold.go)

 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
34
35
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/industrial_dual_analog_in_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Industrial Dual Analog In Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idai, _ := industrial_dual_analog_in_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    idai.SetDebouncePeriod(10000)

    idai.RegisterVoltageReachedCallback(func(channel uint8, voltage int32) {
        fmt.Printf("Channel: %d\n", channel)
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
        fmt.Println()
    })

    // Configure threshold for voltage (channel 1) "greater than 10 V".
    idai.SetVoltageCallbackThreshold(1, '>', 10*1000, 0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The Industrial Dual Analog In Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/industrial_dual_analog_in_bricklet

Nearly every function of the Go bindings can return an DeviceError, implementing the error interface. The error can have one of the following values:

  • DeviceErrorSuccess = 0
  • DeviceErrorInvalidParameter = 1
  • DeviceErrorFunctionNotSupported = 2
  • DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions 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

func NewIndustrialDualAnalogInBricklet(uid string, ipcon *IPConnection) (device IndustrialDualAnalogInBricklet, err error)

Creates a new IndustrialDualAnalogInBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IPConnection has been connected (see examples above).

func (*IndustrialDualAnalogInBricklet) GetVoltage(channel uint8) (voltage int32, err error)

Returns the voltage for the given channel in mV.

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

Advanced Functions

func (*IndustrialDualAnalogInBricklet) SetSampleRate(rate SampleRate) (err error)

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 default value is 6 (2 samples per second).

The following constants are available for this function:

  • SampleRate976SPS = 0
  • SampleRate488SPS = 1
  • SampleRate244SPS = 2
  • SampleRate122SPS = 3
  • SampleRate61SPS = 4
  • SampleRate4SPS = 5
  • SampleRate2SPS = 6
  • SampleRate1SPS = 7
func (*IndustrialDualAnalogInBricklet) GetSampleRate() (rate SampleRate, err error)

Returns the sample rate as set by SetSampleRate().

The following constants are available for this function:

  • SampleRate976SPS = 0
  • SampleRate488SPS = 1
  • SampleRate244SPS = 2
  • SampleRate122SPS = 3
  • SampleRate61SPS = 4
  • SampleRate4SPS = 5
  • SampleRate2SPS = 6
  • SampleRate1SPS = 7
func (*IndustrialDualAnalogInBricklet) SetCalibration(offset [2]int32, gain [2]int32) (err error)

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

func (*IndustrialDualAnalogInBricklet) GetCalibration() (offset [2]int32, gain [2]int32, err error)

Returns the calibration as set by SetCalibration().

func (*IndustrialDualAnalogInBricklet) GetADCValues() (value [2]int32, err error)

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

func (*IndustrialDualAnalogInBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

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.

func (*IndustrialDualAnalogInBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)

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.

func (*IndustrialDualAnalogInBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)

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

The following function ID constants are available for this function:

  • FunctionSetVoltageCallbackPeriod = 2
  • FunctionSetVoltageCallbackThreshold = 4
  • FunctionSetDebouncePeriod = 6
  • FunctionSetSampleRate = 8
  • FunctionSetCalibration = 10
func (*IndustrialDualAnalogInBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*IndustrialDualAnalogInBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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

func (*IndustrialDualAnalogInBricklet) SetVoltageCallbackPeriod(channel uint8, period uint32) (err error)

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

The RegisterVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

func (*IndustrialDualAnalogInBricklet) GetVoltageCallbackPeriod(channel uint8) (period uint32, err error)

Returns the period as set by SetVoltageCallbackPeriod().

func (*IndustrialDualAnalogInBricklet) SetVoltageCallbackThreshold(channel uint8, option ThresholdOption, min int32, max int32) (err error)

Sets the thresholds for the RegisterVoltageReachedCallback 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:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*IndustrialDualAnalogInBricklet) GetVoltageCallbackThreshold(channel uint8) (option ThresholdOption, min int32, max int32, err error)

Returns the threshold as set by SetVoltageCallbackThreshold().

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*IndustrialDualAnalogInBricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

func (*IndustrialDualAnalogInBricklet) GetDebouncePeriod() (debounce uint32, err error)

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 with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later.

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.

func (*IndustrialDualAnalogInBricklet) RegisterVoltageCallback(func(channel uint8, voltage int32)) (registrationId uint64)

A callback can be registered for this event with the RegisterVoltageCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterVoltageCallback(registrationId uint64) function.

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

The RegisterVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

func (*IndustrialDualAnalogInBricklet) RegisterVoltageReachedCallback(func(channel uint8, voltage int32)) (registrationId uint64)

A callback can be registered for this event with the RegisterVoltageReachedCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterVoltageReachedCallback(registrationId uint64) function.

This callback is triggered when the threshold as set by SetVoltageCallbackThreshold() is reached. The callback 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

industrial_dual_analog_in_bricklet.DeviceIdentifier

This constant is used to identify a Industrial Dual Analog In Bricklet.

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

industrial_dual_analog_in_bricklet.DeviceDisplayName

This constant represents the human readable name of a Industrial Dual Analog In Bricklet.