Software / API Bindings / Go / API Reference and Examples / Bricklets (Discontinued) / Analog In Bricklet

Go - Analog In Bricklet¶

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

package main

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ai, _ := 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.
    voltage, _ := ai.GetVoltage()
    fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)

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

Callback¶

Download (example_callback.go)

package main

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

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

    ai.RegisterVoltageCallback(func(voltage uint16) {
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
    })

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

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

Threshold¶

Download (example_threshold.go)

package main

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

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

    ai.RegisterVoltageReachedCallback(func(voltage uint16) {
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
    })

    // Configure threshold for voltage "smaller than 5 V".
    ai.SetVoltageCallbackThreshold('<', 5*1000, 0)

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

API¶

The Analog In Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/analog_in_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 analog_in_bricklet.New(uid string, ipcon *IPConnection) (device AnalogInBricklet, err error)¶

Parameters:	uid – Type: string ipcon – Type: *IPConnection
Returns:	device – Type: AnalogInBricklet err – Type: error

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

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

This device object can be used after the IPConnection has been connected.

func (*AnalogInBricklet) GetVoltage() (voltage uint16, err error)¶

Returns:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 45000] err – Type: error

Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.

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

func (*AnalogInBricklet) SetRange(range_ uint8) (err error)¶

Parameters:	range – Type: uint8, Range: See constants, Default: 0
Returns:	err – Type: error

Sets the measurement range. Possible ranges:

0: Automatically switched
1: 0V - 6.05V, ~1.48mV resolution
2: 0V - 10.32V, ~2.52mV resolution
3: 0V - 36.30V, ~8.86mV resolution
4: 0V - 45.00V, ~11.25mV resolution
5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3 (Plugin)

The following constants are available for this function:

For range:

analog_in_bricklet.RangeAutomatic = 0
analog_in_bricklet.RangeUpTo6V = 1
analog_in_bricklet.RangeUpTo10V = 2
analog_in_bricklet.RangeUpTo36V = 3
analog_in_bricklet.RangeUpTo45V = 4
analog_in_bricklet.RangeUpTo3V = 5

New in version 2.0.1 (Plugin).

func (*AnalogInBricklet) GetRange() (range_ uint8, err error)¶

Returns:	range – Type: uint8, Range: See constants, Default: 0 err – Type: error

Returns the measurement range as set by SetRange().

The following constants are available for this function:

For range:

analog_in_bricklet.RangeAutomatic = 0
analog_in_bricklet.RangeUpTo6V = 1
analog_in_bricklet.RangeUpTo10V = 2
analog_in_bricklet.RangeUpTo36V = 3
analog_in_bricklet.RangeUpTo45V = 4
analog_in_bricklet.RangeUpTo3V = 5

New in version 2.0.1 (Plugin).

Advanced Functions¶

func (*AnalogInBricklet) GetAnalogValue() (value uint16, err error)¶

Returns:	value – Type: uint16, Range: [0 to 2¹² - 1] err – Type: error

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by GetVoltage() 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 AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

func (*AnalogInBricklet) SetAveraging(average uint8) (err error)¶

Parameters:	average – Type: uint8, Range: [0 to 255], Default: 50
Returns:	err – Type: error

Set the length of a averaging for the voltage value.

Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

New in version 2.0.3 (Plugin).

func (*AnalogInBricklet) GetAveraging() (average uint8, err error)¶

Returns:	average – Type: uint8, Range: [0 to 255], Default: 50 err – Type: error

Returns the averaging configuration as set by SetAveraging().

New in version 2.0.3 (Plugin).

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

Returns:

Returns:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: rune, Range: ['a' to 'h', '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 2¹⁶ - 1] err – Type: error

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: rune, Range: ['a' to 'h', '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 2¹⁶ - 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). A Bricklet connected to an Isolator Bricklet is always at 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 (*AnalogInBricklet) SetVoltageCallbackPeriod(period uint32) (err error)¶

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	err – Type: error

Sets the period with which the VoltageCallback callback is triggered periodically. A value of 0 turns the callback off.

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

func (*AnalogInBricklet) GetVoltageCallbackPeriod() (period uint32, err error)¶

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 err – Type: error

Returns the period as set by SetVoltageCallbackPeriod().

func (*AnalogInBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)¶

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	err – Type: error

Sets the period with which the AnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

func (*AnalogInBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)¶

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 err – Type: error

Returns the period as set by SetAnalogValueCallbackPeriod().

func (*AnalogInBricklet) SetVoltageCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0
Returns:	err – Type: error

Sets the thresholds for the VoltageReachedCallback callback.

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

For option:

analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'

func (*AnalogInBricklet) GetVoltageCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 err – Type: error

Returns the threshold as set by SetVoltageCallbackThreshold().

The following constants are available for this function:

For option:

analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'

func (*AnalogInBricklet) SetAnalogValueCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0
Returns:	err – Type: error

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

For option:

analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'

func (*AnalogInBricklet) GetAnalogValueCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: uint16, Range: [0 to 2¹⁶ - 1], Default: 0 err – Type: error

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'

func (*AnalogInBricklet) SetDebouncePeriod(debounce uint32) (err error)¶

Parameters:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	err – Type: error

Sets the period with which the threshold callbacks

VoltageReachedCallback,
AnalogValueReachedCallback

are triggered, if the thresholds

SetVoltageCallbackThreshold(),
SetAnalogValueCallbackThreshold()

keep being reached.

func (*AnalogInBricklet) GetDebouncePeriod() (debounce uint32, err error)¶

Returns:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 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 (*AnalogInBricklet) RegisterVoltageCallback(func(voltage uint16)) (registrationId uint64)¶

Callback Parameters:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 45000]
Returns:	registrationId – Type: uint64

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

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

func (*AnalogInBricklet) RegisterAnalogValueCallback(func(value uint16)) (registrationId uint64)¶

Callback Parameters:	value – Type: uint16, Range: [0 to 2¹² - 1]
Returns:	registrationId – Type: uint64

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

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

func (*AnalogInBricklet) RegisterVoltageReachedCallback(func(voltage uint16)) (registrationId uint64)¶

Callback Parameters:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 45000]
Returns:	registrationId – Type: uint64

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

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

func (*AnalogInBricklet) RegisterAnalogValueReachedCallback(func(value uint16)) (registrationId uint64)¶

Callback Parameters:	value – Type: uint16, Range: [0 to 2¹² - 1]
Returns:	registrationId – Type: uint64

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

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 (*AnalogInBricklet) 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 (*AnalogInBricklet) 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 3
analog_in_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 7
analog_in_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
analog_in_bricklet.FunctionSetDebouncePeriod = 11
analog_in_bricklet.FunctionSetRange = 17
analog_in_bricklet.FunctionSetAveraging = 19

func (*AnalogInBricklet) 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.

The following constants are available for this function:

For functionId:

analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 3
analog_in_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 7
analog_in_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
analog_in_bricklet.FunctionSetDebouncePeriod = 11
analog_in_bricklet.FunctionSetRange = 17
analog_in_bricklet.FunctionSetAveraging = 19

func (*AnalogInBricklet) 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¶

analog_in_bricklet.DeviceIdentifier¶

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

analog_in_bricklet.DeviceDisplayName¶: This constant represents the human readable name of a Analog In Bricklet.