Go - Industrial Counter Bricklet

This is the description of the Go API bindings for the Industrial Counter Bricklet. General information and technical specifications for the Industrial Counter 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
28
29
30
31
32
33
34
35
package main

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ic, _ := industrial_counter_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 counter from channel 0.
    counter, _ := ic.GetCounter(industrial_counter_bricklet.Channel0)
    fmt.Printf("Counter (Channel 0): \n", counter)

    // Get current signal data from channel 0.
    dutyCycle, period, frequency, value, _ := ic.GetSignalData(industrial_counter_bricklet.Channel0)

    fmt.Printf("Duty Cycle (Channel 0): %f %\n", float64(dutyCycle)/100.0)
    fmt.Printf("Period (Channel 0):  ns\n", period)
    fmt.Printf("Frequency (Channel 0): %f Hz\n", float64(frequency)/1000.0)
    fmt.Printf("Value (Channel 0): \n", value)

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

API

The Industrial Counter Bricklet's API is defined in the package github.com/Tinkerforge/go-api-bindings/industrial_counter_bricklet

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

  • BrickletErrorSuccess = 0
  • BrickletErrorInvalidParameter = 1
  • BrickletErrorFunctionNotSupported = 2
  • BrickletErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func NewIndustrialCounterBricklet(uid string, ipcon *IPConnection)(device IndustrialCounterBricklet, err error)

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

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

func (*IndustrialCounterBricklet)GetCounter(channel Channel)(counter int64, err error)

Returns the current counter value for the given channel.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
func (*IndustrialCounterBricklet)GetAllCounter()(counter [4]int64, err error)

Returns the current counter values for all four channels.

func (*IndustrialCounterBricklet)SetCounter(channel Channel, counter int64)(err error)

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
func (*IndustrialCounterBricklet)SetAllCounter(counter [4]int64)(err error)

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

func (*IndustrialCounterBricklet)GetSignalData(channel Channel)(dutyCycle uint16, period uint64, frequency uint32, value bool, err error)

Returns the signal data (duty cycle, period, frequency and value) for the given channel.

The units are:

  • Duty Cycle: 1/100 %
  • Period: ns
  • Frequency: mHz (1/1000 Hz)
  • Value: true = high, false = low

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
func (*IndustrialCounterBricklet)GetAllSignalData()(dutyCycle [4]uint16, period [4]uint64, frequency [4]uint32, value [4]bool, err error)

Returns the signal data (duty cycle, period, frequency and value) for all four channels.

The units are:

  • Duty Cycle: 1/100 %
  • Period: ns
  • Frequency: mHz (1/1000 Hz)
  • Value: true = high, false = low
func (*IndustrialCounterBricklet)SetCounterActive(channel Channel, active bool)(err error)

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
func (*IndustrialCounterBricklet)SetAllCounterActive(active [4]bool)(err error)

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

func (*IndustrialCounterBricklet)GetCounterActive(channel Channel)(active bool, err error)

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
func (*IndustrialCounterBricklet)GetAllCounterActive()(active [4]bool, err error)

Returns the activation state of all four channels.

true = activated, false = deactivated.

func (*IndustrialCounterBricklet)SetCounterConfiguration(channel Channel, countEdge CountEdge, countDirection CountDirection, dutyCyclePrescaler DutyCyclePrescaler, frequencyIntegrationTime FrequencyIntegrationTime)(err error)

