Go - Industrial Digital In 4 Bricklet

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idi4, _ := industrial_digital_in_4_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 value as bitmask.
    valueMask, _ := idi4.GetValue()
    fmt.Printf("Value Mask: %b\n", valueMask)

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

Interrupt

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

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

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

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

    idi4.RegisterInterruptCallback(func(interruptMask uint16, valueMask uint16) {
        fmt.Printf("Interrupt Mask: %b\n", interruptMask)
        fmt.Printf("Value Mask: %b\n", valueMask)
        fmt.Println()
    })

    // Enable interrupt on pin 0
    idi4.SetInterrupt(1 << 0)

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

API

The Industrial Digital In 4 Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/industrial_digital_in_4_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_digital_in_4_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialDigitalIn4Bricklet, err error)
Parameters:
  • uid – Type: string
  • ipcon – Type: *IPConnection
Returns:
  • device – Type: IndustrialDigitalIn4Bricklet
  • err – Type: error

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

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

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

func (*IndustrialDigitalIn4Bricklet) GetValue() (valueMask uint16, err error)
Returns:
  • valueMask – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: error

Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

If no groups are used (see SetGroup()), the pins correspond to the markings on the IndustrialDigital In 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

func (*IndustrialDigitalIn4Bricklet) GetEdgeCount(pin uint8, resetCounter bool) (count uint32, err error)
Parameters:
  • pin – Type: uint8, Range: [0 to 3]
  • resetCounter – Type: bool
Returns:
  • count – Type: uint32, Range: [0 to 232 - 1]
  • err – Type: error

Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with SetEdgeCountConfig().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The edge counters use the grouping as set by SetGroup().

New in version 2.0.1 (Plugin).

Advanced Functions

func (*IndustrialDigitalIn4Bricklet) SetGroup(group [4]rune) (err error)
Parameters:
  • group – Type: [4]rune, Range: ['a' to 'd', 'n']
Returns:
  • err – Type: error

Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with GetAvailableForGroup().

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Digital In 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call GetValue() and read out two Bricklets at the same time.

Changing the group configuration resets all edge counter configurations and values.

func (*IndustrialDigitalIn4Bricklet) GetGroup() (group [4]rune, err error)
Returns:
  • group – Type: [4]rune, Range: ['a' to 'd', 'n']
  • err – Type: error

Returns the group as set by SetGroup()

func (*IndustrialDigitalIn4Bricklet) GetAvailableForGroup() (available uint8, err error)
Returns:
  • available – Type: uint8, Range: [0 to 15]
  • err – Type: error

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

func (*IndustrialDigitalIn4Bricklet) SetEdgeCountConfig(selectionMask uint16, edgeType uint8, debounce uint8) (err error)
Parameters:
  • selectionMask – Type: uint16, Range: [0 to 216 - 1]
  • edgeType – Type: uint8, Range: See constants, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:
  • err – Type: error

Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  • 0 = rising
  • 1 = falling
  • 2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The edge counters use the grouping as set by SetGroup().

The following constants are available for this function:

For edgeType:

  • industrial_digital_in_4_bricklet.EdgeTypeRising = 0
  • industrial_digital_in_4_bricklet.EdgeTypeFalling = 1
  • industrial_digital_in_4_bricklet.EdgeTypeBoth = 2

New in version 2.0.1 (Plugin).

func (*IndustrialDigitalIn4Bricklet) GetEdgeCountConfig(pin uint8) (edgeType uint8, debounce uint8, err error)
Parameters:
  • pin – Type: uint8, Range: [0 to 255]
Returns:
  • edgeType – Type: uint8, Range: See constants, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100
  • err – Type: error

Returns the edge type and debounce time for the selected pin as set by SetEdgeCountConfig().

The following constants are available for this function:

For edgeType:

  • industrial_digital_in_4_bricklet.EdgeTypeRising = 0
  • industrial_digital_in_4_bricklet.EdgeTypeFalling = 1
  • industrial_digital_in_4_bricklet.EdgeTypeBoth = 2

New in version 2.0.1 (Plugin).

func (*IndustrialDigitalIn4Bricklet) 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', '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). A 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 (*IndustrialDigitalIn4Bricklet) 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 debounce period of the InterruptCallback callback.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the Digital In 4 Bricklet, such as a button.

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

func (*IndustrialDigitalIn4Bricklet) SetInterrupt(interruptMask uint16) (err error)
Parameters:
  • interruptMask – Type: uint16, Range: [0 to 216 - 1]
Returns:
  • err – Type: error

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for pins 0 and 3.

The interrupts use the grouping as set by SetGroup().

The interrupt is delivered with the InterruptCallback callback.

func (*IndustrialDigitalIn4Bricklet) GetInterrupt() (interruptMask uint16, err error)
Returns:
  • interruptMask – Type: uint16, Range: [0 to 216 - 1]
  • err – Type: error

Returns the interrupt bitmask as set by SetInterrupt().

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 (*IndustrialDigitalIn4Bricklet) RegisterInterruptCallback(func(interruptMask uint16, valueMask uint16)) (registrationId uint64)
Callback Parameters:
  • interruptMask – Type: uint16, Range: [0 to 216 - 1]
  • valueMask – Type: uint16, Range: [0 to 216 - 1]
Returns:
  • registrationId – Type: uint64

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with SetInterrupt().

The values are a bitmask that specifies which interrupts occurred and the current value bitmask.

For example:

  • (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
  • (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

The interrupts use the grouping as set by SetGroup().

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 (*IndustrialDigitalIn4Bricklet) 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 (*IndustrialDigitalIn4Bricklet) 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:

  • industrial_digital_in_4_bricklet.FunctionSetGroup = 2
  • industrial_digital_in_4_bricklet.FunctionSetDebouncePeriod = 5
  • industrial_digital_in_4_bricklet.FunctionSetInterrupt = 7
  • industrial_digital_in_4_bricklet.FunctionSetEdgeCountConfig = 11
func (*IndustrialDigitalIn4Bricklet) 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • industrial_digital_in_4_bricklet.FunctionSetGroup = 2
  • industrial_digital_in_4_bricklet.FunctionSetDebouncePeriod = 5
  • industrial_digital_in_4_bricklet.FunctionSetInterrupt = 7
  • industrial_digital_in_4_bricklet.FunctionSetEdgeCountConfig = 11
func (*IndustrialDigitalIn4Bricklet) 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_digital_in_4_bricklet.DeviceIdentifier

This constant is used to identify a Industrial Digital In 4 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_digital_in_4_bricklet.DeviceDisplayName

This constant represents the human readable name of a Industrial Digital In 4 Bricklet.