Go - Industrial Dual 0-20mA Bricklet

This is the description of the Go API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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_0_20ma_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 0-20mA Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    id020, _ := industrial_dual_0_20ma_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 current from sensor 1.
    current, _ := id020.GetCurrent(1)
    fmt.Printf("Current (Sensor 1): %f mA\n", float64(current)/1000000.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_0_20ma_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 0-20mA Bricklet.

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

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

    id020.RegisterCurrentCallback(func(sensor uint8, current int32) {
        fmt.Printf("Sensor: %d\n", sensor)
        fmt.Printf("Current: %f mA\n", float64(current)/1000000.0)
        fmt.Println()
    })

    // Set period for current (sensor 1) receiver to 1s (1000ms).
    // Note: The current (sensor 1) callback is only called every second
    //       if the current (sensor 1) has changed since the last call!
    id020.SetCurrentCallbackPeriod(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_0_20ma_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 0-20mA Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    id020, _ := industrial_dual_0_20ma_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).
    id020.SetDebouncePeriod(10000)

    id020.RegisterCurrentReachedCallback(func(sensor uint8, current int32) {
        fmt.Printf("Sensor: %d\n", sensor)
        fmt.Printf("Current: %f mA\n", float64(current)/1000000.0)
        fmt.Println()
    })

    // Configure threshold for current (sensor 1) "greater than 10 mA".
    id020.SetCurrentCallbackThreshold(1, '>', 10*1000000, 0)

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

API

The Industrial Dual 0-20mA Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/industrial_dual_0_20ma_bricklet

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

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

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func industrial_dual_0_20ma_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialDual020mABricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: IndustrialDual020mABricklet
  • err – Type: error

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

device, err := industrial_dual_0_20ma_bricklet.New("YOUR_DEVICE_UID", &ipcon)

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

func (*IndustrialDual020mABricklet) GetCurrent(sensor uint8) (current int32, err error)
Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
Returns:
  • current – Type: int32, Unit: 1 nA, Range: [0 to 22505322]
  • err – Type: error

Returns the current of the specified sensor.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works properly.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

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

Advanced Functions

func (*IndustrialDual020mABricklet) SetSampleRate(rate uint8) (err error)
Parameters:
  • rate – Type: uint8, Range: See constants, Default: 3
Returns:
  • err – Type: error

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value Description
0 240 samples per second, 12 bit resolution
1 60 samples per second, 14 bit resolution
2 15 samples per second, 16 bit resolution
3 4 samples per second, 18 bit resolution

The following constants are available for this function:

For rate:

  • industrial_dual_0_20ma_bricklet.SampleRate240SPS = 0
  • industrial_dual_0_20ma_bricklet.SampleRate60SPS = 1
  • industrial_dual_0_20ma_bricklet.SampleRate15SPS = 2
  • industrial_dual_0_20ma_bricklet.SampleRate4SPS = 3
func (*IndustrialDual020mABricklet) GetSampleRate() (rate uint8, err error)
Returns:
  • rate – Type: uint8, Range: See constants, Default: 3
  • err – Type: error

Returns the sample rate as set by SetSampleRate().

The following constants are available for this function:

For rate:

  • industrial_dual_0_20ma_bricklet.SampleRate240SPS = 0
  • industrial_dual_0_20ma_bricklet.SampleRate60SPS = 1
  • industrial_dual_0_20ma_bricklet.SampleRate15SPS = 2
  • industrial_dual_0_20ma_bricklet.SampleRate4SPS = 3
func (*IndustrialDual020mABricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Returns:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: rune, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmwareVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • deviceIdentifier – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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

func (*IndustrialDual020mABricklet) SetCurrentCallbackPeriod(sensor uint8, period uint32) (err error)
Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Returns:
  • err – Type: error

Sets the period with which the RegisterCurrentCallback callback is triggered periodically for the given sensor. A value of 0 turns the callback off.

The RegisterCurrentCallback callback is only triggered if the current has changed since the last triggering.

func (*IndustrialDual020mABricklet) GetCurrentCallbackPeriod(sensor uint8) (period uint32, err error)
Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
Returns:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • err – Type: error

Returns the period as set by SetCurrentCallbackPeriod().

func (*IndustrialDual020mABricklet) SetCurrentCallbackThreshold(sensor uint8, option rune, min int32, max int32) (err error)
Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
  • option – Type: rune, Range: See constants, Default: 'x'
  • min – Type: int32, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int32, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
Returns:
  • err – Type: error

Sets the thresholds for the RegisterCurrentReachedCallback callback for the given sensor.

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 following constants are available for this function:

For option:

  • industrial_dual_0_20ma_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDual020mABricklet) GetCurrentCallbackThreshold(sensor uint8) (option rune, min int32, max int32, err error)
Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
Returns:
  • option – Type: rune, Range: See constants, Default: 'x'
  • min – Type: int32, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int32, Unit: 1 nA, Range: [-231 to 231 - 1], Default: 0
  • err – Type: error

Returns the threshold as set by SetCurrentCallbackThreshold().

The following constants are available for this function:

For option:

  • industrial_dual_0_20ma_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDual020mABricklet) SetDebouncePeriod(debounce uint32) (err error)
Parameters:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Returns:
  • err – Type: error

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

func (*IndustrialDual020mABricklet) GetDebouncePeriod() (debounce uint32, err error)
Returns:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
  • err – Type: 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 with the corresponding Deregister*Callback function.

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 (*IndustrialDual020mABricklet) RegisterCurrentCallback(func(sensor uint8, current int32)) (registrationId uint64)
Callback Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
  • current – Type: int32, Unit: 1 nA, Range: [0 to 22505322]
Returns:
  • registrationId – Type: uint64

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

The RegisterCurrentCallback callback is only triggered if the current has changed since the last triggering.

func (*IndustrialDual020mABricklet) RegisterCurrentReachedCallback(func(sensor uint8, current int32)) (registrationId uint64)
Callback Parameters:
  • sensor – Type: uint8, Range: [0 to 1]
  • current – Type: int32, Unit: 1 nA, Range: [0 to 22505322]
Returns:
  • registrationId – Type: uint64

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

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.

func (*IndustrialDual020mABricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Returns:
  • apiVersion – Type: [3]uint8
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • err – Type: error

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.

func (*IndustrialDual020mABricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
Returns:
  • responseExpected – Type: bool
  • err – Type: 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.

The following constants are available for this function:

For functionId:

  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackPeriod = 2
  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackThreshold = 4
  • industrial_dual_0_20ma_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_0_20ma_bricklet.FunctionSetSampleRate = 8
func (*IndustrialDual020mABricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameters:
  • functionId – Type: uint8, Range: See constants
  • responseExpected – Type: bool
Returns:
  • err – Type: 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 constants are available for this function:

For functionId:

  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackPeriod = 2
  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackThreshold = 4
  • industrial_dual_0_20ma_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_0_20ma_bricklet.FunctionSetSampleRate = 8
func (*IndustrialDual020mABricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameters:
  • responseExpected – Type: bool
Returns:
  • err – Type: error

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

Constants

industrial_dual_0_20ma_bricklet.DeviceIdentifier

This constant is used to identify a Industrial Dual 0-20mA 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_0_20ma_bricklet.DeviceDisplayName

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.