Sets the counter configuration for the given channel.

  • Count Edge: Counter can count on rising, falling or both edges.
  • Count Direction: Counter can count up or down. You can also use another channel as direction input, see here for details.
  • Duty Cycle Prescaler: Sets a divider for the internal clock. See here for details.
  • Frequency Integration Time: Sets the integration time for the frequency measurement. See here for details.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
  • CountEdgeRising = 0
  • CountEdgeFalling = 1
  • CountEdgeBoth = 2
  • CountDirectionUp = 0
  • CountDirectionDown = 1
  • CountDirectionExternalUp = 2
  • CountDirectionExternalDown = 3
  • DutyCyclePrescaler1 = 0
  • DutyCyclePrescaler2 = 1
  • DutyCyclePrescaler4 = 2
  • DutyCyclePrescaler8 = 3
  • DutyCyclePrescaler16 = 4
  • DutyCyclePrescaler32 = 5
  • DutyCyclePrescaler64 = 6
  • DutyCyclePrescaler128 = 7
  • DutyCyclePrescaler256 = 8
  • DutyCyclePrescaler512 = 9
  • DutyCyclePrescaler1024 = 10
  • DutyCyclePrescaler2048 = 11
  • DutyCyclePrescaler4096 = 12
  • DutyCyclePrescaler8192 = 13
  • DutyCyclePrescaler16384 = 14
  • DutyCyclePrescaler32768 = 15
  • FrequencyIntegrationTime128MS = 0
  • FrequencyIntegrationTime256MS = 1
  • FrequencyIntegrationTime512MS = 2
  • FrequencyIntegrationTime1024MS = 3
  • FrequencyIntegrationTime2048MS = 4
  • FrequencyIntegrationTime4096MS = 5
  • FrequencyIntegrationTime8192MS = 6
  • FrequencyIntegrationTime16384MS = 7
  • FrequencyIntegrationTime32768MS = 8
func (*IndustrialCounterBricklet)GetCounterConfiguration(channel Channel)(countEdge CountEdge, countDirection CountDirection, dutyCyclePrescaler DutyCyclePrescaler, frequencyIntegrationTime FrequencyIntegrationTime, err error)

Returns the counter configuration as set by (*IndustrialCounterBricklet) SetCounterConfiguration.

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
  • CountEdgeRising = 0
  • CountEdgeFalling = 1
  • CountEdgeBoth = 2
  • CountDirectionUp = 0
  • CountDirectionDown = 1
  • CountDirectionExternalUp = 2
  • CountDirectionExternalDown = 3
  • DutyCyclePrescaler1 = 0
  • DutyCyclePrescaler2 = 1
  • DutyCyclePrescaler4 = 2
  • DutyCyclePrescaler8 = 3
  • DutyCyclePrescaler16 = 4
  • DutyCyclePrescaler32 = 5
  • DutyCyclePrescaler64 = 6
  • DutyCyclePrescaler128 = 7
  • DutyCyclePrescaler256 = 8
  • DutyCyclePrescaler512 = 9
  • DutyCyclePrescaler1024 = 10
  • DutyCyclePrescaler2048 = 11
  • DutyCyclePrescaler4096 = 12
  • DutyCyclePrescaler8192 = 13
  • DutyCyclePrescaler16384 = 14
  • DutyCyclePrescaler32768 = 15
  • FrequencyIntegrationTime128MS = 0
  • FrequencyIntegrationTime256MS = 1
  • FrequencyIntegrationTime512MS = 2
  • FrequencyIntegrationTime1024MS = 3
  • FrequencyIntegrationTime2048MS = 4
  • FrequencyIntegrationTime4096MS = 5
  • FrequencyIntegrationTime8192MS = 6
  • FrequencyIntegrationTime16384MS = 7
  • FrequencyIntegrationTime32768MS = 8
func (*IndustrialCounterBricklet)SetChannelLEDConfig(channel Channel, config ChannelLEDConfig)(err error)

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
  • ChannelLEDConfigOff = 0
  • ChannelLEDConfigOn = 1
  • ChannelLEDConfigShowHeartbeat = 2
  • ChannelLEDConfigShowChannelStatus = 3
func (*IndustrialCounterBricklet)GetChannelLEDConfig(channel Channel)(config ChannelLEDConfig, err error)

Returns the channel LED configuration as set by (*IndustrialCounterBricklet) SetChannelLEDConfig

The following constants are available for this function:

  • Channel0 = 0
  • Channel1 = 1
  • Channel2 = 2
  • Channel3 = 3
  • ChannelLEDConfigOff = 0
  • ChannelLEDConfigOn = 1
  • ChannelLEDConfigShowHeartbeat = 2
  • ChannelLEDConfigShowChannelStatus = 3

Advanced Functions

