Go - Industrial Analog Out Bricklet

This is the description of the Go API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out 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 Current

Download (example_simple_current.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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/industrial_analog_out_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 Analog Out Bricklet.

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

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

    // Set output current to 4.5mA
    iao.SetCurrent(4500)
    iao.Enable()

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

Simple Voltage

Download (example_simple_voltage.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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/industrial_analog_out_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 Analog Out Bricklet.

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

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

    // Set output voltage to 3.3V
    iao.SetVoltage(3300)
    iao.Enable()

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

API

The Industrial Analog Out Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/industrial_analog_out_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_analog_out_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialAnalogOutBricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: IndustrialAnalogOutBricklet
  • err – Type: error

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

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

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

func (*IndustrialAnalogOutBricklet) Enable() (err error)
Returns:
  • err – Type: error

Enables the output of voltage and current.

The default is disabled.

func (*IndustrialAnalogOutBricklet) Disable() (err error)
Returns:
  • err – Type: error

Disables the output of voltage and current.

The default is disabled.

func (*IndustrialAnalogOutBricklet) IsEnabled() (enabled bool, err error)
Returns:
  • enabled – Type: bool, Default: false
  • err – Type: error

Returns true if output of voltage and current is enabled, false otherwise.

func (*IndustrialAnalogOutBricklet) SetVoltage(voltage uint16) (err error)
Parameters:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 10000]
Returns:
  • err – Type: error

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

func (*IndustrialAnalogOutBricklet) GetVoltage() (voltage uint16, err error)
Returns:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 10000]
  • err – Type: error

Returns the voltage as set by SetVoltage().

func (*IndustrialAnalogOutBricklet) SetCurrent(current uint16) (err error)
Parameters:
  • current – Type: uint16, Unit: 1 µA, Range: [0 to 24000]
Returns:
  • err – Type: error

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

func (*IndustrialAnalogOutBricklet) GetCurrent() (current uint16, err error)
Returns:
  • current – Type: uint16, Unit: 1 µA, Range: [0 to 24000]
  • err – Type: error

Returns the current as set by SetCurrent().

Advanced Functions

func (*IndustrialAnalogOutBricklet) SetConfiguration(voltageRange uint8, currentRange uint8) (err error)
Parameters:
  • voltageRange – Type: uint8, Range: See constants, Default: 1
  • currentRange – Type: uint8, Range: See constants, Default: 0
Returns:
  • err – Type: error

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V

Possible current ranges are:

  • 4mA to 20mA
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

For voltageRange:

  • industrial_analog_out_bricklet.VoltageRange0To5V = 0
  • industrial_analog_out_bricklet.VoltageRange0To10V = 1

For currentRange:

  • industrial_analog_out_bricklet.CurrentRange4To20mA = 0
  • industrial_analog_out_bricklet.CurrentRange0To20mA = 1
  • industrial_analog_out_bricklet.CurrentRange0To24mA = 2
func (*IndustrialAnalogOutBricklet) GetConfiguration() (voltageRange uint8, currentRange uint8, err error)
Returns:
  • voltageRange – Type: uint8, Range: See constants, Default: 1
  • currentRange – Type: uint8, Range: See constants, Default: 0
  • err – Type: error

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

For voltageRange:

  • industrial_analog_out_bricklet.VoltageRange0To5V = 0
  • industrial_analog_out_bricklet.VoltageRange0To10V = 1

For currentRange:

  • industrial_analog_out_bricklet.CurrentRange4To20mA = 0
  • industrial_analog_out_bricklet.CurrentRange0To20mA = 1
  • industrial_analog_out_bricklet.CurrentRange0To24mA = 2
func (*IndustrialAnalogOutBricklet) 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.

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 (*IndustrialAnalogOutBricklet) 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 (*IndustrialAnalogOutBricklet) 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_analog_out_bricklet.FunctionEnable = 1
  • industrial_analog_out_bricklet.FunctionDisable = 2
  • industrial_analog_out_bricklet.FunctionSetVoltage = 4
  • industrial_analog_out_bricklet.FunctionSetCurrent = 6
  • industrial_analog_out_bricklet.FunctionSetConfiguration = 8
func (*IndustrialAnalogOutBricklet) 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_analog_out_bricklet.FunctionEnable = 1
  • industrial_analog_out_bricklet.FunctionDisable = 2
  • industrial_analog_out_bricklet.FunctionSetVoltage = 4
  • industrial_analog_out_bricklet.FunctionSetCurrent = 6
  • industrial_analog_out_bricklet.FunctionSetConfiguration = 8
func (*IndustrialAnalogOutBricklet) 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_analog_out_bricklet.DeviceIdentifier

This constant is used to identify a Industrial Analog Out 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_analog_out_bricklet.DeviceDisplayName

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