func (*IndustrialCounterBricklet)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 (*IndustrialCounterBricklet)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 (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) SetResponseExpected for the list of function ID constants available for this function.

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

  • FunctionSetCounter = 3
  • FunctionSetAllCounter = 4
  • FunctionSetCounterActive = 7
  • FunctionSetAllCounterActive = 8
  • FunctionSetCounterConfiguration = 11
  • FunctionSetAllCounterCallbackConfiguration = 13
  • FunctionSetAllSignalDataCallbackConfiguration = 15
  • FunctionSetChannelLEDConfig = 17
  • FunctionSetWriteFirmwarePointer = 237
  • FunctionSetStatusLEDConfig = 239
  • FunctionReset = 243
  • FunctionWriteUID = 248
func (*IndustrialCounterBricklet)SetResponseExpectedAll(responseExpected bool)(err error)

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

func (*IndustrialCounterBricklet)GetSPITFPErrorCount()(errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*IndustrialCounterBricklet)SetBootloaderMode(mode BootloaderMode)(status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • BootloaderStatusOK = 0
  • BootloaderStatusInvalidMode = 1
  • BootloaderStatusNoChange = 2
  • BootloaderStatusEntryFunctionNotPresent = 3
  • BootloaderStatusDeviceIdentifierIncorrect = 4
  • BootloaderStatusCRCMismatch = 5
func (*IndustrialCounterBricklet)GetBootloaderMode()(mode BootloaderMode, err error)

Returns the current bootloader mode, see (*IndustrialCounterBricklet) SetBootloaderMode.

The following constants are available for this function:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*IndustrialCounterBricklet)SetWriteFirmwarePointer(pointer uint32)(err error)

Sets the firmware pointer for (*IndustrialCounterBricklet) WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialCounterBricklet)WriteFirmware(data [64]uint8)(status uint8, err error)

Writes 64 Bytes of firmware at the position as written by (*IndustrialCounterBricklet) SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*IndustrialCounterBricklet)SetStatusLEDConfig(config StatusLEDConfig)(err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*IndustrialCounterBricklet)GetStatusLEDConfig()(config StatusLEDConfig, err error)

Returns the configuration as set by (*IndustrialCounterBricklet) SetStatusLEDConfig

The following constants are available for this function:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*IndustrialCounterBricklet)GetChipTemperature()(temperature int16, err error)

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*IndustrialCounterBricklet)Reset()(err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*IndustrialCounterBricklet)WriteUID(uid uint32)(err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

func (*IndustrialCounterBricklet)ReadUID()(uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*IndustrialCounterBricklet)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 (*IndustrialCounterBricklet)SetAllCounterCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*IndustrialCounterBricklet) RegisterAllCounterCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

func (*IndustrialCounterBricklet)GetAllCounterCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*IndustrialCounterBricklet) SetAllCounterCallbackConfiguration.

func (*IndustrialCounterBricklet)SetAllSignalDataCallbackConfiguration(period uint32, valueHasToChange bool)(err error)

The period in ms is the period with which the (*IndustrialCounterBricklet) RegisterAllSignalDataCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

func (*IndustrialCounterBricklet)GetAllSignalDataCallbackConfiguration()(period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by (*IndustrialCounterBricklet) SetAllSignalDataCallbackConfiguration.

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 (*IndustrialCounterBricklet)RegisterAllCounterCallback(func(counter [4]int64))(callbackID uint64)

A callback can be registered for this event with the RegisterAllCounterCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterAllCounterCallback(callbackID uint64) function.

This callback is triggered periodically according to the configuration set by (*IndustrialCounterBricklet) SetAllCounterCallbackConfiguration.

The callback parameters are the same as (*IndustrialCounterBricklet) GetAllCounter.

func (*IndustrialCounterBricklet)RegisterAllSignalDataCallback(func(dutyCycle [4]uint16, period [4]uint64, frequency [4]uint32, value [4]bool))(callbackID uint64)

A callback can be registered for this event with the RegisterAllSignalDataCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterAllSignalDataCallback(callbackID uint64) function.

This callback is triggered periodically according to the configuration set by (*IndustrialCounterBricklet) SetAllSignalDataCallbackConfiguration.

The callback parameters are the same as (*IndustrialCounterBricklet) GetAllSignalData.

Constants

industrial_counter_bricklet.DeviceIdentifier

This constant is used to identify a Industrial Counter Bricklet.

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

industrial_counter_bricklet.DeviceDisplayName

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